@dfinity/sns

中文文档
8.0.0发布于 2026/09/22Apache-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 2258

与服务神经系统项目接口的图书馆.

中文使用文档
文档目录6 节
  1. 目录
  2. 安装
  3. 使用量
  4. 探索方式
  5. 描述方式
  6. 文档

日记

与服务神经系统项目接口的图书馆.

npm version GitHub license

[TIP] 还在使用 @dfinity/sns升级到 @icp-sdk/canisters/sns来啊!

目录

安装

你用得着 sns-js 在您的工程中安装它.

npm i @dfinity/sns

捆绑需要同伴的依赖关系, 请确定您的项目中也提供后续资源 .

npm i @icp-sdk/core @dfinity/utils @dfinity/ledger

使用量

sns-js 可采用两种不同的办法。 第一种方法是探索性的,在这里只需要提供您的项目的 SNS 根罐ID 来初始化一个处理拨打到相应收发筒的包装. 这意味着所有功能都有一个单一的切入点. 第二种方法更为常见,它涉及即时抽取所需的特定罐子.

探索方式

这个 explorative 方法具有简化代码的优点,但这意味着,当它询问 root 用于初始化时 Sns 项目的罐头标识列表.

import { createAgent } from "@dfinity/utils";
import { initSnsWrapper } from "@dfinity/sns";

const agent = await createAgent({
  identity,
  host: HOST,
});

const wrapper = await initSnsWrapper({
  rootOptions: {
    canisterId: rootCanisterId,
  },
  agent,
  certified,
});

const { metadata, swapState } = wrapper;
const [data, token] = await metadata({});

console.log("Sns:", data, token, swapState);

描述方式

描述性方法限制了特征的范围,但更为动词化.

import { createAgent } from "@dfinity/utils";
import { SnsGovernanceCanister } from "@dfinity/sns";

const agent = await createAgent({
  identity,
  host: HOST,
});

const { metadata } = SnsGovernanceCanister.create({
  agent,
  canisterId: rootCanisterId,
});

const data = await metadata({ certified: true });

console.log("Summary data:", data);

文档

您可以找到 API 文档 这里。 。 。 .

版本与发布记录

@dfinity/sns 共发布 1,079 个版本,首次发布于 2022/07/13;过去 12 个月发布了 32 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
8.0.0latest2026/09/221 个月前
7.1.0-next-2026-04-21.1next2026/04/216 个月前
7.1.0-next-2026-04-212026/04/216 个月前
7.1.0-next-2026-04-202026/04/216 个月前
7.1.0-next-2026-02-182026/02/188 个月前
7.1.0-next-2026-02-112026/02/119 个月前

其他发布通道:nightly → 0.0.3-nightly-2022-08-08.1,beta → 7.0.0-beta-2025-12-18,next → 7.1.0-next-2026-04-21.1。

关于 @dfinity/sns 的常见问题

@dfinity/sns 是什么?

与服务神经系统项目接口的图书馆.

如何安装 @dfinity/sns?

在项目目录运行 npm install @dfinity/sns,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@icp-sdk/canisters(^4)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@dfinity/sns 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@dfinity/sns 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@dfinity/sns 可以商用吗?

@dfinity/sns 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@dfinity/sns 的下载量有多少?

根据 npm 官方下载统计,@dfinity/sns 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,258 次,日均约 75 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dfinity/sns 还在维护吗?

最新版本 8.0.0 发布于 2026/09/22(1 个月前);至今共发布 1079 个版本,其中过去 12 个月发布了 32 个;首次发布于 2022/07/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。