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 packages/ckb-indexer/lib/indexer.d.ts:16
new Indexer(ckbIndexerUrl, ckbRpcUrl): Indexer
Parameters
- ckbIndexerUrl: string
- ckbRpcUrl: string
Returns Indexer
- Defined in packages/ckb-indexer/lib/indexer.d.ts:17

Properties

`Private` checkArgs

checkArgs: any

`Private` checkFilterOptions

checkFilterOptions: any

ckbIndexerUri

ckbIndexerUri: string

ckbIndexerUrl

ckbIndexerUrl: string

`Optional` ckbRpcUrl

ckbRpcUrl?: string

`Private` emitMedianTimeEvents

emitMedianTimeEvents: any

emitters

emitters: IndexerEmitter[]

`Private` filterEvents

filterEvents: any

`Private` getCkbRpc

getCkbRpc: any

`Private` getIndexerRpc

getIndexerRpc: any

isSubscribeRunning

isSubscribeRunning: boolean

`Private` loop

loop: any

medianTimeEmitters

medianTimeEmitters: EventEmitter[]

`Private` poll

poll: any

`Private` publishAppendBlockEvents

publishAppendBlockEvents: any

`Private` scheduleLoop

scheduleLoop: any

uri

uri: string

`Static` version

version: string

Methods

asyncSleep

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

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 packages/ckb-indexer/lib/indexer.d.ts:26

getCells

getCells(searchKey, terminator?, searchKeyFilter?): Promise<GetCellsResults>
Parameters
- searchKey: SearchKey
- Optional terminator: Terminator
- Optional searchKeyFilter: SearchKeyFilter
Returns Promise<GetCellsResults>
Implementation of TerminableCellFetcher.getCells
- Defined in packages/ckb-indexer/lib/indexer.d.ts:27

getTransactions

getTransactions<Group>(searchKey, searchKeyFilter?): Promise<IndexerTransactionList<Group>>
Type Parameters
- Group extends boolean = false
Parameters
- searchKey: GetTransactionsSearchKey<Group>
- Optional searchKeyFilter: SearchKeyFilter
Returns Promise<IndexerTransactionList<Group>>
- Defined in packages/ckb-indexer/lib/indexer.d.ts:28

running

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

start

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

startForever

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

stop

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

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

subscribeMedianTime

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

tip

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

waitForSync

waitForSync(blockDifference?): Promise<void>
Parameters
- Optional blockDifference: number
Returns Promise<void>
- Defined in packages/ckb-indexer/lib/indexer.d.ts:22

Class Indexer

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ckbRpcUrl: string

Returns Indexer

Parameters

ckbIndexerUrl: string

ckbRpcUrl: string

Returns Indexer

Properties

Private checkArgs

Private checkFilterOptions

ckbIndexerUri

ckbIndexerUrl

Optional ckbRpcUrl

Private emitMedianTimeEvents

emitters

Private filterEvents

Private getCkbRpc

Private getIndexerRpc

isSubscribeRunning

Private loop

medianTimeEmitters

Private poll

Private publishAppendBlockEvents

Private scheduleLoop

uri

Static version

Methods

asyncSleep

Parameters

timeout: number

Returns Promise<void>

collector

Parameters

queries: CKBIndexerQueryOptions

Optional otherQueryOptions: OtherQueryOptions

Returns indexer.CellCollector

getCells

Parameters

searchKey: SearchKey

Optional terminator: Terminator

Optional searchKeyFilter: SearchKeyFilter

Returns Promise<GetCellsResults>

getTransactions

Type Parameters

Group extends boolean = false

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<Tip>

waitForSync

Parameters

Optional blockDifference: number

Returns Promise<void>

Settings

Member Visibility

`Private` checkArgs

`Private` checkFilterOptions

`Optional` ckbRpcUrl

`Private` emitMedianTimeEvents

`Private` filterEvents

`Private` getCkbRpc

`Private` getIndexerRpc

`Private` loop

`Private` poll

`Private` publishAppendBlockEvents

`Private` scheduleLoop

`Static` version

`Optional` otherQueryOptions: OtherQueryOptions

`Optional` terminator: Terminator

`Optional` searchKeyFilter: SearchKeyFilter

`Optional` searchKeyFilter: SearchKeyFilter

`Optional` blockDifference: number