Class Chain

Hierarchy

Chain

Index

Constructors

constructor

new Chain(__namedParameters: ChainConstructor): Chain
Parameters
- __namedParameters: ChainConstructor
Returns Chain
- Defined in elements/chain/src/chain.ts:74

Properties

`Private` _chainID

_chainID: Buffer

`Private` `Optional` _finalizedHeight

_finalizedHeight?: number

`Private` _genesisHeight

_genesisHeight: number

`Private` `Optional` _lastBlock

_lastBlock?: Block

`Readonly` constants

constants: {
    keepEventsForHeights: number;
    keepInclusionProofsForHeights: number;
    maxBlockHeaderCache: number;
    maxTransactionsSize: number;
    minBlockHeaderCache: number;
}

Type declaration

Readonly keepEventsForHeights: number
Readonly keepInclusionProofsForHeights: number
Readonly maxBlockHeaderCache: number
Readonly maxTransactionsSize: number
Readonly minBlockHeaderCache: number

dataAccess

dataAccess: DataAccess

Accessors

chainID

get chainID(): Buffer
Returns Buffer
- Defined in elements/chain/src/chain.ts:115

finalizedHeight

get finalizedHeight(): number
Returns number
- Defined in elements/chain/src/chain.ts:108

genesisHeight

get genesisHeight(): number
Returns number
- Defined in elements/chain/src/chain.ts:97

lastBlock

get lastBlock(): Block
Returns Block
- Defined in elements/chain/src/chain.ts:101

Methods

`Private` _cacheBlockHeaders

_cacheBlockHeaders(storageLastBlock: Block): Promise<void>
Parameters
- storageLastBlock: Block
Returns Promise<void>
- Defined in elements/chain/src/chain.ts:234

genesisBlockExist

genesisBlockExist(genesisBlock: Block): Promise<boolean>
Parameters
- genesisBlock: Block
Returns Promise<boolean>
- Defined in elements/chain/src/chain.ts:150

init

init(args: ChainInitArgs): void
Parameters
- args: ChainInitArgs
Returns void
- Defined in elements/chain/src/chain.ts:119

loadLastBlocks

loadLastBlocks(genesisBlock: Block): Promise<void>
Parameters
- genesisBlock: Block
Returns Promise<void>
- Defined in elements/chain/src/chain.ts:130

removeBlock

removeBlock(block: Block, state: CurrentState, __namedParameters?: {
saveTempBlock: boolean;
}): Promise<void>
Parameters
- block: Block
- state: CurrentState
- __namedParameters: {
  saveTempBlock: boolean;
  } = ...
  - saveTempBlock: boolean
Returns Promise<void>
- Defined in elements/chain/src/chain.ts:214

resetBlockHeaderCache

resetBlockHeaderCache(): void
Returns void
- Defined in elements/chain/src/chain.ts:146

saveBlock

saveBlock(block: Block, events: Event[], state: CurrentState, finalizedHeight: number, __namedParameters?: {
removeFromTempTable: boolean;
}): Promise<void>
Parameters
- block: Block
- events: Event[]
- state: CurrentState
- finalizedHeight: number
- __namedParameters: {
  removeFromTempTable: boolean;
  } = ...
  - removeFromTempTable: boolean
Returns Promise<void>
- Defined in elements/chain/src/chain.ts:199

validateBlock

validateBlock(block: Block, inputs: BlockValidationInput): void
Parameters
- block: Block
- inputs: BlockValidationInput
Returns void
- Defined in elements/chain/src/chain.ts:176

Class Chain

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: ChainConstructor

Returns Chain

Properties

Private _chainID

Private Optional _finalizedHeight

Private _genesisHeight

Private Optional _lastBlock

Readonly constants

Type declaration

Readonly keepEventsForHeights: number

Readonly keepInclusionProofsForHeights: number

Readonly maxBlockHeaderCache: number

Readonly maxTransactionsSize: number

Readonly minBlockHeaderCache: number

dataAccess

Accessors

chainID

Returns Buffer

finalizedHeight

Returns number

genesisHeight

Returns number

lastBlock

Returns Block

Methods

Private _cacheBlockHeaders

Parameters

storageLastBlock: Block

Returns Promise<void>

genesisBlockExist

Parameters

genesisBlock: Block

Returns Promise<boolean>

init

Parameters

args: ChainInitArgs

Returns void

loadLastBlocks

Parameters

genesisBlock: Block

Returns Promise<void>

removeBlock

Parameters

block: Block

state: CurrentState

__namedParameters: { saveTempBlock: boolean; } = ...

saveTempBlock: boolean

Returns Promise<void>

resetBlockHeaderCache

Returns void

saveBlock

Parameters

block: Block

events: Event[]

state: CurrentState

finalizedHeight: number

__namedParameters: { removeFromTempTable: boolean; } = ...

removeFromTempTable: boolean

Returns Promise<void>

validateBlock

Parameters

block: Block

inputs: BlockValidationInput

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` _chainID

`Private` `Optional` _finalizedHeight

`Private` _genesisHeight

`Private` `Optional` _lastBlock

`Readonly` constants

`Readonly` keepEventsForHeights: number

`Readonly` keepInclusionProofsForHeights: number

`Readonly` maxBlockHeaderCache: number

`Readonly` maxTransactionsSize: number

`Readonly` minBlockHeaderCache: number

`Private` _cacheBlockHeaders

__namedParameters: {
saveTempBlock: boolean;
} = ...

__namedParameters: {
removeFromTempTable: boolean;
} = ...