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

Type Aliases

AbiBaseFragment: { type: string | FragmentTypes }

Type declaration

• readonlytype: string | FragmentTypes

AbiConstructorFragment: AbiBaseFragment & { inputs?: ReadonlyArray<AbiParameter>; stateMutability: string | nonpayable | payable; type: string | constructor }

AbiErrorFragment: AbiBaseFragment & { inputs?: ReadonlyArray<AbiParameter>; name: string; type: string | error }

AbiEventFragment: AbiBaseFragment & { anonymous?: boolean; inputs?: ReadonlyArray<AbiParameter>; name: string; type: string | event }

AbiFallbackFragment: AbiBaseFragment & { constant?: boolean; inputs: never; name: never; outputs: never; payable?: boolean; stateMutability: string | nonpayable | payable | pure | view; type: string | fallback }

AbiFunctionFragment: AbiBaseFragment & { constant?: boolean; inputs?: ReadonlyArray<AbiParameter>; methodNameWithInputs?: string; name: string; outputs?: ReadonlyArray<AbiParameter>; payable?: boolean; signature?: string; stateMutability?: string | nonpayable | payable | pure | view; type: string | function }

AbiInput: string | AbiParameter | { components?: Components; index?: boolean; internalType?: string; name: string; type: string } | {}

AbiParameter: { arrayChildren?: ReadonlyArray<AbiParameter>; arrayLength?: number; baseType?: string; components?: ReadonlyArray<AbiParameter>; indexed?: boolean; internalType?: string; name: string; type: string }

Type declaration

• optionalreadonlyarrayChildren?: ReadonlyArray<AbiParameter>

• optionalreadonlyarrayLength?: number

• optionalreadonlybaseType?: string

• optionalreadonlycomponents?: ReadonlyArray<AbiParameter>

• optionalreadonlyindexed?: boolean

• optionalreadonlyinternalType?: string

• readonlyname: string

• readonlytype: string

Type declaration

• optionalreadonlyaccessList?: AccessList

• optionalreadonlygasUsed?: Numbers

Type parameters

• T: ReadonlyArray<unknown>

ByteTypes: { BYTES_HEX: HexString; BYTES_UINT8ARRAY: Uint8Array }

Type declaration

• BYTES_HEX: HexString

• BYTES_UINT8ARRAY: Uint8Array

Cipher: aes-128-ctr | aes-128-cbc | aes-256-cbc

CipherOptions: { c?: number; dklen?: number; iv?: Uint8Array | string; kdf?: scrypt | pbkdf2; n?: number; p?: number; r?: number; salt?: Uint8Array | string }

Type declaration

• optionalc?: number

• optionaldklen?: number

• optionaliv?: Uint8Array | string

• optionalkdf?: scrypt | pbkdf2

• optionaln?: number

• optionalp?: number

• optionalr?: number

• optionalsalt?: Uint8Array | string

Components: { components?: Components[]; indexed?: boolean; name: string; type: string }

Type declaration

• optionalcomponents?: Components[]

• optionalindexed?: boolean

• name: string

• type: string

ConnectionEvent: { code: number; reason: string; wasClean?: boolean }

Type declaration

• code: number

• reason: string

• optionalwasClean?: boolean

Type parameters

• Params: ReadonlyArray<unknown> | undefined

ContractMethodOutputParameters<Params>: Params extends readonly [] ? void : Params extends readonly [infer

H, ...infer

R] ? R extends readonly [] ? H extends AbiParameter ? MatchPrimitiveType<H[type], H[components]> : [] : ArrToObjectWithFunctions<[...ContractMethodOutputParametersRecursiveArray<Params>]> & ContractMethodOutputParametersRecursiveRecord<Params> : []

Type parameters

• Params: ReadonlyArray<unknown> | undefined

ConvertToNumber<T, Range>: Range extends unknown ? `${Range}` extends T ? Range : never : never

Type parameters

• T: string
• Range: number = _SolidityIndexRange

Eip1193Compatible<API>: Omit<Omit<Web3BaseProvider, request>, asEIP1193Provider> & { request: any }

Eip1193EventName: connect | disconnect | message | chainChanged | accountsChanged

EthExecutionAPI: { eth_accounts: () => Address[]; eth_blockNumber: () => Uint; eth_call: (transaction: TransactionCallAPI, blockNumber: BlockNumberOrTag) => HexStringBytes; eth_clearSubscriptions: (keepSyncing?: boolean) => void; eth_coinbase: () => Address; eth_compileLLL: (code: string) => HexStringBytes; eth_compileSerpent: (code: string) => HexStringBytes; eth_compileSolidity: (code: string) => CompileResultAPI; eth_estimateGas: (transaction: Partial<TransactionWithSenderAPI>, blockNumber: BlockNumberOrTag) => Uint; eth_feeHistory: (blockCount: Uint, newestBlock: BlockNumberOrTag, rewardPercentiles: number[]) => FeeHistoryResultAPI; eth_gasPrice: () => Uint; eth_getBalance: (address: Address, blockNumber: BlockNumberOrTag) => Uint; eth_getBlockByHash: (blockHash: HexString32Bytes, hydrated: boolean) => BlockAPI; eth_getBlockByNumber: (blockNumber: BlockNumberOrTag, hydrated: boolean) => BlockAPI; eth_getBlockTransactionCountByHash: (blockHash: HexString32Bytes) => Uint; eth_getBlockTransactionCountByNumber: (blockNumber: BlockNumberOrTag) => Uint; eth_getCode: (address: Address, blockNumber: BlockNumberOrTag) => HexStringBytes; eth_getCompilers: () => string[]; eth_getFilterChanges: (filterIdentifier: Uint) => FilterResultsAPI; eth_getFilterLogs: (filterIdentifier: Uint) => FilterResultsAPI; eth_getLogs: (filter: Filter) => FilterResultsAPI; eth_getStorageAt: (address: Address, storageSlot: Uint256, blockNumber: BlockNumberOrTag) => HexStringBytes; eth_getTransactionByBlockHashAndIndex: (blockHash: HexString32Bytes, transactionIndex: Uint) => TransactionInfoAPI | undefined; eth_getTransactionByBlockNumberAndIndex: (blockNumber: BlockNumberOrTag, transactionIndex: Uint) => TransactionInfoAPI | undefined; eth_getTransactionByHash: (transactionHash: HexString32Bytes) => TransactionInfoAPI | undefined; eth_getTransactionCount: (address: Address, blockNumber: BlockNumberOrTag) => Uint; eth_getTransactionReceipt: (transactionHash: HexString32Bytes) => TransactionReceiptAPI | undefined; eth_getUncleByBlockHashAndIndex: (blockHash: HexString32Bytes, uncleIndex: Uint) => BlockAPI; eth_getUncleByBlockNumberAndIndex: (blockNumber: BlockNumberOrTag, uncleIndex: Uint) => BlockAPI; eth_getUncleCountByBlockHash: (blockHash: HexString32Bytes) => Uint; eth_getUncleCountByBlockNumber: (blockNumber: BlockNumberOrTag) => Uint; eth_getWork: () => [HexString32Bytes, HexString32Bytes, HexString32Bytes]; eth_hashrate: () => Uint; eth_maxPriorityFeePerGas: () => Uint; eth_mining: () => boolean; eth_newBlockFilter: () => Uint; eth_newFilter: (filter: Filter) => Uint; eth_newPendingTransactionFilter: () => Uint; eth_protocolVersion: () => string; eth_sendRawTransaction: (transaction: HexStringBytes) => HexString32Bytes; eth_sendTransaction: (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>) => HexString32Bytes; eth_sign: (address: Address, message: HexStringBytes) => HexString256Bytes; eth_signTransaction: (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>) => HexStringBytes | SignedTransactionInfoAPI; eth_submitHashrate: (hashRate: HexString32Bytes, id: HexString32Bytes) => boolean; eth_submitWork: (nonce: HexString8Bytes, hash: HexString32Bytes, digest: HexString32Bytes) => boolean; eth_subscribe: (...params: [newHeads] | [newPendingTransactions] | [syncing] | [logs, { address?: HexString; topics?: HexString[] }]) => HexString; eth_syncing: () => SyncingStatusAPI; eth_uninstallFilter: (filterIdentifier: Uint) => boolean; eth_unsubscribe: (subscriptionId: HexString) => HexString }

Type declaration

• eth_accounts: () => Address[]

  • • (): Address[]

      • Returns Address[]

• eth_blockNumber: () => Uint

  • • (): Uint

      • Returns Uint

• eth_call: (transaction: TransactionCallAPI, blockNumber: BlockNumberOrTag) => HexStringBytes

  • • (transaction: TransactionCallAPI, blockNumber: BlockNumberOrTag): HexStringBytes

      • Parameters

           * ##### transaction: [TransactionCallAPI](/api/web3-types/interface/TransactionCallAPI)  
           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns HexStringBytes

• eth_clearSubscriptions: (keepSyncing?: boolean) => void

  • • (keepSyncing?: boolean): void

      • Parameters

           * ##### optionalkeepSyncing: boolean

      Returns void

• eth_coinbase: () => Address

  • • (): Address

      • Returns Address

• eth_compileLLL: (code: string) => HexStringBytes

  • • (code: string): HexStringBytes

      • Parameters

           * ##### code: string

      Returns HexStringBytes

• eth_compileSerpent: (code: string) => HexStringBytes

  • • (code: string): HexStringBytes

      • Parameters

           * ##### code: string

      Returns HexStringBytes

• eth_compileSolidity: (code: string) => CompileResultAPI

  • • (code: string): CompileResultAPI

      • Parameters

           * ##### code: string

      Returns CompileResultAPI

• eth_estimateGas: (transaction: Partial<TransactionWithSenderAPI>, blockNumber: BlockNumberOrTag) => Uint

  • • (transaction: Partial<TransactionWithSenderAPI>, blockNumber: BlockNumberOrTag): Uint

      • Parameters

           * ##### transaction: Partial<[TransactionWithSenderAPI](/api/web3-types#TransactionWithSenderAPI)\>  
           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns Uint

• eth_feeHistory: (blockCount: Uint, newestBlock: BlockNumberOrTag, rewardPercentiles: number[]) => FeeHistoryResultAPI

  • • (blockCount: Uint, newestBlock: BlockNumberOrTag, rewardPercentiles: number[]): FeeHistoryResultAPI

      • Parameters

           * ##### blockCount: [Uint](/api/web3-types#Uint)  
           * ##### newestBlock: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)  
           * ##### rewardPercentiles: number\[\]

      Returns FeeHistoryResultAPI

• eth_gasPrice: () => Uint

  • • (): Uint

      • Returns Uint

• eth_getBalance: (address: Address, blockNumber: BlockNumberOrTag) => Uint

  • • (address: Address, blockNumber: BlockNumberOrTag): Uint

      • Parameters

           * ##### address: [Address](/api/web3-types#Address)  
           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns Uint

• eth_getBlockByHash: (blockHash: HexString32Bytes, hydrated: boolean) => BlockAPI

  • • (blockHash: HexString32Bytes, hydrated: boolean): BlockAPI

      • Parameters

           * ##### blockHash: [HexString32Bytes](/api/web3-types#HexString32Bytes)  
           * ##### hydrated: boolean

      Returns BlockAPI

• eth_getBlockByNumber: (blockNumber: BlockNumberOrTag, hydrated: boolean) => BlockAPI

  • • (blockNumber: BlockNumberOrTag, hydrated: boolean): BlockAPI

      • Parameters

           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)  
           * ##### hydrated: boolean

      Returns BlockAPI

• eth_getBlockTransactionCountByHash: (blockHash: HexString32Bytes) => Uint

  • • (blockHash: HexString32Bytes): Uint

      • Parameters

           * ##### blockHash: [HexString32Bytes](/api/web3-types#HexString32Bytes)

      Returns Uint

• eth_getBlockTransactionCountByNumber: (blockNumber: BlockNumberOrTag) => Uint

  • • (blockNumber: BlockNumberOrTag): Uint

      • Parameters

           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns Uint

• eth_getCode: (address: Address, blockNumber: BlockNumberOrTag) => HexStringBytes

  • • (address: Address, blockNumber: BlockNumberOrTag): HexStringBytes

      • Parameters

           * ##### address: [Address](/api/web3-types#Address)  
           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns HexStringBytes

• eth_getCompilers: () => string[]

  • • (): string[]

      • Returns string[]

• eth_getFilterChanges: (filterIdentifier: Uint) => FilterResultsAPI

  • • (filterIdentifier: Uint): FilterResultsAPI

      • Parameters

           * ##### filterIdentifier: [Uint](/api/web3-types#Uint)

      Returns FilterResultsAPI

• eth_getFilterLogs: (filterIdentifier: Uint) => FilterResultsAPI

  • • (filterIdentifier: Uint): FilterResultsAPI

      • Parameters

           * ##### filterIdentifier: [Uint](/api/web3-types#Uint)

      Returns FilterResultsAPI

• eth_getLogs: (filter: Filter) => FilterResultsAPI

  • • (filter: Filter): FilterResultsAPI

      • Parameters

           * ##### filter: [Filter](/api/web3-types/interface/Filter)

      Returns FilterResultsAPI

• eth_getStorageAt: (address: Address, storageSlot: Uint256, blockNumber: BlockNumberOrTag) => HexStringBytes

  • • (address: Address, storageSlot: Uint256, blockNumber: BlockNumberOrTag): HexStringBytes

      • Parameters

           * ##### address: [Address](/api/web3-types#Address)  
           * ##### storageSlot: [Uint256](/api/web3-types#Uint256)  
           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns HexStringBytes

• eth_getTransactionByBlockHashAndIndex: (blockHash: HexString32Bytes, transactionIndex: Uint) => TransactionInfoAPI | undefined

  • • (blockHash: HexString32Bytes, transactionIndex: Uint): TransactionInfoAPI | undefined

      • Parameters

           * ##### blockHash: [HexString32Bytes](/api/web3-types#HexString32Bytes)  
           * ##### transactionIndex: [Uint](/api/web3-types#Uint)

      Returns TransactionInfoAPI | undefined

• eth_getTransactionByBlockNumberAndIndex: (blockNumber: BlockNumberOrTag, transactionIndex: Uint) => TransactionInfoAPI | undefined

  • • (blockNumber: BlockNumberOrTag, transactionIndex: Uint): TransactionInfoAPI | undefined

      • Parameters

           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)  
           * ##### transactionIndex: [Uint](/api/web3-types#Uint)

      Returns TransactionInfoAPI | undefined

• eth_getTransactionByHash: (transactionHash: HexString32Bytes) => TransactionInfoAPI | undefined

  • • (transactionHash: HexString32Bytes): TransactionInfoAPI | undefined

      • Parameters

           * ##### transactionHash: [HexString32Bytes](/api/web3-types#HexString32Bytes)

      Returns TransactionInfoAPI | undefined

• eth_getTransactionCount: (address: Address, blockNumber: BlockNumberOrTag) => Uint

  • • (address: Address, blockNumber: BlockNumberOrTag): Uint

      • Parameters

           * ##### address: [Address](/api/web3-types#Address)  
           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns Uint

• eth_getTransactionReceipt: (transactionHash: HexString32Bytes) => TransactionReceiptAPI | undefined

  • • (transactionHash: HexString32Bytes): TransactionReceiptAPI | undefined

      • Parameters

           * ##### transactionHash: [HexString32Bytes](/api/web3-types#HexString32Bytes)

      Returns TransactionReceiptAPI | undefined

• eth_getUncleByBlockHashAndIndex: (blockHash: HexString32Bytes, uncleIndex: Uint) => BlockAPI

  • • (blockHash: HexString32Bytes, uncleIndex: Uint): BlockAPI

      • Parameters

           * ##### blockHash: [HexString32Bytes](/api/web3-types#HexString32Bytes)  
           * ##### uncleIndex: [Uint](/api/web3-types#Uint)

      Returns BlockAPI

• eth_getUncleByBlockNumberAndIndex: (blockNumber: BlockNumberOrTag, uncleIndex: Uint) => BlockAPI

  • • (blockNumber: BlockNumberOrTag, uncleIndex: Uint): BlockAPI

      • Parameters

           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)  
           * ##### uncleIndex: [Uint](/api/web3-types#Uint)

      Returns BlockAPI

• eth_getUncleCountByBlockHash: (blockHash: HexString32Bytes) => Uint

  • • (blockHash: HexString32Bytes): Uint

      • Parameters

           * ##### blockHash: [HexString32Bytes](/api/web3-types#HexString32Bytes)

      Returns Uint

• eth_getUncleCountByBlockNumber: (blockNumber: BlockNumberOrTag) => Uint

  • • (blockNumber: BlockNumberOrTag): Uint

      • Parameters

           * ##### blockNumber: [BlockNumberOrTag](/api/web3-types#BlockNumberOrTag)

      Returns Uint

• eth_getWork: () => [HexString32Bytes, HexString32Bytes, HexString32Bytes]

  • • (): [HexString32Bytes, HexString32Bytes, HexString32Bytes]

      • Returns [HexString32Bytes, HexString32Bytes, HexString32Bytes]

• eth_hashrate: () => Uint

  • • (): Uint

      • Returns Uint

• eth_maxPriorityFeePerGas: () => Uint

  • • (): Uint

      • Returns Uint

• eth_mining: () => boolean

  • • (): boolean

      • Returns boolean

• eth_newBlockFilter: () => Uint

  • • (): Uint

      • Returns Uint

• eth_newFilter: (filter: Filter) => Uint

  • • (filter: Filter): Uint

      • Parameters

           * ##### filter: [Filter](/api/web3-types/interface/Filter)

      Returns Uint

• eth_newPendingTransactionFilter: () => Uint

  • • (): Uint

      • Returns Uint

• eth_protocolVersion: () => string

  • • (): string

      • Returns string

• eth_sendRawTransaction: (transaction: HexStringBytes) => HexString32Bytes

  • • (transaction: HexStringBytes): HexString32Bytes

      • Parameters

           * ##### transaction: [HexStringBytes](/api/web3-types#HexStringBytes)

      Returns HexString32Bytes

• eth_sendTransaction: (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>) => HexString32Bytes

  • • (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>): HexString32Bytes

      • Parameters

           * ##### transaction: [TransactionWithSenderAPI](/api/web3-types#TransactionWithSenderAPI) | Partial<[TransactionWithSenderAPI](/api/web3-types#TransactionWithSenderAPI)\>

      Returns HexString32Bytes

• eth_sign: (address: Address, message: HexStringBytes) => HexString256Bytes

  • • (address: Address, message: HexStringBytes): HexString256Bytes

      • Parameters

           * ##### address: [Address](/api/web3-types#Address)  
           * ##### message: [HexStringBytes](/api/web3-types#HexStringBytes)

      Returns HexString256Bytes

• eth_signTransaction: (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>) => HexStringBytes | SignedTransactionInfoAPI

  • • (transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>): HexStringBytes | SignedTransactionInfoAPI

      • Parameters

           * ##### transaction: [TransactionWithSenderAPI](/api/web3-types#TransactionWithSenderAPI) | Partial<[TransactionWithSenderAPI](/api/web3-types#TransactionWithSenderAPI)\>

      Returns HexStringBytes | SignedTransactionInfoAPI

• eth_submitHashrate: (hashRate: HexString32Bytes, id: HexString32Bytes) => boolean

  • • (hashRate: HexString32Bytes, id: HexString32Bytes): boolean

      • Parameters

           * ##### hashRate: [HexString32Bytes](/api/web3-types#HexString32Bytes)  
           * ##### id: [HexString32Bytes](/api/web3-types#HexString32Bytes)

      Returns boolean

• eth_submitWork: (nonce: HexString8Bytes, hash: HexString32Bytes, digest: HexString32Bytes) => boolean

  • • (nonce: HexString8Bytes, hash: HexString32Bytes, digest: HexString32Bytes): boolean

      • Parameters

           * ##### nonce: [HexString8Bytes](/api/web3-types#HexString8Bytes)  
           * ##### hash: [HexString32Bytes](/api/web3-types#HexString32Bytes)  
           * ##### digest: [HexString32Bytes](/api/web3-types#HexString32Bytes)

      Returns boolean

• eth_subscribe: (...params: [newHeads] | [newPendingTransactions] | [syncing] | [logs, { address?: HexString; topics?: HexString[] }]) => HexString

  • • (...params: [newHeads] | [newPendingTransactions] | [syncing] | [logs, { address?: HexString; topics?: HexString[] }]): HexString

      • Parameters

           * ##### rest...params: \[newHeads\] | \[newPendingTransactions\] | \[syncing\] | \[logs, { address?: [HexString](/api/web3-types#HexString); topics?: [HexString](/api/web3-types#HexString)\[\] }\]

      Returns HexString

• eth_syncing: () => SyncingStatusAPI

  • • (): SyncingStatusAPI

      • Returns SyncingStatusAPI

• eth_uninstallFilter: (filterIdentifier: Uint) => boolean

  • • (filterIdentifier: Uint): boolean

      • Parameters

           * ##### filterIdentifier: [Uint](/api/web3-types#Uint)

      Returns boolean

• eth_unsubscribe: (subscriptionId: HexString) => HexString

  • • (subscriptionId: HexString): HexString

      • Parameters

           * ##### subscriptionId: [HexString](/api/web3-types#HexString)

      Returns HexString

EthPersonalAPI: { personal_ecRecover: (signedData: HexString, signature: HexString) => Address; personal_importRawKey: (keyData: HexString, passphrase: string) => HexString; personal_listAccounts: () => Address[]; personal_lockAccount: (address: Address) => boolean; personal_newAccount: (password: string) => Address; personal_sendTransaction: (tx: Transaction, passphrase: string) => HexString; personal_sign: (data: HexString, address: Address, passphrase: string) => HexString; personal_signTransaction: (tx: Transaction, passphrase: string) => HexString; personal_unlockAccount: (address: Address, password: string, unlockDuration: number) => boolean }

Type declaration

• personal_ecRecover: (signedData: HexString, signature: HexString) => Address

  • • (signedData: HexString, signature: HexString): Address

      • Parameters

           * ##### signedData: [HexString](/api/web3-types#HexString)  
           * ##### signature: [HexString](/api/web3-types#HexString)

      Returns Address

• personal_importRawKey: (keyData: HexString, passphrase: string) => HexString

  • • (keyData: HexString, passphrase: string): HexString

      • Parameters

           * ##### keyData: [HexString](/api/web3-types#HexString)  
           * ##### passphrase: string

      Returns HexString

• personal_listAccounts: () => Address[]

  • • (): Address[]

      • Returns Address[]

• personal_lockAccount: (address: Address) => boolean

  • • (address: Address): boolean

      • Parameters

           * ##### address: [Address](/api/web3-types#Address)

      Returns boolean

• personal_newAccount: (password: string) => Address

  • • (password: string): Address

      • Parameters

           * ##### password: string

      Returns Address

• personal_sendTransaction: (tx: Transaction, passphrase: string) => HexString

  • • (tx: Transaction, passphrase: string): HexString

      • Parameters

           * ##### tx: [Transaction](/api/web3-types/interface/Transaction)  
           * ##### passphrase: string

      Returns HexString

• personal_sign: (data: HexString, address: Address, passphrase: string) => HexString

  • • (data: HexString, address: Address, passphrase: string): HexString

      • Parameters

           * ##### data: [HexString](/api/web3-types#HexString)  
           * ##### address: [Address](/api/web3-types#Address)  
           * ##### passphrase: string

      Returns HexString

• personal_signTransaction: (tx: Transaction, passphrase: string) => HexString

  • • (tx: Transaction, passphrase: string): HexString

      • Parameters

           * ##### tx: [Transaction](/api/web3-types/interface/Transaction)  
           * ##### passphrase: string

      Returns HexString

• personal_unlockAccount: (address: Address, password: string, unlockDuration: number) => boolean

  • • (address: Address, password: string, unlockDuration: number): boolean

      • Parameters

           * ##### address: [Address](/api/web3-types#Address)  
           * ##### password: string  
           * ##### unlockDuration: number

      Returns boolean

FilterAbis<Abis, Filter, Abi>: Abi extends Filter ? Abi : never

Type parameters

• Abis: ContractAbi
• Filter
• Abi = Abis[number]

FilterParams: Omit<Filter, blockHash | filter>

FixedSizeArray<T, N>: GrowToSize<T, [], N>

Type parameters

• T
• N: number

FormatType<T, F>: number extends Extract<T, Numbers> ? NumberTypes[F[number]] | Exclude<T, Numbers> : Uint8Array extends Extract<T, Bytes> ? ByteTypes[F[bytes]] | Exclude<T, Bytes> : T extends object | undefined ? { [ P in keyof T ]: FormatType<T[P], F> } : T

GrowToSize<T, A, N>: { 0: A; 1: GrowToSize<T, _Grow<T, A>, N> }[A[length] extends N ? 0 : 1]

Type parameters

• T
• A: T[]
• N: number

IndexKeysForArray<A>: Exclude<keyof A, keyof []>

Type parameters

• A: readonly unknown[]

JsonEventInterface: { anonymous: boolean; indexed: boolean; inputs: Components[]; name: string; type: event }

Type declaration

• anonymous: boolean

• indexed: boolean

• inputs: Components[]

• name: string

• type: event

JsonFunctionInterface: { inputs: Components[]; name: string; outputs?: AbiInput[]; stateMutability?: string; type: function }

Type declaration

• inputs: Components[]

• name: string

• optionaloutputs?: AbiInput[]

• optionalstateMutability?: string

• type: function

JsonRpcId: string | number | undefined

JsonRpcIdentifier: string & (2.0 | 1.0)

Type parameters

• Param = unknown[]

JsonRpcResult: string | number | boolean | Record<string, unknown>

KeyStore: { address: string; crypto: { cipher: Cipher; cipherparams: { iv: string }; ciphertext: string; kdf: pbkdf2 | scrypt; kdfparams: ScryptParams | PBKDF2SHA256Params; mac: HexString }; id: string; version: 3 }

Type declaration

• address: string

• crypto: { cipher: Cipher; cipherparams: { iv: string }; ciphertext: string; kdf: pbkdf2 | scrypt; kdfparams: ScryptParams | PBKDF2SHA256Params; mac: HexString }

  • cipher: Cipher

  • cipherparams: { iv: string }

    * ##### iv: string  

  • ciphertext: string

  • kdf: pbkdf2 | scrypt

  • kdfparams: ScryptParams | PBKDF2SHA256Params

  • mac: HexString

• id: string

• version: 3

Type parameters

• Type: string
• TypeComponents: ReadonlyArray<AbiParameter> | undefined | unknown

Mutable<T>: { -readonly [ P in keyof T ]: T[P] }

Type parameters

• T

NumberTypes: { NUMBER_BIGINT: bigint; NUMBER_HEX: HexString; NUMBER_NUMBER: number; NUMBER_STR: string }

Type declaration

• NUMBER_BIGINT: bigint

• NUMBER_HEX: HexString

• NUMBER_NUMBER: number

• NUMBER_STR: string

Numbers: number | bigint | string | HexString

Optional<T, K>: Pick<Partial<T>, K> & Omit<T, K>

Type parameters

• T
• K: keyof T

PBKDF2SHA256Params: { c: number; dklen: number; prf: hmac-sha256; salt: Uint8Array | string }

Type declaration

• c: number

• dklen: number

• prf: hmac-sha256

• salt: Uint8Array | string

PrimitiveAddressType<Type>: Type extends `address[${infer

Size}]` ? _TypedArray<Address, Size> : Type extends address ? Address : never

Type parameters

• Type: string

PrimitiveBooleanType<Type>: Type extends `bool[${infer

Size}]` ? _TypedArray<boolean, Size> : Type extends bool ? boolean : never

Type parameters

• Type: string

PrimitiveBytesType<Type>: Type extends `bytes${string}[${infer

Size}]` ? _TypedArray<Bytes, Size> : Type extends bytes | `bytes${string}` ? Bytes : never

Type parameters

• Type: string

PrimitiveIntegerType<Type>: Type extends `uint${string}[${infer

Size}]` | `int${string}[${infer

Size}]` ? _TypedArray<Numbers, Size> : Type extends uint | int | `int${string}` | `uint${string}` ? Numbers : never

Type parameters

• Type: string

PrimitiveStringType<Type>: Type extends `string${string}[${infer

Size}]` ? _TypedArray<string, Size> : Type extends string | `string${string}` ? string : never

Type parameters

• Type: string

PrimitiveTupleType<Type, TypeComponents>: TypeComponents extends ReadonlyArray<AbiParameter> ? Type extends tuple ? { [ Param in TypeComponents[number] as Param[name] ]: MatchPrimitiveType<Param[type], Param[components]> } : Type extends `tuple[${infer

Size}]` ? _TypedArray<{ [ Param in TypeComponents[number] as Param[name] ]: MatchPrimitiveType<Param[type], Param[components]> }, Size> : never : never

Type parameters

• Type: string
• TypeComponents: ReadonlyArray<AbiParameter> | undefined | unknown = []

ProviderAccounts: string[]

Receipt: Record<string, unknown>

ScryptParams: { dklen: number; n: number; p: number; r: number; salt: Uint8Array | string }

Type declaration

• dklen: number

• n: number

• p: number

• r: number

• salt: Uint8Array | string

SignResult: SignatureObject & { message?: string; signature: string }

SignTransactionResult: SignatureObject & { rawTransaction: string; transactionHash: string }

SignatureObject: { messageHash: string; r: string; s: string; v: string }

Type declaration

• messageHash: string

• r: string

• s: string

• v: string

SyncingStatusAPI: { currentBlock: Uint; highestBlock: Uint; startingBlock: Uint } | boolean

TransactionOutput: { blockNumber?: Numbers; from?: HexString; gas?: Numbers; gasLimit?: string; input: string; nonce: Numbers; to?: HexString; transactionIndex?: Numbers; value: Numbers } & ({ gasPrice?: never; maxFeePerGas: Numbers; maxPriorityFeePerGas: Numbers } | { gasPrice: Numbers; maxFeePerGas?: never; maxPriorityFeePerGas?: never })

TypedObjectAbbreviated: { t: string; v: EncodingTypes }

ValidChains: goerli | kovan | mainnet | rinkeby | ropsten | sepolia

ValueTypes: address | bool | string | int256 | uint256 | bytes | bigint

Web3APIMethod<T>: string & keyof Exclude<T, unknown>

Web3APIParams<API, Method>: API extends Exclude<Web3APISpec, unknown> ? Parameters<API[Method]> : unknown

Web3APIReturnType<API, Method>: API extends Record<string, (...params: any) => any> ? ReturnType<API[Method]> : any

Web3APISpec: Record<string, (...params: any) => any> | unknown

Web3BaseProviderConstructor: new <API>(url: string, net?: Socket) => Web3BaseProvider<API>

Type declaration

• • new <API>(url: string, net?: Socket): Web3BaseProvider<API>

  • Type parameters

    * **API**: [Web3APISpec](/api/web3-types#Web3APISpec)

  Parameters

     * ##### url: string  
     * ##### optionalnet: Socket  

  Returns Web3BaseProvider<API>

Web3Eip1193ProviderEventCallback<T>: (data: T) => void

Type parameters

• T

Type declaration

• • (data: T): void

  • Parameters

    * ##### data: T

  Returns void

Web3NetAPI: { net_listening: () => boolean; net_peerCount: () => HexString; net_version: () => string }

Type declaration

• net_listening: () => boolean

  • • (): boolean

      • Returns boolean

• net_peerCount: () => HexString

  • • (): HexString

      • Returns HexString

• net_version: () => string

  • • (): string

      • Returns string

Type declaration

• • (error: Error | ProviderRpcError | undefined, result?: JsonRpcSubscriptionResult | JsonRpcNotification<T>): void

  • Parameters

    * ##### error: Error | [ProviderRpcError](/api/web3-types/interface/ProviderRpcError) | undefined  
    * ##### optionalresult: [JsonRpcSubscriptionResult](/api/web3-types/interface/JsonRpcSubscriptionResult) | [JsonRpcNotification](/api/web3-types/interface/JsonRpcNotification)<T\>

  Returns void

Type parameters

• ResultType = unknown

Type declaration

• • (err?: Error | Web3Error | null | JsonRpcResponseWithError<Error>, response?: JsonRpcResponseWithResult<ResultType>): void

  • Parameters

    * ##### optionalerr: Error | [Web3Error](/api/web3-types/interface/Web3Error) | null | [JsonRpcResponseWithError](/api/web3-types/interface/JsonRpcResponseWithError)<Error\>  
    * ##### optionalresponse: [JsonRpcResponseWithResult](/api/web3-types/interface/JsonRpcResponseWithResult)<ResultType\>

  Returns void

Web3ProviderStatus: connecting | connected | disconnected

Web3ValidationErrorObject<K, P, S>: { data?: unknown; instancePath: string; keyword: K; message?: string; params: P; propertyName?: string; schema?: S; schemaPath: string }

Type parameters

• K: string = string
• P = Record<string, any>
• S = unknown

Type declaration

• optionaldata?: unknown

• instancePath: string

• keyword: K

• optionalmessage?: string

• params: P

• optionalpropertyName?: string

• optionalschema?: S

• schemaPath: string

Variables

DEFAULT_RETURN_FORMAT: { bytes: HEX; number: BIGINT } = ...

Type declaration

• readonlybytes: HEX

• readonlynumber: BIGINT

ETH_DATA_FORMAT: { bytes: HEX; number: HEX } = ...

Type declaration

• readonlybytes: HEX

• readonlynumber: HEX