web3-types
Index
Classes
Enumerations
Interfaces
- AbiCoderStruct
- AbiStruct
- AccessListEntry
- AccountObject
- BaseTransactionAPI
- BlockBase
- BlockHeaderOutput
- BlockInput
- BlockOutput
- Common
- CompileResultAPI
- CustomChain
- DecodedParams
- EIP1193Provider
- EthSubscription
- FeeHistoryBase
- Filter
- JsonRpcError
- JsonRpcNotification
- JsonRpcOptionalRequest
- JsonRpcRequest
- JsonRpcResponseWithError
- JsonRpcResponseWithResult
- JsonRpcSubscriptionResult
- LegacyRequestProvider
- LegacySendAsyncProvider
- LegacySendProvider
- Log
- LogBase
- LogsInput
- LogsOutput
- PopulatedUnsignedBaseTransaction
- PopulatedUnsignedEip1559Transaction
- PopulatedUnsignedEip2930Transaction
- PostInput
- PostOutput
- Proof
- ProviderConnectInfo
- ProviderMessage
- ProviderRpcError
- ReceiptInput
- ReceiptOutput
- SignedTransactionInfoAPI
- SocketRequestItem
- StorageProof
- SubscriptionParams
- SyncInput
- SyncOutput
- Transaction
- Transaction1559SignedAPI
- Transaction1559UnsignedAPI
- Transaction2930SignedAPI
- Transaction2930UnsignedAPI
- TransactionCall
- TransactionCallAPI
- TransactionForAccessList
- TransactionInfo
- TransactionInput
- TransactionLegacySignedAPI
- TransactionLegacyUnsignedAPI
- TransactionReceiptBase
- TransactionWithFromAndToLocalWalletIndex
- TransactionWithFromLocalWalletIndex
- TransactionWithToLocalWalletIndex
- Web3APIPayload
- Web3APIRequest
- Web3AccountProvider
- Web3BaseWalletAccount
- Web3DeferredPromiseInterface
- Web3Error
Type Aliases
- AbiBaseFragment
- AbiConstructorFragment
- AbiErrorFragment
- AbiEventFragment
- AbiFallbackFragment
- AbiFragment
- AbiFunctionFragment
- AbiInput
- AbiParameter
- AccessList
- AccessListResult
- Address
- ArrayToIndexObject
- Block
- BlockAPI
- BlockNumberOrTag
- BlockTag
- Bytes
- Cipher
- CipherOptions
- Components
- ConnectionEvent
- ContractAbi
- ContractConstructor
- ContractConstructorArgs
- ContractEvent
- ContractEvents
- ContractMethod
- ContractMethodInputParameters
- ContractMethodOutputParameters
- ContractMethods
- ConvertToNumber
- EncodingTypes
- EthExecutionAPI
- EthPersonalAPI
- FeeHistory
- FeeHistoryResultAPI
- FilterAbis
- FilterResultsAPI
- FixedSizeArray
- GrowToSize
- Hardfork
- HexString
- HexString16Bytes
- HexString256Bytes
- HexString32Bytes
- HexString8Bytes
- HexStringBytes
- HexStringSingleByte
- IndexKeysForArray
- JsonEventInterface
- JsonFunctionInterface
- JsonRpcBatchRequest
- JsonRpcBatchResponse
- JsonRpcId
- JsonRpcIdentifier
- JsonRpcPayload
- JsonRpcResponse
- JsonRpcResult
- KeyStore
- LogAPI
- MatchPrimitiveType
- Mutable
- Numbers
- Optional
- PBKDF2SHA256Params
- PopulatedUnsignedTransaction
- PrimitiveAddressType
- PrimitiveBooleanType
- PrimitiveBytesType
- PrimitiveIntegerType
- PrimitiveStringType
- PrimitiveTupleType
- Receipt
- ScryptParams
- Sha3Input
- SupportedProviders
- SyncingStatusAPI
- Topic
- TransactionHash
- TransactionInfoAPI
- TransactionOutput
- TransactionReceipt
- TransactionReceiptAPI
- TransactionSignedAPI
- TransactionUnsignedAPI
- TransactionWithSenderAPI
- TypedObject
- TypedObjectAbbreviated
- Uint
- Uint256
- Uncles
- ValidChains
- ValueTypes
- Web3APIMethod
- Web3APIParams
- Web3APIReturnType
- Web3APISpec
- Web3BaseProviderConstructor
- Web3EthExecutionAPI
- Web3NetAPI
- Web3ProviderEventCallback
- Web3ProviderRequestCallback
- Web3ProviderStatus
Variables
Type Aliases
AbiBaseFragment
Type declaration
readonlytype: string | FragmentTypes
AbiConstructorFragment
AbiErrorFragment
AbiEventFragment
AbiFallbackFragment
AbiFragment
AbiFunctionFragment
AbiInput
AbiParameter
Type declaration
optionalreadonlyarrayChildren?: ReadonlyArray<AbiParameter>
optionalreadonlyarrayLength?: number
optionalreadonlybaseType?: string
optionalreadonlycomponents?: ReadonlyArray<AbiParameter>
optionalreadonlyindexed?: boolean
readonlyname: string
readonlytype: string
AccessList
AccessListResult
Type declaration
optionalreadonlyaccessList?: AccessList
optionalreadonlygasUsed?: Numbers
Address
ArrayToIndexObject
Type parameters
- T: ReadonlyArray<unknown>
Block
BlockAPI
BlockNumberOrTag
BlockTag
Bytes
Cipher
CipherOptions
Type declaration
optionalc?: number
optionaldklen?: number
optionaliv?: Buffer | string
optionalkdf?: scrypt | pbkdf2
optionaln?: number
optionalp?: number
optionalr?: number
optionalsalt?: Buffer | string
Components
Type declaration
optionalcomponents?: Components[]
optionalindexed?: boolean
name: string
type: string
ConnectionEvent
Type declaration
code: number
reason: string
optionalwasClean?: boolean
ContractAbi
ContractConstructor
Type parameters
- Abis: ContractAbi
ContractConstructorArgs
Type parameters
- Abis: ContractAbi
ContractEvent
Type parameters
- Abi: AbiEventFragment
Type declaration
readonlyAbi: Abi
readonlyInputs: ContractMethodInputParameters<Abi[inputs]>
ContractEvents
Type parameters
- Abis: ContractAbi
ContractMethod
Type parameters
- Abi: AbiFunctionFragment
Type declaration
readonlyAbi: Abi
readonlyInputs: ContractMethodInputParameters<Abi[inputs]>
readonlyOutputs: ContractMethodOutputParameters<Abi[outputs]>
ContractMethodInputParameters
Type parameters
- Params: ReadonlyArray<unknown> | undefined
ContractMethodOutputParameters
Type parameters
- Params: ReadonlyArray<unknown> | undefined
ContractMethods
Type parameters
- Abis: ContractAbi
ConvertToNumber
Type parameters
- T: string
- Range: number = _SolidityIndexRange
EncodingTypes
EthExecutionAPI
Type declaration
eth_accounts: function
Returns string[]
eth_blockNumber: function
Returns string
eth_call: function
Parameters
transaction: TransactionCallAPI
blockNumber: BlockNumberOrTag
Returns string
eth_clearSubscriptions: function
Parameters
optionalkeepSyncing: boolean
Returns void
eth_coinbase: function
Returns string
eth_compileLLL: function
Parameters
code: string
Returns string
eth_compileSerpent: function
Parameters
code: string
Returns string
eth_compileSolidity: function
Parameters
code: string
Returns CompileResultAPI
eth_estimateGas: function
Parameters
transaction: Partial<TransactionWithSenderAPI>
blockNumber: BlockNumberOrTag
Returns string
eth_feeHistory: function
Parameters
blockCount: string
newestBlock: BlockNumberOrTag
rewardPercentiles: number[]
Returns FeeHistoryResultAPI
eth_gasPrice: function
Returns string
eth_getBalance: function
Parameters
address: string
blockNumber: BlockNumberOrTag
Returns string
eth_getBlockByHash: function
Parameters
blockHash: string
hydrated: boolean
Returns BlockAPI
eth_getBlockByNumber: function
Parameters
blockNumber: BlockNumberOrTag
hydrated: boolean
Returns BlockAPI
eth_getBlockTransactionCountByHash: function
Parameters
blockHash: string
Returns string
eth_getBlockTransactionCountByNumber: function
Parameters
blockNumber: BlockNumberOrTag
Returns string
eth_getCode: function
Parameters
address: string
blockNumber: BlockNumberOrTag
Returns string
eth_getCompilers: function
Returns string[]
eth_getFilterChanges: function
Parameters
filterIdentifier: string
Returns FilterResultsAPI
eth_getFilterLogs: function
Parameters
filterIdentifier: string
Returns FilterResultsAPI
eth_getLogs: function
Parameters
filter: Filter
Returns FilterResultsAPI
eth_getStorageAt: function
Parameters
address: string
storageSlot: string
blockNumber: BlockNumberOrTag
Returns string
eth_getTransactionByBlockHashAndIndex: function
Parameters
blockHash: string
transactionIndex: string
Returns undefined | TransactionInfoAPI
eth_getTransactionByBlockNumberAndIndex: function
Parameters
blockNumber: BlockNumberOrTag
transactionIndex: string
Returns undefined | TransactionInfoAPI
eth_getTransactionByHash: function
Parameters
transactionHash: string
Returns undefined | TransactionInfoAPI
eth_getTransactionCount: function
Parameters
address: string
blockNumber: BlockNumberOrTag
Returns string
eth_getTransactionReceipt: function
Parameters
transactionHash: string
Returns undefined | TransactionReceiptAPI
eth_getUncleByBlockHashAndIndex: function
Parameters
blockHash: string
uncleIndex: string
Returns BlockAPI
eth_getUncleByBlockNumberAndIndex: function
Parameters
blockNumber: BlockNumberOrTag
uncleIndex: string
Returns BlockAPI
eth_getUncleCountByBlockHash: function
Parameters
blockHash: string
Returns string
eth_getUncleCountByBlockNumber: function
Parameters
blockNumber: BlockNumberOrTag
Returns string
eth_getWork: function
Returns [string, string, string]
eth_hashrate: function
Returns string
eth_mining: function
Returns boolean
eth_newBlockFilter: function
Returns string
eth_newFilter: function
Parameters
filter: Filter
Returns string
eth_newPendingTransactionFilter: function
Returns string
eth_protocolVersion: function
Returns string
eth_sendRawTransaction: function
Parameters
transaction: string
Returns string
eth_sendTransaction: function
Parameters
transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>
Returns string
eth_sign: function
Parameters
address: string
message: string
Returns string
eth_signTransaction: function
Parameters
transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>
Returns string | SignedTransactionInfoAPI
eth_submitHashrate: function
Parameters
hashRate: string
id: string
Returns boolean
eth_submitWork: function
Parameters
nonce: string
hash: string
digest: string
Returns boolean
eth_subscribe: function
eth_syncing: function
Returns SyncingStatusAPI
eth_uninstallFilter: function
Parameters
filterIdentifier: string
Returns boolean
eth_unsubscribe: function
Parameters
subscriptionId: string
Returns string
EthPersonalAPI
Type declaration
personal_ecRecover: function
Parameters
signedData: string
signature: string
Returns string
personal_importRawKey: function
Parameters
keyData: string
passphrase: string
Returns string
personal_listAccounts: function
Returns string[]
personal_lockAccount: function
Parameters
address: string
Returns boolean
personal_newAccount: function
Parameters
password: string
Returns string
personal_sendTransaction: function
Parameters
tx: Transaction
passphrase: string
Returns string
personal_sign: function
Parameters
data: string
address: string
passphrase: string
Returns string
personal_signTransaction: function
Parameters
tx: Transaction
passphrase: string
Returns string
personal_unlockAccount: function
Parameters
address: string
password: string
unlockDuration: number
Returns boolean
FeeHistory
FeeHistoryResultAPI
FilterAbis
Type parameters
- Abis: ContractAbi
- Filter
- Abi = Abis[number]
FilterResultsAPI
FixedSizeArray
Type parameters
- T
- N: number
GrowToSize
Type parameters
- T
- A: T[]
- N: number
Hardfork
HexString
HexString16Bytes
HexString256Bytes
HexString32Bytes
HexString8Bytes
HexStringBytes
HexStringSingleByte
IndexKeysForArray
Type parameters
- A: readonly unknown[]
JsonEventInterface
Type declaration
anonymous: boolean
indexed: boolean
inputs: Components[]
name: string
type: event
JsonFunctionInterface
Type declaration
inputs: Components[]
name: string
optionaloutputs?: AbiInput[]
optionalstateMutability?: string
type: function
JsonRpcBatchRequest
JsonRpcBatchResponse
Type parameters
- Result = JsonRpcResult
- Error = JsonRpcResult
JsonRpcId
JsonRpcIdentifier
JsonRpcPayload
Type parameters
- Param = unknown[]
JsonRpcResponse
Type parameters
- Result = JsonRpcResult
- Error = JsonRpcResult
JsonRpcResult
KeyStore
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
LogAPI
MatchPrimitiveType
Type parameters
- Type: string
- TypeComponents: ReadonlyArray<AbiParameter> | undefined
Mutable
Type parameters
- T
Numbers
Optional
Type parameters
- T
- K: keyof T
PBKDF2SHA256Params
Type declaration
c: number
dklen: number
prf: hmac-sha256
salt: Buffer | string
PopulatedUnsignedTransaction
PrimitiveAddressType
Type parameters
- Type: string
PrimitiveBooleanType
Type parameters
- Type: string
PrimitiveBytesType
Type parameters
- Type: string
PrimitiveIntegerType
Type parameters
- Type: string
PrimitiveStringType
Type parameters
- Type: string
PrimitiveTupleType
Type parameters
- Type: string
- TypeComponents: ReadonlyArray<AbiParameter> | undefined = []
Receipt
ScryptParams
Type declaration
dklen: number
n: number
p: number
r: number
salt: Buffer | string
Sha3Input
SupportedProviders
Type parameters
- API: Web3APISpec = Web3EthExecutionAPI
SyncingStatusAPI
Topic
TransactionHash
TransactionInfoAPI
TransactionOutput
TransactionReceipt
TransactionReceiptAPI
TransactionSignedAPI
TransactionUnsignedAPI
TransactionWithSenderAPI
TypedObject
Type declaration
type: string
value: EncodingTypes
TypedObjectAbbreviated
Type declaration
t: string
v: EncodingTypes
Uint
Uint256
Uncles
ValidChains
ValueTypes
Web3APIMethod
Type parameters
- T: Web3APISpec
Web3APIParams
Type parameters
- API: Web3APISpec
- Method: Web3APIMethod<API>
Web3APIReturnType
Type parameters
- API: Web3APISpec
- Method: Web3APIMethod<API>
Web3APISpec
Web3BaseProviderConstructor
Type declaration
Type parameters
- API: Web3APISpec
Parameters
url: string
optionalnet: Socket
Returns Web3BaseProvider<API>
Web3EthExecutionAPI
Web3NetAPI
Type declaration
net_listening: function
Returns boolean
net_peerCount: function
Returns string
net_version: function
Returns string
Web3ProviderEventCallback
Type parameters
- T = JsonRpcResult
Type declaration
Parameters
error: Error | ProviderRpcError | undefined
optionalresult: JsonRpcSubscriptionResult | JsonRpcNotification<T>
Returns void
Web3ProviderRequestCallback
Type parameters
- ResultType = unknown
Type declaration
Parameters
optionalerr: Error | Web3Error | null | JsonRpcResponseWithError<Error>
optionalresponse: JsonRpcResponseWithResult<ResultType>
Returns void