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

Jump to bottom

Readme update #27

Merged
merged 13 commits into from
Nov 22, 2023
Merged

Readme update #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d482a88
tests and safe deploy fun
talhamalik883 Nov 15, 2023
7f9b7bc
internal functions mocking
talhamalik883 Nov 15, 2023
8978d41
tests updated
talhamalik883 Nov 16, 2023
4a0ec34
Signer fix and biconomy get wallets function (#20)
anshulforyou Nov 17, 2023
038bab8
testing workflow added
anshulforyou Nov 17, 2023
9e5677e
Merge branch 'develop' of https://github.com/aarc-xyz/aarc-sdk into d…
anshulforyou Nov 17, 2023
ef8ba1b
Sdk bug fixes (#21)
anshulforyou Nov 20, 2023
59cf8af
nft transfer gasless updated
anshulforyou Nov 20, 2023
cb9bf57
package version changes
anshulforyou Nov 20, 2023
1bb071e
Update README.md
anshulforyou Nov 21, 2023
0b1ce0d
Update README.md - CRITICAL (#26)
theblackmace Nov 22, 2023
3aaf65f
Update README.md (#24)
theblackmace Nov 22, 2023
c42b375
Merge branch 'staging' into develop
anshulforyou Nov 22, 2023
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
1 change: 0 additions & 1 deletion .npmignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ src
tests
.github
jest.config.*
```
9 changes: 3 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,20 @@ 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](https://rebrand.ly/aarc-dashboard) to get the API Key on your email instantly!
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!

## Initialise the SDK

Import and initialise the Aarc SDK in your project.

```typescript
import { ethers } from "ethers";
import { AarcSDK } from "aarc-sdk";

let aarcSDK = new AarcSDK({
rpcUrl: rpcUrl,
chainId: chainId,
apiKey: "YOUR_API_KEY",
});

await aarcSDK.init();
```

# Usage
Expand Down Expand Up @@ -106,7 +103,7 @@ await aarcSDK.executeMigration({
},
...
],
GELATO_RELAYER_API_KEY // Use the link above to get the gelato relayer key
gelatoApiKey: GELATO_RELAYER_API_KEY // Use the link above to get the gelato relayer key
})
// Returns the response given below
```
Expand Down Expand Up @@ -151,7 +148,7 @@ const newSafeAddress = await aarcSDK.generateSafeSCW(

### Biconomy Smart Wallet

Fetching Existing Safes:
Fetching Biconomy Smart Wallets:

Retrieve a list of all Biconomy smart wallets associated with the user's EOA:
```typescript
Expand Down
Loading