Class Web3Provider

Hierarchy

  • JsonRpcProvider
    • Web3Provider

Methods

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

Properties

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

Accessors

ready network blockNumber polling pollingInterval _cache

Constructors

constructor

Methods

getFeeData

  • Returns Promise<FeeData>

addListener

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns Provider

removeListener

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns Provider

Static isProvider

  • Parameters

    • value: any

    Returns value is Provider

_ready

  • _ready(): Promise<Network>

  • Returns Promise<Network>

Static getFormatter

  • Returns Formatter

Static getNetwork

  • Parameters

    • network: Networkish

    Returns Network

ccipReadFetch

  • Parameters

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

    Returns Promise<null | string>

_getInternalBlockNumber

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

  • Parameters

    • maxAge: number

    Returns Promise<number>

poll

  • Returns Promise<void>

resetEventsBlock

  • Parameters

    • blockNumber: number

    Returns void

getNetwork

  • Returns Promise<Network>

_getFastBlockNumber

  • _getFastBlockNumber(): Promise<number>

  • Returns Promise<number>

_setFastBlockNumber

  • _setFastBlockNumber(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

waitForTransaction

  • Parameters

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

    Returns Promise<TransactionReceipt>

_waitForTransaction

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

  • Parameters

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

    Returns Promise<TransactionReceipt>

getBlockNumber

  • Returns Promise<number>

getGasPrice

  • Returns Promise<BigNumber>

getBalance

  • Parameters

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

    Returns Promise<BigNumber>

getTransactionCount

  • Parameters

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

    Returns Promise<number>

getCode

  • Parameters

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

    Returns Promise<string>

getStorageAt

  • Parameters

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

    Returns Promise<string>

_wrapTransaction

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

  • Parameters

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

    Returns TransactionResponse

sendTransaction

  • Parameters

    • signedTransaction: string | Promise<string>

    Returns Promise<TransactionResponse>

_getTransactionRequest

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

  • Parameters

    • transaction: Deferrable<TransactionRequest>

    Returns Promise<Transaction>

_getFilter

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

  • Parameters

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

    Returns Promise<Filter | FilterByBlockHash>

_call

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

  • Parameters

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

    Returns Promise<string>

call

  • Parameters

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

    Returns Promise<string>

estimateGas

  • Parameters

    • transaction: Deferrable<TransactionRequest>

    Returns Promise<BigNumber>

_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>

getBlock

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>

    Returns Promise<Block>

getBlockWithTransactions

  • Parameters

    • blockHashOrBlockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BlockWithTransactions>

getTransaction

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionResponse>

getTransactionReceipt

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionReceipt>

getLogs

  • Parameters

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

    Returns Promise<Log[]>

getEtherPrice

  • Returns Promise<number>

_getBlockTag

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

  • Parameters

    • blockTag: BlockTag | Promise<BlockTag>

    Returns Promise<BlockTag>

getResolver

  • Parameters

    • name: string

    Returns Promise<null | Resolver>

_getResolver

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

  • Parameters

    • name: string
    • Optional operation: string

    Returns Promise<string>

resolveName

  • Parameters

    • name: string | Promise<string>

    Returns Promise<null | string>

lookupAddress

  • Parameters

    • address: string | Promise<string>

    Returns Promise<null | string>

getAvatar

  • Parameters

    • nameOrAddress: string

    Returns Promise<null | string>

_addEventListener

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

  • Parameters

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

    Returns Web3Provider

on

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns Web3Provider

once

  • Parameters

    • eventName: EventType
    • listener: Listener

    Returns Web3Provider

emit

  • Parameters

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

    Returns boolean

listenerCount

  • Parameters

    • Optional eventName: EventType

    Returns number

listeners

  • Parameters

    • Optional eventName: EventType

    Returns Listener[]

off

  • Parameters

    • eventName: EventType
    • Optional listener: Listener

    Returns Web3Provider

removeAllListeners

  • Parameters

    • Optional eventName: EventType

    Returns Web3Provider

Static defaultUrl

  • Returns string

detectNetwork

  • Returns Promise<Network>

_uncachedDetectNetwork

  • _uncachedDetectNetwork(): Promise<Network>

  • Returns Promise<Network>

getSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns JsonRpcSigner

getUncheckedSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns UncheckedJsonRpcSigner

listAccounts

  • Returns Promise<string[]>

prepareRequest

  • Parameters

    • method: string
    • params: any

    Returns [string, any[]]

perform

  • Parameters

    • method: string
    • params: any

    Returns Promise<any>

_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

Static hexlifyTransaction

  • Parameters

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

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

    • [key: string]: string | AccessList

send

  • Parameters

    • method: string
    • params: any[]

    Returns Promise<any>

Properties

Readonly _isProvider

_isProvider: boolean

_networkPromise

_networkPromise: Promise<Network>

_network

_network: Network

_events

_events: Event[]

formatter

formatter: Formatter

_emitted

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

Type declaration

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

_pollingInterval

_pollingInterval: number

_poller

_poller: Timer

_bootstrapPoll

_bootstrapPoll: Timer

_lastBlockNumber

_lastBlockNumber: number

_maxFilterBlockRange

_maxFilterBlockRange: number

_fastBlockNumber

_fastBlockNumber: number

_fastBlockNumberPromise

_fastBlockNumberPromise: Promise<number>

_fastQueryDate

_fastQueryDate: number

_maxInternalBlockNumber

_maxInternalBlockNumber: number

_internalBlockNumber

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

Readonly anyNetwork

anyNetwork: boolean

disableCcipRead

disableCcipRead: boolean

Readonly connection

connection: ConnectionInfo

_pendingFilter

_pendingFilter: Promise<number>

_nextId

_nextId: number

_eventLoopCache

_eventLoopCache: Record<string, Promise<any>>

Readonly provider

provider: ExternalProvider

Readonly jsonRpcFetchFunc

jsonRpcFetchFunc: JsonRpcFetchFunc

Accessors

ready

  • get ready(): Promise<Network>

  • Returns Promise<Network>

network

  • get network(): Network

  • Returns Network

blockNumber

  • get blockNumber(): number

  • Returns number

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

_cache

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

  • Returns Record<string, Promise<any>>

Constructors

constructor

  • Parameters

    • provider: ExternalProvider | JsonRpcFetchFunc
    • Optional network: Networkish

    Returns Web3Provider

Settings

Member Visibility

Theme

Generated using TypeDoc