Providers
MinedBlock
An Interface to indicate a Block has been included in the blockchain. This asserts a Type Guard
that necessary properties are non-null.
Before a block is included, it is a pending block.
The Date this block was
included at.
The number of transactions in this block.
Returns the list of extended transaction hashes, in the order they were executed within the block.
Returns the complete extended transactions, in the order they were executed within the block.
This is only available for blocks which prefetched transactions, by passing
Returns the complete transactions, in the order they were executed within the block.
This is only available for blocks which prefetched transactions, by passing
Returns the list of transaction hashes, in the order they were executed within the block.
Get the extended transaction at
If a Block was fetched with a request to include the transactions this will allow synchronous access to those
transactions.
If the transactions were not prefetched, this will throw.
Get the transaction at
Returns true if this block been mined. This provides a type guard for all properties on a
MinedBlock.
Returns a JSON-friendly value.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
provider | readonly | Provider | The provider connected to the block used to fetch additional details if necessary. | Block.provider |
Accessors
date
Returns
null | Date
The date this block was included at, or null if the timestamp is not available.
Source
providers/provider.ts:826length
Returns
number
The number of transactions.
Source
providers/provider.ts:816outboundEtxs
Returns
readonlystring[]
The list of extended transaction hashes.
Source
providers/provider.ts:689prefetchedExtTransactions
true to prefetchTxs into
getBlock.
Throws
If the transactions were not prefetched.Returns
ExternalTransactionResponse[]
The list of prefetched extended transactions.
Source
providers/provider.ts:737prefetchedTransactions
true to prefetchTxs into
getBlock.
Throws
If the transactions were not prefetched.Returns
TransactionResponse[]
The list of prefetched transactions.
Source
providers/provider.ts:707transactions
Returns
readonlystring[]
The list of transaction hashes.
Source
providers/provider.ts:675Methods
getExtTransaction()
index within this block.
Parameters
| Parameter | Type | Description |
|---|---|---|
indexOrHash | string | number | The index or hash of the extended transaction. |
Returns
Promise<ExternalTransactionResponse>
A promise resolving to the extended transaction.
Inherited from
Block.getExtTransaction
Throws
If the extended transaction is not found.Source
providers/provider.ts:883getPrefetchedTransaction()
Parameters
| Parameter | Type | Description |
|---|---|---|
indexOrHash | string | number | The index or hash of the transaction. |
Returns
TransactionResponse
The transaction.
Inherited from
Block.getPrefetchedTransaction
Throws
If the transaction is not found.Source
providers/provider.ts:927getTransaction()
index within this block.
Parameters
| Parameter | Type | Description |
|---|---|---|
indexOrHash | string | number | The index or hash of the transaction. |
Returns
Promise<TransactionResponse | ExternalTransactionResponse>
A promise resolving to the transaction.
Inherited from
Block.getTransaction
Throws
If the transaction is not found.Source
providers/provider.ts:842isMined()
Returns
this is MinedBlock
True if the block has been mined.
Inherited from
Block.isMined
Source
providers/provider.ts:949toJSON()
Returns
BlockParams
The JSON-friendly value.
Inherited from
Block.toJSON