CKB Indexer for Lumos framework, might be suitable for independent usage as well
Last updated 9 days ago by xuejie.nervos .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @ckb-lumos/indexer 
SYNC missed versions from official npm registry.


CKB indexer used in lumos framework. Might be possible for independent usage as well. It is based on a Rust based native indexer for stability and performance.

The indexer is designed to consume from the following sources:

  • Direct access of CKB's data dir via RocksDB's readonly or secondary mode;
  • Consistent queries of CKB's RPC.

It is also designed to store the indexed data in either of the following storage choices:

  • A local RocksDB directory;
  • Remote SQL database, supported databases now include latest stable versions of PostgreSQL and MySQL.

Note for the moment, SQLite is not officially supported, single-node users or Electron users are highly recommended to use the RocksDB solution.


const { Indexer, CellCollector } = require('@ckb-lumos/indexer');
const indexer = new Indexer("", "/tmp/indexed-data")

To query existing cells, you can create a CellCollector:

collector = new CellCollector(indexer, {
  lock: {
    hash_type: "data",
    args: "0x62e907b15cbf27d5425399ebf6f0fb50ebb88f18",

for await (const cell of collector.collect()) {

Prefix search is supported on args.

Similar solution can be used to query for transactions related to a lock script:

txCollector = new TransactionCollector(indexer, {
  lock: {
    hash_type: "data",
    args: "0x62e907b15cbf27d5425399ebf6f0fb50ebb88f18",

for await (const tx of txCollector.collect()) {

Current Tags

  • 0.1.7                                ...           latest (9 days ago)

4 Versions

  • 0.1.7                                ...           9 days ago
  • 0.1.6                                ...           9 days ago
  • 0.1.3                                ...           a month ago
  • 0.1.2                                ...           a month ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 20
Dependencies (6)
Dev Dependencies (2)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |