CKBC(oin)

CKBC(oin) is a CKB-backed coin project built on Nervos CKB. Its goal is to make CKB available to more applications in the form of a standard token.

Users can deposit CKB into a public Vault and receive CKBC at a rate of 1 CKB = 1 CKBC. CKBC can be transferred freely or redeemed 1:1 for CKB from the Vault. The project includes a smart contract, a TypeScript SDK, and a ready-to-use web application.

The application currently supports CKB Testnet only. Please use a testnet wallet and testnet assets.

See docs/ckbc.md for the protocol design and validation rules.

Project Structure

.
├── app/       Web app for wallet connection, deposits, redemptions, transfers, and transaction history
├── lib/       CKBC TypeScript SDK and testnet deployment configuration
├── scripts/   Vault smart contract and contract tests
└── docs/      Protocol documentation

Run Locally

Node.js and pnpm are required.

pnpm install
pnpm --filter ckbc build
pnpm --filter app dev

Open http://localhost:3000 in your browser.

Build and Test

# Build the SDK and web app
pnpm build

# Run SDK tests
pnpm --filter ckbc test:ci

# Run smart contract tests
cd scripts
make test

See scripts/README.md for smart contract build requirements and network configuration.