@bsv/wallet-toolbox
Version:
BRC100 conforming wallet, wallet storage and wallet signer components
62 lines • 1.94 kB
TypeScript
import { Chain } from '../../../../sdk/types';
import { LiveIngestorApi } from '../Api/LiveIngestorApi';
import { ChaintracksStorageApi } from '../Api/ChaintracksStorageApi';
import { BlockHeader } from '../Api/BlockHeaderApi';
export interface LiveIngestorBaseOptions {
/**
* The target chain: "main" or "test"
*/
chain: Chain;
}
/**
*
*/
export declare abstract class LiveIngestorBase implements LiveIngestorApi {
static createLiveIngestorBaseOptions(chain: Chain): LiveIngestorBaseOptions;
chain: Chain;
log: (...args: any[]) => void;
constructor(options: LiveIngestorBaseOptions);
/**
* Release resources.
* Override if required.
*/
shutdown(): Promise<void>;
private storageEngine?;
/**
* Allocate resources.
* @param storage coordinating storage engine.
*/
setStorage(storage: ChaintracksStorageApi, log: (...args: any[]) => void): Promise<void>;
/**
*
* @returns coordinating storage engine.
*/
storage(): ChaintracksStorageApi;
/**
* Called to retrieve a missing block header,
* when the previousHash of a new header is unknown.
*
* @param hash block hash of missing header
*/
abstract getHeaderByHash(hash: string): Promise<BlockHeader | undefined>;
/**
* Begin retrieving new block headers.
*
* New headers are pushed onto the liveHeaders array.
*
* Continue waiting for new headers.
*
* Return only when either `stopListening` or `shutdown` are called.
*
* Be prepared to resume listening after `stopListening` but not
* after `shutdown`.
*
* @param liveHeaders
*/
abstract startListening(liveHeaders: BlockHeader[]): Promise<void>;
/**
* Causes `startListening` to stop listening for new block headers and return.
*/
abstract stopListening(): void;
}
//# sourceMappingURL=LiveIngestorBase.d.ts.map