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.

Extends

Properties

PropertyModifierTypeDescriptionInherited from
providerreadonlyProviderThe provider connected to the block used to fetch additional details if necessary.Block.provider

Accessors

date

get date(): null | Date
The Date this block was included at.

Returns

null | Date The date this block was included at, or null if the timestamp is not available.

Source

providers/provider.ts:826

length

get length(): number
The number of transactions in this block.

Returns

number The number of transactions.

Source

providers/provider.ts:816

outboundEtxs

get outboundEtxs(): readonly string[]
Returns the list of extended transaction hashes, in the order they were executed within the block.

Returns

readonly string[] The list of extended transaction hashes.

Source

providers/provider.ts:689

prefetchedExtTransactions

get prefetchedExtTransactions(): ExternalTransactionResponse[]
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 true to prefetchTxs into getBlock.

Throws

If the transactions were not prefetched.

Returns

ExternalTransactionResponse[] The list of prefetched extended transactions.

Source

providers/provider.ts:737

prefetchedTransactions

get prefetchedTransactions(): TransactionResponse[]
Returns the complete transactions, in the order they were executed within the block. This is only available for blocks which prefetched transactions, by passing true to prefetchTxs into getBlock.

Throws

If the transactions were not prefetched.

Returns

TransactionResponse[] The list of prefetched transactions.

Source

providers/provider.ts:707

transactions

get transactions(): readonly string[]
Returns the list of transaction hashes, in the order they were executed within the block.

Returns

readonly string[] The list of transaction hashes.

Source

providers/provider.ts:675

Methods

getExtTransaction()

getExtTransaction(indexOrHash): Promise<ExternalTransactionResponse>
Get the extended transaction at index within this block.

Parameters

ParameterTypeDescription
indexOrHashstring | numberThe 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:883

getPrefetchedTransaction()

getPrefetchedTransaction(indexOrHash): TransactionResponse
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.

Parameters

ParameterTypeDescription
indexOrHashstring | numberThe 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:927

getTransaction()

getTransaction(indexOrHash): Promise<TransactionResponse | ExternalTransactionResponse>
Get the transaction at index within this block.

Parameters

ParameterTypeDescription
indexOrHashstring | numberThe 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:842

isMined()

isMined(): this is MinedBlock
Returns true if this block been mined. This provides a type guard for all properties on a MinedBlock.

Returns

this is MinedBlock True if the block has been mined.

Inherited from

Block.isMined

Source

providers/provider.ts:949

toJSON()

toJSON(): BlockParams
Returns a JSON-friendly value.

Returns

BlockParams The JSON-friendly value.

Inherited from

Block.toJSON

Source

providers/provider.ts:763