Class AlchemyProvider

Ethers provider with Alchemy-specific functions.

This is not a network-agnostic.

Hierarchy

  • AlchemyProvider
    • AlchemyProvider

Constructors

constructor

Properties

_bootstrapPoll _emitted _eventLoopCache _events _fastBlockNumber _fastBlockNumberPromise _fastQueryDate _internalBlockNumber _isProvider _lastBlockNumber _maxFilterBlockRange _maxInternalBlockNumber _network _networkPromise _nextId _pendingFilter _poller _pollingInterval anyNetwork apiKey assetTransfersSupportOrderParam connection disableCcipRead formatter

Accessors

_cache blockNumber network polling pollingInterval ready

Methods

_addEventListener _call _getAddress _getBlock _getBlockTag _getFastBlockNumber _getFilter _getInternalBlockNumber _getResolver _getTransactionRequest _ready _setFastBlockNumber _startEvent _startPending _stopEvent _uncachedDetectNetwork _waitForTransaction _wrapTransaction addListener call ccipReadFetch detectNetwork emit estimateGas getAssetTransfers getAvatar getBalance getBlock getBlockNumber getBlockWithTransactions getCode getEtherPrice getFeeData getGasPrice getLogs getNetwork getResolver getSigner getStorageAt getTokenBalances getTokenMetadata getTransaction getTransactionCount getTransactionReceipt getUncheckedSigner isCommunityResource listAccounts listenerCount listeners lookupAddress off on once perform poll polygon_getFeeData prepareRequest removeAllListeners removeListener resetEventsBlock resolveName send sendTransaction waitForTransaction defaultUrl getApiKey getFormatter getNetwork getUrl getWebSocketProvider hexlifyTransaction isProvider

Constructors

constructor

  • Parameters

    • Optional network: Networkish
    • Optional apiKey: any

    Returns AlchemyProvider

Properties

_bootstrapPoll

_bootstrapPoll: Timer

_emitted

_emitted: {
    [eventName: string]: number | "pending";
}

Type declaration

  • [eventName: string]: number | "pending"

_eventLoopCache

_eventLoopCache: Record<string, Promise<any>>

_events

_events: Event[]

_fastBlockNumber

_fastBlockNumber: number

_fastBlockNumberPromise

_fastBlockNumberPromise: Promise<number>

_fastQueryDate

_fastQueryDate: number

_internalBlockNumber

_internalBlockNumber: Promise<{
    blockNumber: number;
    reqTime: number;
    respTime: number;
}>

Readonly _isProvider

_isProvider: boolean

_lastBlockNumber

_lastBlockNumber: number

_maxFilterBlockRange

_maxFilterBlockRange: number

_maxInternalBlockNumber

_maxInternalBlockNumber: number

_network

_network: Network

_networkPromise

_networkPromise: Promise<Network>

_nextId

_nextId: number

_pendingFilter

_pendingFilter: Promise<number>

_poller

_poller: Timer

_pollingInterval

_pollingInterval: number

Readonly anyNetwork

anyNetwork: boolean

Readonly apiKey

apiKey: any

assetTransfersSupportOrderParam

assetTransfersSupportOrderParam: boolean = false

Readonly connection

connection: ConnectionInfo

disableCcipRead

disableCcipRead: boolean

formatter

formatter: Formatter

Accessors

_cache

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

  • Returns Record<string, Promise<any>>

blockNumber

  • get blockNumber(): number

  • Returns number

network

  • get network(): Network

  • Returns Network

polling

  • get polling(): boolean

  • Returns boolean

  • set polling(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

pollingInterval

  • get pollingInterval(): number

  • Returns number

  • set pollingInterval(value: number): void

  • Parameters

    • value: number

    Returns void

ready

  • get ready(): Promise<Network>

  • Returns Promise<Network>

Methods

_addEventListener

  • _addEventListener(eventName: EventType, listener: Listener, once: boolean): AlchemyProvider

  • Parameters

    • eventName: EventType
    • listener: Listener
    • once: boolean

    Returns AlchemyProvider

_call

  • _call(transaction: TransactionRequest, blockTag: BlockTag, attempt: number): Promise<string>

  • Parameters

    • transaction: TransactionRequest
    • blockTag: BlockTag
    • attempt: number

    Returns Promise<string>

_getAddress

  • _getAddress(addressOrName: string | Promise<string>): Promise<string>

  • Parameters

    • addressOrName: string | Promise<string>

    Returns Promise<string>

_getBlock

  • _getBlock(blockHashOrBlockTag: BlockTag | Promise<BlockTag>, includeTransactions?: boolean): Promise<Block | BlockWithTransactions>

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>
    • Optional includeTransactions: boolean

    Returns Promise<Block | BlockWithTransactions>

_getBlockTag

  • _getBlockTag(blockTag: BlockTag | Promise<BlockTag>): Promise<BlockTag>

  • Parameters

    • blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BlockTag>

_getFastBlockNumber

  • _getFastBlockNumber(): Promise<number>

  • Returns Promise<number>

_getFilter

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

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Filter | FilterByBlockHash>

_getInternalBlockNumber

  • _getInternalBlockNumber(maxAge: number): Promise<number>

  • Parameters

    • maxAge: number

    Returns Promise<number>

_getResolver

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

  • Parameters

    • name: string
    • Optional operation: string

    Returns Promise<string>

_getTransactionRequest

  • _getTransactionRequest(transaction: Deferrable<TransactionRequest>): Promise<Transaction>

  • Parameters

    • transaction: Deferrable<TransactionRequest>

    Returns Promise<Transaction>

_ready

  • _ready(): Promise<Network>

  • Returns Promise<Network>

_setFastBlockNumber

  • _setFastBlockNumber(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

_startEvent

  • _startEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

_startPending

  • _startPending(): void

  • Returns void

_stopEvent

  • _stopEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

_uncachedDetectNetwork

  • _uncachedDetectNetwork(): Promise<Network>

  • Returns Promise<Network>

_waitForTransaction

  • _waitForTransaction(transactionHash: string, confirmations: number, timeout: number, replaceable: {
        data: string;
        from: string;
        nonce: number;
        startBlock: number;
        to: string;
        value: BigNumber;
    }): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string
    • confirmations: number
    • timeout: number
    • replaceable: {
          data: string;
          from: string;
          nonce: number;
          startBlock: number;
          to: string;
          value: BigNumber;
      }
      • data: string
      • from: string
      • nonce: number
      • startBlock: number
      • to: string
      • value: BigNumber

    Returns Promise<TransactionReceipt>

_wrapTransaction

  • _wrapTransaction(tx: Transaction, hash?: string, startBlock?: number): TransactionResponse

  • Parameters

    • tx: Transaction
    • Optional hash: string
    • Optional startBlock: number

    Returns TransactionResponse

addListener

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns Provider

call

  • Parameters

    • transaction: Deferrable<TransactionRequest>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<string>

ccipReadFetch

  • Parameters

    • tx: Transaction
    • calldata: string
    • urls: string[]

    Returns Promise<null | string>

detectNetwork

  • Returns Promise<Network>

emit

  • Parameters

    • eventName: EventType
    • Rest ...args: any[]

    Returns boolean

estimateGas

  • Parameters

    • transaction: Deferrable<TransactionRequest>

    Returns Promise<BigNumber>

getAssetTransfers

getAvatar

  • Parameters

    • nameOrAddress: string

    Returns Promise<null | string>

getBalance

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BigNumber>

getBlock

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>

    Returns Promise<Block>

getBlockNumber

  • Returns Promise<number>

getBlockWithTransactions

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BlockWithTransactions>

getCode

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<string>

getEtherPrice

  • Returns Promise<number>

getFeeData

getGasPrice

  • Returns Promise<BigNumber>

getLogs

  • Parameters

    • filter: Filter | FilterByBlockHash | Promise<Filter | FilterByBlockHash>

    Returns Promise<Log[]>

getNetwork

  • Returns Promise<Network>

getResolver

  • Parameters

    • name: string

    Returns Promise<null | Resolver>

getSigner

  • Parameters

    • Optional address: string

    Returns JsonRpcSigner

getStorageAt

  • Parameters

    • addressOrName: string | Promise<string>
    • position: BigNumberish | Promise<BigNumberish>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<string>

getTokenBalances

getTokenMetadata

getTransaction

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionResponse>

getTransactionCount

  • Parameters

    • addressOrName: string | Promise<string>
    • Optional blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<number>

getTransactionReceipt

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionReceipt>

getUncheckedSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns UncheckedJsonRpcSigner

isCommunityResource

  • Returns boolean

listAccounts

  • Returns Promise<string[]>

listenerCount

  • Parameters

    • Optional eventName: EventType

    Returns number

listeners

  • Parameters

    • Optional eventName: EventType

    Returns Listener[]

lookupAddress

  • Parameters

    • address: string | Promise<string>

    Returns Promise<null | string>

off

  • Parameters

    • eventName: EventType
    • Optional listener: Listener

    Returns AlchemyProvider

on

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns AlchemyProvider

once

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns AlchemyProvider

perform

  • Parameters

    • method: string
    • params: any

    Returns Promise<any>

poll

  • Returns Promise<void>

Private polygon_getFeeData

prepareRequest

  • Parameters

    • method: string
    • params: any

    Returns [string, any[]]

removeAllListeners

  • Parameters

    • Optional eventName: EventType

    Returns AlchemyProvider

removeListener

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns Provider

resetEventsBlock

  • Parameters

    • blockNumber: number

    Returns void

resolveName

  • Parameters

    • name: string | Promise<string>

    Returns Promise<null | string>

send

  • Parameters

    • method: string
    • params: any[]

    Returns Promise<any>

sendTransaction

  • Parameters

    • signedTransaction: string | Promise<string>

    Returns Promise<TransactionResponse>

waitForTransaction

  • Parameters

    • transactionHash: string
    • Optional confirmations: number
    • Optional timeout: number

    Returns Promise<TransactionReceipt>

Static defaultUrl

  • Returns string

Static getApiKey

  • Parameters

    • apiKey: any

    Returns any

Static getFormatter

  • Returns Formatter

Static getNetwork

  • Parameters

    • network: Networkish

    Returns Network

Static getUrl

  • Provide limited retry number for Alchemy.

    Parameters

    • network: Network
    • apiKey: string

    Returns ConnectionInfo

Static getWebSocketProvider

  • Parameters

    • Optional network: Networkish
    • Optional apiKey: any

    Returns AlchemyWebSocketProvider

Static hexlifyTransaction

  • Parameters

    • transaction: TransactionRequest
    • Optional allowExtra: {
          [key: string]: boolean;
      }
      • [key: string]: boolean

    Returns {
        [key: string]: string | AccessList;
    }

    • [key: string]: string | AccessList

Static isProvider

  • Parameters

    • value: any

    Returns value is Provider

Settings

Member Visibility

Theme

Generated using TypeDoc