@alchemy/aa-alchemy

@alchemy/aa-alchemy

This package contains AlchemyProvider, an implementation of SmartAccountProvider class defined in aa-core. It also contains middleware for accessing the Alchemy Gas Manager (an ERC-4337 Paymaster) and for doing Fee Estimates according to the expectations of the Alchemy Rundler (an ERC-4337 Bundler). 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 @alchemy/aa-core package, you can simply install this package and start using the AlchemyProvider. If you are not using @alchemy/aa-core, you can install it and follow the instructions in the "Getting started" docs to get started.

yarn add @alchemy/aa-alchemy

npm i -s @alchemy/aa-alchemy

pnpm i @alchemy/aa-alchemy

Usage

You can create AlchemyProvider like so:

import {
  LightSmartContractAccount,
  getDefaultLightAccountFactoryAddress,
} from "@alchemy/aa-accounts";
import { AlchemyProvider } from "@alchemy/aa-alchemy";
import { LocalAccountSigner, type SmartAccountSigner } from "@alchemy/aa-core";
import { sepolia } from "@alchemy/aa-core";

const chain = sepolia;
const PRIVATE_KEY = "0xYourEOAPrivateKey";
const eoaSigner: SmartAccountSigner =
  LocalAccountSigner.privateKeyToAccountSigner(`0x${PRIVATE_KEY}`);

export const provider = new AlchemyProvider({
  apiKey: "ALCHEMY_API_KEY", // replace with your alchemy api key of the Alchemy app associated with the Gas Manager, get yours at https://dashboard.alchemy.com/
  chain,
}).connect(
  (rpcClient) =>
    new LightSmartContractAccount({
      chain,
      owner: eoaSigner,
      factoryAddress: getDefaultLightAccountFactoryAddress(chain),
      rpcClient,
    })
);

Changelog

3.0.0-alpha.13 (2024-02-16)

Note: Version bump only for package root