@aa-sdk/ethers

@aa-sdk/ethers

This package contains EthersProviderAdapter and AccountSigner, respective extensions of the JsonRpcProvider and Signer classes defined in ethers.js external library.

If you currently rely ethers.js for web3 development, you can use these ethers.js-compatible JsonRpcProvider and Signer to integrate Account Abstraction into your dApp. You may also find the util methods helpful.

This repo is community maintained and we welcome contributions!

Getting started

If you are already using the @aa-sdk/core package, you can simply install this package and start using the EthersProviderAdapter and AccountSigner. If you are not using @aa-sdk/core, you can install it and follow the instructions in the "Getting started" docs to get started.

yarn add @aa-sdk/ethers

npm i -s @aa-sdk/ethers

pnpm i @aa-sdk/ethers

Usage

You can create a provider and connect it to a signer account like so:

import {
  LightSmartContractAccount,
  getDefaultLightAccountFactoryAddress,
} from "@alchemy/aa-accounts";
import { EthersProviderAdapter } from "@aa-sdk/ethers";
import { LocalAccountSigner, SmartAccountSigner } from "@aa-sdk/core";
import { Alchemy, Network } from "alchemy-sdk";
import { polygonMumbai } from "@aa-sdk/core";

const chain = polygonMumbai;

// 1. Create a provider using EthersProviderAdapter
const alchemy = new Alchemy({
  apiKey: process.env.API_KEY!,
  network: Network.MATIC_MUMBAI,
});
const ethersProvider = await alchemy.config.getProvider();

const provider = EthersProviderAdapter.fromEthersProvider(ethersProvider);

const signer: SmartAccountSigner = LocalAccountSigner.mnemonicToAccountSigner(
  process.env.YOUR_OWNER_MNEMONIC!
);

// 2. Connect the provider to the smart account signer
export const signer = provider.connectToAccount(
  (rpcClient) =>
    new LightSmartContractAccount({
      chain,
      factoryAddress: getDefaultLightAccountFactoryAddress(chain),
      rpcClient,
      signer,
    })
);

Changelog

4.0.0-alpha.9 (2024-07-31)

Bug Fixes

• add missing react-remove-scroll dep (#804) (8da7858)
• add use client to a bunch of hooks that was misisng it (#829) (77825b0)
• alchemy signer redirect was broken (dcc0317)
• core: initial state parsing and disconnect logic (#842) (1f1047b)
• core: the reconnect method was causing an infinite loop (#808) (190e25f)
• demo app not building (#733) (0dd262e)
• docs: broken build script for docs (42bc397)
• exporting queryClient and typing uiConfig in example (#844) (289e5c1)
• fix demo header links and update guide (#845) (c3ae1eb)
• fixing nav links (#848) (a446b52)
• lowercase strings in the UI components (#784) (71a8b74)
• merge base into this (1409772)
• passing gas manager to createConfig should use it (#836) (b8fce22)
• react: fix sign in header hiding itself (#851) (a9a51e0)
• ui-demo app not building (8803f9b)
• ui-demo-app: fix the package json to include latest ak pkgs (#825) (52e7629)
• ui-demo: add passkey toggle wasn't working (#843) (eb22036)
• ui-demo: signer state was being cleared when ui config changed (#838) (10274e4)
• update CSS override url attempt 2 (#861) (2942e70)
• use updated package path in prettier config (#741) (622fe54)
• yarn.lock had wrong versions of alpha packages (3c197bc)

Code Refactoring

• change the prefix for aa-sdk packages (#722) (8ef751e)

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

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

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

Features

• aa-sdk/core: add default arguments for erc7677 middleware (#839) (5dccebd)
• aa-sdk/core: add erc7677 middleware (#823) (69ea495)
• aa: new chain (#835) (bfcf4f7)
• adaptive icons for light and dark UI (#713) (61a2960)
• add ability to customize border radius in ui demo (#785) (b12c1f6)
• add border radius to account kit theme config (#781) (9abbb88)
• add code preview snippets (#760) (a767ac9)
• add color picker (#732) (8979f43)
• add custom theme switch component (#726) (79e952c)
• add doc generator for class methods (#806) (e177533)
• add illustration styles option (#730) (0391dc5)
• add injected wallets to the UX (#841) (5686986)
• add links (#765) (3fabf28)
• add new logo (#762) (d2e6df6)
• add passkey success state (#711) (a99460d)
• add photo upload (a290d18)
• add showBack prop and auto determine navigation (#712) (7b1e68c)
• add skeleton for ui demo (c5705b0)
• add stylize tab (264b6a8)
• add tabs and passkey section to demo app (ec868e8)
• add toggle for code preview mode (#731) (f12436e)
• add UI config defaults, better back navigation to auth UI (#827) (08565dc)
• add updated error UI + custom error rendering (#705) (0b23625)
• bring the rest of the auth flow inline with the designs (#708) (993f6e2)
• change email validation rule (#710) (f869f5e)
• clean up UI state on log out (#832) (cffda84)
• color picker for dark mode (#777) (952bd3d), closes #778
• enable linting class methods from exported classes (2ee9eb9)
• erc7677: create a new middle ware for erc7677 to replace gasManager middleWare (#840) (0020257)
• fix state override parameter type (#720) (6c9c720)
• hook up color and theme variables (#758) (4cb0f6a)
• icon animations (#717) (74c5425)
• integrate shadcn and start on auth methods in demo app (13e87da)
• logged in state (#763) (0b2f31e)
• new and improved auth modal (#761) (02c33ea)
• pull strings out to their own file for future localization (#715) (5c0d516)
• read auth card props from context, simplify UI config (#789) (de6fff5)
• respect OS or root class for dark mode (#759) (30cfd28)
• responsive styling for demo app (#810) (569c142)
• smaller footer in UI components (#811) (9c1eaee)
• some UI component polish from sync with product (#831) (f0f5922)
• start to bring auth modal styles inline with designs (#702) (6e3502b)
• support different illustration styles (#767) (6e61d87)
• surface descriptive session key errors (#718) (c550465)
• update some demo app copy and UI for alpha testing (#830) (37fec2c)
• updates to demo app UI from design feedback (#805) (9c52201)
• use brand accent color as icon colors (#780) (933dd13)

Reverts

• add base skeleton for docs refactor (dca6081)

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