Class Web3ZKsyncL1

config

eth

Readonlyproviders

utils

Static OptionalgivenProvider

Staticmodules

StaticonNewProviderDiscovered

Static Readonlyproviders

StaticrequestEIP6963Providers

Staticutils

Staticversion

accountProvider

• get accountProvider(): undefined | Web3AccountProvider<Web3BaseWalletAccount>

• Returns undefined | Web3AccountProvider<Web3BaseWalletAccount>

BatchRequest

• get BatchRequest(): (new () => Web3BatchRequest)

• Will return the Web3BatchRequest constructor.

  Returns (new () => Web3BatchRequest)

  • • new (): Web3BatchRequest

    • Returns Web3BatchRequest

blockHeaderTimeout

• get blockHeaderTimeout(): number

• The blockHeaderTimeout is used over socket-based connections. This option defines the amount seconds it should wait for 'newBlockHeaders' event before falling back to polling to fetch transaction receipt. Default is 10 seconds.

  Returns number
• set blockHeaderTimeout(val): void

• Will set the blockHeaderTimeout

  Parameters

  • val: number

  Returns void

contractDataInputFill

• get contractDataInputFill(): "input" | "data" | "both"

• The contractDataInputFill options property will allow you to set the hash of the method signature and encoded parameters to the property either data, input or both within your contract. This will affect the contracts send, call and estimateGas methods Default is data.

  Returns "input" | "data" | "both"
• set contractDataInputFill(val): void

• Will set the contractDataInputFill

  Parameters

  • val: "input" | "data" | "both"

  Returns void

currentProvider

• get currentProvider(): undefined | Web3BaseProvider<API>

• Will return the current provider. (The same as provider)

  Returns undefined | Web3BaseProvider<API>

  Returns the current provider

  Example

  const web3Context = new Web3Context("http://localhost:8545");
  console.log(web3Context.provider);
  > HttpProvider {
  	clientUrl: 'http://localhost:8545',
  	httpProviderOptions: undefined
   }
  Copy

• set currentProvider(provider): void

• Will set the current provider. (The same as provider)

  Parameters

  • provider: undefined | string | SupportedProviders<API>

    SupportedProviders The provider to set

  Returns void

  Example

   const web3Context = new Web3Context("http://localhost:8545");
  web3Context.currentProvider = "ws://localhost:8545";
  console.log(web3Context.provider);
  > WebSocketProvider {
  _eventEmitter: EventEmitter {
  _events: [Object: null prototype] {},
  _eventsCount: 0,
  ...
  }
  Copy

defaultAccount

• get defaultAccount(): undefined | string

• This default address is used as the default from property, if no from property is specified in for the following methods:

  • web3.eth.sendTransaction()
  • web3.eth.call()
  • myContract.methods.myMethod().call()
  • myContract.methods.myMethod().send()

  Returns undefined | string
• set defaultAccount(val): void

• Will set the default account.

  Parameters

  • val: undefined | string

  Returns void

defaultBlock

• get defaultBlock(): BlockNumberOrTag

• The default block is used for certain methods. You can override it by passing in the defaultBlock as last parameter. The default value is "latest".

  • web3.eth.getBalance()
  • web3.eth.getCode()
  • web3.eth.getTransactionCount()
  • web3.eth.getStorageAt()
  • web3.eth.call()
  • myContract.methods.myMethod().call()

  Returns BlockNumberOrTag
• set defaultBlock(val): void

• Will set the default block.

  • A block number
  • "earliest" - String: The genesis block
  • "latest" - String: The latest block (current head of the blockchain)
  • "pending" - String: The currently mined block (including pending transactions)
  • "finalized" - String: (For POS networks) The finalized block is one which has been accepted as canonical by greater than 2/3 of validators
  • "safe" - String: (For POS networks) The safe head block is one which under normal network conditions, is expected to be included in the canonical chain. Under normal network conditions the safe head and the actual tip of the chain will be equivalent (with safe head trailing only by a few seconds). Safe heads will be less likely to be reorged than the proof of work network`s latest blocks.

  Parameters

  • val: BlockNumberOrTag

  Returns void

defaultChain

• get defaultChain(): string

• Returns string

• set defaultChain(val): void

• Parameters

  • val: string

  Returns void

defaultCommon

• get defaultCommon(): undefined | Common

• Will get the default common property The default common property does contain the following Common object:

  • customChain - Object: The custom chain properties
    • name - string: (optional) The name of the chain
    • networkId - number: Network ID of the custom chain
    • chainId - number: Chain ID of the custom chain
  • baseChain - string: (optional) mainnet, goerli, kovan, rinkeby, or ropsten
  • hardfork - string: (optional) chainstart, homestead, dao, tangerineWhistle, spuriousDragon, byzantium, constantinople, petersburg, istanbul, berlin, or london Default is undefined.

  Returns undefined | Common
• set defaultCommon(val): void

• Will set the default common property

  Parameters

  • val: undefined | Common

  Returns void

defaultHardfork

• get defaultHardfork(): string

• Will return the default hardfork. Default is london The default hardfork property can be one of the following:

  • chainstart
  • homestead
  • dao
  • tangerineWhistle
  • spuriousDragon
  • byzantium
  • constantinople
  • petersburg
  • istanbul
  • berlin
  • london
  • 'arrowGlacier',
  • 'tangerineWhistle',
  • 'muirGlacier'

  Returns string
• set defaultHardfork(val): void

• Will set the default hardfork.

  Parameters

  • val: string

  Returns void

defaultMaxPriorityFeePerGas

• get defaultMaxPriorityFeePerGas(): Numbers

• Returns Numbers

• set defaultMaxPriorityFeePerGas(val): void

• Parameters

  • val: Numbers

  Returns void

defaultNetworkId

• get defaultNetworkId(): undefined | Numbers

• Returns undefined | Numbers

• set defaultNetworkId(val): void

• Parameters

  • val: undefined | Numbers

  Returns void

defaultReturnFormat

• get defaultReturnFormat(): DataFormat

• Returns DataFormat

• set defaultReturnFormat(val): void

• Parameters

  • val: DataFormat

  Returns void

defaultTransactionType

• get defaultTransactionType(): Numbers

• Returns Numbers

• set defaultTransactionType(val): void

• Parameters

  • val: Numbers

  Returns void

enableExperimentalFeatures

• get enableExperimentalFeatures(): {
      useRpcCallSpecification: boolean;
      useSubscriptionWhenCheckingBlockTimeout: boolean;
  }

• The enableExperimentalFeatures is used to enable trying new experimental features that are still not fully implemented or not fully tested or still have some related issues. Default is false for every feature.

  Returns {
      useRpcCallSpecification: boolean;
      useSubscriptionWhenCheckingBlockTimeout: boolean;
  }

  • useRpcCallSpecification: boolean

  • useSubscriptionWhenCheckingBlockTimeout: boolean
• set enableExperimentalFeatures(val): void

• Will set the enableExperimentalFeatures

  Parameters

  • val: {
        useRpcCallSpecification: boolean;
        useSubscriptionWhenCheckingBlockTimeout: boolean;
    }

    • useRpcCallSpecification: boolean

    • useSubscriptionWhenCheckingBlockTimeout: boolean

  Returns void

givenProvider

• get givenProvider(): undefined | SupportedProviders<never>

• Will return the givenProvider if available.

  When using web3.js in an Ethereum compatible browser, it will set with the current native provider by that browser. Will return the given provider by the (browser) environment, otherwise undefined.

  Returns undefined | SupportedProviders<never>

handleRevert

• get handleRevert(): boolean

• The handleRevert options property returns the revert reason string if enabled for the following methods:

  • web3.eth.sendTransaction()
  • web3.eth.call()
  • myContract.methods.myMethod().call()
  • myContract.methods.myMethod().send() Default is false.

  Note: At the moment handleRevert is only supported for sendTransaction and not for sendSignedTransaction

  Returns boolean
• set handleRevert(val): void

• Will set the handleRevert

  Parameters

  • val: boolean

  Returns void

maxListenersWarningThreshold

• get maxListenersWarningThreshold(): number

• Returns number

• set maxListenersWarningThreshold(val): void

• Parameters

  • val: number

  Returns void

provider

• get provider(): undefined | Web3BaseProvider<API>

• Will return the current provider.

  Returns undefined | Web3BaseProvider<API>

  Returns the current provider

  Example

  const web3 = new Web3Context("http://localhost:8545");
  console.log(web3.provider);
  > HttpProvider {
  	clientUrl: 'http://localhost:8545',
  	httpProviderOptions: undefined
   }
  Copy

• set provider(provider): void

• Will set the current provider.

  Parameters

  • provider: undefined | string | SupportedProviders<API>

    The provider to set

    Accepted providers are of type SupportedProviders

  Returns void

  Example

   const web3Context = new web3ContextContext("http://localhost:8545");
  web3Context.provider = "ws://localhost:8545";
  console.log(web3Context.provider);
  > WebSocketProvider {
  _eventEmitter: EventEmitter {
  _events: [Object: null prototype] {},
  _eventsCount: 0,
  ...
  }
  Copy

requestManager

• get requestManager(): Web3RequestManager<API>

• Returns Web3RequestManager<API>

subscriptionManager

• get subscriptionManager(): Web3SubscriptionManager<API, RegisteredSubs>

• Will return the current subscriptionManager (Web3SubscriptionManager)

  Returns Web3SubscriptionManager<API, RegisteredSubs>

transactionBlockTimeout

• get transactionBlockTimeout(): number

• The transactionBlockTimeout is used over socket-based connections. This option defines the amount of new blocks it should wait until the first confirmation happens, otherwise the PromiEvent rejects with a timeout error. Default is 50.

  Returns number
• set transactionBlockTimeout(val): void

• Will set the transactionBlockTimeout.

  Parameters

  • val: number

  Returns void

transactionBuilder

• get transactionBuilder(): undefined | TransactionBuilder<unknown>

• Returns undefined | TransactionBuilder<unknown>

• set transactionBuilder(val): void

• Parameters

  • val: undefined | TransactionBuilder<unknown>

  Returns void

transactionConfirmationBlocks

• get transactionConfirmationBlocks(): number

• This defines the number of blocks it requires until a transaction is considered confirmed. Default is 24.

  Returns number
• set transactionConfirmationBlocks(val): void

• Will set the transactionConfirmationBlocks.

  Parameters

  • val: number

  Returns void

transactionConfirmationPollingInterval

• get transactionConfirmationPollingInterval(): undefined | number

• Returns undefined | number

• set transactionConfirmationPollingInterval(val): void

• Parameters

  • val: undefined | number

  Returns void

transactionPollingInterval

• get transactionPollingInterval(): number

• Used over HTTP connections. This option defines the number of seconds between Web3 calls for a receipt which confirms that a transaction was mined by the network. Default is 1000 ms.

  Returns number
• set transactionPollingInterval(val): void

• Will set the transactionPollingInterval.

  Parameters

  • val: number

  Returns void

transactionPollingTimeout

• get transactionPollingTimeout(): number

• Used over HTTP connections. This option defines the number of seconds Web3 will wait for a receipt which confirms that a transaction was mined by the network. Note: If this method times out, the transaction may still be pending. Default is 750 seconds (12.5 minutes).

  Returns number
• set transactionPollingTimeout(val): void

• Will set the transactionPollingTimeout.

  Parameters

  • val: number

  Returns void

transactionReceiptPollingInterval

• get transactionReceiptPollingInterval(): undefined | number

• The transactionPollingInterval is used over HTTP connections. This option defines the number of seconds between Web3 calls for a receipt which confirms that a transaction was mined by the network. Default is undefined

  Returns undefined | number
• set transactionReceiptPollingInterval(val): void

• Will set the transactionReceiptPollingInterval

  Parameters

  • val: undefined | number

  Returns void

transactionSendTimeout

• get transactionSendTimeout(): number

• The time used to wait for Ethereum Node to return the sent transaction result. Note: If the RPC call stuck at the Node and therefor timed-out, the transaction may still be pending or even mined by the Network. We recommend checking the pending transactions in such a case. Default is 750 seconds (12.5 minutes).

  Returns number
• set transactionSendTimeout(val): void

• Will set the transactionSendTimeout.

  Parameters

  • val: number

  Returns void

transactionTypeParser

• get transactionTypeParser(): undefined | TransactionTypeParser

• Returns undefined | TransactionTypeParser

• set transactionTypeParser(val): void

• Parameters

  • val: undefined | TransactionTypeParser

  Returns void

wallet

• get wallet(): undefined | Web3BaseWallet<Web3BaseWalletAccount>

• Returns undefined | Web3BaseWallet<Web3BaseWalletAccount>

emit

• emit<K>(eventName, params): void

• Type Parameters

  • K extends Web3ConfigEvent

  Parameters

  • eventName: K
  • params: {
        CONFIG_CHANGE:
            | {
                name: "handleRevert";
                newValue: boolean;
                oldValue: boolean;
            }
            | {
                name: "defaultAccount";
                newValue: undefined | string;
                oldValue: undefined | string;
            }
            | {
                name: "defaultBlock";
                newValue: BlockNumberOrTag;
                oldValue: BlockNumberOrTag;
            }
            | {
                name: "transactionSendTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionBlockTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionConfirmationBlocks";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingInterval";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionReceiptPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "transactionConfirmationPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "blockHeaderTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "maxListenersWarningThreshold";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "contractDataInputFill";
                newValue: "input" | "data" | "both";
                oldValue: "input" | "data" | "both";
            }
            | {
                name: "defaultNetworkId";
                newValue: undefined | Numbers;
                oldValue: undefined | Numbers;
            }
            | {
                name: "defaultChain";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultHardfork";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultCommon";
                newValue: undefined | Common;
                oldValue: undefined | Common;
            }
            | {
                name: "defaultTransactionType";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "defaultMaxPriorityFeePerGas";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "enableExperimentalFeatures";
                newValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
                oldValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
            }
            | {
                name: "transactionBuilder";
                newValue: undefined | TransactionBuilder;
                oldValue: undefined | TransactionBuilder;
            }
            | {
                name: "transactionTypeParser";
                newValue: undefined | TransactionTypeParser;
                oldValue: undefined | TransactionTypeParser;
            }
            | {
                name: "defaultReturnFormat";
                newValue: DataFormat;
                oldValue: DataFormat;
            };
    }[K]

  Returns void

eventNames

• eventNames(): (string | symbol)[]

• Returns (string | symbol)[]

extend

• extend(extendObj): this

• This method allows extending the web3 modules. Note: This method is only for backward compatibility, and It is recommended to use Web3 v4 Plugin feature for extending web3.js functionality if you are developing something new.

  Parameters

  • extendObj: ExtensionObject

  Returns this

getContextObject

• getContextObject(): Web3ContextObject<EthExecutionAPI, RegisteredSubscription>

• Returns Web3ContextObject<EthExecutionAPI, RegisteredSubscription>

getMaxListeners

• getMaxListeners(): number

• Returns number

link

• link<T>(parentContext): void

• Link current context to another context.

  Type Parameters

  • T extends Web3Context<unknown, any>

  Parameters

  • parentContext: T

  Returns void

listenerCount

• listenerCount<K>(eventName): number

• Type Parameters

  • K extends Web3ConfigEvent

  Parameters

  • eventName: K

  Returns number

listeners

• listeners<K>(eventName): ((...args: any[]) => void)[]

• Type Parameters

  • K extends Web3ConfigEvent

  Parameters

  • eventName: K

  Returns ((...args: any[]) => void)[]

off

• off<K>(eventName, fn): void

• Type Parameters

  • K extends Web3ConfigEvent

  Parameters

  • eventName: K
  • fn: Web3EventCallback<{
        CONFIG_CHANGE:
            | {
                name: "handleRevert";
                newValue: boolean;
                oldValue: boolean;
            }
            | {
                name: "defaultAccount";
                newValue: undefined | string;
                oldValue: undefined | string;
            }
            | {
                name: "defaultBlock";
                newValue: BlockNumberOrTag;
                oldValue: BlockNumberOrTag;
            }
            | {
                name: "transactionSendTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionBlockTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionConfirmationBlocks";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingInterval";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionReceiptPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "transactionConfirmationPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "blockHeaderTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "maxListenersWarningThreshold";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "contractDataInputFill";
                newValue: "input" | "data" | "both";
                oldValue: "input" | "data" | "both";
            }
            | {
                name: "defaultNetworkId";
                newValue: undefined | Numbers;
                oldValue: undefined | Numbers;
            }
            | {
                name: "defaultChain";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultHardfork";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultCommon";
                newValue: undefined | Common;
                oldValue: undefined | Common;
            }
            | {
                name: "defaultTransactionType";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "defaultMaxPriorityFeePerGas";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "enableExperimentalFeatures";
                newValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
                oldValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
            }
            | {
                name: "transactionBuilder";
                newValue: undefined | TransactionBuilder;
                oldValue: undefined | TransactionBuilder;
            }
            | {
                name: "transactionTypeParser";
                newValue: undefined | TransactionTypeParser;
                oldValue: undefined | TransactionTypeParser;
            }
            | {
                name: "defaultReturnFormat";
                newValue: DataFormat;
                oldValue: DataFormat;
            };
    }[K]>

  Returns void

on

• on<K>(eventName, fn): void

• Type Parameters

  • K extends Web3ConfigEvent

  Parameters

  • eventName: K
  • fn: Web3EventCallback<{
        CONFIG_CHANGE:
            | {
                name: "handleRevert";
                newValue: boolean;
                oldValue: boolean;
            }
            | {
                name: "defaultAccount";
                newValue: undefined | string;
                oldValue: undefined | string;
            }
            | {
                name: "defaultBlock";
                newValue: BlockNumberOrTag;
                oldValue: BlockNumberOrTag;
            }
            | {
                name: "transactionSendTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionBlockTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionConfirmationBlocks";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingInterval";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionReceiptPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "transactionConfirmationPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "blockHeaderTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "maxListenersWarningThreshold";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "contractDataInputFill";
                newValue: "input" | "data" | "both";
                oldValue: "input" | "data" | "both";
            }
            | {
                name: "defaultNetworkId";
                newValue: undefined | Numbers;
                oldValue: undefined | Numbers;
            }
            | {
                name: "defaultChain";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultHardfork";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultCommon";
                newValue: undefined | Common;
                oldValue: undefined | Common;
            }
            | {
                name: "defaultTransactionType";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "defaultMaxPriorityFeePerGas";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "enableExperimentalFeatures";
                newValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
                oldValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
            }
            | {
                name: "transactionBuilder";
                newValue: undefined | TransactionBuilder;
                oldValue: undefined | TransactionBuilder;
            }
            | {
                name: "transactionTypeParser";
                newValue: undefined | TransactionTypeParser;
                oldValue: undefined | TransactionTypeParser;
            }
            | {
                name: "defaultReturnFormat";
                newValue: DataFormat;
                oldValue: DataFormat;
            };
    }[K]>

  Returns void

once

• once<K>(eventName, fn): void

• Type Parameters

  • K extends Web3ConfigEvent

  Parameters

  • eventName: K
  • fn: Web3EventCallback<{
        CONFIG_CHANGE:
            | {
                name: "handleRevert";
                newValue: boolean;
                oldValue: boolean;
            }
            | {
                name: "defaultAccount";
                newValue: undefined | string;
                oldValue: undefined | string;
            }
            | {
                name: "defaultBlock";
                newValue: BlockNumberOrTag;
                oldValue: BlockNumberOrTag;
            }
            | {
                name: "transactionSendTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionBlockTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionConfirmationBlocks";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingInterval";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionPollingTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "transactionReceiptPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "transactionConfirmationPollingInterval";
                newValue: undefined | number;
                oldValue: undefined | number;
            }
            | {
                name: "blockHeaderTimeout";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "maxListenersWarningThreshold";
                newValue: number;
                oldValue: number;
            }
            | {
                name: "contractDataInputFill";
                newValue: "input" | "data" | "both";
                oldValue: "input" | "data" | "both";
            }
            | {
                name: "defaultNetworkId";
                newValue: undefined | Numbers;
                oldValue: undefined | Numbers;
            }
            | {
                name: "defaultChain";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultHardfork";
                newValue: string;
                oldValue: string;
            }
            | {
                name: "defaultCommon";
                newValue: undefined | Common;
                oldValue: undefined | Common;
            }
            | {
                name: "defaultTransactionType";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "defaultMaxPriorityFeePerGas";
                newValue: Numbers;
                oldValue: Numbers;
            }
            | {
                name: "enableExperimentalFeatures";
                newValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
                oldValue: {
                    useRpcCallSpecification: boolean;
                    useSubscriptionWhenCheckingBlockTimeout: boolean;
                };
            }
            | {
                name: "transactionBuilder";
                newValue: undefined | TransactionBuilder;
                oldValue: undefined | TransactionBuilder;
            }
            | {
                name: "transactionTypeParser";
                newValue: undefined | TransactionTypeParser;
                oldValue: undefined | TransactionTypeParser;
            }
            | {
                name: "defaultReturnFormat";
                newValue: DataFormat;
                oldValue: DataFormat;
            };
    }[K]>

  Returns void

registerPlugin

• registerPlugin(plugin): void

• Parameters

  • plugin: Web3PluginBase<unknown>

  Returns void

removeAllListeners

• removeAllListeners(): EventEmitter

• Returns EventEmitter

setConfig

• setConfig(options): void

• Parameters

  • options: Partial<Web3ConfigOptions>

  Returns void

setMaxListenerWarningThreshold

• setMaxListenerWarningThreshold(maxListenersWarningThreshold): void

• Parameters

  • maxListenersWarningThreshold: number

  Returns void

setProvider

• setProvider(provider?): boolean

• Will set the provider.

  Parameters

  • Optionalprovider: string | SupportedProviders<EthExecutionAPI>

    SupportedProviders The provider to set

  Returns boolean

  Returns true if the provider was set

setRequestManagerMiddleware

• setRequestManagerMiddleware(requestManagerMiddleware): void

• Parameters

  • requestManagerMiddleware: RequestManagerMiddleware<EthExecutionAPI>

  Returns void

use

• use<T, T2>(ContextRef, ...args): T

• Use to create new object of any type extended by Web3Context and link it to current context. This can be used to initiate a global context object and then use it to create new objects of any type extended by Web3Context.

  Type Parameters

  • T extends Web3Context<unknown, any>
  • T2 extends unknown[]

  Parameters

  • ContextRef: Web3ContextConstructor<T, T2>
  • Rest...args: [...T2[]]

  Returns T