Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ckb-devrel/ccc/llms.txt

Use this file to discover all available pages before exploring further.

JoyID is a passkey-based wallet that requires no seed phrase or browser extension. Users authenticate with biometrics (Face ID, Touch ID) or device PIN, making it one of the most accessible wallets for CKB.

​
Installation

npm install @ckb-ccc/joy-id
If you are using @ckb-ccc/connector-react or @ckb-ccc/ccc, JoyID is already included — no separate installation needed.

​
Usage

JoyID is automatically registered when using the CCC connector: 
import { ccc } from "@ckb-ccc/connector-react";

export default function App({ children }) {
  return (
    <ccc.Provider name="My App" icon="/icon.png">
      {children}
    </ccc.Provider>
  );
}
When the user opens the wallet selector, JoyID appears as an option. No additional configuration is required.

​
Signer details

PropertyValue
SignerTypeCKB
SignerSignTypeJoyId
NetworksCKB Mainnet, CKB Testnet

​
Lumos compatibility

JoyID is supported via Lumos patches if you are using the Lumos SDK: 
import { generateDefaultScriptInfos } from "@ckb-ccc/lumos-patches";

// Call before using Lumos — no @ckb-lumos/joyid needed
registerCustomLockScriptInfos(generateDefaultScriptInfos());
See the @ckb-ccc/lumos-patches page for details.

Build docs developers (and LLMs) love

Get started for freeTalk to us