@ckb-ccc/lumos-patches

@ckb-ccc/lumos-patches adds lock script support for JoyID, Nostr (NostrLock), and Portal (PWLock) wallets to the Lumos SDK. If you have an existing Lumos-based application and want to support these wallets without migrating to CCC, apply these patches.

Who needs it

Install @ckb-ccc/lumos-patches if you have an existing Lumos-based codebase and want to:

• Sign transactions with JoyID (no @ckb-lumos/joyid required).
• Sign transactions with Nostr wallets.
• Sign transactions with Portal wallet.

Installation

npm install @ckb-ccc/lumos-patches

yarn add @ckb-ccc/lumos-patches

pnpm add @ckb-ccc/lumos-patches

Exports

Applying the patches

Call generateDefaultScriptInfos() and register the result with Lumos before composing any transactions:

import { generateDefaultScriptInfos } from "@ckb-ccc/lumos-patches";
import { registerCustomLockScriptInfos } from "@ckb-lumos/common-scripts/lib/common";

// Apply patches once at app startup — before using Lumos.
// You no longer need @ckb-lumos/joyid after this.
registerCustomLockScriptInfos(generateDefaultScriptInfos());

After registration, Lumos will be able to collect cells and set up witnesses for the following lock scripts on both mainnet and testnet:

Custom script info

If you need to add a different custom lock, use generateScriptInfo directly:

import { generateScriptInfo } from "@ckb-ccc/lumos-patches";
import { ccc } from "@ckb-ccc/core";

const myLockInfo = generateScriptInfo(
  "0xYOUR_CODE_HASH",
  [
    // array of ccc.CellDepInfoLike
    {
      cellDep: {
        outPoint: { txHash: "0x...", index: 0 },
        depType: "depGroup",
      },
    },
  ],
  65, // dummy lock length in bytes for fee estimation
);

How it works

generateDefaultScriptInfos returns a LockScriptInfo for each supported script on both mainnet and testnet. Each info object:

1. Provides a CellCollector that filters cells matching the lock's code hash.
2. Implements setupInputCell to add the correct cell deps and a dummy witness of the right size (used by Lumos for fee estimation).

The lock scripts are looked up from @ckb-ccc/core's built-in MAINNET_SCRIPTS and TESTNET_SCRIPTS constants, so you don't need to hardcode any hashes.

Lumos version compatibility

This package is tested against:

@ckb-lumos/base              0.24.0-next.2
@ckb-lumos/codec             0.24.0-next.2
@ckb-lumos/common-scripts    0.24.0-next.2
@ckb-lumos/config-manager    0.24.0-next.2
@ckb-lumos/helpers           0.24.0-next.2