web3-core

Index

Classes

• Web3BatchRequest
• Web3Config
• Web3Context
• Web3EthPluginBase
• Web3EventEmitter
• Web3PluginBase
• Web3PromiEvent
• Web3RequestManager
• Web3Subscription
• Web3SubscriptionManager

Enumerations

• Web3ConfigEvent
• Web3RequestManagerEvent

Functions

• isEIP1193Provider
• isLegacyRequestProvider
• isLegacySendAsyncProvider
• isLegacySendProvider
• isMetaMaskProvider
• isSupportSubscriptions
• isSupportedProvider
• isWeb3Provider

Interfaces

• ExtensionObject
• Method
• RequestManagerMiddleware
• Web3ConfigOptions
• Web3Emitter

Namespaces

• formatters

References

• inputAddressFormatter
• inputBlockNumberFormatter
• inputCallFormatter
• inputDefaultBlockNumberFormatter
• inputLogFormatter
• inputPostFormatter
• inputSignFormatter
• inputStorageKeysFormatter
• inputTopicFormatter
• inputTransactionFormatter
• outputBigIntegerFormatter
• outputBlockFormatter
• outputLogFormatter
• outputPostFormatter
• outputProofFormatter
• outputSyncingFormatter
• outputTransactionFormatter
• outputTransactionReceiptFormatter
• txInputOptionsFormatter

Type Aliases

• CustomTransactionSchema
• PromiseExecutor
• TransactionBuilder
• TransactionTypeParser
• Web3ContextConstructor
• Web3ContextFactory
• Web3ContextInitOptions
• Web3ContextObject
• Web3EventCallback
• Web3EventKey
• Web3EventMap
• Web3SubscriptionConstructor

Variables

• DEFAULT_BATCH_REQUEST_TIMEOUT

References

inputAddressFormatter

Re-exports inputAddressFormatter

inputBlockNumberFormatter

Re-exports inputBlockNumberFormatter

inputCallFormatter

Re-exports inputCallFormatter

inputDefaultBlockNumberFormatter

Re-exports inputDefaultBlockNumberFormatter

inputLogFormatter

Re-exports inputLogFormatter

inputPostFormatter

Re-exports inputPostFormatter

inputSignFormatter

Re-exports inputSignFormatter

inputStorageKeysFormatter

Re-exports inputStorageKeysFormatter

inputTopicFormatter

Re-exports inputTopicFormatter

inputTransactionFormatter

Re-exports inputTransactionFormatter

outputBigIntegerFormatter

Re-exports outputBigIntegerFormatter

outputBlockFormatter

Re-exports outputBlockFormatter

outputLogFormatter

Re-exports outputLogFormatter

outputPostFormatter

Re-exports outputPostFormatter

outputProofFormatter

Re-exports outputProofFormatter

outputSyncingFormatter

Re-exports outputSyncingFormatter

outputTransactionFormatter

Re-exports outputTransactionFormatter

outputTransactionReceiptFormatter

Re-exports outputTransactionReceiptFormatter

txInputOptionsFormatter

Re-exports txInputOptionsFormatter

Type Aliases

CustomTransactionSchema

CustomTransactionSchema: { properties: Record<string, Schema>; type: string }

Type declaration

• properties: Record<string, Schema>

• type: string

PromiseExecutor

PromiseExecutor<T>: (resolve: (data: T) => void, reject: (reason: unknown) => void) => void

Type parameters

• T

Type declaration

• • (resolve: (data: T) => void, reject: (reason: unknown) => void): void

  • Parameters

    • resolve: (data: T) => void

    • reject: (reason: unknown) => void

    Returns void

TransactionBuilder

TransactionBuilder<API>: <ReturnType>(options: { fillGasPrice?: boolean; privateKey?: HexString | Uint8Array; transaction: Transaction; web3Context: Web3Context<API> }) => Promise<ReturnType>

Type parameters

• API: Web3APISpec = unknown

Type declaration

• • <ReturnType>(options: { fillGasPrice?: boolean; privateKey?: HexString | Uint8Array; transaction: Transaction; web3Context: Web3Context<API> }): Promise<ReturnType>

  • Type parameters

    • ReturnType = Transaction

    Parameters

    • options: { fillGasPrice?: boolean; privateKey?: HexString | Uint8Array; transaction: Transaction; web3Context: Web3Context<API> }

    • optionalfillGasPrice: boolean

    • optionalprivateKey: HexString | Uint8Array

    • transaction: Transaction

    • web3Context: Web3Context<API>

    Returns Promise<ReturnType>

TransactionTypeParser

TransactionTypeParser: (transaction: Transaction) => HexString | undefined

Type declaration

• • (transaction: Transaction): HexString | undefined

  • Parameters

    • transaction: Transaction

    Returns HexString | undefined

Web3ContextConstructor

Web3ContextConstructor<T, T2>: new (...args: [extras: T2, context: Web3ContextObject]) => T

Type parameters

• T: Web3Context
• T2: unknown[]

Type declaration

• • new (...args: [extras: T2, context: Web3ContextObject]): T

  • Parameters

    • rest...args: [extras: T2, context: Web3ContextObject]

    Returns T

Web3ContextFactory

Web3ContextFactory<T, T2>: Web3ContextConstructor<T, T2> & { fromContextObject: any }

Type parameters

• T: Web3Context
• T2: unknown[]

Web3ContextInitOptions

Web3ContextInitOptions<API, RegisteredSubs>: { accountProvider?: Web3AccountProvider<Web3BaseWalletAccount>; config?: Partial<Web3ConfigOptions>; provider?: SupportedProviders<API> | string; registeredSubscriptions?: RegisteredSubs; requestManager?: Web3RequestManager<API>; requestManagerMiddleware?: RequestManagerMiddleware<API>; subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>; wallet?: Web3BaseWallet<Web3BaseWalletAccount> }

Type parameters

• API: Web3APISpec = unknown
• RegisteredSubs: {} = any

Type declaration

• optionalaccountProvider?: Web3AccountProvider<Web3BaseWalletAccount>

• optionalconfig?: Partial<Web3ConfigOptions>

• optionalprovider?: SupportedProviders<API> | string

• optionalregisteredSubscriptions?: RegisteredSubs

• optionalrequestManager?: Web3RequestManager<API>

• optionalrequestManagerMiddleware?: RequestManagerMiddleware<API>

• optionalsubscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>

• optionalwallet?: Web3BaseWallet<Web3BaseWalletAccount>

Web3ContextObject

Web3ContextObject<API, RegisteredSubs>: { accountProvider?: Web3AccountProvider<Web3BaseWalletAccount>; config: Web3ConfigOptions; provider?: SupportedProviders<API> | string; providers: typeof Web3RequestManager.providers; registeredSubscriptions?: RegisteredSubs; requestManager: Web3RequestManager<API>; subscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>; wallet?: Web3BaseWallet<Web3BaseWalletAccount> }

Type parameters

• API: Web3APISpec = unknown
• RegisteredSubs: {} = any

Type declaration

• optionalaccountProvider?: Web3AccountProvider<Web3BaseWalletAccount>

• config: Web3ConfigOptions

• optionalprovider?: SupportedProviders<API> | string

• providers: typeof Web3RequestManager.providers

• optionalregisteredSubscriptions?: RegisteredSubs

• requestManager: Web3RequestManager<API>

• optionalsubscriptionManager?: Web3SubscriptionManager<API, RegisteredSubs>

• optionalwallet?: Web3BaseWallet<Web3BaseWalletAccount>

Web3EventCallback

Web3EventCallback<T>: (params: T) => void | Promise<void>

Type parameters

• T

Type declaration

• • (params: T): void | Promise<void>

  • Parameters

    • params: T

    Returns void | Promise<void>

Web3EventKey

Web3EventKey<T>: string & keyof T

Type parameters

• T: Web3EventMap

Web3EventMap

Web3EventMap: Record<string, unknown>

Web3SubscriptionConstructor

Web3SubscriptionConstructor<API, SubscriptionType>: new (args: any, options: { returnFormat?: DataFormat; subscriptionManager: Web3SubscriptionManager<API> } | { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }) => SubscriptionType | new (args: any, options: { returnFormat?: DataFormat; subscriptionManager: Web3SubscriptionManager<API> }) => SubscriptionType | new (args: any, options: { requestManager: Web3RequestManager<API>; returnFormat?: DataFormat }) => SubscriptionType

Type parameters

• API: Web3APISpec
• SubscriptionType: Web3Subscription<any, any, API> = Web3Subscription<any, any, API>

Variables

constDEFAULT_BATCH_REQUEST_TIMEOUT

DEFAULT_BATCH_REQUEST_TIMEOUT: 1000 = 1000