https://github.com/alchemyplatform/aa-sdk

https://github.com/alchemyplatform/aa-sdk

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/alchemyplatform/aa-sdk
• Owner: alchemyplatform
• License: mit
• Created: 2023-05-19T18:57:41.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-06T17:30:28.000Z (5 months ago)
• Last Synced: 2024-02-06T17:47:01.538Z (5 months ago)
• Language: TypeScript
• Homepage: https://www.alchemy.com/account-abstraction
• Size: 44.1 MB
• Stars: 141
• Watchers: 16
• Forks: 83
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Lists

• awesome-account-abstraction - alchemyplatform/aa-sdk

README

        
# aa-sdk

The `aa-sdk` is a type-safe and performant suite of TypeScript SDKs built on top of [viem](https://viem.sh/) to provide ergonomic methods for sending user operations, sponsoring gas, and deploying smart accounts. It handles all the complexity of ERC-4337 under the hood to make account abstraction simple.

There are currently 5 SDKs that are part of the `aa-sdk` suite:

1. [`aa-core`](https://github.com/alchemyplatform/aa-sdk/tree/main/packages/core)

2. [`aa-alchemy`](https://github.com/alchemyplatform/aa-sdk/tree/main/packages/alchemy)

3. [`aa-accounts`](https://github.com/alchemyplatform/aa-sdk/tree/main/packages/accounts)

4. [`aa-signers`](<(https://github.com/alchemyplatform/aa-sdk/tree/main/packages/signers)>)

5. [`aa-ethers`](https://github.com/alchemyplatform/aa-sdk/tree/main/packages/ethers)

The core 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`](https://docs.ethers.org/v5/) 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](https://accountkit.alchemy.com/smart-accounts/custom/using-your-own) implementation, [Signer](https://accountkit.alchemy.com/signers/choosing-a-signer.html), [Gas Manager API](https://accountkit.alchemy.com/getting-started/overview.html#gas-manager-api) and RPC Provider.

## Getting started

The `aa-sdk` is part of [Account Kit](https://accountkit.alchemy.com). Check out this [quickstart guide](https://accountkit.alchemy.com/getting-started/setup.html) to get started, or an [overview](https://accountkit.alchemy.com/packages/) of each of the SDKs in this repo.

## Contributing

We welcome contributions to `aa-sdk`. Please see our [contributing guidelines](CONTRIBUTING.md) for more information.