Skip to main content

StarknetBtcStoredHeader

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:22

Representing a bitcoin blockheader struct which has already been saved and committed inside the Starknet BTC relay smart contract

Implements

Methods

computeNext()

computeNext(header): StarknetBtcStoredHeader;

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:136

Computes and returns a new stored blockheader after adding a new blockheader on top of it

Parameters

ParameterTypeDescription
headerStarknetBtcHeaderThe new blockheader to append to the chain

Returns

StarknetBtcStoredHeader

Implementation of

BtcStoredHeader.computeNext


fromSerializedFeltArray()

static fromSerializedFeltArray(span): StarknetBtcStoredHeader;

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:167

Deserializes the store bitcoin blockheader from its felt252 array representation

Parameters

ParameterTypeDescription
spanBigNumberish[]felt252 array encoding the stored blockheader, has to be at least 42 felts long

Returns

StarknetBtcStoredHeader


getBlockHash()

getBlockHash(): Buffer;

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:85

Returns

Buffer

Inherit Doc


getBlockheight()

getBlockheight(): number;

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:50

Blockheight of the current block

Returns

number

Implementation of

BtcStoredHeader.getBlockheight


getChainWork()

getChainWork(): Buffer;

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:57

Total accumulated chainwork at this block

Returns

Buffer

Implementation of

BtcStoredHeader.getChainWork


getHeader()

getHeader(): StarknetBtcHeader;

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:64

The actual blockheader that was saved

Returns

StarknetBtcHeader

Implementation of

BtcStoredHeader.getHeader


getLastDiffAdjustment()

getLastDiffAdjustment(): number;

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:71

UNIX seconds timestamp of the last difficulty adjustment

Returns

number

Implementation of

BtcStoredHeader.getLastDiffAdjustment


getPrevBlockTimestamps()

getPrevBlockTimestamps(): number[];

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:78

UNIX seconds timestamps of the last 11 blocks, used for checking the median block time rule

Returns

number[]

Implementation of

BtcStoredHeader.getPrevBlockTimestamps


serialize()

serialize(): BigNumberish[];

Defined in: atomiq-chain-starknet/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts:150

Serializes the bitcoin stored blockheader struct to an array of felt252 of length 42

Returns

BigNumberish[]