CkbIndexer | lumos

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

Hierarchy

CkbIndexer

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in packages/ckb-indexer/lib/indexer.d.ts:15
Parameters
- ckbRpcUrl: string
Returns CkbIndexer
- Defined in packages/ckb-indexer/lib/indexer.d.ts:16
Parameters
- ckbIndexerUrl: string
- ckbRpcUrl: string
Returns CkbIndexer

Properties

ckbIndexerUri

ckbIndexerUri: string

ckbIndexerUrl

ckbIndexerUrl: string

Optional ckbRpcUrl

ckbRpcUrl: string | undefined

emitters

emitters: IndexerEmitter[]

isSubscribeRunning

isSubscribeRunning: boolean

medianTimeEmitters

medianTimeEmitters: EventEmitter[]

uri

uri: string

Static version

version: string

Methods

asyncSleep

asyncSleep(timeout: number): Promise<void>

- Defined in packages/ckb-indexer/lib/indexer.d.ts:21
Parameters
- timeout: number
Returns Promise<void>

collector

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

- Defined in packages/ckb-indexer/lib/indexer.d.ts:26
collector cells without blockHash by default.if you need blockHash, please add OtherQueryOptions.withBlockHash and OtherQueryOptions.ckbRpcUrl. don't use OtherQueryOption if you don't need blockHash,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/lib/indexer.d.ts:27
Parameters
- searchKey: SearchKey
- Optional terminator: Terminator
- Optional searchKeyFilter: SearchKeyFilter
Returns Promise<GetCellsResults>

getTransactions

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

- Defined in packages/ckb-indexer/lib/indexer.d.ts:28
Type parameters
- Group: boolean
Parameters
- searchKey: GetTransactionsSearchKey<Group>
- Optional searchKeyFilter: SearchKeyFilter
Returns Promise<IndexerTransactionList<Group>>

running

running(): boolean

- Defined in packages/ckb-indexer/lib/indexer.d.ts:29
Returns boolean

start

start(): void

- Defined in packages/ckb-indexer/lib/indexer.d.ts:30
Returns void

startForever

startForever(): void

- Defined in packages/ckb-indexer/lib/indexer.d.ts:31
Returns void

stop

stop(): void

- Defined in packages/ckb-indexer/lib/indexer.d.ts:32
Returns void

subscribe(queries: CKBIndexerQueryOptions): EventEmitter

- Defined in packages/ckb-indexer/lib/indexer.d.ts:33
Parameters
- queries: CKBIndexerQueryOptions
Returns EventEmitter

subscribeMedianTime

subscribeMedianTime(): EventEmitter

- Defined in packages/ckb-indexer/lib/indexer.d.ts:42
Returns EventEmitter

tip

tip(): Promise<IndexerType.Tip>

- Defined in packages/ckb-indexer/lib/indexer.d.ts:20
Returns Promise<IndexerType.Tip>

waitForSync

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

- Defined in packages/ckb-indexer/lib/indexer.d.ts:22
Parameters
- Optional blockDifference: undefined | number
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ckbRpcUrl: string

Returns CkbIndexer

Parameters

ckbIndexerUrl: string

ckbRpcUrl: string

Returns CkbIndexer

Properties

ckbIndexerUri

ckbIndexerUrl

Optional 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

Optional terminator: Terminator

Optional searchKeyFilter: SearchKeyFilter

Returns Promise<GetCellsResults>

getTransactions

Type parameters

Group: boolean

Parameters

searchKey: GetTransactionsSearchKey<Group>

Optional searchKeyFilter: SearchKeyFilter

Returns Promise<IndexerTransactionList<Group>>

running

Returns boolean

start

Returns void

startForever

Returns void

stop

Returns void

subscribe

Parameters

queries: CKBIndexerQueryOptions

Returns EventEmitter

subscribeMedianTime

Returns EventEmitter

tip

Returns Promise<IndexerType.Tip>

waitForSync

Parameters

Optional blockDifference: undefined | number

Returns Promise<void>