@alchemy/aa-signers

@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 in kebab-case (we are 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 for SmartAccountSigner, along with any additional types or utils files.
• If you need to extend the SmartAccountSigner or AuthSmartAccountSigner class, add a file called signer.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 by aa-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 have defined in src/index.ts
• Open a PR and we will review it as soon as possible!

Changelog

4.0.0-beta.0 (2024-08-28)

Bug Fixes

• add missing react-remove-scroll dep (#804) (09d9217)
• add use client to a bunch of hooks that was misisng it (#829) (9be5834)
• await instance reset (#919) (10d5a95)
• core: initial state parsing and disconnect logic (#842) (d3e80ad)
• core: the reconnect method was causing an infinite loop (#808) (0d094e8)
• demo app not building (#733) (2bbf359)
• docs: broken build script for docs (e4ef3d2)
• exporting queryClient and typing uiConfig in example (#844) (f6cc40e)
• fix demo header links and update guide (#845) (817d0ab)
• fixing nav links (#848) (9ec5a40)
• lowercase strings in the UI components (#784) (58422c3)
• merge base into this (e41b396)
• passing gas manager to createConfig should use it (#836) (53b4e95)
• react: fix sign in header hiding itself (#851) (90b3e20)
• ui-demo app not building (e2cb348)
• ui-demo-app: fix the package json to include latest ak pkgs (#825) (78e95fd)
• ui-demo: add passkey toggle wasn't working (#843) (1c11f2d)
• ui-demo: signer state was being cleared when ui config changed (#838) (cc5db85)
• ui-modal: don't render ui modal if no ui config is passed in (#943) (65b1584)
• update CSS override url attempt 2 (#861) (4bd9c04)
• use updated package path in prettier config (#741) (918d65f)
• yarn.lock had wrong versions of alpha packages (fb3ae94)

Code Refactoring

• change the prefix for aa-sdk packages (#722) (02f2f16)

• move plugingen from aa-sdk to account-kit since it depends on smart-contracts (073e8f6)

• split aa-alchemy into account-kit packages (#704) (55e6632), closes #706

• refactor!: move chain definitions out of aa-sdk core (#772) (1385441), closes #772

Features

• aa-sdk/core: add default arguments for erc7677 middleware (#839) (848f316)
• aa-sdk/core: add erc7677 middleware (#823) (4a30808)
• aa: new chain (#835) (1e3b4b9)
• add ability to customize border radius in ui demo (#785) (2ce7d2d)
• add border radius to account kit theme config (#781) (dcd2ac1)
• add code preview snippets (#760) (7215e32)
• add color picker (#732) (f77344d)
• add custom theme switch component (#726) (ff0bc22)
• add doc generator for class methods (#806) (a389f65)
• add illustration styles option (#730) (3a2ec81)
• add injected wallets to the UX (#841) (9de08b3)
• add links (#765) (919e88f)
• add new logo (#762) (2ec34b6)
• add photo upload (ebcf76f)
• add skeleton for ui demo (38f797a)
• add stylize tab (59a3322)
• add tabs and passkey section to demo app (e4d624d)
• add toggle for code preview mode (#731) (3642161)
• add UI config defaults, better back navigation to auth UI (#827) (bf9157c)
• add wallet connect to injected wallet setup (e00166d)
• allow for passkey + email signup (#920) (651a60e)
• chains: add arbnova and shape (#937) (938181b)
• clean up UI state on log out (#832) (85548c8)
• color picker for dark mode (#777) (666d095), closes #778
• enable linting class methods from exported classes (1b87a51)
• erc7677: create a new middle ware for erc7677 to replace gasManager middleWare (#840) (4be87d3)
• hook up color and theme variables (#758) (1714070)
• icon animations (#717) (0368570)
• integrate shadcn and start on auth methods in demo app (723046e)
• logged in state (#763) (69d6c57)
• make it easier to start with account-kit/core (#933) (6d98643)
• new and improved auth modal (#761) (2296917)
• react: enable multi-owner la usage in core and react (#893) (43464da)
• read auth card props from context, simplify UI config (#789) (e7eae44)
• respect OS or root class for dark mode (#759) (66aade5)
• responsive styling for demo app (#810) (a4af327)
• smaller footer in UI components (#811) (ef89ccd)
• some UI component polish from sync with product (#831) (37a98c0)
• support different illustration styles (#767) (37296d3)
• surface descriptive session key errors (#718) (593e84c)
• update some demo app copy and UI for alpha testing (#830) (fd48725)
• updates to demo app UI from design feedback (#805) (c2d7f38)
• use brand accent color as icon colors (#780) (d3d62b3)

Reverts

• add base skeleton for docs refactor (e7663f6)

BREAKING CHANGES

• moves the chain definitions out of aa-sdk core and into account-kit/infra

• @alchemy/plugingen has been moved to @account-kit/plugingen

• @alchemy/aa-_ packages have been renamed to @aa-sdk/_

• this removes the @alchemy/aa-alchemy package in favor of @account-kit/*

• @alchemy/aa-accounts was deleted in favor of @account-kit/accounts

• refactor: further rename packages