CCC ships as a collection of focused npm packages. Install only what your project requires.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.
Packages
@ckb-ccc/core
Low-level CKB primitives: Transaction, Signer, Client, Address, Script, and
all encoding utilities.
@ckb-ccc/shell
Node.js / backend usage. Includes core, spore, udt, and ssri — everything
you need for server-side scripts.
@ckb-ccc/ccc
All-in-one bundle with all wallet integrations. Use for custom UI or when
you need every wallet available in a single import.
@ckb-ccc/connector
Framework-agnostic Web Component connector. Drop a
<ccc-connector> element
into any HTML page.@ckb-ccc/connector-react
React
Provider component and useCcc() hook for wallet integration with
minimal boilerplate.@ckb-ccc/spore
Spore Protocol SDK — create, transfer, and melt on-chain digital objects
(DOBs) and clusters.
@ckb-ccc/udt
UDT and xUDT token SDK — issue, transfer, and mint User Defined Tokens on
CKB.
@ckb-ccc/ssri
SSRI (Script-Sourced Rich Information) protocol support for interacting with
CKB smart contracts.
@ckb-ccc/lumos-patches
Compatibility patches that enable the Lumos SDK to work with JoyID, Nostr,
and Portal wallets.
@ckb-ccc/joy-id
JoyID passkey-based wallet integration — no seed phrase required.
@ckb-ccc/eip6963
EIP-6963 multi-wallet discovery for EVM wallets such as MetaMask and Rabby.
@ckb-ccc/nip07
Nostr NIP-07 wallet integration for signing with Nostr browser extensions.
Package reference
| Package | Purpose | Install |
|---|---|---|
@ckb-ccc/core | CKB primitives and encoding | npm install @ckb-ccc/core |
@ckb-ccc/shell | Node.js / backend scripting | npm install @ckb-ccc/shell |
@ckb-ccc/ccc | All-in-one for custom UI | npm install @ckb-ccc/ccc |
@ckb-ccc/connector | Web Component connector | npm install @ckb-ccc/connector |
@ckb-ccc/connector-react | React connector | npm install @ckb-ccc/connector-react |
@ckb-ccc/spore | Spore Protocol SDK | npm install @ckb-ccc/spore |
@ckb-ccc/udt | UDT / xUDT token SDK | npm install @ckb-ccc/udt |
@ckb-ccc/ssri | SSRI protocol | npm install @ckb-ccc/ssri |
@ckb-ccc/lumos-patches | Lumos compatibility | npm install @ckb-ccc/lumos-patches |
@ckb-ccc/joy-id | JoyID wallet | npm install @ckb-ccc/joy-id |
@ckb-ccc/eip6963 | EVM wallets (EIP-6963) | npm install @ckb-ccc/eip6963 |
@ckb-ccc/nip07 | Nostr NIP-07 wallet | npm install @ckb-ccc/nip07 |
Import pattern
All packages expose their public API on a singleccc namespace object:
cccA:
Your
tsconfig.json must set moduleResolution to node16, nodenext, or
bundler and must not disable resolvePackageJsonExports. CCC uses Package
Entry Points
for tree shaking.