Account Abstraction SDK (aa-sdk)

The aa-sdk is a type-safe and performant TypeScript library built on top of viem to provide ergonomic methods for sending user operations, sponsoring gas, and deploying smart contract accounts. It handles all the complexity of ERC-4337 under the hood to make account abstraction simple.

The SDK also implements an EIP-1193 provider interface to easily plug into any popular dapp or wallet connect libraries such as RainbowKit, Wagmi, and Web3Modal. It also includes ethers.js adapters to provide full support for ethers.js apps.

The aa-sdk is modular at every layer of the stack and can be easily extended to fit your custom needs. You can plug in any smart account implementation, Signer, gas manager API, RPC provider.

Getting Started

Install the Packages

yarn add @alchemy/aa-accounts @alchemy/aa-core

Light Account Example

Docs

The aa-sdk is part of Alchemy's Account Kit. For more information, check out the Account Kit docs.

Contributing

1. clone the repo
2. run yarn
3. verify tests pass
   • be sure to use the node version specified in package.json, currently 18.16
   • run node -v
   • run yarn build
   • run yarn test
4. make changes to packages
5. reverify that all tests pass
6. format code changes
   • run yarn run lint:write
7. confirm code passes format checks
   • run yarn run lint:check
8. commit code with a standardized commit message
   • format: [subject-type]: [description starting with lowercase letters] (#[issue number])
   • example: feat: add sanity check on provider connect for clearer error message (#181)
   • note: run git log to see more examples and acceptable subject-types
9. push to your github fork
10. create a pull request with the original Alchemy project

• note: pull request title must pass the Enforce PR Title Format
• format: [subject-type]: [description starting with lowercase letters]
• run echo "[YOUR_PR_TITLE_HERE] | yarn commitlint
• passing example: run echo "docs: add build and test documentation update (#195)" | yarn commitlint

11. celebrate