ichigo-sdk
v0.3.1
Published
Web3 Wallet SDK - Using AA (ERC-4337) and WebAuthn (PassKeys).
Downloads
14
Readme
🍓 Ichigo SDK
Web3 Wallet SDK - Using AA (ERC-4337) and WebAuthn (PassKeys).
Features:
- Fully customisable UI
- Integrated Paymaster support - Alchemy, Stackup, Custom.
- No Extensiosn, No new apps necessary - Works directly into browser
- Batch operations
- Easy to use
- Secured by web standard WebAuthn - Trusted by companies like Apple & Google.
Notes
Few important notes:
- Users are identified by
username
- unique string - Each
username
has its own unique account address Passkeys
are used for authentication.username
is connected to the specificPasskey
. The user who owns thePasskey
, owns the account.- AA wallet is created on the first write operation. However you can always get the wallet address by
username
.
Current limitations
- Chain:
Base Sepolia
- Browsers:
Chrome
,Brave
Initialization
Using Alchemy paymaster and bundler:
import { IchigoSDK } from "ichigo-sdk";
/**
* You can get RPC URL and PolicyID from Alchemy Dashboard:
* https://dashboard.alchemy.com/apps
* https://dashboard.alchemy.com/gas-manager
*/
const RPC_URL =
"https://base-sepolia.g.alchemy.com/v2/JOMsB_RG7ymuGmGM1NqlFRXuwYJ1E1Yh";
const POLICY_ID = "ae7829c6-25de-4150-9cc8-274d53bf209a";
export const sdk = new IchigoSDK({
rpc: RPC_URL,
paymaster: {
type: "ALCHEMY",
policyId: POLICY_ID,
rpc: RPC_URL,
},
});
Mint
Mint NFT (ERC721):
await sdk.mint({
type: "ERC721",
contractAddress: "0x10bb2Ee7761C2356F7D7e42311b0fDf8e5e4dCA1",
username: "user_unique_username", // passkey will be attached to the username
});
Mint ERC20:
await sdk.mint({
type: "ERC20",
contractAddress: "0x72788aAd0e291cDC498dd814dE76c34ae2d46a39",
username: "user_unique_username",
});
Transfer
Transfer NFT (ERC721):
await sdk.transfer({
type: "ERC721",
contractAddress: "0x10bb2Ee7761C2356F7D7e42311b0fDf8e5e4dCA1",
toAddress: "0x91D76D31080ca88339a4E506aFfB4dED4b192bCb",
id: 117,
username: "user_unique_username",
});
Transfer ERC20:
await sdk.transfer({
type: "ERC20",
contractAddress: "0x10bb2Ee7761C2356F7D7e42311b0fDf8e5e4dCA1",
toAddress: "0x91D76D31080ca88339a4E506aFfB4dED4b192bCb",
count: 7,
username: "user_unique_username",
});
Batch Call (Custom)
Low-level api to implement any smart contract call(s) into a single transaction:
const toAddress = "0x91D76D31080ca88339a4E506aFfB4dED4b192bCb";
const count = 7;
await sdk.batchCall(
[
{
contractAddress: "0x10bb2Ee7761C2356F7D7e42311b0fDf8e5e4dCA1",
fnName: "transfer",
args: () => [toAddress, count], // function arguments
abi: [/* ABI goes here */],
},
],
{
username: "user_unique_username",
}
);
Utility
You can always get the wallet address of any username. It will not do any operation on-chain.
const walletAddress = await sdk.getWalletAddress("user_unique_username");