CkbIndexer | lumos

CkbIndexer.collector will not get cell with block_hash by default, please use OtherQueryOptions.withBlockHash and OtherQueryOptions.CKBRpcUrl to get block_hash if you need.

Hierarchy

CkbIndexer

Implements

Indexer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CkbIndexer(ckbIndexerUrl: string, ckbRpcUrl: string): CkbIndexer

- Defined in packages/ckb-indexer/src/indexer.ts:47
Parameters
- ckbIndexerUrl: string
- ckbRpcUrl: string
Returns CkbIndexer

Properties

ckbIndexerUrl

ckbIndexerUrl: string

ckbRpcUrl

ckbRpcUrl: string

emitters

emitters: IndexerEmitter[] = []

isSubscribeRunning

isSubscribeRunning: boolean = false

medianTimeEmitters

medianTimeEmitters: EventEmitter[] = []

uri

uri: string

Static version

version: string = "0.3.2"

Methods

asyncSleep

asyncSleep(timeout: number): Promise<void>

- Defined in packages/ckb-indexer/src/indexer.ts:61
Parameters
- timeout: number
Returns Promise<void>

collector

collector(queries: CKBIndexerQueryOptions, otherQueryOptions?: OtherQueryOptions): CellCollector

- Defined in packages/ckb-indexer/src/indexer.ts:82
collector cells without block_hash by default.if you need block_hash, please add OtherQueryOptions.withBlockHash and OtherQueryOptions.ckbRpcUrl. don't use OtherQueryOption if you don't need block_hash,cause it will slowly your collect.

Parameters
- queries: CKBIndexerQueryOptions
- Optional otherQueryOptions: OtherQueryOptions
Returns CellCollector

getCells

getCells(searchKey: SearchKey, terminator?: Terminator, searchKeyFilter?: SearchKeyFilter): Promise<GetCellsResults>

- Defined in packages/ckb-indexer/src/indexer.ts:99
Parameters
- searchKey: SearchKey
- Default value terminator: Terminator = DefaultTerminator
- Default value searchKeyFilter: SearchKeyFilter = {}
Returns Promise<GetCellsResults>

getTransactions

getTransactions(searchKey: SearchKey, searchKeyFilter?: SearchKeyFilter): Promise<IndexerTransactionList>

- Defined in packages/ckb-indexer/src/indexer.ts:142
Parameters
- searchKey: SearchKey
- Default value searchKeyFilter: SearchKeyFilter = {}
Returns Promise<IndexerTransactionList>

running

running(): boolean

- Defined in packages/ckb-indexer/src/indexer.ts:166
Returns boolean

start

start(): void

- Defined in packages/ckb-indexer/src/indexer.ts:170
Returns void

startForever

startForever(): void

- Defined in packages/ckb-indexer/src/indexer.ts:177
Returns void

stop

stop(): void

- Defined in packages/ckb-indexer/src/indexer.ts:184
Returns void

subscribe(queries: CKBIndexerQueryOptions): EventEmitter

- Defined in packages/ckb-indexer/src/indexer.ts:191
Parameters
- queries: CKBIndexerQueryOptions
Returns EventEmitter

subscribeMedianTime

subscribeMedianTime(): EventEmitter

- Defined in packages/ckb-indexer/src/indexer.ts:420
Returns EventEmitter

tip

tip(): Promise<Tip>

- Defined in packages/ckb-indexer/src/indexer.ts:56
Returns Promise<Tip>

waitForSync

waitForSync(blockDifference?: number): Promise<void>

- Defined in packages/ckb-indexer/src/indexer.ts:65
Parameters
- Default value blockDifference: number = 0
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ckbIndexerUrl: string

ckbRpcUrl: string

Returns CkbIndexer

Properties

ckbIndexerUrl

ckbRpcUrl

emitters

isSubscribeRunning

medianTimeEmitters

uri

Static version

Methods

asyncSleep

Parameters

timeout: number

Returns Promise<void>

collector

Parameters

queries: CKBIndexerQueryOptions

Optional otherQueryOptions: OtherQueryOptions

Returns CellCollector

getCells

Parameters

searchKey: SearchKey

Default value terminator: Terminator = DefaultTerminator

Default value searchKeyFilter: SearchKeyFilter = {}

Returns Promise<GetCellsResults>

getTransactions

Parameters

searchKey: SearchKey

Default value searchKeyFilter: SearchKeyFilter = {}

Returns Promise<IndexerTransactionList>

running

Returns boolean

start

Returns void

startForever

Returns void

stop

Returns void

subscribe

Parameters

queries: CKBIndexerQueryOptions

Returns EventEmitter

subscribeMedianTime

Returns EventEmitter

tip

Returns Promise<Tip>

waitForSync

Parameters

Default value blockDifference: number = 0

Returns Promise<void>