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

chore: add more detail to readmes about contract addresses, and add breadcrumb #63

Merged
merged 1 commit into from
Jul 30, 2023
Merged

chore: add more detail to readmes about contract addresses, and add breadcrumb #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ npm i -s @alchemy/aa-ethers

## Example Usage to Interact with [Simple Accounts](https://github.com/eth-infinitism/account-abstraction/blob/develop/contracts/samples/SimpleAccount.sol)

**Note 🗒️:** We've also included an [E2E example here](https://github.com/alchemyplatform/aa-sdk/tree/main/examples/alchemy-daapp). This example DApp creates a simple account wallet and mints an NFT in one flow.

### via `aa-core`

```ts
Expand Down
6 changes: 5 additions & 1 deletion examples/alchemy-daapp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,15 @@ export const serverConfigs: Record<number, ServerConfiguration> = {
nftContractAddress: "<your-nft-contract-address>",
simpleAccountFactoryAddress: "<your-simple-account-factory-address>",
gasManagerPolicyId: "<your-gas-manager-policy-id>",
chain: polygon,
chain: polygonMumbai,
},
// Repeat for other chains as needed
};
```
### **🗒️ Notes:** for `nftContractAddress` and `simpleAccountFactoryAddress`
- There are already contract addresses deployed for them across [various chains here](https://github.com/alchemyplatform/aa-sdk/blob/main/examples/alchemy-daapp/src/configs/clientConfigs.ts).
- We used eth-infinitism's [simpleAccountFactory here](https://github.com/eth-infinitism/account-abstraction/blob/main/contracts/samples/SimpleAccountFactory.sol).
- Finally, the contracts sibling package has the copy of the [NFT contract](https://github.com/alchemyplatform/aa-sdk/tree/main/examples/contracts/DAAppNFT/src) along instructions on [how to deploy it](https://github.com/alchemyplatform/aa-sdk/blob/main/examples/contracts/README.md).

4. Update the serverConfigs.ts file with your alchemy API keys:
```typescript
Expand Down