Skip to main content

rpcMethods

Index

Namespaces

Namespaces

ethRpcMethods

ethRpcMethods:

call

call(requestManager: Web3RequestManager<EthExecutionAPI>, transaction: TransactionCallAPI, blockNumber: BlockNumberOrTag): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transaction: TransactionCallAPI
- blockNumber: BlockNumberOrTag
Returns Promise<string>

compileLLL

compileLLL(requestManager: Web3RequestManager<EthExecutionAPI>, code: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- code: string
Returns Promise<string>

compileSerpent

compileSerpent(requestManager: Web3RequestManager<EthExecutionAPI>, code: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- code: string
Returns Promise<string>

compileSolidity

compileSolidity(requestManager: Web3RequestManager<EthExecutionAPI>, code: string): Promise<CompileResultAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- code: string
Returns Promise<CompileResultAPI>

createAccessList

createAccessList(requestManager: Web3RequestManager<EthExecutionAPI>, transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>, blockNumber: BlockNumberOrTag): Promise<any>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>
- blockNumber: BlockNumberOrTag
Returns Promise<any>

estimateGas

estimateGas<TransactionType>(requestManager: Web3RequestManager<EthExecutionAPI>, transaction: Partial<TransactionType>, blockNumber: BlockNumberOrTag): Promise<string>

Type parameters
- TransactionType = TransactionWithSenderAPI
Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transaction: Partial<TransactionType>
- blockNumber: BlockNumberOrTag
Returns Promise<string>

getAccounts

getAccounts(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string[]>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string[]>

getBalance

getBalance(requestManager: Web3RequestManager<EthExecutionAPI>, address: string, blockNumber: BlockNumberOrTag): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- address: string
- blockNumber: BlockNumberOrTag
Returns Promise<string>

getBlockByHash

getBlockByHash(requestManager: Web3RequestManager<EthExecutionAPI>, blockHash: string, hydrated: boolean): Promise<BlockAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockHash: string
- hydrated: boolean
Returns Promise<BlockAPI>

getBlockByNumber

getBlockByNumber(requestManager: Web3RequestManager<EthExecutionAPI>, blockNumber: BlockNumberOrTag, hydrated: boolean): Promise<BlockAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockNumber: BlockNumberOrTag
- hydrated: boolean
Returns Promise<BlockAPI>

getBlockNumber

getBlockNumber(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

getBlockTransactionCountByHash

getBlockTransactionCountByHash(requestManager: Web3RequestManager<EthExecutionAPI>, blockHash: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockHash: string
Returns Promise<string>

getBlockTransactionCountByNumber

getBlockTransactionCountByNumber(requestManager: Web3RequestManager<EthExecutionAPI>, blockNumber: BlockNumberOrTag): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockNumber: BlockNumberOrTag
Returns Promise<string>

getChainId

getChainId(requestManager: Web3RequestManager<Web3EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<Web3EthExecutionAPI>
Returns Promise<string>

getCode

getCode(requestManager: Web3RequestManager<EthExecutionAPI>, address: string, blockNumber: BlockNumberOrTag): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- address: string
- blockNumber: BlockNumberOrTag
Returns Promise<string>

getCoinbase

getCoinbase(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

getCompilers

getCompilers(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string[]>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string[]>

getFeeHistory

getFeeHistory(requestManager: Web3RequestManager<EthExecutionAPI>, blockCount: string, newestBlock: BlockNumberOrTag, rewardPercentiles: number[]): Promise<FeeHistoryResultAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockCount: string
- newestBlock: BlockNumberOrTag
- rewardPercentiles: number[]
Returns Promise<FeeHistoryResultAPI>

getFilterChanges

getFilterChanges(requestManager: Web3RequestManager<EthExecutionAPI>, filterIdentifier: string): Promise<FilterResultsAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- filterIdentifier: string
Returns Promise<FilterResultsAPI>

getFilterLogs

getFilterLogs(requestManager: Web3RequestManager<EthExecutionAPI>, filterIdentifier: string): Promise<FilterResultsAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- filterIdentifier: string
Returns Promise<FilterResultsAPI>

getGasPrice

getGasPrice(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

getHashRate

getHashRate(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

getLogs

getLogs(requestManager: Web3RequestManager<EthExecutionAPI>, filter: Filter): Promise<FilterResultsAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- filter: Filter
Returns Promise<FilterResultsAPI>

getMaxPriorityFeePerGas

getMaxPriorityFeePerGas(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

getMining

getMining(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<boolean>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<boolean>

getNodeInfo

getNodeInfo(requestManager: Web3RequestManager<Web3EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<Web3EthExecutionAPI>
Returns Promise<string>

getPendingTransactions

getPendingTransactions(requestManager: Web3RequestManager<Web3EthExecutionAPI>): Promise<TransactionInfo[]>

Parameters
- requestManager: Web3RequestManager<Web3EthExecutionAPI>
Returns Promise<TransactionInfo[]>

getProof

getProof(requestManager: Web3RequestManager<Web3EthExecutionAPI>, address: string, storageKeys: string[], blockNumber: BlockNumberOrTag): Promise<AccountObject>

Parameters
- requestManager: Web3RequestManager<Web3EthExecutionAPI>
- address: string
- storageKeys: string[]
- blockNumber: BlockNumberOrTag
Returns Promise<AccountObject>

getProtocolVersion

getProtocolVersion(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

getStorageAt

getStorageAt(requestManager: Web3RequestManager<EthExecutionAPI>, address: string, storageSlot: string, blockNumber: BlockNumberOrTag): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- address: string
- storageSlot: string
- blockNumber: BlockNumberOrTag
Returns Promise<string>

getSyncing

getSyncing(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<SyncingStatusAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<SyncingStatusAPI>

getTransactionByBlockHashAndIndex

getTransactionByBlockHashAndIndex(requestManager: Web3RequestManager<EthExecutionAPI>, blockHash: string, transactionIndex: string): Promise<TransactionInfoAPI | undefined>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockHash: string
- transactionIndex: string
Returns Promise<TransactionInfoAPI | undefined>

getTransactionByBlockNumberAndIndex

getTransactionByBlockNumberAndIndex(requestManager: Web3RequestManager<EthExecutionAPI>, blockNumber: BlockNumberOrTag, transactionIndex: string): Promise<TransactionInfoAPI | undefined>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockNumber: BlockNumberOrTag
- transactionIndex: string
Returns Promise<TransactionInfoAPI | undefined>

getTransactionByHash

getTransactionByHash(requestManager: Web3RequestManager<EthExecutionAPI>, transactionHash: string): Promise<TransactionInfoAPI | undefined>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transactionHash: string
Returns Promise<TransactionInfoAPI | undefined>

getTransactionCount

getTransactionCount(requestManager: Web3RequestManager<EthExecutionAPI>, address: string, blockNumber: BlockNumberOrTag): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- address: string
- blockNumber: BlockNumberOrTag
Returns Promise<string>

getTransactionReceipt

getTransactionReceipt(requestManager: Web3RequestManager<EthExecutionAPI>, transactionHash: string): Promise<TransactionReceiptAPI | undefined>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transactionHash: string
Returns Promise<TransactionReceiptAPI | undefined>

getUncleByBlockHashAndIndex

getUncleByBlockHashAndIndex(requestManager: Web3RequestManager<EthExecutionAPI>, blockHash: string, uncleIndex: string): Promise<BlockAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockHash: string
- uncleIndex: string
Returns Promise<BlockAPI>

getUncleByBlockNumberAndIndex

getUncleByBlockNumberAndIndex(requestManager: Web3RequestManager<EthExecutionAPI>, blockNumber: BlockNumberOrTag, uncleIndex: string): Promise<BlockAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockNumber: BlockNumberOrTag
- uncleIndex: string
Returns Promise<BlockAPI>

getUncleCountByBlockHash

getUncleCountByBlockHash(requestManager: Web3RequestManager<EthExecutionAPI>, blockHash: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockHash: string
Returns Promise<string>

getUncleCountByBlockNumber

getUncleCountByBlockNumber(requestManager: Web3RequestManager<EthExecutionAPI>, blockNumber: BlockNumberOrTag): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- blockNumber: BlockNumberOrTag
Returns Promise<string>

getWork

getWork(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<[string, string, string]>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<[string, string, string]>

newBlockFilter

newBlockFilter(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

newFilter

newFilter(requestManager: Web3RequestManager<EthExecutionAPI>, filter: Filter): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- filter: Filter
Returns Promise<string>

newPendingTransactionFilter

newPendingTransactionFilter(requestManager: Web3RequestManager<EthExecutionAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
Returns Promise<string>

requestAccounts

requestAccounts(requestManager: Web3RequestManager<Web3EthExecutionAPI>): Promise<string[]>

Parameters
- requestManager: Web3RequestManager<Web3EthExecutionAPI>
Returns Promise<string[]>

sendRawTransaction

sendRawTransaction(requestManager: Web3RequestManager<EthExecutionAPI>, transaction: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transaction: string
Returns Promise<string>

sendTransaction

sendTransaction(requestManager: Web3RequestManager<EthExecutionAPI>, transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>
Returns Promise<string>

sign

sign(requestManager: Web3RequestManager<EthExecutionAPI>, address: string, message: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- address: string
- message: string
Returns Promise<string>

signTransaction

signTransaction(requestManager: Web3RequestManager<EthExecutionAPI>, transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>): Promise<string | SignedTransactionInfoAPI>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- transaction: TransactionWithSenderAPI | Partial<TransactionWithSenderAPI>
Returns Promise<string | SignedTransactionInfoAPI>

signTypedData

signTypedData(requestManager: Web3RequestManager<EthExecutionAPI>, address: string, typedData: Eip712TypedData, useLegacy?: boolean): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- address: string
- typedData: Eip712TypedData
- optionaluseLegacy: boolean
Returns Promise<string>

submitHashrate

submitHashrate(requestManager: Web3RequestManager<EthExecutionAPI>, hashRate: string, id: string): Promise<boolean>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- hashRate: string
- id: string
Returns Promise<boolean>

submitWork

submitWork(requestManager: Web3RequestManager<EthExecutionAPI>, nonce: string, hash: string, digest: string): Promise<boolean>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- nonce: string
- hash: string
- digest: string
Returns Promise<boolean>

uninstallFilter

uninstallFilter(requestManager: Web3RequestManager<EthExecutionAPI>, filterIdentifier: string): Promise<boolean>

Parameters
- requestManager: Web3RequestManager<EthExecutionAPI>
- filterIdentifier: string
Returns Promise<boolean>

netRpcMethods

netRpcMethods:

getId

getId(requestManager: Web3RequestManager<Web3NetAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<Web3NetAPI>
Returns Promise<string>

getPeerCount

getPeerCount(requestManager: Web3RequestManager<Web3NetAPI>): Promise<string>

Parameters
- requestManager: Web3RequestManager<Web3NetAPI>
Returns Promise<string>

isListening

isListening(requestManager: Web3RequestManager<Web3NetAPI>): Promise<boolean>

Parameters
- requestManager: Web3RequestManager<Web3NetAPI>
Returns Promise<boolean>

personalRpcMethods

personalRpcMethods:

ecRecover

ecRecover(requestManager: Web3RequestManager<EthPersonalAPI>, signedData: string, signature: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- signedData: string
- signature: string
Returns Promise<string>

getAccounts

getAccounts(requestManager: Web3RequestManager<EthPersonalAPI>): Promise<string[]>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
Returns Promise<string[]>

importRawKey

importRawKey(requestManager: Web3RequestManager<EthPersonalAPI>, keyData: string, passphrase: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- keyData: string
- passphrase: string
Returns Promise<string>

lockAccount

lockAccount(requestManager: Web3RequestManager<EthPersonalAPI>, address: string): Promise<boolean>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- address: string
Returns Promise<boolean>

newAccount

newAccount(requestManager: Web3RequestManager<EthPersonalAPI>, password: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- password: string
Returns Promise<string>

sendTransaction

sendTransaction(requestManager: Web3RequestManager<EthPersonalAPI>, tx: Transaction, passphrase: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- tx: Transaction
- passphrase: string
Returns Promise<string>

sign

sign(requestManager: Web3RequestManager<EthPersonalAPI>, data: string, address: string, passphrase: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- data: string
- address: string
- passphrase: string
Returns Promise<string>

signTransaction

signTransaction(requestManager: Web3RequestManager<EthPersonalAPI>, tx: Transaction, passphrase: string): Promise<string>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- tx: Transaction
- passphrase: string
Returns Promise<string>

unlockAccount

unlockAccount(requestManager: Web3RequestManager<EthPersonalAPI>, address: string, password: string, unlockDuration: number): Promise<boolean>

Parameters
- requestManager: Web3RequestManager<EthPersonalAPI>
- address: string
- password: string
- unlockDuration: number
Returns Promise<boolean>

Page Options

Hide Inherited

ethRpcMethods
netRpcMethods
personalRpcMethods