ckbtc-js
A library for interfacing with ckBTC on the Internet Computer.
[!TIP]
Still using @dfinity/ckbtc? Upgrade to @icp-sdk/canisters/ckbtc!
Table of contents
Installation
You can use ckbtc-js by installing it in your project.
npm i @dfinity/ckbtc
The bundle needs peer dependencies, be sure that following resources are available in your project as well.
npm i @icp-sdk/core @dfinity/utils
Usage
The features are available through the class CkBtcMinterCanister. It has to be instantiated with a canister ID.
import { CkBtcMinterCanister } from "@dfinity/ckbtc";
import { createAgent } from "@dfinity/utils";
const agent = await createAgent({
identity,
host: HOST,
});
const { getBtcAddress } = CkBtcMinterCanister.create({
agent,
canisterId: MY_CKBTC_MINTER_CANISTER_ID,
});
const btcAddress = await getBtcAddress({});
Documentation
You can find the API docs here.
Resources
关于 @dfinity/ckbtc 的常见问题
@dfinity/ckbtc 是什么？
A library for interfacing with ckBTC.
如何安装 @dfinity/ckbtc？
在项目目录运行 npm install @dfinity/ckbtc，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@icp-sdk/canisters（^4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@dfinity/ckbtc 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@dfinity/ckbtc 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require() 都可以使用，打包工具会自动选择合适的版本。
@dfinity/ckbtc 可以商用吗？
@dfinity/ckbtc 使用 Apache-2.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。
@dfinity/ckbtc 的下载量有多少？
根据 npm 官方下载统计，@dfinity/ckbtc 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,919 次，日均约 97 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@dfinity/ckbtc 还在维护吗？
最新版本 8.0.0 发布于 2026/09/22（1 个月前）；至今共发布 816 个版本，其中过去 12 个月发布了 32 个；首次发布于 2023/02/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。