types
Index
Enumerations
Classes
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
Enumerations
BlockTags
EARLIEST
FINALIZED
LATEST
PENDING
SAFE
Classes
abstractWeb3BaseProvider
Type parameters
- API: Web3APISpec = EthExecutionAPI
constructor
Type parameters
- API: unknown = EthExecutionAPI
Returns Web3BaseProvider<API>
[symbol]
Returns boolean
abstractconnect
Returns void
abstractdisconnect
Parameters
optionalcode: number
optionaldata: string
Returns void
abstractgetStatus
Returns Web3ProviderStatus
abstracton
Parameters
type: disconnect
callback: Web3ProviderEventCallback<ProviderRpcError>
Returns void
optionalabstractonce
Type parameters
- T = JsonRpcResult
Parameters
type: string
callback: Web3ProviderEventCallback<T>
Returns void
optionalabstractremoveAllListeners
Parameters
type: string
Returns void
abstractremoveListener
Parameters
type: string
callback: Web3ProviderEventCallback<JsonRpcResult>
Returns void
abstractrequest
Type parameters
- Method: string
- ResultType = unknown
Parameters
args: Web3APIPayload<API, Method>
Returns Promise<JsonRpcResponseWithResult<ResultType>>
abstractreset
Returns void
send
Type parameters
- ResultType = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
callback: (err?: null | Error, response?: JsonRpcResponse<ResultType, JsonRpcResult>) => void
Returns void
sendAsync
Type parameters
- R = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
Returns Promise<JsonRpcResponse<R, JsonRpcResult>>
abstractsupportsSubscriptions
Returns boolean
staticisWeb3Provider
Parameters
provider: unknown
Returns boolean
abstractWeb3BaseWallet
Type parameters
constructor
Type parameters
Parameters
accountProvider: Web3AccountProvider<T>
Returns Web3BaseWallet<T>
abstractadd
Parameters
account: string | T
Returns Web3BaseWallet<T>
abstractclear
Returns Web3BaseWallet<T>
abstractcreate
Parameters
numberOfAccounts: number
Returns Web3BaseWallet<T>
abstractdecrypt
Parameters
encryptedWallet: KeyStore[]
password: string
optionaloptions: Record<string, unknown>
Returns Promise<Web3BaseWallet<T>>
abstractencrypt
Parameters
password: string
optionaloptions: Record<string, unknown>
Returns Promise<KeyStore[]>
abstractget
Parameters
addressOrIndex: string | number
Returns undefined | T
abstractload
Parameters
password: string
optionalkeyName: string
Returns Promise<Web3BaseWallet<T>>
abstractremove
Parameters
addressOrIndex: string | number
Returns boolean
abstractsave
Parameters
password: string
optionalkeyName: string
Returns Promise<boolean>
Interfaces
AbiCoderStruct
optionalcomponents
optionalname
type
AbiStruct
optionalname
type
AccessListEntry
optionalreadonlyaddress
optionalreadonlystorageKeys
AccountObject
readonlyaccountProof
readonlybalance
readonlycodeHash
readonlynonce
readonlystorageHash
readonlystorageProof
BaseTransactionAPI
optionalreadonlychainId
optionalreadonlydata
readonlygas
optionalreadonlyhash
readonlyinput
readonlynonce
optionalreadonlyto
readonlytype
readonlyvalue
BlockBase
Type parameters
- ByteType
- HexStringType
- NumberType
- extraDataType
- TransactionTypes
- logsBloomType
optionalreadonlybaseFeePerGas
optionalreadonlydifficulty
readonlyextraData
readonlygasLimit
readonlygasUsed
optionalreadonlyhash
optionalreadonlylogsBloom
readonlyminer
readonlymixHash
readonlynonce
readonlynumber
readonlyparentHash
readonlyreceiptsRoot
readonlysha3Uncles
readonlysize
readonlystateRoot
readonlytimestamp
readonlytotalDifficulty
readonlytransactions
readonlytransactionsRoot
readonlyuncles
BlockHeaderOutput
optionalreadonlybaseFeePerGas
optionalreadonlydifficulty
readonlygasLimit
readonlygasUsed
optionalreadonlyminer
optionalreadonlynumber
optionalreadonlyparentHash
readonlysha3Uncles
readonlytimestamp
optionalreadonlytotalDifficulty
optionalreadonlytransactions
BlockInput
optionalreadonlybaseFeePerGas
optionalreadonlydifficulty
readonlygasLimit
readonlygasUsed
optionalreadonlyminer
optionalreadonlynumber
readonlysize
readonlytimestamp
optionalreadonlytotalDifficulty
optionalreadonlytransactions
BlockOutput
optionalreadonlybaseFeePerGas
optionalreadonlydifficulty
readonlygasLimit
readonlygasUsed
optionalreadonlyminer
optionalreadonlynumber
optionalreadonlyparentHash
readonlysize
readonlytimestamp
optionalreadonlytotalDifficulty
optionalreadonlytransactions
Common
optionalbaseChain
customChain
optionalhardfork
CompileResultAPI
readonlycode
readonlyinfo
Type declaration
readonlyabiDefinition: Record<string, unknown>[]
readonlycompilerVersion: string
readonlydeveloperDoc: { methods: Record<string, unknown> }
readonlymethods: Record<string, unknown>
readonlylanguage: string
readonlylanguageVersion: string
readonlysource: string
readonlyuserDoc: { methods: Record<string, unknown> }
readonlymethods: Record<string, unknown>
CustomChain
chainId
optionalname
networkId
DecodedParams
__length__
EIP1193Provider
Type parameters
- API: Web3APISpec
request
Type parameters
- Method: string
- ResponseType = Web3APIReturnType<API, Method>
Parameters
args: Web3APIPayload<API, Method>
Returns Promise<unknown>
EthSubscription
readonlydata
Type declaration
readonlyresult: unknown
readonlysubscription: string
readonlytype
FeeHistoryBase
Type parameters
- NumberType
readonlybaseFeePerGas
readonlygasUsedRatio
readonlyoldestBlock
readonlyreward
Filter
optionalreadonlyaddress
optionalreadonlyfromBlock
optionalreadonlytoBlock
optionalreadonlytopics
JsonRpcError
Type parameters
- T = JsonRpcResult
readonlycode
optionalreadonlydata
readonlymessage
JsonRpcNotification
Type parameters
- T = JsonRpcResult
optionalreadonlyid
readonlyjsonrpc
readonlymethod
readonlyparams
readonlyresult
JsonRpcOptionalRequest
Type parameters
- ParamType = unknown[]
optionalreadonlyid
optionalreadonlyjsonrpc
readonlymethod
optionalreadonlyparams
JsonRpcRequest
Type parameters
- T = unknown[]
readonlyid
readonlyjsonrpc
readonlymethod
optionalreadonlyparams
JsonRpcResponseWithError
Type parameters
- Error = JsonRpcResult
readonlyerror
readonlyid
readonlyjsonrpc
optionalreadonlyresult
JsonRpcResponseWithResult
Type parameters
- T = JsonRpcResult
optionalreadonlyerror
readonlyid
readonlyjsonrpc
readonlyresult
JsonRpcSubscriptionResult
readonlyid
readonlyjsonrpc
readonlymethod
readonlyparams
readonlyresult
LegacyRequestProvider
request
Type parameters
- R = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
callback: (err: undefined | Error, response: JsonRpcResponse<R, JsonRpcResult>) => void
Returns void
LegacySendAsyncProvider
sendAsync
Type parameters
- R = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
Returns Promise<JsonRpcResponse<R, JsonRpcResult>>
LegacySendProvider
send
Type parameters
- R = JsonRpcResult
- P = unknown
Parameters
payload: JsonRpcPayload<P>
callback: (err?: null | Error, response?: JsonRpcResponse<R, JsonRpcResult>) => void
Returns void
Log
optionalreadonlyaddress
optionalreadonlyblockHash
optionalreadonlyblockNumber
optionalreadonlydata
optionalreadonlyid
optionalreadonlylogIndex
optionalreadonlyremoved
optionalreadonlytopics
optionalreadonlytransactionHash
optionalreadonlytransactionIndex
LogBase
Type parameters
- NumberType
- ByteType
optionalreadonlyaddress
optionalreadonlyblockHash
optionalreadonlyblockNumber
optionalreadonlydata
optionalreadonlyid
optionalreadonlylogIndex
optionalreadonlyremoved
optionalreadonlytopics
optionalreadonlytransactionHash
optionalreadonlytransactionIndex
LogsInput
readonlyaddress
optionalreadonlyblockHash
optionalreadonlyblockNumber
readonlydata
optionalreadonlyid
optionalreadonlylogIndex
readonlytopics
optionalreadonlytransactionHash
optionalreadonlytransactionIndex
LogsOutput
readonlyaddress
optionalreadonlyblockHash
optionalreadonlyblockNumber
readonlydata
optionalreadonlyid
optionalreadonlylogIndex
readonlyremoved
readonlytopics
optionalreadonlytransactionHash
optionalreadonlytransactionIndex
PopulatedUnsignedBaseTransaction
chain
chainId
common
data
from
optionalgas
gasLimit
gasPrice
hardfork
networkId
nonce
optionalto
type
value
PopulatedUnsignedEip1559Transaction
accessList
chain
chainId
common
data
from
optionalgas
gasLimit
gasPrice
hardfork
maxFeePerGas
maxPriorityFeePerGas
networkId
nonce
optionalto
type
value
PopulatedUnsignedEip2930Transaction
accessList
chain
chainId
common
data
from
optionalgas
gasLimit
gasPrice
hardfork
networkId
nonce
optionalto
type
value
PostInput
optionalreadonlyexpiry
optionalreadonlypriority
optionalreadonlysent
optionalreadonlytopics
optionalreadonlyttl
optionalreadonlyworkProved
optionalreadonlyworkToProve
PostOutput
optionalreadonlyexpiry
optionalreadonlypriority
optionalreadonlysent
optionalreadonlytopics
optionalreadonlyttl
optionalreadonlyworkProved
optionalreadonlyworkToProve
Proof
readonlyaddress
readonlybalance
readonlynonce
ProviderConnectInfo
readonlychainId
ProviderMessage
readonlydata
readonlytype
ProviderRpcError
code
optionaldata
ReceiptInput
optionalreadonlyblockNumber
optionalreadonlycontractAddress
readonlycumulativeGasUsed
optionalreadonlyeffectiveGasPrice
readonlygasUsed
optionalreadonlylogs
optionalreadonlystatus
optionalreadonlytransactionIndex
ReceiptOutput
optionalreadonlyblockNumber
optionalreadonlycontractAddress
readonlycumulativeGasUsed
optionalreadonlyeffectiveGasPrice
readonlygasUsed
optionalreadonlylogs
readonlystatus
optionalreadonlytransactionIndex
SignedTransactionInfoAPI
raw
tx
SocketRequestItem
Type parameters
- API: Web3APISpec
- Method: Web3APIMethod<API>
- ResponseType
deferredPromise
payload
StorageProof
readonlykey
readonlyproof
readonlyvalue
SubscriptionParams
Type parameters
- T = JsonRpcResult
readonlyresult
readonlysubscription
SyncInput
readonlycurrentBlock
readonlyhighestBlock
optionalreadonlyknownStates
optionalreadonlypulledStates
readonlystartingBlock
SyncOutput
readonlycurrentBlock
readonlyhighestBlock
optionalreadonlyknownStates
optionalreadonlypulledStates
readonlystartingBlock
Transaction
optionalaccessList
optionalchain
optionalchainId
optionalcommon
optionaldata
optionalfrom
optionalgas
optionalgasLimit
optionalgasPrice
optionalhardfork
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnetworkId
optionalnonce
optionalr
optionals
optionalto
optionaltype
optionalv
optionalvalue
optionalyParity
Transaction1559SignedAPI
readonlyaccessList
optionalreadonlychainId
optionalreadonlydata
readonlygas
optionalreadonlyhash
readonlyinput
readonlymaxFeePerGas
readonlymaxPriorityFeePerGas
readonlynonce
readonlyr
readonlys
optionalreadonlyto
readonlytype
readonlyvalue
readonlyyParity
Transaction1559UnsignedAPI
readonlyaccessList
optionalreadonlychainId
optionalreadonlydata
readonlygas
optionalreadonlyhash
readonlyinput
readonlymaxFeePerGas
readonlymaxPriorityFeePerGas
readonlynonce
optionalreadonlyto
readonlytype
readonlyvalue
Transaction2930SignedAPI
readonlyaccessList
optionalreadonlychainId
optionalreadonlydata
readonlygas
readonlygasPrice
optionalreadonlyhash
readonlyinput
readonlynonce
readonlyr
readonlys
optionalreadonlyto
readonlytype
readonlyvalue
readonlyyParity
Transaction2930UnsignedAPI
readonlyaccessList
optionalreadonlychainId
optionalreadonlydata
readonlygas
readonlygasPrice
optionalreadonlyhash
readonlyinput
readonlynonce
optionalreadonlyto
readonlytype
readonlyvalue
TransactionCall
optionalaccessList
optionalchain
optionalchainId
optionalcommon
optionaldata
optionalfrom
optionalgas
optionalgasLimit
optionalgasPrice
optionalhardfork
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnetworkId
optionalnonce
optionalr
optionals
to
optionaltype
optionalv
optionalvalue
optionalyParity
TransactionCallAPI
optionalreadonlyaccessList
optionalreadonlydata
optionalreadonlyfrom
optionalreadonlygas
optionalreadonlygasPrice
optionalreadonlymaxFeePerGas
optionalreadonlymaxPriorityFeePerGas
readonlyto
optionalreadonlytype
optionalreadonlyvalue
TransactionForAccessList
optionalaccessList
optionalchain
optionalchainId
optionalcommon
optionaldata
from
optionalgas
optionalgasLimit
optionalgasPrice
optionalhardfork
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnetworkId
optionalnonce
optionalr
optionals
optionalto
optionaltype
optionalv
optionalvalue
optionalyParity
TransactionInfo
optionalaccessList
optionalreadonlyblockHash
optionalreadonlyblockNumber
optionalchain
optionalchainId
optionalcommon
optionaldata
readonlyfrom
optionalgas
optionalgasLimit
optionalgasPrice
optionalhardfork
readonlyhash
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnetworkId
optionalnonce
optionalr
optionals
optionalto
optionalreadonlytransactionIndex
optionaltype
optionalv
optionalvalue
optionalyParity
TransactionInput
optionalreadonlyblockNumber
optionalreadonlychainId
optionalreadonlydata
optionalreadonlyfrom
readonlygas
optionalreadonlygasLimit
optionalreadonlygasPrice
optionalreadonlyinput
optionalreadonlymaxFeePerGas
optionalreadonlymaxPriorityFeePerGas
readonlynonce
optionalreadonlyto
optionalreadonlytransactionIndex
optionalreadonlytype
readonlyvalue
TransactionLegacySignedAPI
optionalreadonlychainId
optionalreadonlydata
readonlygas
readonlygasPrice
optionalreadonlyhash
readonlyinput
readonlynonce
readonlyr
readonlys
optionalreadonlyto
readonlytype
readonlyv
readonlyvalue
TransactionLegacyUnsignedAPI
optionalreadonlychainId
optionalreadonlydata
readonlygas
readonlygasPrice
optionalreadonlyhash
readonlyinput
readonlynonce
optionalreadonlyto
readonlytype
readonlyvalue
TransactionReceiptBase
Type parameters
- numberType
- hashByteType
- logsBloomByteType
- logsType
readonlyblockHash
readonlyblockNumber
optionalreadonlycontractAddress
readonlycumulativeGasUsed
optionalreadonlyeffectiveGasPrice
readonlyfrom
readonlygasUsed
readonlylogs
readonlylogsBloom
readonlyroot
readonlystatus
readonlyto
readonlytransactionHash
readonlytransactionIndex
optionalreadonlytype
TransactionWithFromAndToLocalWalletIndex
optionalaccessList
optionalchain
optionalchainId
optionalcommon
optionaldata
from
optionalgas
optionalgasLimit
optionalgasPrice
optionalhardfork
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnetworkId
optionalnonce
optionalr
optionals
to
optionaltype
optionalv
optionalvalue
optionalyParity
TransactionWithFromLocalWalletIndex
optionalaccessList
optionalchain
optionalchainId
optionalcommon
optionaldata
from
optionalgas
optionalgasLimit
optionalgasPrice
optionalhardfork
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnetworkId
optionalnonce
optionalr
optionals
optionalto
optionaltype
optionalv
optionalvalue
optionalyParity
TransactionWithToLocalWalletIndex
optionalaccessList
optionalchain
optionalchainId
optionalcommon
optionaldata
optionalfrom
optionalgas
optionalgasLimit
optionalgasPrice
optionalhardfork
optionalinput
optionalmaxFeePerGas
optionalmaxPriorityFeePerGas
optionalnetworkId
optionalnonce
optionalr
optionals
to
optionaltype
optionalv
optionalvalue
optionalyParity
Web3APIPayload
Type parameters
- API: Web3APISpec
- Method: Web3APIMethod<API>
optionalreadonlyid
optionalreadonlyjsonrpc
method
optionalparams
optionalreadonlyrequestOptions
Web3APIRequest
Type parameters
- API: Web3APISpec
- Method: Web3APIMethod<API>
method
optionalparams
Web3AccountProvider
Type parameters
- T
create
Returns T
decrypt
Parameters
keystore: string | KeyStore
password: string
optionaloptions: Record<string, unknown>
Returns Promise<T>
privateKeyToAccount
Parameters
privateKey: string
Returns T
Web3BaseWalletAccount
readonlyaddress
readonlyprivateKey
readonlyencrypt
Parameters
password: string
optionaloptions: Record<string, unknown>
Returns Promise<KeyStore>
readonlysign
Parameters
data: string | Record<string, unknown>
Returns { message?: string; messageHash: string; r: string; s: string; signature: string; v: string }
optionalreadonlymessage?: string
readonlymessageHash: string
readonlyr: string
readonlys: string
readonlysignature: string
readonlyv: string
readonlysignTransaction
Parameters
tx: Record<string, unknown>
Returns Promise<{ messageHash: string; r: string; rawTransaction: string; s: string; transactionHash: string; v: string }>
Web3DeferredPromiseInterface
Type parameters
- T
state
reject
Parameters
optionalreason: unknown
Returns void
resolve
Parameters
value: T | PromiseLike<T>
Returns void
startTimer
Returns void
Web3Error
readonlycode
readonlyname
optionalreadonlystack
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