web3-core | API | Web3.js (original) (raw)

Index

References

Type Aliases

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

Type declaration

• properties: Record<string, Schema>

• type: string

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

Type declaration

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

  • Type parameters

    * **ReturnType** \= [Transaction](/api/web3/namespace/types#Transaction)

  Parameters

     * ##### options: { fillGasPrice?: boolean; privateKey?: [HexString](/api/web3/namespace/types#HexString) | Uint8Array; transaction: [Transaction](/api/web3/namespace/types#Transaction); web3Context: [Web3Context](/api/web3-core/class/Web3Context)<API\> }  
        * ##### optionalfillGasPrice: boolean  
        * ##### optionalprivateKey: [HexString](/api/web3/namespace/types#HexString) | Uint8Array  
        * ##### transaction: [Transaction](/api/web3/namespace/types#Transaction)  
        * ##### web3Context: [Web3Context](/api/web3-core/class/Web3Context)<API\>  

  Returns Promise<ReturnType>

Type declaration

• • (transaction: Transaction): HexString | undefined

  • Parameters

    * ##### transaction: [Transaction](/api/web3/namespace/types#Transaction)

  Returns HexString | undefined

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

Type declaration

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

  • Parameters

    * ##### rest...args: \[extras: T2, context: [Web3ContextObject](/api/web3-core#Web3ContextObject)\]

  Returns T

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>

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<T>: (params: T) => void | Promise<void>

Type parameters

• T

Type declaration

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

  • Parameters

    * ##### params: T

  Returns void | Promise<void>

Web3EventKey<T>: string & keyof T

Web3EventMap: Record<string, unknown>

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

Variables

DEFAULT_BATCH_REQUEST_TIMEOUT: 1000 = 1000