Class Indexer

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

Hierarchy

Indexer

Implements

CellProvider
TerminableCellFetcher

Constructors

constructor

new Indexer(ckbRpcUrl): Indexer
Parameters
- ckbRpcUrl: string
Returns Indexer
- Defined in ckb-indexer/src/indexer.ts:55
new Indexer(ckbIndexerUrl, ckbRpcUrl): Indexer
Parameters
- ckbIndexerUrl: string
- ckbRpcUrl: string
Returns Indexer
- Defined in ckb-indexer/src/indexer.ts:56

Properties

ckbIndexerUri

ckbIndexerUri: string

ckbIndexerUrl

ckbIndexerUrl: string

`Optional` ckbRpcUrl

ckbRpcUrl?: string

emitters

emitters: IndexerEmitter[] = []

isSubscribeRunning

isSubscribeRunning: boolean = false

medianTimeEmitters

medianTimeEmitters: EventEmitter[] = []

uri

uri: string

`Static` version

version: string = "0.4.1"

Methods

asyncSleep

asyncSleep(timeout): Promise<void>
Parameters
- timeout: number
Returns Promise<void>
- Defined in ckb-indexer/src/indexer.ts:83

`Private` checkArgs

checkArgs(argsLen, emitterArgs, args): boolean
Parameters
- argsLen: undefined | number | "any"
- emitterArgs: string
- args: string
Returns boolean
- Defined in ckb-indexer/src/indexer.ts:363

`Private` checkFilterOptions

checkFilterOptions(emitter, blockNumber, outputData, emitterScript, script): boolean
Parameters
- emitter: IndexerEmitter
- blockNumber: string
- outputData: string
- emitterScript: Script
- script: undefined | Script
Returns boolean
- Defined in ckb-indexer/src/indexer.ts:341

collector

collector(queries, otherQueryOptions?): indexer.CellCollector
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 indexer.CellCollector
Implementation of CellProvider.collector
- Defined in ckb-indexer/src/indexer.ts:104

`Private` emitMedianTimeEvents

emitMedianTimeEvents(): Promise<void>
Returns Promise<void>
- Defined in ckb-indexer/src/indexer.ts:379

`Private` filterEvents

filterEvents(output, blockNumber, outputData): void
Parameters
- output: Output
- blockNumber: string
- outputData: string
Returns void
- Defined in ckb-indexer/src/indexer.ts:304

getCells

getCells(searchKey, terminator?, searchKeyFilter?): Promise<GetCellsResults>
Parameters
- searchKey: SearchKey
- terminator: Terminator = DefaultTerminator
- searchKeyFilter: SearchKeyFilter = {}
Returns Promise<GetCellsResults>
Implementation of TerminableCellFetcher.getCells
- Defined in ckb-indexer/src/indexer.ts:111

`Private` getCkbRpc

getCkbRpc(): RPC
Returns RPC
- Defined in ckb-indexer/src/indexer.ts:62

`Private` getIndexerRpc

getIndexerRpc(): IndexerRpc
Returns IndexerRpc
- Defined in ckb-indexer/src/indexer.ts:67

getTransactions

getTransactions<Group>(searchKey, searchKeyFilter?): Promise<IndexerTransactionList<Group>>
Type Parameters
- Group extends boolean = false
Parameters
- searchKey: GetTransactionsSearchKey<Group>
- searchKeyFilter: SearchKeyFilter = {}
Returns Promise<IndexerTransactionList<Group>>
- Defined in ckb-indexer/src/indexer.ts:123

`Private` loop

loop(): void
Returns void
- Defined in ckb-indexer/src/indexer.ts:212

`Private` poll

poll(): Promise<number>
Returns Promise<number>
- Defined in ckb-indexer/src/indexer.ts:235

`Private` publishAppendBlockEvents

publishAppendBlockEvents(block): Promise<void>
Parameters
- block: Block
Returns Promise<void>
- Defined in ckb-indexer/src/indexer.ts:268

running

running(): boolean
Returns boolean
- Defined in ckb-indexer/src/indexer.ts:151

`Private` scheduleLoop

scheduleLoop(timeout?): void
Parameters
- timeout: number = 1
Returns void
- Defined in ckb-indexer/src/indexer.ts:229

start

start(): void
Returns void
- Defined in ckb-indexer/src/indexer.ts:155

startForever

startForever(): void
Returns void
- Defined in ckb-indexer/src/indexer.ts:162

stop

stop(): void
Returns void
- Defined in ckb-indexer/src/indexer.ts:169

subscribe(queries): EventEmitter
Parameters
- queries: CKBIndexerQueryOptions
Returns EventEmitter
- Defined in ckb-indexer/src/indexer.ts:176

subscribeMedianTime

subscribeMedianTime(): EventEmitter
Returns EventEmitter
- Defined in ckb-indexer/src/indexer.ts:390

tip

tip(): Promise<Tip>
Returns Promise<Tip>
- Defined in ckb-indexer/src/indexer.ts:79

waitForSync

waitForSync(blockDifference?): Promise<void>
Parameters
- blockDifference: number = 0
Returns Promise<void>
- Defined in ckb-indexer/src/indexer.ts:87

Class Indexer

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ckbRpcUrl: string

Returns Indexer

Parameters

ckbIndexerUrl: string

ckbRpcUrl: string

Returns Indexer

Properties

ckbIndexerUri

ckbIndexerUrl

Optional ckbRpcUrl

emitters

isSubscribeRunning

medianTimeEmitters

uri

Static version

Methods

asyncSleep

Parameters

timeout: number

Returns Promise<void>

Private checkArgs

Parameters

argsLen: undefined | number | "any"

emitterArgs: string

args: string

Returns boolean

Private checkFilterOptions

Parameters

emitter: IndexerEmitter

blockNumber: string

outputData: string

emitterScript: Script

script: undefined | Script

Returns boolean

collector

Parameters

queries: CKBIndexerQueryOptions

Optional otherQueryOptions: OtherQueryOptions

Returns indexer.CellCollector

Private emitMedianTimeEvents

Returns Promise<void>

Private filterEvents

Parameters

output: Output

blockNumber: string

outputData: string

Returns void

getCells

Parameters

searchKey: SearchKey

terminator: Terminator = DefaultTerminator

searchKeyFilter: SearchKeyFilter = {}

Returns Promise<GetCellsResults>

Private getCkbRpc

Returns RPC

Private getIndexerRpc

Returns IndexerRpc

getTransactions

Type Parameters

Group extends boolean = false

Parameters

searchKey: GetTransactionsSearchKey<Group>

searchKeyFilter: SearchKeyFilter = {}

Returns Promise<IndexerTransactionList<Group>>

Private loop

Returns void

Private poll

Returns Promise<number>

Private publishAppendBlockEvents

Parameters

`Optional` ckbRpcUrl

`Static` version

`Private` checkArgs

`Private` checkFilterOptions

`Optional` otherQueryOptions: OtherQueryOptions

`Private` emitMedianTimeEvents

`Private` filterEvents

`Private` getCkbRpc

`Private` getIndexerRpc

`Private` loop

`Private` poll

`Private` publishAppendBlockEvents

`Private` scheduleLoop