Skip to content

Commit

Permalink
docs: reorganize the sidebar (#300)
Browse files Browse the repository at this point in the history
  • Loading branch information
avasisht23 committed Dec 4, 2023
1 parent 0763a82 commit a1376c4
Show file tree
Hide file tree
Showing 45 changed files with 851 additions and 675 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
# aa-sdk

The `aa-sdk` is a type-safe and performant TypeScript library 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.
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.

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.
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/accounts/using-your-own) implementation, [Signer](https://accountkit.alchemy.com/smart-accounts/signers/overview), [Gas Manager API](https://accountkit.alchemy.com/overview/introduction.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.html) to get started.
The `aa-sdk` is part of [Account Kit](https://accountkit.alchemy.com). Check out this [quickstart guide](https://accountkit.alchemy.com/getting-started.html) to get started, or an [overview](https://accountkit.alchemy.com/overview/package-overview.html) of each of the SDKs in this repo.

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/provider/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ export interface ISmartAccountProvider<

/**
* This takes an ethereum transaction and converts it into a UserOperation, sends the UserOperation, and waits
* on the receipt of that UserOperation (ie. has it been mined). If you don't want to wait for the UserOperation
* on the receipt of that UserOperation (i.e. has it been mined). If you don't want to wait for the UserOperation
* to mine, it's recommended to user {@link sendUserOperation} instead.
*
* @param request - a {@link RpcTransactionRequest} object representing a traditional ethereum transaction
Expand All @@ -220,7 +220,7 @@ export interface ISmartAccountProvider<

/**
* This takes a set of ethereum transactions and converts them into one UserOperation, sends the UserOperation, and waits
* on the receipt of that UserOperation (ie. has it been mined). If you don't want to wait for the UserOperation
* on the receipt of that UserOperation (i.e. has it been mined). If you don't want to wait for the UserOperation
* to mine, it's recommended to user {@link sendUserOperation} instead.
*
* NOTE: the account you're sending the transactions to MUST support batch transactions.
Expand Down

0 comments on commit a1376c4

Please sign in to comment.