# @dfinity/sns 中文文档

规范地址：https://npmcn.com/package/%40dfinity/sns/

版本：8\.0\.0
npm 元数据更新时间：2026-10-05T08:14:05.798Z
中文译文更新时间：2026-11-13T05:04:36.000Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dfinity/sns
原文对照：https://npmcn.com/package/%40dfinity/sns/?lang=original
项目主页：https://github.com/dfinity/icp-js-canisters#readme
源码仓库：https://github.com/dfinity/icp-js-canisters

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：25.4 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@icp-sdk/canisters ^4
- 首次发布：2022-07-13T07:22:11.484Z
- 最新版本发布：2026-09-22T07:54:10.364Z
- 近 30 天下载量：2258（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：1079（近 12 个月 32 个）

## 中文简介

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

## 安装

```sh
npm install @dfinity/sns
```

也可以使用：`pnpm add @dfinity/sns`、`yarn add @dfinity/sns`、`bun add @dfinity/sns`

## README

# 日记

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

[![npm version](https://img.shields.io/npm/v/@dfinity/sns.svg?logo=npm)](https://www.npmjs.com/package/@dfinity/sns) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

> \[TIP\] 还在使用 `@dfinity/sns`升级到 [`@icp-sdk/canisters/sns`](https://js.icp.build/canisters/latest/upgrading/v1/)来啊!

## 目录

-   [安装](https://npmcn.com/package/%40dfinity/sns/#readme-installation)
-   [使用量](https://npmcn.com/package/%40dfinity/sns/#readme-usage)
-   [特征](https://npmcn.com/package/%40dfinity/sns/#readme-features)

## 安装

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

```bash
npm i @dfinity/sns
```

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

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

## 使用量

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

### 探索方式

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

```ts
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);
```

### 描述方式

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

```ts
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 文档 [这里](https://js.icp.build/canisters/latest/api/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 和提交记录判断。