Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Web3Provider

Hierarchy

  • JsonRpcProvider
    • Web3Provider

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_bootstrapPoll

_bootstrapPoll: Timer

_emitted

_emitted: {}

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 connection

connection: ConnectionInfo

disableCcipRead

disableCcipRead: boolean

formatter

formatter: Formatter

Readonly jsonRpcFetchFunc

jsonRpcFetchFunc: JsonRpcFetchFunc

Readonly provider

provider: ExternalProvider

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
  • set polling(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

pollingInterval

  • get pollingInterval(): number
  • set pollingInterval(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

ready

  • get ready(): Promise<Network>

  • Returns Promise<Network>

Methods

_addEventListener

  • Parameters

    Returns Web3Provider

_call

  • Parameters

    Returns Promise<string>

_getAddress

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

  • Parameters

    • addressOrName: string | Promise<string>

    Returns Promise<string>

_getBlock

  • Parameters

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

    Returns Promise<Block | BlockWithTransactions>

_getBlockTag

  • Parameters

    Returns Promise<BlockTag>

_getFastBlockNumber

  • _getFastBlockNumber(): Promise<number>

  • Returns Promise<number>

_getFilter

_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

  • Parameters

    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

  • Parameters

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

    Returns TransactionResponse

addListener

  • Parameters

    Returns Provider

call

  • Parameters

    Returns Promise<string>

ccipReadFetch

  • ccipReadFetch(tx: Transaction, calldata: string, urls: string[]): Promise<null | string>

  • Parameters

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

    Returns Promise<null | string>

detectNetwork

  • detectNetwork(): Promise<Network>

  • Returns Promise<Network>

emit

  • emit(eventName: EventType, ...args: any[]): boolean

  • Parameters

    Returns boolean

estimateGas

  • Parameters

    Returns Promise<BigNumber>

getAvatar

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

  • Parameters

    • nameOrAddress: string

    Returns Promise<null | string>

getBalance

  • getBalance(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<BigNumber>

  • Parameters

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

    Returns Promise<BigNumber>

getBlock

  • Parameters

    Returns Promise<Block>

getBlockNumber

  • getBlockNumber(): Promise<number>

  • Returns Promise<number>

getBlockWithTransactions

  • Parameters

    Returns Promise<BlockWithTransactions>

getCode

  • getCode(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<string>

  • Parameters

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

    Returns Promise<string>

getEtherPrice

  • getEtherPrice(): Promise<number>

  • Returns Promise<number>

getFeeData

  • Returns Promise<FeeData>

getGasPrice

  • getGasPrice(): Promise<BigNumber>

  • Returns Promise<BigNumber>

getLogs

getNetwork

  • getNetwork(): Promise<Network>

  • Returns Promise<Network>

getResolver

  • getResolver(name: string): Promise<null | Resolver>

  • Parameters

    • name: string

    Returns Promise<null | Resolver>

getSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns JsonRpcSigner

getStorageAt

  • Parameters

    Returns Promise<string>

getTransaction

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionResponse>

getTransactionCount

  • getTransactionCount(addressOrName: string | Promise<string>, blockTag?: BlockTag | Promise<BlockTag>): Promise<number>

  • Parameters

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

    Returns Promise<number>

getTransactionReceipt

  • getTransactionReceipt(transactionHash: string | Promise<string>): Promise<TransactionReceipt>

  • Parameters

    • transactionHash: string | Promise<string>

    Returns Promise<TransactionReceipt>

getUncheckedSigner

  • Parameters

    • Optional addressOrIndex: string | number

    Returns UncheckedJsonRpcSigner

listAccounts

  • listAccounts(): Promise<string[]>

  • Returns Promise<string[]>

listenerCount

  • Parameters

    Returns number

listeners

  • Parameters

    Returns Listener[]

lookupAddress

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

  • Parameters

    • address: string | Promise<string>

    Returns Promise<null | string>

off

  • Parameters

    Returns Web3Provider

on

  • Parameters

    Returns Web3Provider

once

  • Parameters

    Returns Web3Provider

perform

  • perform(method: string, params: any): Promise<any>

  • Parameters

    • method: string
    • params: any

    Returns Promise<any>

poll

  • poll(): Promise<void>

  • Returns Promise<void>

prepareRequest

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

  • Parameters

    • method: string
    • params: any

    Returns [string, any[]]

removeAllListeners

  • Parameters

    Returns Web3Provider

removeListener

  • Parameters

    Returns Provider

resetEventsBlock

  • resetEventsBlock(blockNumber: number): void

  • Parameters

    • blockNumber: number

    Returns void

resolveName

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

  • Parameters

    • name: string | Promise<string>

    Returns Promise<null | string>

send

  • send(method: string, params: any[]): Promise<any>

  • Parameters

    • method: string
    • params: any[]

    Returns Promise<any>

sendTransaction

  • Parameters

    • signedTransaction: string | Promise<string>

    Returns Promise<TransactionResponse>

waitForTransaction

  • waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<TransactionReceipt>

  • Parameters

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

    Returns Promise<TransactionReceipt>

Static defaultUrl

  • defaultUrl(): string

  • Returns string

Static getFormatter

  • Returns Formatter

Static getNetwork

  • Parameters

    Returns Network

Static hexlifyTransaction

  • Parameters

    Returns {}

Static isProvider

  • isProvider(value: any): value is Provider

  • Parameters

    • value: any

    Returns value is Provider

Generated using TypeDoc