Skip to content

Commit

Permalink
feat: update README about gas (#3)
Browse files Browse the repository at this point in the history
# Summary

Update README, make it more explicit that gas tokens are withdrawn from
MSCA wallets.

## Detail

## Testing

## Documentation

---

**Requested Reviewers:** @mention
  • Loading branch information
yifan-circle authored Jan 10, 2025
1 parent b319125 commit 77c6951
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# msca-wallet-recovery

Official repository for interfacing with modular smart contract account (MSCA) wallets
Official repository for interfacing with ERC-6900 modular smart contract account (MSCA) wallets

## Introduction

Demonstrates how to interface with an MSCA wallet.
Demonstrates how to interface with Circle's ERC-6900 MSCA wallets.
Generalizes provider (i.e. Alchemy, Infura, etc.) for broadcasting user ops and uses standard SDKs for packing/unpacking data (viem + permissionless).
IMPORTANT: assumes MSCA wallet has been deployed to blockchain (on-chain nonce > 0).
Demonstrates the following:
Expand All @@ -14,6 +14,10 @@ Demonstrates the following:
- Note, gas fees are by default set to snapshot values from mempool when user op is built. This can lead to failures when broadcasting if gas fees rise before the user op is sent. You can modify `GAS_FEES_MULTIPLIER` env var to a value larger than 1 to pay more gas fees, which will make it more likely the token transfer will succeed and speed up the time it takes for the token transfer to be settled.
- Utility function for signing text with wallet

## Prerequisites

With transactions originating from a MSCA wallet, the gas fee is withdrawn from the MSCA wallet's native token balance. Prior to sending any transactions, please ensure that you have deposited sufficient amount of native tokens into the MSCA wallet. Please also be noted that MSCA wallet transactions cannot withdraw gas tokens from the owner wallets of the MSCA wallet.

## Supported Blockchains

- Polygon PoS (Mainnet/Amoy)
Expand Down

0 comments on commit 77c6951

Please sign in to comment.