在浏览器中运行 Lumos

TL;NR

lumos 最初运行时只为支持 NodeJS，并没有考虑运行在 web 环境中。为了在 web 端运行，我们用 ckb-indexer 替换了 native indexer，增加大数库 BI 等一系列升级，使 lumos 可以运行在 web 环境下

下面获取余额的示例，将为你展示如何在你的 web 项目中使用 lumos。

npm install @ckb-lumos/lumos
# yarn add @ckb-lumos/lumos

import { Script, Indexer, BI } from "@ckb-lumos/lumos";
async function main(): Promise<BI> {
  const lock = { code_hash: '0x...', hash_type: 'type', args: '0x...' }
  const CKB_RPC_URL = "https://testnet.ckb.dev/rpc";
  const CKB_INDEXER_URL = "https://testnet.ckb.dev/indexer";
  const indexer = new Indexer(CKB_INDEXER_URL, CKB_RPC_URL);
  const collector = indexer.collector({ lock });
  let balance: BI = BI.from(0);
  for await (const cell of collector.collect()) {
    balance = balance.add(cell.cell_output.capacity);
  }
  return balance;
}
main();

完整的示例请参考 ckb-indexer-collector example

ckb-indexer

因为 @ckb-lumos/indexer 和 @ckb-lumos/sql-indexer 使用时需要在本地启动数据库和编译代码，无法在 web 端运行，所以我们推出了 @ckb-lumos/ckb-indexer, 并逐步移除了 @ckb-lumos/indexer 和 @ckb-lumos/sql-indexer . @ckb-lumos/ckb-indexer 的使用示例如下.

const { Indexer } = require ("@ckb-lumos/ckb-indexer");
const nodeUri = "https://testnet.ckb.dev/rpc";
const indexUri = "https://testnet.ckb.dev/indexer";
const indexer = new Indexer (indexUri, nodeUri);

具体使用教程，请参考 ckb-indexer 使用指导.

如需从 @ckb-lumos/indexer 迁移到 @ckb-lumos/ckb-indexer , 请参考迁移文档.

root package

@ckb-lumos 组织下有多个包，例如 @ckb-lumos/helpers,@ckb-lumos/config 等。用户在使用的时候需要单独引用一个包。比如要使用 parseAddress 就要引用 @ckb-lumos/helpers. 使用 initializeConfig 就要引用 @ckb-lumos/config

为了方便用户使用，我们推出了新的 @ckb-lumos/lumos 包。包含所有的子包，无需再逐一引入子包.

import {
  Script,
  Indexer as CkbIndexer,
  helpers,
  config,
} from "@ckb-lumos/lumos";
config.initializeConfig(config.predefined.AGGRON4);
const address = "ckt1qyqxgftlqzmtv05cwcyl4xlz6ryx6dgsyrasjrp27t";
const lock: Script = helpers.parseAddress(address);

BI 大数库

为了方便大数的计算，我们提供了大数库 BI. 可以进行字符串，数字等和 BI 的相互转换和一些常见运算.

import { BI } from "@ckb-lumos/bi";
BI.from (1).add (1)

更多使用 API 请参考 BI 测试用例

后续计划

整合 moleculec.
提供更多的工具函数，方便操作交易结构.
整合 standalone debugger 让单元测试脱链.

在浏览器中运行 Lumos

TL;NR​

ckb-indexer​

root package​

BI 大数库​

更多更新​

后续计划​

TL;NR

ckb-indexer

root package

BI 大数库

更多更新

后续计划