Skip to content

Commit

Permalink
package version changes
Browse files Browse the repository at this point in the history
  • Loading branch information
anshulforyou committed Nov 20, 2023
1 parent 59cf8af commit cb9bf57
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ src
.gitattributes
.eslintrc.js
.prettierrc
tests
.github
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ npm install ethers@5.7.2 aarc-sdk

## Get the API Key

To use Aarc SDK, an API key is required. Fill out this form to request the API key.
To use Aarc SDK, an API key is required. Fill out [this form](https://rebrand.ly/aarc-dashboard) to get the API Key on your email instantly!

## Initialise the SDK

Expand Down Expand Up @@ -66,8 +66,8 @@ await aarcSDK.executeMigration({
[
{
tokenAddress:TOKEN1_ADDRESS,
amount:TOKEN1_AMOUNT, // ethers.BigNumber in case of erc20 and native token
tokenIds: string[] // tokenIds for nfts
amount?:TOKEN1_AMOUNT, // ethers.BigNumber in case of erc20 and native token
tokenIds?: string[] // tokenIds for nfts
},
...
]
Expand Down Expand Up @@ -101,8 +101,8 @@ await aarcSDK.executeMigration({
[
{
tokenAddress:TOKEN1_ADDRESS,
amount:TOKEN1_AMOUNT, // ethers.BigNumber in case of erc20 and native token
tokenIds: string[] // tokenIds for nfts
amount?:TOKEN1_AMOUNT, // ethers.BigNumber in case of erc20 and native token
tokenIds?: string[] // tokenIds for nfts
},
...
],
Expand Down Expand Up @@ -163,7 +163,9 @@ 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
const newBiconomySCWAddress = await aarcSDK.generateBiconomySCW();
const newBiconomySCWAddress = await aarcSDK.generateBiconomySCW(
signer // wallet owner's ethers.signer object
);
// Returns a counterfactual address for the new Biconomy wallet
```

Expand All @@ -173,4 +175,4 @@ const newBiconomySCWAddress = await aarcSDK.generateBiconomySCW();
This project is licensed under the MIT License - see the [LICENSE](./LICENSE.md) for details.

## Support and Feedback
For support or to share feedback, please schedule a meet here. You can also share your ideas and feedback on the community forum.
For support or to share feedback, please schedule a 15 min catchup [here](https://calendly.com/arihant-aarc/15min). You can also share your ideas and feedback on the [community forum](https://aarc.featurebase.app/).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "aarc-sdk",
"version": "0.0.1-beta.3",
"version": "0.0.1-beta.4",
"description": "The Aarc SDK is a TypeScript library that makes it easy for developers to transfer assets from Externally Owned Accounts (EOA) to any destination address. It simplifies the asset transfer process by supporting various token standards, such as ERC20 and ERC721, and offering custom flows like batched transactions, gasless transactions, and paying gas fees with the same asset being moved. Additionally, it enables custom contract interaction within the same transaction using permit2(), allowing for direct swaps and bridge functionality.",
"main": "dist/index.js",
"scripts": {
Expand Down

0 comments on commit cb9bf57

Please sign in to comment.