@tabascoweb3/aa-signers
v1.2.3
Published
A collection of signers used to create ERC-4337 smart accounts
Downloads
3
Readme
@alchemy/aa-signers
This package contains various implementations of the SmartAccountSigner
and AuthSmartAccountSigner
classes defined in aa-core
. This repo is community maintained and we welcome contributions!
Getting started
If you are already using the @alchemy/aa-core
package, you can simply install this package and start using the accounts. If you are not using @alchemy/aa-core
, you can install it and follow the instructions in the README to get started.
via yarn
yarn add @alchemy/aa-signers
via npm
npm i -s @alchemy/aa-signers
Contributing
If you are looking to add a new account type, please follow the following structure.
- Create a new folder in
src
with the name of your account type inkebab-case
(we're following kebab casing for files throughout the project). - Create a new file in the folder you just created called
signer.ts
and add your implementation forSmartAccountSigner
, along with any additional types or utils files. - If you need to extend the
SmartAccountSigner
orAuthSmartAccountSigner
class, add a file calledsigner.ts
in a new sub-folder under this package and add your implementation for.
- Ideally, your
SmartAccountSigner
impl should just work with the base provider provided byaa-core
and whatever peer dependencies you install. - If not, consider generalizing the use case and updating SmartAccountSigner
- Add some tests for your account and provider (if created) by creating a subfolder in your
signer/my-signer
called__tests__
and make sure your files end with the.test.ts
suffix - export the classes and types you've defined in
src/index.ts
- Open a PR and we'll review it as soon as possible!