EthersProviderAdapter

Defined in: aa-sdk/ethers/src/provider-adapter.ts:20

Lightweight Adapter for SmtAccountProvider to enable Signer Creation

Extends

• JsonRpcProvider

Constructors

Constructor

new EthersProviderAdapter(opts): EthersProviderAdapter;

Defined in: aa-sdk/ethers/src/provider-adapter.ts:48

Configures and initializes the account provider based on the given options.

Example

import { AccountSigner, EthersProviderAdapter } from "@aa-sdk/ethers";
import { LocalAccountSigner } from "@aa-sdk/core";
import { sepolia } from "@account-kit/infra";
import { createLightAccount } from "@account-kit/smart-contracts";
 
const account = await createLightAccount({
  transport: http("https://rpc.testnet.aepps.com"),
  chain: sepolia,
  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey()),
});
 
const provider = new EthersProviderAdapter({
  account,
  chain: sepolia,
  rpcProvider: "https://eth-sepolia.g.alchemy.com/v2/your-api-key",
});

Parameters

Returns

EthersProviderAdapter

Overrides

JsonRpcProvider.constructor;

Properties

Accessors

_cache

Get Signature

get _cache(): Record<string, Promise<any>>;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:33

Returns

Record<string, Promise<any>>

Inherited from

JsonRpcProvider._cache;

blockNumber

Get Signature

get blockNumber(): number;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:101

Returns

number

Inherited from

JsonRpcProvider.blockNumber;

network

Get Signature

get network(): Network;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:98

Returns

Network

Inherited from

JsonRpcProvider.network;

polling

Get Signature

get polling(): boolean;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:102

Returns

boolean

Set Signature

set polling(value): void;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:103

Parameters

Returns

void

Inherited from

JsonRpcProvider.polling;

pollingInterval

Get Signature

get pollingInterval(): number;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:104

Returns

number

Set Signature

set pollingInterval(value): void;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:105

Parameters

Returns

void

Inherited from

JsonRpcProvider.pollingInterval;

ready

Get Signature

get ready(): Promise<Network>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:91

Returns

Promise<Network>

Inherited from

JsonRpcProvider.ready;

Methods

_addEventListener()

_addEventListener(
   eventName,
   listener,
   once): this;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:147

Parameters

Returns

this

Inherited from

JsonRpcProvider._addEventListener;

_call()

_call(
   transaction,
   blockTag,
   attempt): Promise<string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:127

Parameters

Returns

Promise<string>

Inherited from

JsonRpcProvider._call;

_getAddress()

_getAddress(addressOrName): Promise<string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:130

Parameters

Returns

Promise<string>

Inherited from

JsonRpcProvider._getAddress;

_getBlock()

_getBlock(blockHashOrBlockTag, includeTransactions?): Promise<Block | BlockWithTransactions>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:131

Parameters

Returns

Promise<Block | BlockWithTransactions>

Inherited from

JsonRpcProvider._getBlock;

_getBlockTag()

_getBlockTag(blockTag): Promise<BlockTag>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:138

Parameters

Returns

Promise<BlockTag>

Inherited from

JsonRpcProvider._getBlockTag;

_getFastBlockNumber()

_getFastBlockNumber(): Promise<number>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:106

Returns

Promise<number>

Inherited from

JsonRpcProvider._getFastBlockNumber;

_getFilter()

_getFilter(filter): Promise<Filter | FilterByBlockHash>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:126

Parameters

Returns

Promise<Filter | FilterByBlockHash>

Inherited from

JsonRpcProvider._getFilter;

_getInternalBlockNumber()

_getInternalBlockNumber(maxAge): Promise<number>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:95

Parameters

Returns

Promise<number>

Inherited from

JsonRpcProvider._getInternalBlockNumber;

_getResolver()

_getResolver(name, operation?): Promise<string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:140

Parameters

Returns

Promise<string>

Inherited from

JsonRpcProvider._getResolver;

_getTransactionRequest()

_getTransactionRequest(transaction): Promise<Transaction>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:125

Parameters

Returns

Promise<Transaction>

Inherited from

JsonRpcProvider._getTransactionRequest;

_ready()

_ready(): Promise<Network>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:90

Returns

Promise<Network>

Inherited from

JsonRpcProvider._ready;

_setFastBlockNumber()

_setFastBlockNumber(blockNumber): void;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:107

Parameters

Returns

void

Inherited from

JsonRpcProvider._setFastBlockNumber;

_startEvent()

_startEvent(event): void;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:44

Parameters

Returns

void

Inherited from

JsonRpcProvider._startEvent;

_startPending()

_startPending(): void;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:45

Returns

void

Inherited from

JsonRpcProvider._startPending;

_stopEvent()

_stopEvent(event): void;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:46

Parameters

Returns

void

Inherited from

JsonRpcProvider._stopEvent;

_uncachedDetectNetwork()

_uncachedDetectNetwork(): Promise<Network>;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:37

Returns

Promise<Network>

Inherited from

JsonRpcProvider._uncachedDetectNetwork;

_waitForTransaction()

_waitForTransaction(
   transactionHash,
   confirmations,
   timeout,
   replaceable): Promise<TransactionReceipt>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:109

Parameters

Returns

Promise<TransactionReceipt>

Inherited from

JsonRpcProvider._waitForTransaction;

_wrapTransaction()

_wrapTransaction(
   tx,
   hash?,
   startBlock?): TransactionResponse;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:123

Parameters

Returns

TransactionResponse

Inherited from

JsonRpcProvider._wrapTransaction;

addListener()

addListener(eventName, listener): Provider;

Defined in: node_modules/@ethersproject/abstract-provider/lib/index.d.ts:149

Parameters

Returns

Provider

Inherited from

JsonRpcProvider.addListener;

call()

call(transaction, blockTag?): Promise<string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:128

Parameters

Returns

Promise<string>

Inherited from

JsonRpcProvider.call;

ccipReadFetch()

ccipReadFetch(
   tx,
   calldata,
   urls): Promise<null | string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:94

Parameters

Returns

Promise<null | string>

Inherited from

JsonRpcProvider.ccipReadFetch;

connectToAccount()

connectToAccount<TAccount>(account): AccountSigner<TAccount>;

Defined in: aa-sdk/ethers/src/provider-adapter.ts:90

Connects the Provider to an Account and returns a Signer

Type Parameters

Parameters

Returns

AccountSigner<TAccount>

an AccountSigner that can be used to sign and send user operations

detectNetwork()

detectNetwork(): Promise<Network>;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:36

Returns

Promise<Network>

Inherited from

JsonRpcProvider.detectNetwork;

emit()

emit(eventName, ...args): boolean;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:150

Parameters

Returns

boolean

Inherited from

JsonRpcProvider.emit;

estimateGas()

estimateGas(transaction): Promise<BigNumber>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:129

Parameters

Returns

Promise<BigNumber>

Inherited from

JsonRpcProvider.estimateGas;

getAvatar()

getAvatar(nameOrAddress): Promise<null | string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:143

Parameters

Returns

Promise<null | string>

Inherited from

JsonRpcProvider.getAvatar;

getBalance()

getBalance(addressOrName, blockTag?): Promise<BigNumber>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:119

Parameters

Returns

Promise<BigNumber>

Inherited from

JsonRpcProvider.getBalance;

getBlock()

getBlock(blockHashOrBlockTag): Promise<Block>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:132

Parameters

Returns

Promise<Block>

Inherited from

JsonRpcProvider.getBlock;

getBlockNumber()

getBlockNumber(): Promise<number>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:117

Returns

Promise<number>

Inherited from

JsonRpcProvider.getBlockNumber;

getBlockWithTransactions()

getBlockWithTransactions(blockHashOrBlockTag): Promise<BlockWithTransactions>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:133

Parameters

Returns

Promise<BlockWithTransactions>

Inherited from

JsonRpcProvider.getBlockWithTransactions;

getBundlerClient()

getBundlerClient(): BundlerClient<Transport>;

Defined in: aa-sdk/ethers/src/provider-adapter.ts:123

Creates and returns a BundlerClient using the existing account provider's transport and chain.

Example

import { AccountSigner, EthersProviderAdapter } from "@aa-sdk/ethers";
import { LocalAccountSigner } from "@aa-sdk/core";
import { sepolia } from "@account-kit/infra";
import { createLightAccount } from "@account-kit/smart-contracts";
 
const account = await createLightAccount({
  transport: http("https://rpc.testnet.aepps.com"),
  chain: sepolia,
  signer: LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey()),
});
 
const provider = new EthersProviderAdapter({
  account,
  chain: sepolia,
  rpcProvider: "https://eth-sepolia.g.alchemy.com/v2/your-api-key",
});
 
const bundlerClient = provider.getBundlerClient();

Returns

BundlerClient<Transport>

A bundler client configured with the existing account provider.

getCode()

getCode(addressOrName, blockTag?): Promise<string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:121

Parameters

Returns

Promise<string>

Inherited from

JsonRpcProvider.getCode;

getEtherPrice()

getEtherPrice(): Promise<number>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:137

Returns

Promise<number>

Inherited from

JsonRpcProvider.getEtherPrice;

getFeeData()

getFeeData(): Promise<FeeData>;

Defined in: node_modules/@ethersproject/abstract-provider/lib/index.d.ts:127

Returns

Promise<FeeData>

Inherited from

JsonRpcProvider.getFeeData;

getGasPrice()

getGasPrice(): Promise<BigNumber>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:118

Returns

Promise<BigNumber>

Inherited from

JsonRpcProvider.getGasPrice;

getLogs()

getLogs(filter): Promise<Log[]>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:136

Parameters

Returns

Promise<Log[]>

Inherited from

JsonRpcProvider.getLogs;

getNetwork()

getNetwork(): Promise<Network>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:100

Returns

Promise<Network>

Inherited from

JsonRpcProvider.getNetwork;

getResolver()

getResolver(name): Promise<null | Resolver>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:139

Parameters

Returns

Promise<null | Resolver>

Inherited from

JsonRpcProvider.getResolver;

getSigner()

getSigner(addressOrIndex?): JsonRpcSigner;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:38

Parameters

Returns

JsonRpcSigner

Inherited from

JsonRpcProvider.getSigner;

getStorageAt()

getStorageAt(
   addressOrName,
   position,
   blockTag?): Promise<string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:122

Parameters

Returns

Promise<string>

Inherited from

JsonRpcProvider.getStorageAt;

getTransaction()

getTransaction(transactionHash): Promise<TransactionResponse>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:134

Parameters

Returns

Promise<TransactionResponse>

Inherited from

JsonRpcProvider.getTransaction;

getTransactionCount()

getTransactionCount(addressOrName, blockTag?): Promise<number>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:120

Parameters

Returns

Promise<number>

Inherited from

JsonRpcProvider.getTransactionCount;

getTransactionReceipt()

getTransactionReceipt(transactionHash): Promise<TransactionReceipt>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:135

Parameters

Returns

Promise<TransactionReceipt>

Inherited from

JsonRpcProvider.getTransactionReceipt;

getUncheckedSigner()

getUncheckedSigner(addressOrIndex?): UncheckedJsonRpcSigner;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:39

Parameters

Returns

UncheckedJsonRpcSigner

Inherited from

JsonRpcProvider.getUncheckedSigner;

listAccounts()

listAccounts(): Promise<string[]>;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:40

Returns

Promise<string[]>

Inherited from

JsonRpcProvider.listAccounts;

listenerCount()

listenerCount(eventName?): number;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:151

Parameters

Returns

number

Inherited from

JsonRpcProvider.listenerCount;

listeners()

listeners(eventName?): Listener[];

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:152

Parameters

Returns

Listener[]

Inherited from

JsonRpcProvider.listeners;

lookupAddress()

lookupAddress(address): Promise<null | string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:142

Parameters

Returns

Promise<null | string>

Inherited from

JsonRpcProvider.lookupAddress;

off()

off(eventName, listener?): this;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:153

Parameters

Returns

this

Inherited from

JsonRpcProvider.off;

on()

on(eventName, listener): this;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:148

Parameters

Returns

this

Inherited from

JsonRpcProvider.on;

once()

once(eventName, listener): this;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:149

Parameters

Returns

this

Inherited from

JsonRpcProvider.once;

perform()

perform(method, params): Promise<any>;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:43

Parameters

Returns

Promise<any>

Inherited from

JsonRpcProvider.perform;

poll()

poll(): Promise<void>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:96

Returns

Promise<void>

Inherited from

JsonRpcProvider.poll;

prepareRequest()

prepareRequest(method, params): [string, any[]];

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:42

Parameters

Returns

[string, any[]]

Inherited from

JsonRpcProvider.prepareRequest;

removeAllListeners()

removeAllListeners(eventName?): this;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:154

Parameters

Returns

this

Inherited from

JsonRpcProvider.removeAllListeners;

removeListener()

removeListener(eventName, listener): Provider;

Defined in: node_modules/@ethersproject/abstract-provider/lib/index.d.ts:150

Parameters

Returns

Provider

Inherited from

JsonRpcProvider.removeListener;

resetEventsBlock()

resetEventsBlock(blockNumber): void;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:97

Parameters

Returns

void

Inherited from

JsonRpcProvider.resetEventsBlock;

resolveName()

resolveName(name): Promise<null | string>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:141

Parameters

Returns

Promise<null | string>

Inherited from

JsonRpcProvider.resolveName;

send()

send(method, params): Promise<any>;

Defined in: aa-sdk/ethers/src/provider-adapter.ts:79

Rewrites the send method to use the account provider's EIP-1193 compliant request method

Parameters

Returns

Promise<any>

the result of the RPC call

Overrides

JsonRpcProvider.send;

sendTransaction()

sendTransaction(signedTransaction): Promise<TransactionResponse>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:124

Parameters

Returns

Promise<TransactionResponse>

Inherited from

JsonRpcProvider.sendTransaction;

waitForTransaction()

waitForTransaction(
   transactionHash,
   confirmations?,
   timeout?): Promise<TransactionReceipt>;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:108

Parameters

Returns

Promise<TransactionReceipt>

Inherited from

JsonRpcProvider.waitForTransaction;

defaultUrl()

static defaultUrl(): string;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:35

Returns

string

Inherited from

JsonRpcProvider.defaultUrl;

fromEthersProvider()

static fromEthersProvider(provider, chain): EthersProviderAdapter;

Defined in: aa-sdk/ethers/src/provider-adapter.ts:139

Creates an instance of EthersProviderAdapter from an ethers.js JsonRpcProvider.

Parameters

Returns

EthersProviderAdapter

an instance of EthersProviderAdapter

getFormatter()

static getFormatter(): Formatter;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:92

Returns

Formatter

Inherited from

JsonRpcProvider.getFormatter;

getNetwork()

static getNetwork(network): Network;

Defined in: node_modules/@ethersproject/providers/lib/base-provider.d.ts:93

Parameters

Returns

Network

Inherited from

JsonRpcProvider.getNetwork;

hexlifyTransaction()

static hexlifyTransaction(transaction, allowExtra?): object;

Defined in: node_modules/@ethersproject/providers/lib/json-rpc-provider.d.ts:47

Parameters

Returns

object

Inherited from

JsonRpcProvider.hexlifyTransaction;

isProvider()

static isProvider(value): value is Provider;

Defined in: node_modules/@ethersproject/abstract-provider/lib/index.d.ts:154

Parameters

Returns

value is Provider

Inherited from

JsonRpcProvider.isProvider;