Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updated with V2 Compatibility #63

Closed
wants to merge 9 commits into from
Closed

README updated with V2 Compatibility #63

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d11e0a9
SDK 0.2.0-beta.3 version release (#56)
anshulforyou Jan 10, 2024
1a35ff4
Version 0.2.0-beta.4 bigNumber dependency removed (#61)
anshulforyou Jan 12, 2024
b4aad59
update: readem compatible w/ v2
megabyte0x Jan 14, 2024
81771c3
updated table
megabyte0x Jan 14, 2024
09dd79d
Update README.md
megabyte0x Jan 14, 2024
5e4f171
updated with new field types
megabyte0x Jan 15, 2024
5dae0a4
Update README.md
megabyte0x Jan 15, 2024
3f41f85
add: dashobard image
megabyte0x Jan 15, 2024
86c9b51
fix: migration -> migrate
megabyte0x Jan 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 65 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ The Aarc SDK is a TypeScript library that makes it easy for developers to transf
- ERC20Permit support for streamlined token approvals.
- Gasless transactions using Relayers (EIP2771).

# Getting Started

## Prerequisites
- Node.js (v12.x or later)
- Basic understanding of Ethereum and smart contracts.
Expand All @@ -18,11 +20,9 @@ Install ethers.js and Aarc SDK using npm:
npm install ethers@5.7.2 aarc-sdk
```

# Getting Started

## Get the API Key

To use Aarc SDK, an API key is required. Fill out [this form](https://rebrand.ly/aarc-api) to get the API Key on your email instantly!
To use Aarc SDK, an API key is required. Get the **API Key** from the [Dashboard](https://dashboard.aarc.xyz/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mention the link of the gitbook as well here on the steps to fuel the gas tank

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added the link and a single image of dashboard. Mentioning all the steps here is not necessary IMO.


## Initialise the SDK

Expand All @@ -40,7 +40,21 @@ let aarcSDK = new AarcSDK({

# Usage

## Fetching token balances
- [Fetching Token Balances](#fetching-token-balances)
- [Mirgate Assets](#mirgate-assets)
- [Migration Assets \[With Gasless Flow\]](#migration-assets-with-gasless-flow)
- [Migration of Assets \[Pay Gas with Stables\]](#migration-of-assets-pay-gas-with-stables)
- [Moving Native Tokens and Wallet Deployment](#moving-native-tokens-and-wallet-deployment)
- [Smart Wallet Integration](#smart-wallet-integration)
- [Safe Smart Wallet](#safe-smart-wallet)
- [Fetching Existing Safes](#fetching-existing-safes)
- [Creating a New Safe Wallet](#creating-a-new-safe-wallet)
- [Biconomy Smart Wallet](#biconomy-smart-wallet)
- [Fetching Biconomy Smart Wallets](#fetching-biconomy-smart-wallets)
- [Creating a New Biconomy Wallet](#creating-a-new-biconomy-wallet)
- [Smart Wallet Deployment](#smart-wallet-deployment)

## Fetching Token Balances

Retrieve balances of all tokens in an EOA wallet:

Expand All @@ -52,7 +66,8 @@ let balances = await aarcSDK.fetchBalances(
);
```

## Moving Assets

## Mirgate Assets
megabyte0x marked this conversation as resolved.
Show resolved Hide resolved

Transfer tokens from EOA to any receiver wallet address:

Expand All @@ -73,23 +88,23 @@ await aarcSDK.executeMigration({
// Returns the response given below
```

Output:
### Output
```bash
[
{
tokenAddress,
amount,
message,
txHash,
tokenId
tokenAddress: string;
taskId?: string;
amount?: BigNumber | BigNumberish;
message: string;
txHash?: string;
tokenId?: string;
},
...
]
```

### Moving Assets without gas
## Migration Assets [With Gasless Flow]
megabyte0x marked this conversation as resolved.
Show resolved Hide resolved

Transfer tokens from EOA to any receiver wallet address without gas fees. Please note that we use Gelato Relayer to provide the gasless functionality. Please get the Gelato [API Key](https://docs.gelato.network/developer-services/relay/payment-and-fees/1balance-and-relay) to use the gasless functionality.
Transfer tokens from EOA to any receiver wallet address **without paying gas fees**.

```typescript
await aarcSDK.executeMigrationGasless({
Expand All @@ -103,35 +118,48 @@ await aarcSDK.executeMigrationGasless({
tokenIds?: string[] // tokenIds for nfts
},
...
],
gelatoApiKey: GELATO_RELAYER_API_KEY // Use the link above to get the gelato relayer key
]
megabyte0x marked this conversation as resolved.
Show resolved Hide resolved
})
// Returns the response given below
```

Output:
### Output:
```bash
[
{
tokenAddress,
amount,
message,
txHash,
tokenId
tokenAddress: string;
taskId?: string;
amount?: BigNumber | BigNumberish;
message: string;
txHash?: string;
tokenId?: string;
},
...
]
```

## Migration of Assets [Pay Gas with Stables]

Transfer tokens from EOA to any receiver wallet address by **paying gas in Stable Coins.**

```typescript
await aarcSDK.executeForwardTransaction({
senderSigner: signer,
receiverAddress:"0x786E6045eacb96cAe0259cd761e151b68B85bdA7"
});
```

> [!NOTE]
AARC SDK currently supports a few of the Stable Tokens on different networks. You can check about them [here](https://docs.aarc.xyz/developer-docs/integration-guide/usage/assets-migration/user-pays-gas-with-erc20-tokens-forwarder-flow#supported-networks-and-tokens).


## Moving Native Tokens and Wallet Deployment

The following code snippet demonstrates a method to transfer native tokens while simultaneously deploying a wallet using the aarcSDK.

This code snippet illustrates a process to transfer native tokens and deploy a wallet concurrently using the aarcSDK. Essential parameters such as the owner's address (EOA_ADDRESS), the type of wallet to deploy (WALLET_TYPE), the signer (ethers.signer object), the receiver's wallet address (RECEIVER_WALLET_ADDRESS), an optional amount of tokens to transfer (amount), and an index for deploying multiple wallets under the same EOA (deploymentWalletIndex) are included.

#### NOTE
If the wallet corresponding to the provided owner address (EOA_ADDRESS) and index (deploymentWalletIndex) is already deployed, the deployment process will not occur, and only the token transfer will be executed.
This code snippet illustrates a process to transfer native tokens and deploy a wallet concurrently using the `aarcSDK`. Essential parameters such as the owner's address (`EOA_ADDRESS`), the type of wallet to deploy (`WALLET_TYPE`), the `signer` (ethers.signer object), the receiver's wallet address (`RECEIVER_WALLET_ADDRESS`), an optional amount of tokens to transfer (`amount`), and an index for deploying multiple wallets under the same EOA (`deploymentWalletIndex`) are included.

> [!NOTE]
If the wallet corresponding to the provided owner address (`EOA_ADDRESS`) and index (`deploymentWalletIndex`) is already deployed, the deployment process will not occur, and only the token transfer will be executed.


```typescript
Expand All @@ -151,17 +179,17 @@ await aarcSDK.transferNativeAndDeploy({
## Smart Wallet Integration
The Aarc SDK seamlessly integrates with different smart wallets. It currently supports Safe and Biconomy smart wallets and will add more options in the future.

### Safe smart wallet
### Safe Smart Wallet

Fetching Existing Safes:
#### Fetching Existing Safes:

Retrieve a list of all Safe smart wallets associated with the user's EOA:
```typescript
const safes = await aarcSDK.getAllSafes(owner: string); // owner's eoaAddress
// This returns an array of Safe wallet addresses
```

Creating a New Safe Wallet:
#### Creating a New Safe Wallet:

Generate a new Safe smart wallet. The address returned is a counterfactual address, and the wallet needs to be deployed later. Asset migration can be directed to this address even before deployment.
```typescript
Expand All @@ -174,15 +202,15 @@ const newSafeAddress = await aarcSDK.generateSafeSCW(

### Biconomy Smart Wallet

Fetching Biconomy Smart Wallets:
#### Fetching Biconomy Smart Wallets:

Retrieve a list of all Biconomy smart wallets associated with the user's EOA:
```typescript
const biconomySWs = await aarcSDK.getAllBiconomySCWs(owner: string); // owner's eoaAddress
// This returns an array of Biconomy wallet addresses
```

Creating a New Biconomy Wallet:
#### Creating a New Biconomy Wallet:

Similar to the Safe wallet, you can create a Biconomy smart wallet. The address provided is also a counterfactual address, requiring later deployment. The migration process can target this address immediately.
```typescript
Expand All @@ -192,14 +220,14 @@ const newBiconomySCWAddress = await aarcSDK.generateBiconomySCW(
// Returns a counterfactual address for the new Biconomy wallet
```

## Wallet Deployment
## Smart Wallet Deployment

You have the capability to deploy Biconomy or Safe wallets by utilizing the provided code snippets.

The code snippet below showcases how to deploy a wallet using the AarcSDK. It involves specifying essential parameters such as the owner's address (EOA_ADDRESS), the type of wallet to deploy (WALLET_TYPE.BICONOMY or WALLET_TYPE.SAFE), the signer (ethers.signer object), and an optional index for deploying multiple wallets under the same EOA.
The code snippet below showcases how to deploy a wallet using the AarcSDK. It involves specifying essential parameters such as the owner's address (`EOA_ADDRESS`), the type of wallet to deploy (`WALLET_TYPE.BICONOMY` or `WALLET_TYPE.SAFE`), the `signer` (ethers.signer object), and an optional index for deploying multiple wallets under the same EOA.

#### NOTE
If the wallet corresponding to the provided owner address (EOA_ADDRESS) and index (deploymentWalletIndex) is already deployed, the deployment process will not occur.
> [!NOTE]
If the wallet corresponding to the provided owner address (`EOA_ADDRESS`) and index (`deploymentWalletIndex`) is already deployed, the deployment process will not occur.


```typescript
Expand All @@ -213,7 +241,7 @@ await aarcSDK.deployWallet({
})
```

#### More coming soon
### More coming soon 👀

## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE.md) for details.
Expand Down
137 changes: 4 additions & 133 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading