Home Reference Source Test
public class | source

ChainDataStore

Static Method Summary

Static Public Methods
public static
public static

getPersistent(jdb: JungleDB): ChainDataStore

public static

initPersistent(jdb: JungleDB)

Constructor Summary

Public Constructor
public

constructor(chainStore: IObjectStore, blockStore: IObjectStore)

Member Summary

Public Members
public get

txs: Array<JDB.Transaction>

Method Summary

Public Methods
public

abort(): Promise

public

commit(): Promise

public

async getBlock(key: Hash, includeBody: boolean): Block

public

async getBlockAt(height: number, includeBody: boolean): PromiseBlock>

public

getBlocks(startBlockHash: Hash, count: number, forward: boolean): Promise<Array<Block>>

public

async getBlocksBackward(startBlockHash: Hash, count: number, includeBody: boolean): Promise<Array<Block>>

public

async getBlocksForward(startBlockHash: Hash, count: number): Promise<Array<Block>>

public

async getChainData(key: Hash, includeBody: boolean): PromiseChainData>

public

async getChainDataAt(height: number, includeBody: boolean): PromiseChainData>

public

async getChainDataCandidatesAt(height: number): Promise<?Array<ChainData>>

public

async getHead(): Promise<Hash|undefined>

public

async getNearestBlockAt(height: number, lower: boolean): PromiseBlock>

public

async getRawBlock(key: Hash, includeForks: boolean): PromiseUint8Array>

public

async getSuccessorBlocks(block: Block): Promise<Array<Block>>

public

putChainData(key: Hash, chainData: ChainData, includeBody: boolean): Promise<void>

public

putChainDataSync(key: Hash, chainData: ChainData, includeBody: boolean): void

public
public

setHead(key: Hash): Promise<void>

public

setHeadSync(key: Hash): void

public
public

synchronousTransaction(enableWatchdog: boolean): ChainDataStore

public

transaction(enableWatchdog: boolean): ChainDataStore

public

truncate(): Promise

Static Public Methods

public static createVolatile(): ChainDataStore source

Return:

ChainDataStore

public static getPersistent(jdb: JungleDB): ChainDataStore source

Params:

NameTypeAttributeDescription
jdb JungleDB

Return:

ChainDataStore

public static initPersistent(jdb: JungleDB) source

Params:

NameTypeAttributeDescription
jdb JungleDB

Public Constructors

public constructor(chainStore: IObjectStore, blockStore: IObjectStore) source

Params:

NameTypeAttributeDescription
chainStore IObjectStore
blockStore IObjectStore

Public Members

public get txs: Array<JDB.Transaction> source

Public Methods

public abort(): Promise source

Return:

Promise

public commit(): Promise source

Return:

Promise

public async getBlock(key: Hash, includeBody: boolean): Block source

Params:

NameTypeAttributeDescription
key Hash
includeBody boolean
  • optional

Return:

Block (nullable: true)

public async getBlockAt(height: number, includeBody: boolean): PromiseBlock> source

Params:

NameTypeAttributeDescription
height number
includeBody boolean
  • optional

Return:

PromiseBlock>

public getBlocks(startBlockHash: Hash, count: number, forward: boolean): Promise<Array<Block>> source

Params:

NameTypeAttributeDescription
startBlockHash Hash
count number
  • optional
forward boolean
  • optional

Return:

Promise<Array<Block>>

public async getBlocksBackward(startBlockHash: Hash, count: number, includeBody: boolean): Promise<Array<Block>> source

Params:

NameTypeAttributeDescription
startBlockHash Hash
count number
includeBody boolean

Return:

Promise<Array<Block>>

public async getBlocksForward(startBlockHash: Hash, count: number): Promise<Array<Block>> source

Params:

NameTypeAttributeDescription
startBlockHash Hash
count number

Return:

Promise<Array<Block>>

public async getChainData(key: Hash, includeBody: boolean): PromiseChainData> source

Params:

NameTypeAttributeDescription
key Hash
includeBody boolean
  • optional

Return:

PromiseChainData>

public async getChainDataAt(height: number, includeBody: boolean): PromiseChainData> source

Params:

NameTypeAttributeDescription
height number
includeBody boolean
  • optional

Return:

PromiseChainData>

public async getChainDataCandidatesAt(height: number): Promise<?Array<ChainData>> source

Params:

NameTypeAttributeDescription
height number

Return:

Promise<?Array<ChainData>>

public async getHead(): Promise<Hash|undefined> source

Return:

Promise<Hash|undefined>

public async getNearestBlockAt(height: number, lower: boolean): PromiseBlock> source

Params:

NameTypeAttributeDescription
height number
lower boolean
  • optional

Return:

PromiseBlock>

public async getRawBlock(key: Hash, includeForks: boolean): PromiseUint8Array> source

Params:

NameTypeAttributeDescription
key Hash
includeForks boolean
  • optional

Return:

PromiseUint8Array>

public async getSuccessorBlocks(block: Block): Promise<Array<Block>> source

Params:

NameTypeAttributeDescription
block Block

Return:

Promise<Array<Block>>

public putChainData(key: Hash, chainData: ChainData, includeBody: boolean): Promise<void> source

Params:

NameTypeAttributeDescription
key Hash
chainData ChainData
includeBody boolean
  • optional

Return:

Promise<void>

public putChainDataSync(key: Hash, chainData: ChainData, includeBody: boolean): void source

Params:

NameTypeAttributeDescription
key Hash
chainData ChainData
includeBody boolean
  • optional

Return:

void

public removeChainDataSync(key: Hash): void source

Params:

NameTypeAttributeDescription
key Hash

Return:

void

public setHead(key: Hash): Promise<void> source

Params:

NameTypeAttributeDescription
key Hash

Return:

Promise<void>

public setHeadSync(key: Hash): void source

Params:

NameTypeAttributeDescription
key Hash

Return:

void

public snapshot(): ChainDataStore source

Return:

ChainDataStore

public synchronousTransaction(enableWatchdog: boolean): ChainDataStore source

Params:

NameTypeAttributeDescription
enableWatchdog boolean
  • optional

Return:

ChainDataStore

public transaction(enableWatchdog: boolean): ChainDataStore source

Params:

NameTypeAttributeDescription
enableWatchdog boolean
  • optional

Return:

ChainDataStore

public truncate(): Promise source

Return:

Promise