0.1.3 • Published 3 years ago

ethereum-json-rpc-types v0.1.3

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

eth-json-rpc-types

typescript types for JSON-RPC 2.0

Overview

Classes

Interfaces

Type aliases

Type aliases

Address

Ƭ Address: string

Defined in index.d.ts:69


AddressOrNull

Ƭ AddressOrNull: Address | Null

Defined in index.d.ts:186


Addresses

Ƭ Addresses: Address[]

Defined in index.d.ts:123

List of contract addresses from which to monitor events


BlockDifficulty

Ƭ BlockDifficulty: string

Defined in index.d.ts:192

Integer of the difficulty for this block


BlockExtraData

Ƭ BlockExtraData: string

Defined in index.d.ts:204

The 'extra data' field of this block


BlockGasLimit

Ƭ BlockGasLimit: string

Defined in index.d.ts:216

The maximum gas allowed in this block


BlockGasUsed

Ƭ BlockGasUsed: string

Defined in index.d.ts:222

The total used gas by all transactions in this block


BlockHash

Ƭ BlockHash: string

Defined in index.d.ts:148

The hex representation of the Keccak 256 of the RLP encoded block


BlockHashOrNull

Ƭ BlockHashOrNull: Keccak | Null

Defined in index.d.ts:20

The block hash or null when its the pending block


BlockLogsBloom

Ƭ BlockLogsBloom: string

Defined in index.d.ts:167

The bloom filter for the logs of the block or null when its the pending block


BlockNumber

Ƭ BlockNumber: string

Defined in index.d.ts:26

The hex representation of the block's height


BlockNumberOrNull

Ƭ BlockNumberOrNull: BlockNumber | Null

Defined in index.d.ts:32

The block number or null when its the pending block


BlockNumberOrTag

Ƭ BlockNumberOrTag: BlockNumber | BlockNumberTag

Defined in index.d.ts:539


BlockNumberTag

Ƭ BlockNumberTag: "earliest" | "latest" | "pending"

Defined in index.d.ts:117

The optional block height description


BlockOrNull

Ƭ BlockOrNull: Block | Null

Defined in index.d.ts:606


BlockReceiptsRoot

Ƭ BlockReceiptsRoot: string

Defined in index.d.ts:185

The root of the receipts trie of the block


BlockShaUncles

Ƭ BlockShaUncles: string

Defined in index.d.ts:161

Keccak hash of the uncles data in the block


BlockSize

Ƭ BlockSize: string

Defined in index.d.ts:210

Integer the size of this block in bytes


BlockStateRoot

Ƭ BlockStateRoot: string

Defined in index.d.ts:179

The root of the final state trie of the block


BlockTimeStamp

Ƭ BlockTimeStamp: string

Defined in index.d.ts:228

The unix timestamp for when the block was collated


BlockTotalDifficulty

Ƭ BlockTotalDifficulty: Integer | Null

Defined in index.d.ts:198

Integer of the total difficulty of the chain until this block


BlockTransactionsRoot

Ƭ BlockTransactionsRoot: string

Defined in index.d.ts:173

The root of the transactions trie of the block.


BloomFilter

Ƭ BloomFilter: string

Defined in index.d.ts:362

A 2048 bit bloom filter from the logs of the transaction. Each log sets 3 bits though taking the low-order 11 bits of each of the first three pairs of bytes in a Keccak 256 hash of the log's byte series


BooleanVyG3AETh

Ƭ BooleanVyG3AETh: boolean

Defined in index.d.ts:537


Bytes

Ƭ Bytes: string

Defined in index.d.ts:576

Hex representation of a variable length byte array


ChainId

Ƭ ChainId: string

Defined in index.d.ts:598


ClientVersion

Ƭ ClientVersion: string

Defined in index.d.ts:589


Data

Ƭ Data: string

Defined in index.d.ts:538


DataWord

Ƭ DataWord: string

Defined in index.d.ts:582

Hex representation of a 256 bit unit of data


Difficulty

Ƭ Difficulty: string

Defined in index.d.ts:493

The boundary condition ('target'), 2^256 / difficulty.


EthBlockNumber

Ƭ EthBlockNumber: function

Defined in index.d.ts:631

Type declaration:

▸ (): Promise‹BlockNumberOrTag


EthCall

Ƭ EthCall: function

Defined in index.d.ts:632

Type declaration:

▸ (transaction: Transaction, blockNumber: BlockNumberOrTag): Promise‹Bytes

Parameters:

NameType
transactionTransaction
blockNumberBlockNumberOrTag

EthChainId

Ƭ EthChainId: function

Defined in index.d.ts:633

Type declaration:

▸ (): Promise‹ChainId


EthCoinbase

Ƭ EthCoinbase: function

Defined in index.d.ts:634

Type declaration:

▸ (): Promise‹Address


EthEstimateGas

Ƭ EthEstimateGas: function

Defined in index.d.ts:635

Type declaration:

▸ (transaction: Transaction): Promise‹Integer

Parameters:

NameType
transactionTransaction

EthGasPrice

Ƭ EthGasPrice: function

Defined in index.d.ts:636

Type declaration:

▸ (): Promise‹GasPriceResult


EthGetBalance

Ƭ EthGetBalance: function

Defined in index.d.ts:637

Type declaration:

▸ (address: Address, blockNumber: BlockNumber): Promise‹IntegerOrNull

Parameters:

NameType
addressAddress
blockNumberBlockNumber

EthGetBlockByHash

Ƭ EthGetBlockByHash: function

Defined in index.d.ts:638

Type declaration:

▸ (blockHash: BlockHash, includeTransactions: IsTransactionsIncluded): Promise‹BlockOrNull

Parameters:

NameType
blockHashBlockHash
includeTransactionsIsTransactionsIncluded

EthGetBlockByNumber

Ƭ EthGetBlockByNumber: function

Defined in index.d.ts:639

Type declaration:

▸ (blockNumber: BlockNumberOrTag, includeTransactions: IsTransactionsIncluded): Promise‹BlockOrNull

Parameters:

NameType
blockNumberBlockNumberOrTag
includeTransactionsIsTransactionsIncluded

EthGetBlockTransactionCountByHash

Ƭ EthGetBlockTransactionCountByHash: function

Defined in index.d.ts:640

Type declaration:

▸ (blockHash: BlockHash): Promise‹IntegerOrNull

Parameters:

NameType
blockHashBlockHash

EthGetBlockTransactionCountByNumber

Ƭ EthGetBlockTransactionCountByNumber: function

Defined in index.d.ts:641

Type declaration:

▸ (blockNumber: BlockNumberOrTag): Promise‹IntegerOrNull

Parameters:

NameType
blockNumberBlockNumberOrTag

EthGetCode

Ƭ EthGetCode: function

Defined in index.d.ts:642

Type declaration:

▸ (address: Address, blockNumber: BlockNumber): Promise‹Bytes

Parameters:

NameType
addressAddress
blockNumberBlockNumber

EthGetFilterChanges

Ƭ EthGetFilterChanges: function

Defined in index.d.ts:643

Type declaration:

▸ (filterId: FilterId): Promise‹LogResult

Parameters:

NameType
filterIdFilterId

EthGetFilterLogs

Ƭ EthGetFilterLogs: function

Defined in index.d.ts:644

Type declaration:

▸ (filterId: FilterId): Promise‹SetOfLogs

Parameters:

NameType
filterIdFilterId

EthGetLogs

Ƭ EthGetLogs: function

Defined in index.d.ts:648

Type declaration:

▸ (filter: Filter): Promise‹SetOfLogs

Parameters:

NameType
filterFilter

EthGetProof

Ƭ EthGetProof: function

Defined in index.d.ts:659

Type declaration:

▸ (address: Address, storageKeys: StorageKeys, blockNumber: BlockNumberOrTag): Promise‹ProofAccountOrNull

Parameters:

NameType
addressAddress
storageKeysStorageKeys
blockNumberBlockNumberOrTag

EthGetRawTransactionByBlockHashAndIndex

Ƭ EthGetRawTransactionByBlockHashAndIndex: function

Defined in index.d.ts:646

Type declaration:

▸ (blockHash: BlockHash, index: Integer): Promise‹Bytes

Parameters:

NameType
blockHashBlockHash
indexInteger

EthGetRawTransactionByBlockNumberAndIndex

Ƭ EthGetRawTransactionByBlockNumberAndIndex: function

Defined in index.d.ts:647

Type declaration:

▸ (blockNumber: BlockNumberOrTag, index: Integer): Promise‹Bytes

Parameters:

NameType
blockNumberBlockNumberOrTag
indexInteger

EthGetRawTransactionByHash

Ƭ EthGetRawTransactionByHash: function

Defined in index.d.ts:645

Type declaration:

▸ (transactionHash: TransactionHash): Promise‹Bytes

Parameters:

NameType
transactionHashTransactionHash

EthGetStorageAt

Ƭ EthGetStorageAt: function

Defined in index.d.ts:649

Type declaration:

▸ (address: Address, key: Position, blockNumber: BlockNumberOrTag): Promise‹DataWord

Parameters:

NameType
addressAddress
keyPosition
blockNumberBlockNumberOrTag

EthGetTransactionByBlockHashAndIndex

Ƭ EthGetTransactionByBlockHashAndIndex: function

Defined in index.d.ts:650

Type declaration:

▸ (blockHash: BlockHash, index: Integer): Promise‹TransactionOrNull

Parameters:

NameType
blockHashBlockHash
indexInteger

EthGetTransactionByBlockNumberAndIndex

Ƭ EthGetTransactionByBlockNumberAndIndex: function

Defined in index.d.ts:651

Type declaration:

▸ (blockNumber: BlockNumberOrTag, index: Integer): Promise‹TransactionOrNull

Parameters:

NameType
blockNumberBlockNumberOrTag
indexInteger

EthGetTransactionByHash

Ƭ EthGetTransactionByHash: function

Defined in index.d.ts:652

Type declaration:

▸ (transactionHash: TransactionHash): Promise‹TransactionOrNull

Parameters:

NameType
transactionHashTransactionHash

EthGetTransactionCount

Ƭ EthGetTransactionCount: function

Defined in index.d.ts:653

Type declaration:

▸ (address: Address, blockNumber: BlockNumberOrTag): Promise‹NonceOrNull

Parameters:

NameType
addressAddress
blockNumberBlockNumberOrTag

EthGetTransactionReceipt

Ƭ EthGetTransactionReceipt: function

Defined in index.d.ts:654

Type declaration:

▸ (transactionHash: TransactionHash): Promise‹TransactionReceiptOrNull

Parameters:

NameType
transactionHashTransactionHash

EthGetUncleByBlockHashAndIndex

Ƭ EthGetUncleByBlockHashAndIndex: function

Defined in index.d.ts:655

Type declaration:

▸ (blockHash: BlockHash, index: Integer): Promise‹BlockOrNull

Parameters:

NameType
blockHashBlockHash
indexInteger

EthGetUncleByBlockNumberAndIndex

Ƭ EthGetUncleByBlockNumberAndIndex: function

Defined in index.d.ts:656

Type declaration:

▸ (uncleBlockNumber: BlockNumber, index: Integer): Promise‹BlockOrNull

Parameters:

NameType
uncleBlockNumberBlockNumber
indexInteger

EthGetUncleCountByBlockHash

Ƭ EthGetUncleCountByBlockHash: function

Defined in index.d.ts:657

Type declaration:

▸ (blockHash: BlockHash): Promise‹IntegerOrNull

Parameters:

NameType
blockHashBlockHash

EthGetUncleCountByBlockNumber

Ƭ EthGetUncleCountByBlockNumber: function

Defined in index.d.ts:658

Type declaration:

▸ (blockNumber: BlockNumberOrTag): Promise‹IntegerOrNull

Parameters:

NameType
blockNumberBlockNumberOrTag

EthGetWork

Ƭ EthGetWork: function

Defined in index.d.ts:660

Type declaration:

▸ (): Promise‹GetWorkResults


EthHashrate

Ƭ EthHashrate: function

Defined in index.d.ts:661

Type declaration:

▸ (): Promise‹Integer


EthMining

Ƭ EthMining: function

Defined in index.d.ts:662

Type declaration:

▸ (): Promise‹BooleanVyG3AETh


EthNewBlockFilter

Ƭ EthNewBlockFilter: function

Defined in index.d.ts:663

Type declaration:

▸ (): Promise‹FilterId


EthNewFilter

Ƭ EthNewFilter: function

Defined in index.d.ts:664

Type declaration:

▸ (filter: Filter): Promise‹Integer

Parameters:

NameType
filterFilter

EthNewPendingTransactionFilter

Ƭ EthNewPendingTransactionFilter: function

Defined in index.d.ts:665

Type declaration:

▸ (): Promise‹FilterId


EthPendingTransactions

Ƭ EthPendingTransactions: function

Defined in index.d.ts:666

Type declaration:

▸ (): Promise‹Transactions


EthProtocolVersion

Ƭ EthProtocolVersion: function

Defined in index.d.ts:667

Type declaration:

▸ (): Promise‹Integer


EthSendRawTransaction

Ƭ EthSendRawTransaction: function

Defined in index.d.ts:668

Type declaration:

▸ (signedTransactionData: Bytes): Promise‹Keccak

Parameters:

NameType
signedTransactionDataBytes

EthSubmitHashrate

Ƭ EthSubmitHashrate: function

Defined in index.d.ts:669

Type declaration:

▸ (hashRate: DataWord, id: DataWord): Promise‹BooleanVyG3AETh

Parameters:

NameType
hashRateDataWord
idDataWord

EthSubmitWork

Ƭ EthSubmitWork: function

Defined in index.d.ts:670

Type declaration:

▸ (nonce: Nonce, powHash: PowHash, mixHash: MixHash): Promise‹BooleanVyG3AETh

Parameters:

NameType
nonceNonce
powHashPowHash
mixHashMixHash

EthSyncing

Ƭ EthSyncing: function

Defined in index.d.ts:671

Type declaration:

▸ (): Promise‹IsSyncingResult


EthUninstallFilter

Ƭ EthUninstallFilter: function

Defined in index.d.ts:672

Type declaration:

▸ (filterId: FilterId): Promise‹BooleanVyG3AETh

Parameters:

NameType
filterIdFilterId

FilterId

Ƭ FilterId: string

Defined in index.d.ts:546

An identifier used to reference the filter.


From

Ƭ From: string

Defined in index.d.ts:38

The sender of the transaction


GasPriceResult

Ƭ GasPriceResult: string

Defined in index.d.ts:604

Integer of the current gas price


GetWorkResults

Ƭ GetWorkResults: [PowHash, SeedHash, Difficulty]

Defined in index.d.ts:612


Integer

Ƭ Integer: string

Defined in index.d.ts:81

Hex representation of the integer


IntegerOrNull

Ƭ IntegerOrNull: Integer | Null

Defined in index.d.ts:605


IsNetListening

Ƭ IsNetListening: boolean

Defined in index.d.ts:590


IsSyncingResult

Ƭ IsSyncingResult: SyncingData | BooleanVyG3AETh

Defined in index.d.ts:619


IsTransactionsIncluded

Ƭ IsTransactionsIncluded: boolean

Defined in index.d.ts:540


Keccak

Ƭ Keccak: string

Defined in index.d.ts:8

Hex representation of a Keccak 256 hash


LogAddress

Ƭ LogAddress: string

Defined in index.d.ts:297

Sender of the transaction


LogData

Ƭ LogData: string

Defined in index.d.ts:303

The data/input string sent along with the transaction


LogIndex

Ƭ LogIndex: string

Defined in index.d.ts:309

The index of the event within its transaction, null when its pending


LogIsRemoved

Ƭ LogIsRemoved: boolean

Defined in index.d.ts:315

Whether or not the log was orphaned off the main chain


LogResult

Ƭ LogResult: Log[]

Defined in index.d.ts:607


LogTopics

Ƭ LogTopics: Topic[]

Defined in index.d.ts:136

Topics are order-dependent. Each topic can also be an array of DATA with 'or' options.


Logs

Ƭ Logs: Log[]

Defined in index.d.ts:356

An array of all the logs triggered during the transaction


MixHash

Ƭ MixHash: string

Defined in index.d.ts:588

The mix digest.


NetListening

Ƭ NetListening: function

Defined in index.d.ts:628

Type declaration:

▸ (): Promise‹IsNetListening


NetPeerCount

Ƭ NetPeerCount: function

Defined in index.d.ts:629

Type declaration:

▸ (): Promise‹NumConnectedPeers


NetVersion

Ƭ NetVersion: function

Defined in index.d.ts:630

Type declaration:

▸ (): Promise‹NetworkId


NetworkId

Ƭ NetworkId: string

Defined in index.d.ts:597


Nonce

Ƭ Nonce: string

Defined in index.d.ts:154

A number only to be used once


NonceOrNull

Ƭ NonceOrNull: Nonce | Null

Defined in index.d.ts:155


Null

Ƭ Null: null

Defined in index.d.ts:14

Null


NumConnectedPeers

Ƭ NumConnectedPeers: string

Defined in index.d.ts:596

Hex representation of number of connected peers


OneOrArrayOfAddresses

Ƭ OneOrArrayOfAddresses: Address | Addresses

Defined in index.d.ts:124


Position

Ƭ Position: string

Defined in index.d.ts:564

Hex representation of the storage slot where the variable exists


PowHash

Ƭ PowHash: string

Defined in index.d.ts:481

Current block header PoW hash.


ProofAccountAddress

Ƭ ProofAccountAddress: string

Defined in index.d.ts:401

The address of the account or contract of the request


ProofAccountBalance

Ƭ ProofAccountBalance: string

Defined in index.d.ts:419

The Ether balance of the account or contract of the request


ProofAccountCodeHash

Ƭ ProofAccountCodeHash: string

Defined in index.d.ts:425

The code hash of the contract of the request (keccak(NULL) if external account)


ProofAccountNonce

Ƭ ProofAccountNonce: string

Defined in index.d.ts:431

The transaction count of the account or contract of the request


ProofAccountOrNull

Ƭ ProofAccountOrNull: ProofAccount | Null

Defined in index.d.ts:611


ProofAccountStorageHash

Ƭ ProofAccountStorageHash: string

Defined in index.d.ts:437

The storage hash of the contract of the request (keccak(rlp(NULL)) if external account)


ProofNode

Ƭ ProofNode: string

Defined in index.d.ts:407

An individual node used to prove a path down a merkle-patricia-tree


ProofNodes

Ƭ ProofNodes: ProofNode[]

Defined in index.d.ts:413

The set of node values needed to traverse a patricia merkle tree (from root to leaf) to retrieve a value


ReceiptContractAddress

Ƭ ReceiptContractAddress: Address | Null

Defined in index.d.ts:338

The contract address created, if the transaction was a contract creation, otherwise null


ReceiptCumulativeGasUsed

Ƭ ReceiptCumulativeGasUsed: string

Defined in index.d.ts:344

The gas units used by the transaction


ReceiptGasUsed

Ƭ ReceiptGasUsed: string

Defined in index.d.ts:350

The total gas used by the transaction


ReceiptPostTransactionState

Ƭ ReceiptPostTransactionState: string

Defined in index.d.ts:368

The intermediate stateRoot directly after transaction execution.


ReceiptStatus

Ƭ ReceiptStatus: boolean

Defined in index.d.ts:374

Whether or not the transaction threw an error.


SeedHash

Ƭ SeedHash: string

Defined in index.d.ts:487

The seed hash used for the DAG.


SetOfLogs

Ƭ SetOfLogs: Log[]

Defined in index.d.ts:608


StorageKeys

Ƭ StorageKeys: any

Defined in index.d.ts:570

A storage key is indexed from the solidity compiler by the order it is declared. For mappings it uses the keccak of the mapping key with its position (and recursively for X-dimensional mappings)


StorageProofKey

Ƭ StorageProofKey: string

Defined in index.d.ts:142

The key used to get the storage slot in its account tree.


StorageProofSet

Ƭ StorageProofSet: StorageProof[]

Defined in index.d.ts:460

Current block header PoW hash.


StorageProofValue

Ƭ StorageProofValue: string

Defined in index.d.ts:443

The value of the storage slot in its account tree


SyncingDataCurrentBlock

Ƭ SyncingDataCurrentBlock: string

Defined in index.d.ts:505

The current block, same as eth_blockNumber


SyncingDataHighestBlock

Ƭ SyncingDataHighestBlock: string

Defined in index.d.ts:511

The estimated highest block


SyncingDataKnownStates

Ƭ SyncingDataKnownStates: string

Defined in index.d.ts:517

The known states


SyncingDataPulledStates

Ƭ SyncingDataPulledStates: string

Defined in index.d.ts:523

The pulled states


SyncingDataStartingBlock

Ƭ SyncingDataStartingBlock: string

Defined in index.d.ts:499

Block at which the import started (will only be reset, after the sync reached his head)


To

Ƭ To: Address | Null

Defined in index.d.ts:75

Destination address of the transaction. Null if it was a contract create.


Topic

Ƭ Topic: string

Defined in index.d.ts:130

32 Bytes DATA of indexed log arguments. (In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256))


TransactionGas

Ƭ TransactionGas: string

Defined in index.d.ts:44

The gas limit provided by the sender in Wei


TransactionGasPrice

Ƭ TransactionGasPrice: string

Defined in index.d.ts:50

The gas price willing to be paid by the sender in Wei


TransactionHash

Ƭ TransactionHash: string

Defined in index.d.ts:56

Keccak 256 Hash of the RLP encoding of a transaction


TransactionIndex

Ƭ TransactionIndex: Integer | Null

Defined in index.d.ts:87

The index of the transaction. null when its pending


TransactionInput

Ƭ TransactionInput: string

Defined in index.d.ts:62

The data field sent with the transaction


TransactionNonce

Ƭ TransactionNonce: string

Defined in index.d.ts:68

The total number of prior transactions made by the sender


TransactionOrNull

Ƭ TransactionOrNull: Transaction | Null

Defined in index.d.ts:609


TransactionOrTransactionHash

Ƭ TransactionOrTransactionHash: Transaction | TransactionHash

Defined in index.d.ts:246


TransactionReceiptOrNull

Ƭ TransactionReceiptOrNull: Receipt | Null

Defined in index.d.ts:610


TransactionSigR

Ƭ TransactionSigR: string

Defined in index.d.ts:105

ECDSA signature r


TransactionSigS

Ƭ TransactionSigS: string

Defined in index.d.ts:111

ECDSA signature s


TransactionSigV

Ƭ TransactionSigV: string

Defined in index.d.ts:99

ECDSA recovery id


TransactionValue

Ƭ TransactionValue: string

Defined in index.d.ts:93

Value of Ether being transferred in Wei


Transactions

Ƭ Transactions: Transaction[]

Defined in index.d.ts:618

An array of transactions


TransactionsOrHashes

Ƭ TransactionsOrHashes: TransactionOrTransactionHash[]

Defined in index.d.ts:252

Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter


UncleHash

Ƭ UncleHash: string

Defined in index.d.ts:258

Block hash of the RLP encoding of an uncle block


UncleHashes

Ƭ UncleHashes: UncleHash[]

Defined in index.d.ts:264

Array of uncle hashes


Web3ClientVersion

Ƭ Web3ClientVersion: function

Defined in index.d.ts:626

Type declaration:

▸ (): Promise‹ClientVersion


Web3Sha3

Ƭ Web3Sha3: function

Defined in index.d.ts:627

Type declaration:

▸ (data: Data): Promise‹Keccak

Parameters:

NameType
dataData