diff --git a/.github/workflows/llms-full.yaml b/.github/workflows/llms-full.yaml new file mode 100644 index 000000000..7556ddd7d --- /dev/null +++ b/.github/workflows/llms-full.yaml @@ -0,0 +1,40 @@ +name: llms-full + +on: + push: + branches: [master] + paths: + - website/docs/** + - website/static/llms.txt + - scripts/generate-llms-full.js + +permissions: + contents: write + +jobs: + regenerate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + ref: master + + - uses: actions/setup-node@v4 + with: + node-version: 20 + + - name: Generate llms-full + run: node scripts/generate-llms-full.js + + - name: Commit llms-full + run: | + if git diff --quiet -- website/static/llms-full.txt; then + echo "llms-full.txt is already up to date" + exit 0 + fi + + git config user.name "github-actions[bot]" + git config user.email "41898282+github-actions[bot]@users.noreply.github.com" + git add website/static/llms-full.txt + git commit -m "docs: update llms-full" + git push origin master diff --git a/scripts/generate-llms-full.js b/scripts/generate-llms-full.js index b92f383cf..de1b591f5 100644 --- a/scripts/generate-llms-full.js +++ b/scripts/generate-llms-full.js @@ -37,17 +37,41 @@ function parseFrontmatter(content) { const raw = match[1]; const meta = {}; + let currentArrayKey = null; + + function cleanValue(value) { + value = value.trim(); + if (value.startsWith('"') && value.endsWith('"')) { + return value.slice(1, -1); + } + if (value.startsWith("'") && value.endsWith("'")) { + return value.slice(1, -1); + } + return value; + } + for (const line of raw.split("\n")) { + const arrayItemMatch = line.match(/^\s+-\s+(.*)$/); + if (currentArrayKey && arrayItemMatch) { + meta[currentArrayKey].push(cleanValue(arrayItemMatch[1])); + continue; + } + const m = line.match(/^([a-zA-Z0-9_-]+):\s*(.*)$/); if (m) { - let value = m[2].trim(); - if (value.startsWith('"') && value.endsWith('"')) { - value = value.slice(1, -1); - } else if (value.startsWith("'") && value.endsWith("'")) { - value = value.slice(1, -1); + const key = m[1]; + const value = m[2].trim(); + if (value === "") { + meta[key] = []; + currentArrayKey = key; + } else { + meta[key] = cleanValue(value); + currentArrayKey = null; } - meta[m[1]] = value; + continue; } + + currentArrayKey = null; } return { frontmatter: match[0], body: content.slice(match[0].length), meta }; } @@ -295,6 +319,29 @@ function getDocUrl(filePath, meta) { return `https://docs.nervos.org/docs/${withoutExt}`; } +function formatPageMetadata(meta) { + const fields = [ + ["description", "Description"], + ["tags", "Tags"], + ["audience", "Audience"], + ["related", "Related"], + ["difficulty", "Difficulty"], + ["last_reviewed", "Last reviewed"], + ]; + const lines = []; + + for (const [key, label] of fields) { + const value = meta[key]; + if (Array.isArray(value) && value.length > 0) { + lines.push(`${label}: ${value.join(", ")}`); + } else if (typeof value === "string" && value.length > 0) { + lines.push(`${label}: ${value}`); + } + } + + return lines.length > 0 ? `${lines.join("\n")}\n\n` : ""; +} + function main() { const files = walk(DOCS_DIR).sort(); @@ -328,6 +375,7 @@ function main() { output += `---\n\n`; output += `## Source: ${relative}\n`; output += `URL: ${url}\n\n`; + output += formatPageMetadata(meta); output += cleaned; output += "\n\n"; } diff --git a/website/docs/ckb-fundamentals/cell-model.md b/website/docs/ckb-fundamentals/cell-model.md index a46b2714c..00870b5e1 100644 --- a/website/docs/ckb-fundamentals/cell-model.md +++ b/website/docs/ckb-fundamentals/cell-model.md @@ -1,6 +1,23 @@ --- id: cell-model title: Cell Model +description: "Understand CKB's generalized UTXO Cell Model, including Live Cells, Dead Cells, capacity, ownership, state rent, and scalability." +tags: + - concept + - cell-model + - utxo + - capacity + - transaction +audience: + - dApp developers + - Script developers +related: + - /docs/getting-started/how-ckb-works + - /docs/tech-explanation/cell + - /docs/tech-explanation/capacity + - /docs/tech-explanation/transaction +difficulty: beginner +last_reviewed: 2026-06-24 --- > Nervos CKB inherits Bitcoin’s architecture and creates the Cell Model, a generalized UTXO model as state storage. diff --git a/website/docs/ckb-fundamentals/nervos-blockchain.md b/website/docs/ckb-fundamentals/nervos-blockchain.md index a0dffa9d2..f0bfad58a 100644 --- a/website/docs/ckb-fundamentals/nervos-blockchain.md +++ b/website/docs/ckb-fundamentals/nervos-blockchain.md @@ -1,6 +1,22 @@ --- id: nervos-blockchain title: Nervos Blockchain +description: "Get a beginner overview of Nervos CKB as a layered, proof-of-work blockchain for CKBytes, on-chain state, and CKB-VM programs." +tags: + - concept + - layer-1 + - ckb-vm + - consensus +audience: + - dApp developers + - Script developers +related: + - /docs/getting-started/how-ckb-works + - /docs/ckb-fundamentals/cell-model + - /docs/ckb-fundamentals/ckb-vm + - /docs/ckb-fundamentals/consensus +difficulty: beginner +last_reviewed: 2026-06-24 --- ## What is the Nervos Blockchain? @@ -32,9 +48,9 @@ Further information about CKByte will be presented in the [Cell Model](cell-mode ## Programming on Nervos -Nervos offers smart contract programmability using a growing number of well-known general-purpose programming languages, such as Javascript, Rust, and C. +Nervos offers smart contract programmability using a growing number of well-known general-purpose programming languages, such as JavaScript, Rust, and C. -All programs on Nervos can store data and state on-chain，which makes creating complex applications and customized tokens a simple and straightforward process. +All programs on Nervos can store data and state on-chain, which makes creating complex applications and customized tokens a simple and straightforward process. All code runs in CKB-VM. CKB-VM is a high-performance RISC-V virtual machine that provides a secure, consistent and flexible environment for developers. Multiple instances of CKB-VM can execute different smart contracts concurrently, which enables substantial scaling improvements through massive parallelization. diff --git a/website/docs/dapp/create-dob.mdx b/website/docs/dapp/create-dob.mdx index 0e179f88e..d6f2ddf06 100644 --- a/website/docs/dapp/create-dob.mdx +++ b/website/docs/dapp/create-dob.mdx @@ -1,6 +1,22 @@ --- id: create-dob title: Create a DOB +description: "Build a dApp that uses the Spore protocol to turn user-provided content into an immutable on-chain digital object on CKB." +tags: + - dapp + - tutorial + - spore + - cell-data + - ccc +audience: + - dApp developers +related: + - /docs/assets-token-standards/spore-protocol + - /docs/dapp/store-data-on-cell + - /docs/dapp/create-token + - /docs/sdk-and-devtool/ccc +difficulty: intermediate +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; @@ -170,7 +186,7 @@ const renderSpore = async () => { ## Congratulations! -By following this tutorial this far, you have mastered how digital-object works on CKB. Here's a quick recap: +After following this tutorial, you have mastered how digital objects work on CKB. Here's a quick recap: - How Spore protocol works on CKB - Create an on-chain digital object with a picture via Spore-SDK diff --git a/website/docs/dapp/create-token.mdx b/website/docs/dapp/create-token.mdx index d839e26aa..437639dc8 100644 --- a/website/docs/dapp/create-token.mdx +++ b/website/docs/dapp/create-token.mdx @@ -1,6 +1,22 @@ --- id: create-token title: Create a Fungible Token +description: "Issue and query a custom fungible token on CKB using the xUDT standard, Type Scripts, Cell data, and the CCC SDK." +tags: + - dapp + - tutorial + - xudt + - type-script + - ccc +audience: + - dApp developers +related: + - /docs/assets-token-standards/xudt + - /docs/dapp/transfer-ckb + - /docs/dapp/create-dob + - /docs/sdk-and-devtool/ccc +difficulty: intermediate +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; @@ -209,7 +225,7 @@ const txHash = await signer.sendTransaction(tx); ## Congratulations! -By following this tutorial this far, you have mastered how custom tokens work on CKB. Here's a quick recap: +After following this tutorial, you have mastered how custom tokens work on CKB. Here's a quick recap: - Create a CKB transaction containing a xUDT Cell in the outputs - The data of the xUDT Cell contains the amount number of the token diff --git a/website/docs/dapp/simple-lock.mdx b/website/docs/dapp/simple-lock.mdx index d1771963d..4e18dd9e9 100644 --- a/website/docs/dapp/simple-lock.mdx +++ b/website/docs/dapp/simple-lock.mdx @@ -1,6 +1,23 @@ --- id: simple-lock title: Build a Simple Lock +description: "Build a full-stack CKB dApp with a simple hash Lock Script, Script deployment, frontend integration, and token unlocking flow." +tags: + - dapp + - tutorial + - script + - lock-script + - ckb-js-vm +audience: + - dApp developers + - Script developers +related: + - /docs/script/intro-to-script + - /docs/script/js/js-vm + - /docs/script/rust/rust-example-simple-lock + - /docs/dapp/transfer-ckb +difficulty: advanced +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; diff --git a/website/docs/dapp/transfer-ckb.mdx b/website/docs/dapp/transfer-ckb.mdx index aaac634f6..69c852735 100644 --- a/website/docs/dapp/transfer-ckb.mdx +++ b/website/docs/dapp/transfer-ckb.mdx @@ -1,6 +1,22 @@ --- id: transfer-ckb title: Transfer CKB +description: "Build a simple dApp that generates accounts, checks CKB balances, creates a transfer transaction, pays fees, and broadcasts it." +tags: + - dapp + - tutorial + - ccc + - transaction + - cell-model +audience: + - dApp developers +related: + - /docs/getting-started/quick-start + - /docs/sdk-and-devtool/ccc + - /docs/dapp/write-message + - /docs/ckb-fundamentals/cell-model +difficulty: beginner +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; @@ -73,7 +89,7 @@ export async function capacityOf(address: string): Promise { ``` :::tip -In Nervos CKB, Shannon is the smallest currency unit, with 1 CKB = 10^8 Shannons. This unit system is similar to Bitcoin's Satoshis, where 1 Bitcoin = 10^8 Satoshis. In CCC SDK, the value handle are mostly done in the **Shannon unit**. +In Nervos CKB, Shannon is the smallest currency unit, with 1 CKB = 10^8 Shannons. This unit system is similar to Bitcoin's Satoshis, where 1 Bitcoin = 10^8 Satoshis. In the CCC SDK, values are mostly handled in the **Shannon unit**. ::: Next, we can start to transfer balance. Check out the transfer function in `lib.ts`: @@ -148,7 +164,7 @@ You can open the console on the browser to see the full transaction to confirm t ## Congratulations! -By following this tutorial this far, you have mastered how balance transfers work on CKB. Here's a quick recap: +After following this tutorial, you have mastered how balance transfers work on CKB. Here's a quick recap: - The capacity of a Cell indicates both the CKB balance and the amount of data that can be stored in the Cell simultaneously. - Transferring CKB balance involves transferring some Cells from the sender to the receiver. diff --git a/website/docs/dapp/write-message.mdx b/website/docs/dapp/write-message.mdx index 1eac3f0cb..5eda2cddc 100644 --- a/website/docs/dapp/write-message.mdx +++ b/website/docs/dapp/write-message.mdx @@ -1,6 +1,22 @@ --- id: store-data-on-cell title: Store Data on Cell +description: "Build a dApp that writes a text message into CKB Cell data, then reads the Live Cell back and decodes the stored value." +tags: + - dapp + - tutorial + - cell-data + - cell-model + - ccc +audience: + - dApp developers +related: + - /docs/dapp/transfer-ckb + - /docs/ckb-fundamentals/cell-model + - /docs/tech-explanation/outputs-data + - /docs/sdk-and-devtool/ccc +difficulty: beginner +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; @@ -19,7 +35,7 @@ import ExampleLink from "@components/ExampleLink"; In this tutorial, you will learn how to tuck a nifty message - "**Hello CKB!**" - into a Cell on the CKB blockchain. Imagine it as sending a message in a bottle, but the ocean is digital, and the bottle is a super secure, tamper-proof CKB Cell! -As you have learned from the first tutorial [Transfer CKB](/docs/dapp/transfer-ckb), the Cell can store any type of data in the data field of Cell structure. Here we will put a text message encoding in hex string format and store it in the data field. Once your words are encoded and inscribed into the blockchain, we'll then get the hex string from the same Cell back and then decode them to the original text message. the method of encoding and decoding is totally up to your favorite, we use the `TextDecoder` for simplicity through the tutorial. +As you learned from the first tutorial, [Transfer CKB](/docs/dapp/transfer-ckb), a Cell can store any type of data in the data field of the Cell structure. Here, we will encode a text message as a hex string and store it in the data field. Once your words are encoded and inscribed into the blockchain, we'll get the hex string back from the same Cell and decode it to the original text message. The encoding and decoding method is up to you; we use `TextDecoder` for simplicity throughout the tutorial. ## Setup Devnet & Run Example @@ -40,11 +56,11 @@ You can also read the full code online or download it {" "} As a result: @@ -101,8 +118,8 @@ A Script in CKB is a binary executable that can be executed on-chain. It is a />{" "} - `code_hash` : identifies the Script code to be loaded into the CKB-VM -- `hash_type` : indicates the the method CKB-VM uses to locate the Script code or Script. -- `args` : provides specific arguments that differentiate one Script from another, such as a users’s public key hash. +- `hash_type` : indicates the method CKB-VM uses to locate the Script code or Script. +- `args` : provides specific arguments that differentiate one Script from another, such as a user’s public key hash. There’re two main types of Scripts: diff --git a/website/docs/getting-started/quick-start.mdx b/website/docs/getting-started/quick-start.mdx index 9dac0ead6..fdd66326b 100644 --- a/website/docs/getting-started/quick-start.mdx +++ b/website/docs/getting-started/quick-start.mdx @@ -1,6 +1,24 @@ --- id: quick-start title: Quick Start (5min) +description: "Set up a local CKB devnet with OffCKB and choose the right next path for building dApps, scripts, nodes, or core concepts." +tags: + - getting-started + - devnet + - offckb + - dapp + - script +audience: + - dApp developers + - Script developers + - Node operators +related: + - /docs/dapp/transfer-ckb + - /docs/script/rust/rust-quick-start + - /docs/getting-started/how-ckb-works + - /docs/ckb-fundamentals/cell-model +difficulty: beginner +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; diff --git a/website/docs/getting-started/rpcs.mdx b/website/docs/getting-started/rpcs.mdx index 3a91a35b4..5ffb98610 100644 --- a/website/docs/getting-started/rpcs.mdx +++ b/website/docs/getting-started/rpcs.mdx @@ -1,6 +1,22 @@ --- id: rpcs title: RPCs +description: "Connect to CKB JSON-RPC endpoints, use public RPC nodes safely, and call common methods such as get_tip_block_number and send_transaction." +tags: + - rpc + - node + - json-rpc + - transaction +audience: + - dApp developers + - Node operators +related: + - /docs/node/install-ckb + - /docs/node/run-mainnet-node + - /docs/node/run-testnet-node + - /docs/sdk-and-devtool/ccc +difficulty: intermediate +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; @@ -43,7 +59,7 @@ CKB exposes a set of RPCs in [JSON-RPC 2.0](https://www.jsonrpc.org/specificatio ## Basic Usage -The following commands uses [get_tip_block_number](https://github.com/nervosnetwork/ckb/blob/master/rpc/README.md#get_tip_block_number) RPC to fetch the `tip` block number, of the latest block number in the longest blockchain: +The following command uses the [get_tip_block_number](https://github.com/nervosnetwork/ckb/blob/master/rpc/README.md#get_tip_block_number) RPC to fetch the `tip` block number, the latest block number in the longest blockchain: ```mdx-code-block @@ -76,7 +92,7 @@ http://localhost:8114 ``` -The following commands uses `send_transaction` RPC to send transactions to the CKB network: +The following command uses the `send_transaction` RPC to send transactions to the CKB network: ```mdx-code-block @@ -153,7 +169,7 @@ http://localhost:8114 ``` -It should be noted that `send_transaction` is asynchronous, that is, the return of the transaction hash, does not mean that the transaction is fully verified, if you need to follow up on the status of the transaction, it is recommended to use the following get_transaction rpc： +It should be noted that `send_transaction` is asynchronous. Returning the transaction hash does not mean that the transaction is fully verified. If you need to follow up on the status of the transaction, use the following `get_transaction` RPC: ```mdx-code-block diff --git a/website/docs/node/install-ckb.mdx b/website/docs/node/install-ckb.mdx index 3fe87f012..6502f5724 100644 --- a/website/docs/node/install-ckb.mdx +++ b/website/docs/node/install-ckb.mdx @@ -1,6 +1,22 @@ --- id: install-ckb title: Install CKB +description: "Install the CKB binary from releases, source, or Docker, then proceed to Mainnet, Testnet, or Docker node setup." +tags: + - node + - install + - mainnet + - testnet + - docker +audience: + - Node operators +related: + - /docs/node/run-mainnet-node + - /docs/node/run-testnet-node + - /docs/node/run-node-docker + - /docs/getting-started/rpcs +difficulty: beginner +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; diff --git a/website/docs/script/intro-to-script.mdx b/website/docs/script/intro-to-script.mdx index 6bf132ebb..7fd4a1154 100644 --- a/website/docs/script/intro-to-script.mdx +++ b/website/docs/script/intro-to-script.mdx @@ -1,6 +1,22 @@ --- id: intro-to-script title: "Intro to Script" +description: "Learn what CKB Scripts are, how Lock Scripts and Type Scripts execute, and how code_hash, hash_type, and args locate Script code." +tags: + - script + - concept + - lock-script + - type-script + - ckb-vm +audience: + - Script developers +related: + - /docs/script/rust/rust-quick-start + - /docs/tech-explanation/script + - /docs/tech-explanation/lock-script + - /docs/tech-explanation/type-script +difficulty: beginner +last_reviewed: 2026-06-24 --- import Tooltip from "@components/Tooltip"; @@ -26,7 +42,7 @@ A Script can be one of two types: In most cases, Lock Script and Type Script function similarly. The only key difference is that, the output Cells' Lock Scripts will NOT be executed in a transaction, whereas the input Cells' Lock Scripts, the input Cells' Type Scripts, and the output Cells' Type Scripts will be executed. -This difference has led to the different usecases of Lock Script and Type Script as we have mentioned above. Lock Script is often used to control owner ship of a Cell while Type Script defines what kinds of changes of a Cell is valid for the transaction. +This difference has led to the different use cases of Lock Script and Type Script as we have mentioned above. Lock Script is often used to control ownership of a Cell, while Type Script defines what kinds of changes to a Cell are valid for the transaction. ## Script Structure diff --git a/website/docs/script/rust/rust-quick-start.mdx b/website/docs/script/rust/rust-quick-start.mdx index 564440082..775f58516 100644 --- a/website/docs/script/rust/rust-quick-start.mdx +++ b/website/docs/script/rust/rust-quick-start.mdx @@ -1,6 +1,23 @@ --- id: rust-quick-start title: "Quick Start" +description: "Create, build, test, and debug CKB Scripts in Rust using the recommended project template, no_std setup, and local examples." +tags: + - script + - tutorial + - rust + - ckb-vm + - testing +audience: + - Rust developers + - Script developers +related: + - /docs/script/intro-to-script + - /docs/script/rust/rust-build + - /docs/script/rust/rust-test + - /docs/script/rust/rust-debug +difficulty: intermediate +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; @@ -28,7 +45,7 @@ import ExampleLink from "@site/src/components/ExampleLink"; ]} /> -This chapter provides a step-by-step guide on developing contracts with Rust on CKB with several examples. As a "Quick Start" guide, it will not diving into in-depth details. For a more comprehensive understanding, please refer to the subsequent chapters. +This chapter provides a step-by-step guide on developing contracts with Rust on CKB with several examples. As a "Quick Start" guide, it will not go into deep detail. For a more comprehensive understanding, please refer to the subsequent chapters. Before proceeding, you should be familiar with: diff --git a/website/docs/sdk-and-devtool/ccc.mdx b/website/docs/sdk-and-devtool/ccc.mdx index e6ad21325..3215b27fd 100644 --- a/website/docs/sdk-and-devtool/ccc.mdx +++ b/website/docs/sdk-and-devtool/ccc.mdx @@ -1,6 +1,22 @@ --- id: ccc title: JavaScript/TypeScript (CCC) +description: "Use the CCC TypeScript SDK to compose transactions, connect wallets, sign messages, issue assets, and build CKB applications." +tags: + - ccc + - typescript + - sdk + - transaction + - wallet +audience: + - dApp developers +related: + - /docs/dapp/transfer-ckb + - /docs/dapp/create-token + - /docs/integrate-wallets/ccc-wallet + - /docs/getting-started/rpcs +difficulty: intermediate +last_reviewed: 2026-06-24 --- import Tabs from "@theme/Tabs"; @@ -11,7 +27,7 @@ import Tooltip from "@components/Tooltip"; ## Introduction -Common Chain Connector (CCC) is a JavaScript/Typescript SDK tailored for CKB. Highly recommended as the primary CKB development tool, CCC offers advantages over alternatives such as [Lumos](https://github.com/ckb-js/lumos) and [ckb-js-sdk](https://github.com/ckb-js/ckb-sdk-js). +Common Chain Connector (CCC) is a JavaScript/TypeScript SDK tailored for CKB. Highly recommended as the primary CKB development tool, CCC offers advantages over alternatives such as [Lumos](https://github.com/ckb-js/lumos) and [ckb-js-sdk](https://github.com/ckb-js/ckb-sdk-js). CCC also serves as a [wallet connector](/docs/integrate-wallets/ccc-wallet) enhancing interoperability between wallets across different blockchains. Explore by checking out the [CCC Demo](https://app.ckbccc.com/). @@ -87,7 +103,7 @@ Please notice that these advanced interfaces are subject to change and may not b ## Transaction Composing -Below is a example demonstrating how to compose a transaction for transferring CKB: +Below is an example demonstrating how to compose a transaction for transferring CKB: ```tsx const tx = ccc.Transaction.from({ diff --git a/website/docs/tech-explanation/transaction.md b/website/docs/tech-explanation/transaction.md index 9825589ae..2d001ffee 100644 --- a/website/docs/tech-explanation/transaction.md +++ b/website/docs/tech-explanation/transaction.md @@ -1,6 +1,24 @@ --- id: transaction title: Transaction +description: "Reference the CKB transaction structure, including cell_deps, header_deps, inputs, witnesses, outputs, outputs_data, and transaction states." +tags: + - transaction + - reference + - cell-model + - witness + - cell-deps +audience: + - dApp developers + - Script developers +related: + - /docs/tech-explanation/inputs + - /docs/tech-explanation/outputs + - /docs/tech-explanation/witness + - /docs/tech-explanation/cell-deps + - /docs/dapp/transfer-ckb +difficulty: intermediate +last_reviewed: 2026-06-24 --- import Tooltip from "@components/Tooltip"; diff --git a/website/package.json b/website/package.json index 3dccfb4dc..739c0a58b 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "docs.nervos.org", - "version": "2.43.0", + "version": "2.44.0", "description": "Official docs website for Nervos CKB", "license": "MIT", "scripts": { @@ -44,7 +44,6 @@ "clsx": "^1.1.1", "connect": "^3.7.0", "hast-util-is-element": "1.1.0", - "logrocket": "^8.1.0", "prism-react-renderer": "^2.3.1", "react": "^18.2.0", "react-dom": "^18.2.0", diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index b6d100e23..83ea40b28 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -1,5 +1,4 @@ import { useEffect } from "react"; -import LogRocket from "logrocket"; import Layout from "@theme/Layout"; import clsx from "clsx"; import { useColorMode } from "@docusaurus/theme-common"; @@ -22,10 +21,6 @@ import { } from "../components/Home"; export default function Home() { - useEffect(() => { - LogRocket.init("ghkibu/nervos-doc"); - }, []); - return ( | +| File | Description | Actions | +| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| `llms.txt` | A concise map of the official docs with recommended entry points and CKB-specific answer guardrails. | | | `llms-full.txt` | The full documentation corpus converted from docs source files into cleaner Markdown for long-context models, RAG, and offline indexing. | | ## Starter Prompts @@ -988,6 +988,13 @@ CKB-VM isn’t just a virtual machine—it is a **universal computer** embedded ## Source: ckb-fundamentals/cell-model.md URL: https://docs.nervos.org/docs/ckb-fundamentals/cell-model +Description: Understand CKB's generalized UTXO Cell Model, including Live Cells, Dead Cells, capacity, ownership, state rent, and scalability. +Tags: concept, cell-model, utxo, capacity, transaction +Audience: dApp developers, Script developers +Related: /docs/getting-started/how-ckb-works, /docs/tech-explanation/cell, /docs/tech-explanation/capacity, /docs/tech-explanation/transaction +Difficulty: beginner +Last reviewed: 2026-06-24 + > Nervos CKB inherits Bitcoin’s architecture and creates the Cell Model, a generalized UTXO model as state storage. > This approach maintains Bitcoin's simplicity and consistency. > In CKB, all states are stored in Cells, computation is done off-chain, and nodes handle all verification. @@ -1126,7 +1133,7 @@ Nervos CKB offers native SDKs in several mainstream programming languages, such ## CKB-VM Version -The CKB network has introduced various CKB-VM versions over time to enhance security, performance, resolve bugs, and support new RISC-V extensions. To check out all versions of the CKB-VM from previous hard fork events, please visit [VM Version History](/docs/history-and-hard-forks/history-vm-version) +The CKB network has introduced various CKB-VM versions over time to enhance security, performance, resolve bugs, and support new RISC-V extensions. To check out all versions of the CKB-VM from previous hard fork events, please visit [VM Version History](/docs/script/vm-version) --- @@ -1494,6 +1501,13 @@ For more information on Eaglesong, refer to [RFC Eaglesong](https://github.com/n ## Source: ckb-fundamentals/nervos-blockchain.md URL: https://docs.nervos.org/docs/ckb-fundamentals/nervos-blockchain +Description: Get a beginner overview of Nervos CKB as a layered, proof-of-work blockchain for CKBytes, on-chain state, and CKB-VM programs. +Tags: concept, layer-1, ckb-vm, consensus +Audience: dApp developers, Script developers +Related: /docs/getting-started/how-ckb-works, /docs/ckb-fundamentals/cell-model, /docs/ckb-fundamentals/ckb-vm, /docs/ckb-fundamentals/consensus +Difficulty: beginner +Last reviewed: 2026-06-24 + ## What is the Nervos Blockchain? Nervos blockchain, also known as Common Knowledge Base, is the rock-bottom layer of the Nervos ecosystem. As the foundation, Nervos blockchain provides trust for all the layers built on top of it. It is designed to maximize decentralization while remaining minimal, flexible, and secure. Its primary objective is to reliably preserve any data and assets stored therein. @@ -1519,13 +1533,13 @@ To store 100 bytes of data in Nervos, it is mandatory to have 100 CKBytes. If yo CKBytes can also be deposited in the Nervos DAO，where they gain rewards in a staking-like process. -Further information about CKByte will be presented in the [Cell Model](cell-model.md) and [Economics](economics.md) sections. +Further information about CKByte will be presented in the [Cell Model](cell-model.md) and [Economics](/docs/assets-token-standards/economics) sections. ## Programming on Nervos -Nervos offers smart contract programmability using a growing number of well-known general-purpose programming languages, such as Javascript, Rust, and C. +Nervos offers smart contract programmability using a growing number of well-known general-purpose programming languages, such as JavaScript, Rust, and C. -All programs on Nervos can store data and state on-chain，which makes creating complex applications and customized tokens a simple and straightforward process. +All programs on Nervos can store data and state on-chain, which makes creating complex applications and customized tokens a simple and straightforward process. All code runs in CKB-VM. CKB-VM is a high-performance RISC-V virtual machine that provides a secure, consistent and flexible environment for developers. Multiple instances of CKB-VM can execute different smart contracts concurrently, which enables substantial scaling improvements through massive parallelization. @@ -1546,6 +1560,13 @@ More details on the design of Nervos’ consensus implementation will be discuss ## Source: dapp/create-dob.mdx URL: https://docs.nervos.org/docs/dapp/create-dob +Description: Build a dApp that uses the Spore protocol to turn user-provided content into an immutable on-chain digital object on CKB. +Tags: dapp, tutorial, spore, cell-data, ccc +Audience: dApp developers +Related: /docs/assets-token-standards/spore-protocol, /docs/dapp/store-data-on-cell, /docs/dapp/create-token, /docs/sdk-and-devtool/ccc +Difficulty: intermediate +Last reviewed: 2026-06-24 + # Create a Digital Object Using Spore Protocol **Estimated Time:** 5 - 10 min @@ -1704,7 +1725,7 @@ const renderSpore = async () => { ## Congratulations! -By following this tutorial this far, you have mastered how digital-object works on CKB. Here's a quick recap: +After following this tutorial, you have mastered how digital objects work on CKB. Here's a quick recap: - How Spore protocol works on CKB - Create an on-chain digital object with a picture via Spore-SDK @@ -1724,6 +1745,13 @@ By following this tutorial this far, you have mastered how digital-object works ## Source: dapp/create-token.mdx URL: https://docs.nervos.org/docs/dapp/create-token +Description: Issue and query a custom fungible token on CKB using the xUDT standard, Type Scripts, Cell data, and the CCC SDK. +Tags: dapp, tutorial, xudt, type-script, ccc +Audience: dApp developers +Related: /docs/assets-token-standards/xudt, /docs/dapp/transfer-ckb, /docs/dapp/create-dob, /docs/sdk-and-devtool/ccc +Difficulty: intermediate +Last reviewed: 2026-06-24 + # Create a Fungible Token **Estimated Time:** 5 - 10 min @@ -1921,7 +1949,7 @@ const txHash = await signer.sendTransaction(tx); ## Congratulations! -By following this tutorial this far, you have mastered how custom tokens work on CKB. Here's a quick recap: +After following this tutorial, you have mastered how custom tokens work on CKB. Here's a quick recap: - Create a CKB transaction containing a xUDT Cell in the outputs - The data of the xUDT Cell contains the amount number of the token @@ -1943,6 +1971,13 @@ By following this tutorial this far, you have mastered how custom tokens work on ## Source: dapp/simple-lock.mdx URL: https://docs.nervos.org/docs/dapp/simple-lock +Description: Build a full-stack CKB dApp with a simple hash Lock Script, Script deployment, frontend integration, and token unlocking flow. +Tags: dapp, tutorial, script, lock-script, ckb-js-vm +Audience: dApp developers, Script developers +Related: /docs/script/intro-to-script, /docs/script/js/js-vm, /docs/script/rust/rust-example-simple-lock, /docs/dapp/transfer-ckb +Difficulty: advanced +Last reviewed: 2026-06-24 + # Build a Simple Lock **Estimated Time:** 10 - 15 min @@ -2308,6 +2343,13 @@ By following this tutorial, you've mastered the basics of building a custom lock ## Source: dapp/transfer-ckb.mdx URL: https://docs.nervos.org/docs/dapp/transfer-ckb +Description: Build a simple dApp that generates accounts, checks CKB balances, creates a transfer transaction, pays fees, and broadcasts it. +Tags: dapp, tutorial, ccc, transaction, cell-model +Audience: dApp developers +Related: /docs/getting-started/quick-start, /docs/sdk-and-devtool/ccc, /docs/dapp/write-message, /docs/ckb-fundamentals/cell-model +Difficulty: beginner +Last reviewed: 2026-06-24 + # View and Transfer a CKB Balance **Estimated Time:** 2 - 5 min @@ -2368,7 +2410,7 @@ export async function capacityOf(address: string): Promise { } ``` -In Nervos CKB, Shannon is the smallest currency unit, with 1 CKB = 10^8 Shannons. This unit system is similar to Bitcoin's Satoshis, where 1 Bitcoin = 10^8 Satoshis. In CCC SDK, the value handle are mostly done in the **Shannon unit**. +In Nervos CKB, Shannon is the smallest currency unit, with 1 CKB = 10^8 Shannons. This unit system is similar to Bitcoin's Satoshis, where 1 Bitcoin = 10^8 Satoshis. In the CCC SDK, values are mostly handled in the **Shannon unit**. Next, we can start to transfer balance. Check out the transfer function in `lib.ts`: @@ -2442,7 +2484,7 @@ You can open the console on the browser to see the full transaction to confirm t ## Congratulations! -By following this tutorial this far, you have mastered how balance transfers work on CKB. Here's a quick recap: +After following this tutorial, you have mastered how balance transfers work on CKB. Here's a quick recap: - The capacity of a Cell indicates both the CKB balance and the amount of data that can be stored in the Cell simultaneously. - Transferring CKB balance involves transferring some Cells from the sender to the receiver. @@ -2460,6 +2502,13 @@ By following this tutorial this far, you have mastered how balance transfers wor ## Source: dapp/write-message.mdx URL: https://docs.nervos.org/docs/dapp/store-data-on-cell +Description: Build a dApp that writes a text message into CKB Cell data, then reads the Live Cell back and decodes the stored value. +Tags: dapp, tutorial, cell-data, cell-model, ccc +Audience: dApp developers +Related: /docs/dapp/transfer-ckb, /docs/ckb-fundamentals/cell-model, /docs/tech-explanation/outputs-data, /docs/sdk-and-devtool/ccc +Difficulty: beginner +Last reviewed: 2026-06-24 + # Store Data on Cell **Estimated Time:** 2 - 5 min @@ -2469,7 +2518,7 @@ URL: https://docs.nervos.org/docs/dapp/store-data-on-cell In this tutorial, you will learn how to tuck a nifty message - "**Hello CKB!**" - into a Cell on the CKB blockchain. Imagine it as sending a message in a bottle, but the ocean is digital, and the bottle is a super secure, tamper-proof CKB Cell! -As you have learned from the first tutorial [Transfer CKB](/docs/dapp/transfer-ckb), the Cell can store any type of data in the data field of Cell structure. Here we will put a text message encoding in hex string format and store it in the data field. Once your words are encoded and inscribed into the blockchain, we'll then get the hex string from the same Cell back and then decode them to the original text message. the method of encoding and decoding is totally up to your favorite, we use the `TextDecoder` for simplicity through the tutorial. +As you learned from the first tutorial, [Transfer CKB](/docs/dapp/transfer-ckb), a Cell can store any type of data in the data field of the Cell structure. Here, we will encode a text message as a hex string and store it in the data field. Once your words are encoded and inscribed into the blockchain, we'll get the hex string back from the same Cell and decode it to the original text message. The encoding and decoding method is up to you; we use `TextDecoder` for simplicity throughout the tutorial. ## Setup Devnet & Run Example @@ -2488,11 +2537,11 @@ You can also read the full code online or download it here. ## Behind the Scene -Open the `lib.ts` file in your project, it lists all the important functions that do the most of work for the project. +Open the `lib.ts` file in your project. It lists the important functions that do most of the work for the project. ### Encode & Decode Message -Since Cell's data field can store any type of data, we need to design our encoding and decoding method for the message we want to read and write on-chain. +Since a Cell's data field can store any type of data, we need to design an encoding and decoding method for the message we want to read and write on-chain. ```ts export function utf8ToHex(utf8String: string): string { @@ -2547,7 +2596,7 @@ const tx = ccc.Transaction.from({ Here we build the output Cell to store the message data by putting the hex format of the text message into the data field of the output Cell. -Next, we ask CCC to complete the transaction for us with transaction fee: +Next, we ask CCC to complete the transaction for us with a transaction fee: ```ts // Complete missing parts for transaction @@ -2593,7 +2642,7 @@ export async function readOnChainMessage(txHash: string, index = "0x0") { ## Congratulations! -By following this tutorial this far, you have mastered how storing data on Cells works on CKB. Here's a quick recap: +After following this tutorial, you have mastered how storing data on Cells works on CKB. Here's a quick recap: - We can store arbitrary data in the `data` field of Cell. - We need a way to encode and decode our data for understanding and using our raw on-chain data later. @@ -4884,6 +4933,13 @@ offckb system-scripts --network ## Source: getting-started/how-ckb-works.mdx URL: https://docs.nervos.org/docs/getting-started/how-ckb-works +Description: Learn how CKB uses Cells, Scripts, transactions, CKB-VM, and proof-of-work consensus to secure and update on-chain state. +Tags: concept, cell-model, script, transaction, ckb-vm +Audience: dApp developers, Script developers +Related: /docs/getting-started/quick-start, /docs/ckb-fundamentals/cell-model, /docs/script/intro-to-script, /docs/tech-explanation/transaction +Difficulty: beginner +Last reviewed: 2026-06-24 + # How CKB Works Whether you’re new to blockchain or have a technical background, this guide will help you understand how CKB works. We’ll explore the fundamental components—Cell Model, Scripts, Transaction, and CKB-VM—in a way that’s easy to grasp. @@ -4930,8 +4986,8 @@ A Script in CKB is a binary executable that can be executed on-chain. It is a {" "} - `code_hash` : identifies the Script code to be loaded into the CKB-VM -- `hash_type` : indicates the the method CKB-VM uses to locate the Script code or Script. -- `args` : provides specific arguments that differentiate one Script from another, such as a users’s public key hash. +- `hash_type` : indicates the method CKB-VM uses to locate the Script code or Script. +- `args` : provides specific arguments that differentiate one Script from another, such as a user’s public key hash. There’re two main types of Scripts: @@ -4981,6 +5037,13 @@ With the above theoretical knowledge, you're ready to hit the road. ## Source: getting-started/quick-start.mdx URL: https://docs.nervos.org/docs/getting-started/quick-start +Description: Set up a local CKB devnet with OffCKB and choose the right next path for building dApps, scripts, nodes, or core concepts. +Tags: getting-started, devnet, offckb, dapp, script +Audience: dApp developers, Script developers, Node operators +Related: /docs/dapp/transfer-ckb, /docs/script/rust/rust-quick-start, /docs/getting-started/how-ckb-works, /docs/ckb-fundamentals/cell-model +Difficulty: beginner +Last reviewed: 2026-06-24 + # Quick Start (5min) Welcome to the Nervos CKB ecosystem! This guide will help you set up your local development environment in just a few minutes. After that, you can explore the various paths to build on CKB. @@ -5092,6 +5155,13 @@ Happy building! 🎉 ## Source: getting-started/rpcs.mdx URL: https://docs.nervos.org/docs/getting-started/rpcs +Description: Connect to CKB JSON-RPC endpoints, use public RPC nodes safely, and call common methods such as get_tip_block_number and send_transaction. +Tags: rpc, node, json-rpc, transaction +Audience: dApp developers, Node operators +Related: /docs/node/install-ckb, /docs/node/run-mainnet-node, /docs/node/run-testnet-node, /docs/sdk-and-devtool/ccc +Difficulty: intermediate +Last reviewed: 2026-06-24 + # RPCs CKB RPCs are a set of programming interfaces provided by the Nervos CKB blockchain, enabling developers to interact with the network for querying data, managing transactions, and deploying Scripts directly. @@ -5124,7 +5194,7 @@ CKB exposes a set of RPCs in [JSON-RPC 2.0](https://www.jsonrpc.org/specificatio ## Basic Usage -The following commands uses [get_tip_block_number](https://github.com/nervosnetwork/ckb/blob/master/rpc/README.md#get_tip_block_number) RPC to fetch the `tip` block number, of the latest block number in the longest blockchain: +The following command uses the [get_tip_block_number](https://github.com/nervosnetwork/ckb/blob/master/rpc/README.md#get_tip_block_number) RPC to fetch the `tip` block number, the latest block number in the longest blockchain: **Command:** @@ -5146,7 +5216,7 @@ http://localhost:8114 {"jsonrpc":"2.0","result":"0x2cb4","id":2} ``` -The following commands uses `send_transaction` RPC to send transactions to the CKB network: +The following command uses the `send_transaction` RPC to send transactions to the CKB network: **Command:** @@ -5212,7 +5282,7 @@ http://localhost:8114 } ``` -It should be noted that `send_transaction` is asynchronous, that is, the return of the transaction hash, does not mean that the transaction is fully verified, if you need to follow up on the status of the transaction, it is recommended to use the following get_transaction rpc： +It should be noted that `send_transaction` is asynchronous. Returning the transaction hash does not mean that the transaction is fully verified. If you need to follow up on the status of the transaction, use the following `get_transaction` RPC: **Command:** @@ -6690,13 +6760,20 @@ In addition to the direct impact of CKB price declines on miners, a surge in CKB ## Source: node/install-ckb.mdx URL: https://docs.nervos.org/docs/node/install-ckb +Description: Install the CKB binary from releases, source, or Docker, then proceed to Mainnet, Testnet, or Docker node setup. +Tags: node, install, mainnet, testnet, docker +Audience: Node operators +Related: /docs/node/run-mainnet-node, /docs/node/run-testnet-node, /docs/node/run-node-docker, /docs/getting-started/rpcs +Difficulty: beginner +Last reviewed: 2026-06-24 + # Install CKB There are three ways to install and run the CKB binary, depending on your platform and preference: -- [Download from release](#download-from-release) – the fastest way. Grab a prebuilt binary package from the official GitHub Releases +- [Download from release](#method-1-download-from-release) – the fastest way. Grab a prebuilt binary package from the official GitHub Releases page and unzip it. -- [Build from source](#build-from-source) – recommended if you want to compile with the latest changes or verify the build process yourself. +- [Build from source](#method-2-build-from-source) – recommended if you want to compile with the latest changes or verify the build process yourself. - [Use Docker](/docs/node/run-node-docker) – if your platform isn’t directly supported, or if you prefer containerized environments, you can run CKB inside Docker. ## Method 1: Download from Release @@ -6895,9 +6972,9 @@ ckb.toml This article covers the following configuration topics: -- [Node Discoverability](#improve-node-discoverability) +- [Node Discoverability](#node-discoverability) - [Light client support and WSS access](#light-client-support--wss-access) -- [Proxy and onion support](#proxy-and-onion-support) +- [Proxy and onion support](#proxy-and-toronion) - [Fee estimator](#fee-estimator) - [Run multiple nodes](#run-multiple-nodes) @@ -7697,6 +7774,8 @@ Modify the `genesis_epoch_length` parameter in the `specs/dev.toml` file under t genesis_epoch_length = 1000 # The unit of meansurement is "block". ``` +If you are initializing a devnet from existing Mainnet or Testnet data, `genesis_epoch_length` must match the value used by the source chain. Mainnet was launched with `1743`, while Testnet uses the default `1000`. A mismatch produces a genesis hash mismatch error on startup. See the upstream [`docs/devnet-from-existing-data.md`](https://github.com/nervosnetwork/ckb/blob/v0.207.0/docs/devnet-from-existing-data.md) for the full procedure. + #### 3b. Set Permanent Difficulty When `permanent_difficulty_in_dummy` is set to `true`, all epochs will use the same length as the genesis epoch length, skipping the difficulty adjustment entirely. This param is typically used in conjunction with `genesis_epoch_length`. @@ -9734,6 +9813,8 @@ where: - `__ckb_std_main`: the entry function. When executed, it dynamically loads the lib and runs this function. The transaction information of the Script is passed through the two above-mentioned environment variables. - `__set_script_info`: responsible for passing the global state necessary for `exec` and `spawn`. +:::caution Attention + - The separate crate `$crate::env::Arg` is used to prevent project complexity, as combining these two functions would complicate maintenance. - For developers wishing to use this feature, we recommend to use `ckb-testtool` for development and testing to simplify work. - Script and Native Simulator are bound one-to-one. If `ckb-testtool` cannot locate the corresponding Native Simulator, it will automatically execute the Script's results. @@ -10227,6 +10308,13 @@ Before we finish, I do want to shout out Google's [fuzzing](https://github.com/g ## Source: script/intro-to-script.mdx URL: https://docs.nervos.org/docs/script/intro-to-script +Description: Learn what CKB Scripts are, how Lock Scripts and Type Scripts execute, and how code_hash, hash_type, and args locate Script code. +Tags: script, concept, lock-script, type-script, ckb-vm +Audience: Script developers +Related: /docs/script/rust/rust-quick-start, /docs/tech-explanation/script, /docs/tech-explanation/lock-script, /docs/tech-explanation/type-script +Difficulty: beginner +Last reviewed: 2026-06-24 + # Intro to Script A Script in Nervos CKB is a binary executable that can be executed on-chain. It is Turing-complete and can perform arbitrary logic to guard and protect your on-chain assets. You can think of it as smart contract. @@ -10248,7 +10336,7 @@ A Script can be one of two types: In most cases, Lock Script and Type Script function similarly. The only key difference is that, the output Cells' Lock Scripts will NOT be executed in a transaction, whereas the input Cells' Lock Scripts, the input Cells' Type Scripts, and the output Cells' Type Scripts will be executed. -This difference has led to the different usecases of Lock Script and Type Script as we have mentioned above. Lock Script is often used to control owner ship of a Cell while Type Script defines what kinds of changes of a Cell is valid for the transaction. +This difference has led to the different use cases of Lock Script and Type Script as we have mentioned above. Lock Script is often used to control ownership of a Cell, while Type Script defines what kinds of changes to a Cell are valid for the transaction. ## Script Structure @@ -10679,7 +10767,7 @@ ckb-js-vm supports the following options to control its execution behavior: - `-e `: Execute JavaScript code directly from the command line string - `-r `: Read and execute JavaScript code from the specified file - `-t `: Specify the target resource cell's code_hash and hash_type in hexadecimal format -- `-f`: Enable [file system](./js-vm#simple-file-system-and-modules) mode, which provides support for JavaScript modules and imports +- `-f`: Enable [file system](./js-vm-file-system) mode, which provides support for JavaScript modules and imports Note, the `-c` and `-r` options can only work with `ckb-debugger`. The `-c` option is particularly useful for preparing optimized bytecode as described in the previous section. When no options are specified, ckb-js-vm runs in its default @@ -10889,7 +10977,7 @@ While it's often more resource-efficient to write all JavaScript code in a singl support in ckb-js-vm through either: - Executing or spawning ckb-js-vm with the "-f" parameter -- Using ckb-js-vm flags with file system enabled (see the [Working with ckb-js-vm](./js-vm#ckb-js-vm-command-line-options) chapter for details) +- Using ckb-js-vm flags with file system enabled (see the [Command Line Options](./js-vm-cmd-line-options) chapter for details) ### Unpacking a Simple File System @@ -14006,6 +14094,8 @@ where: - `__ckb_std_main`: the entry function. When executed, it dynamically loads the lib and runs this function. The transaction information of the Script is passed through the two above-mentioned environment variables. - `__set_script_info`: responsible for passing the global state necessary for `exec` and `spawn`. +:::caution Attention + - The separate crate `$crate::env::Arg` is used to prevent project complexity, as combining these two functions would complicate maintenance. - For developers wishing to use this feature, we recommend to use `ckb-testtool` for development and testing to simplify work. - Script and Native Simulator are bound one-to-one. If `ckb-testtool` cannot locate the corresponding Native Simulator, it will automatically execute the Script's results. @@ -15064,12 +15154,19 @@ Here's a quick recap: ## Source: script/rust/rust-quick-start.mdx URL: https://docs.nervos.org/docs/script/rust/rust-quick-start +Description: Create, build, test, and debug CKB Scripts in Rust using the recommended project template, no_std setup, and local examples. +Tags: script, tutorial, rust, ckb-vm, testing +Audience: Rust developers, Script developers +Related: /docs/script/intro-to-script, /docs/script/rust/rust-build, /docs/script/rust/rust-test, /docs/script/rust/rust-debug +Difficulty: intermediate +Last reviewed: 2026-06-24 + # Quick Start **Estimated Time:** 5 - 15min **Tools:** script -This chapter provides a step-by-step guide on developing contracts with Rust on CKB with several examples. As a "Quick Start" guide, it will not diving into in-depth details. For a more comprehensive understanding, please refer to the subsequent chapters. +This chapter provides a step-by-step guide on developing contracts with Rust on CKB with several examples. As a "Quick Start" guide, it will not go into deep detail. For a more comprehensive understanding, please refer to the subsequent chapters. Before proceeding, you should be familiar with: @@ -16141,11 +16238,11 @@ URL: https://docs.nervos.org/docs/script/spawn-cross-script-calling The Meepo hard fork in 2024 has introduced a range of enhancements into CKB Script development, with one major innovation being Spawn. -In [CKB Script](/docs/script/intro-to-script), Spawn refers to a concept and a set of syscalls for creating new processes. Unlike the [exec syscall](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0034-vm-syscalls-2/0034-vm-syscalls-2.md#exec) introduced during [CKB’s first hard fork in 2021](/docs/history-and-hard-forks/ckb-hard-fork-history#1st-hard-fork--ckb-edition-mirana-2021), Spawn enables **direct cross-script calls**, simplifying development process while offering greater control and optimization. +In [CKB Script](/docs/script/intro-to-script), Spawn refers to a concept and a set of syscalls for creating new processes. Unlike the [exec syscall](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0034-vm-syscalls-2/0034-vm-syscalls-2.md#exec) introduced during [CKB’s first hard fork in 2021](/docs/history-and-hard-forks/ckb-hard-fork-history#mirana-hardfork), Spawn enables **direct cross-script calls**, simplifying development process while offering greater control and optimization. ## Why Spawn -The exec syscall, introduced into CKB-VM during [CKB’s first hard fork](/docs/history-and-hard-forks/ckb-hard-fork-history#1st-hard-fork--ckb-edition-mirana-2021), was designed to enable the loading and executing of a new Script within the current execution space. While powerful, exec can be inefficient, especially when preserving the current execution space is necessary. With exec, all state information of the current Script is discarded. When Script A calls Script B using exec, Script A's context is lost (This means that even if Script A has remaining code after executing `exec`, that code will not be executed.), as illustrated below: +The exec syscall, introduced into CKB-VM during [CKB’s first hard fork](/docs/history-and-hard-forks/ckb-hard-fork-history#mirana-hardfork), was designed to enable the loading and executing of a new Script within the current execution space. While powerful, exec can be inefficient, especially when preserving the current execution space is necessary. With exec, all state information of the current Script is discarded. When Script A calls Script B using exec, Script A's context is lost (This means that even if Script A has remaining code after executing `exec`, that code will not be executed.), as illustrated below: ``` +----------+ Exec +----------+ @@ -16552,7 +16649,7 @@ A collection of CKB-VM syscalls. Also include relevant constant, such as return | 0 | 2061 | [ckb_load_tx_hash](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-transaction-hash) | Calculate the hash of the current transaction and copy it using partial loading. | | 0 | 2062 | [ckb_load_script_hash](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-script-hash) | Calculate the hash of currently running Script and copy it using partial loading. | | 0 | 2071 | [ckb_load_cell](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-cell) | Serialize the specified Cell in the current transaction using the Molecule Encoding 1 format and copy it using partial loading. | -| 0 | 2072 | [ckb_load_header](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-header) | Serialize the specified header associated with an input Cell, dep Cell, or header dep using the Molecule Encoding 1 format and copy it using partial loading. | +| 0 | 2072 | [ckb_load_header](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-header) | Serialize the specified header associated with an input Cell, dep Cell, or header dep using the Molecule Encoding 1 format and copy it using partial loading. For unconfirmed Cells supplied by the tx-pool, the syscall returns `CKB_ITEM_MISSING` instead of aborting. | | 0 | 2073 | [ckb_load_input](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-input) | Serialize the specified input Cell in the current transaction using the Molecule Encoding 1 format and copy it using partial loading. | | 0 | 2074 | [ckb_load_witness](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-witness) | Load the specified witness in the current transaction and copy it using partial loading. | | 0 | 2081 | [ckb_load_cell_by_field](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-cell-by-field) | Load a single field from the specified Cell in the current transaction and copy it using partial loading. | @@ -16561,7 +16658,7 @@ A collection of CKB-VM syscalls. Also include relevant constant, such as return | 0 | 2091 | [ckb_load_cell_data_as_code](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-cell-data-as-code) | Load the data from the Cell data field in the specified Cell from the current transaction, mark the loaded memory page as executable, and copy it using partial loading. The loaded code can then be executed by CKB-VM at a later time. | | 0 | 2092 | [ckb_load_cell_data](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#load-cell-data) | Load the data from the Cell data field in the specified Cell from the current transaction and copy it using partial loading. | | 0 | 2177 | [ckb_debug](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0009-vm-syscalls/0009-vm-syscalls.md#debug) | Print the specified message in CKB's terminal output for the purposes of debugging. | -| 2 | 2104 | [ckb_load_extension](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0050-vm-syscalls-3/0050-vm-syscalls-3.md#load-block-extension) | Load the extension field data and copy it using partial loading. | +| 2 | 2104 | [ckb_load_extension](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0050-vm-syscalls-3/0050-vm-syscalls-3.md#load-block-extension) | Load the extension field data and copy it using partial loading. For unconfirmed Cells supplied by the tx-pool, the syscall returns `CKB_ITEM_MISSING` instead of aborting. | | 2 | 2601 | [ckb_spawn](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0050-vm-syscalls-3/0050-vm-syscalls-3.md#spawn) | Run a Script executable from the specified Cell using the current VM context, but return to the original calling Script executable upon termination. This is similar to the [spawn function]() found in several operating systems and programming languages. | | 2 | 2602 | [ckb_wait](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0050-vm-syscalls-3/0050-vm-syscalls-3.md#wait) | Pause until the execution of a process specified by `pid` has ended. | | 2 | 2603 | [ckb_process_id](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0050-vm-syscalls-3/0050-vm-syscalls-3.md#process-id) | Get the current process id. | @@ -17527,11 +17624,18 @@ No known issues have been reported for this VM version. ## Source: sdk-and-devtool/ccc.mdx URL: https://docs.nervos.org/docs/sdk-and-devtool/ccc +Description: Use the CCC TypeScript SDK to compose transactions, connect wallets, sign messages, issue assets, and build CKB applications. +Tags: ccc, typescript, sdk, transaction, wallet +Audience: dApp developers +Related: /docs/dapp/transfer-ckb, /docs/dapp/create-token, /docs/integrate-wallets/ccc-wallet, /docs/getting-started/rpcs +Difficulty: intermediate +Last reviewed: 2026-06-24 + # JavaScript/TypeScript (CCC) ## Introduction -Common Chain Connector (CCC) is a JavaScript/Typescript SDK tailored for CKB. Highly recommended as the primary CKB development tool, CCC offers advantages over alternatives such as [Lumos](https://github.com/ckb-js/lumos) and [ckb-js-sdk](https://github.com/ckb-js/ckb-sdk-js). +Common Chain Connector (CCC) is a JavaScript/TypeScript SDK tailored for CKB. Highly recommended as the primary CKB development tool, CCC offers advantages over alternatives such as [Lumos](https://github.com/ckb-js/lumos) and [ckb-js-sdk](https://github.com/ckb-js/ckb-sdk-js). CCC also serves as a [wallet connector](/docs/integrate-wallets/ccc-wallet) enhancing interoperability between wallets across different blockchains. Explore by checking out the [CCC Demo](https://app.ckbccc.com/). @@ -17586,7 +17690,7 @@ Please notice that these advanced interfaces are subject to change and may not b ## Transaction Composing -Below is a example demonstrating how to compose a transaction for transferring CKB: +Below is an example demonstrating how to compose a transaction for transferring CKB: ```tsx const tx = ccc.Transaction.from({ @@ -20480,15 +20584,30 @@ println!("address: {}", address.to_string()); In the world of CKB, a Lock Script can be represented as an address. It is possible to parse an address from an encoded string and then obtain its network and Script. +If you are testing this inside a new `cargo new --bin` project, add these dependencies to `Cargo.toml` and place the code inside `src/main.rs`. + +```bash title='Cargo.toml' +[dependencies] +ckb-sdk = "3.7.0" +ckb-types = "0.200.0" +``` + ```rust use ckb_sdk::types::Address; use ckb_types::packed::Script; use std::str::FromStr; -let addr_str = "ckb1qzda0cr08m85hc8jlnfp3zer7xulejywt49kt2rr0vthywaa50xwsqgvf0k9sc40s3azmpfvhyuudhahpsj72tsr8cx3d"; -let addr = Address::from_str(addr_str).unwrap(); -let _network = addr.network(); -let _script: Script = addr.payload().into(); +fn main() { + let addr_str = "ckt1qzda0cr08m85hc8jlnfp3zer7xulejywt49kt2rr0vthywaa50xwsqvwg2cen8extgq8s5puft8vf40px3f599cytcyd8"; + + let addr = Address::from_str(addr_str).expect("valid CKB address"); + let network = addr.network(); + let script: Script = addr.payload().into(); + + println!("Address: {}", addr); + println!("Network: {:?}", network); + println!("Lock Script: {:?}", script); +} ``` Short address and full bech32 address are deprecated. For more details about addresses, check out [CKB Address](/docs/ckb-fundamentals/ckb-address) and [RFC-0021](https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0021-ckb-address-format/0021-ckb-address-format.md). @@ -25173,7 +25292,7 @@ URL: https://docs.nervos.org/docs/tech-explanation/outputs # outputs -The transaction destroys the Cells listed in `inputs` and creates new Cells listed in `outputs`. These output Cells follow the same structure as the standard [Cell structure](<(/docs/tech-explanation/cell#cell-structure)>) and can later be used as inputs in future transactions. +The transaction destroys the Cells listed in `inputs` and creates new Cells listed in `outputs`. These output Cells follow the same structure as the standard [Cell structure](/docs/tech-explanation/cell#cell-structure) and can later be used as inputs in future transactions. --- @@ -25299,6 +25418,13 @@ We differentiate the terms Script and Code as follows: ## Source: tech-explanation/transaction.md URL: https://docs.nervos.org/docs/tech-explanation/transaction +Description: Reference the CKB transaction structure, including cell_deps, header_deps, inputs, witnesses, outputs, outputs_data, and transaction states. +Tags: transaction, reference, cell-model, witness, cell-deps +Audience: dApp developers, Script developers +Related: /docs/tech-explanation/inputs, /docs/tech-explanation/outputs, /docs/tech-explanation/witness, /docs/tech-explanation/cell-deps, /docs/dapp/transfer-ckb +Difficulty: intermediate +Last reviewed: 2026-06-24 + # Transaction A transaction in CKB destroys some Cells (outputs from previous transactions) and generates new ones. diff --git a/website/yarn.lock b/website/yarn.lock index 416a0c576..15f286c58 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -6327,9 +6327,9 @@ http-parser-js@>=0.5.1: integrity sha512-vDlkRPDJn93swjcjqMSaGSPABbIarsr1TLAui/gLDXzV5VsJNdXNzMYDyNBLQkjWQCJ1uizu8T2oDMhmGt0PRA== http-proxy-middleware@^2.0.3: - version "2.0.9" - resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz#e9e63d68afaa4eee3d147f39149ab84c0c2815ef" - integrity sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q== + version "2.0.10" + resolved "https://registry.yarnpkg.com/http-proxy-middleware/-/http-proxy-middleware-2.0.10.tgz#b2df7b705203d7a8c269ac8450cf96b00c532f94" + integrity sha512-RKzRWNPxUZqbuk3BC5mGVJbBnWgr+diEnjJexIOytFbBzDy88Fbh/YvBr3DsNrl1jYAfjWfpATEv0NO35FDuPQ== dependencies: "@types/http-proxy" "^1.17.8" http-proxy "^1.18.1" @@ -6983,11 +6983,6 @@ log-update@^6.0.0: strip-ansi "^7.1.0" wrap-ansi "^9.0.0" -logrocket@^8.1.0: - version "8.1.0" - resolved "https://registry.yarnpkg.com/logrocket/-/logrocket-8.1.0.tgz#2b804985b5370b359831ee03c92423e08ac48044" - integrity sha512-0PRv9lnS90KBrL3mfiQzcKEPvNT3N55pRN0PRe/q3DqWFQbIW1p72MmMp9a3Qi9la6o+TXri7r68ZE0AM7vsDA== - longest-streak@^3.0.0: version "3.1.0" resolved "https://registry.yarnpkg.com/longest-streak/-/longest-streak-3.1.0.tgz#62fa67cd958742a1574af9f39866364102d90cd4"