Skip to content

Commit

Permalink
Merge pull request #43 from 0xClouds/update_read_me
Browse files Browse the repository at this point in the history
update: readme
  • Loading branch information
kevinchen-cb authored Nov 25, 2024
2 parents b48bacd + d675ab2 commit a5402b7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# [Coinbase Developer Platform Paymaster & Bundler Examples](https://github.com/coinbase/paymaster-bundler-examples)

This repo has code examples on how to sponsor a mint for a [Knight Warriors](https://sepolia.basescan.org/token/0x66519fcaee1ed65bc9e0acc25ccd900668d3ed49) NFT on Base Sepolia using Coinbase Developer Platform's Paymaster & Bundler. If you'd like to see a live demo app sponsoring NFT mints in action, check out ours [here](https://buildonchainapps.xyz/paymaster-bundler).
✨ Looking for frontend examples? Be sure to check out our **[Wagmi](https://github.com/coinbase/paymaster-bundler-examples/tree/master/examples/wagmi)** example for inspiration and guidance! ✨

This repo has code examples on how to sponsor a mint for a [Knight Warriors](https://sepolia.basescan.org/token/0x66519fcaee1ed65bc9e0acc25ccd900668d3ed49) NFT on Base Sepolia using Coinbase Developer Platform's Paymaster & Bundler. If you'd like to see a live demo app sponsoring NFT mints in action, check out ours [here](https://paymaster-demo-app.vercel.app/).

We currently have examples for the following SDKs, but contributions are always welcome! See [Contributing](https://github.com/coinbase/paymaster-bundler-examples/blob/master/CONTRIBUTING.md) for more details.

Expand All @@ -9,20 +11,25 @@ We currently have examples for the following SDKs, but contributions are always
- [Alchemy (aa-core)](https://github.com/coinbase/paymaster-bundler-examples/tree/master/examples/alchemy)
- [Pimlico (permissionless.js)](https://github.com/coinbase/paymaster-bundler-examples/tree/master/examples/pimlico)
- [ZeroDev (@zerodev/sdk)](https://github.com/coinbase/paymaster-bundler-examples/tree/master/examples/zerodev)
- [Wagmi (wevm/wagmi)](https://github.com/coinbase/paymaster-bundler-examples/tree/master/examples/wagmi)
- [Viem](https://github.com/coinbase/paymaster-bundler-examples/tree/master/examples/viem)

### Supported Account Types

- [SimpleAccount](https://github.com/eth-infinitism/account-abstraction/blob/develop/contracts/samples/SimpleAccount.sol) (default)
- [Safe](https://safe.global/)
- [Kernel](https://github.com/zerodevapp/kernel)
- [Coinbase Smart Account](https://github.com/coinbase/smart-wallet)

### Compatibility

| SDK | Simple | Safe | Kernel |
| ----------------- | ------ | ---- | ------ |
| aa-core ||||
| permissionless.js ||||
| @zerodev/sdk ||||
| SDK | Simple | Safe | Kernel | Coinbase |
| ----------------- | ------ | ---- | ------ | -------- |
| aa-core |||||
| permissionless.js |||||
| @zerodev/sdk |||||
| wevm/wagmi |||||
| viem |||||

## Getting Started

Expand Down Expand Up @@ -109,4 +116,4 @@ Waiting for transaction...

### 7. Play around with our demo app

If you'd like to see an example of an app sponsoring NFT mints in action, check out our demo app [here](https://buildonchainapps.xyz/paymaster-bundler).
If you'd like to see an example of an app sponsoring NFT mints in action, check out our demo app [here](https://paymaster-demo-app.vercel.app/).
1 change: 0 additions & 1 deletion examples/wagmi/.env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
VITE_RPC_URL='YOUR_RPC_URL'
VITE_CONTRACT_ADDRESS="0x66519FCAee1Ed65bc9e0aCc25cCD900668D3eD49"
VITE_ACCOUNT_TYPE='simple' # simple, safe, kernel
2 changes: 1 addition & 1 deletion examples/wagmi/src/wagmi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const config = createConfig({
}),
],
transports: {
[baseSepolia.id]: http(import.meta.env.RPC_URL),
[baseSepolia.id]: http(import.meta.env.VITE_RPC_URL),
},
});

Expand Down

0 comments on commit a5402b7

Please sign in to comment.