# @circle-fin/w3s-pw-web-sdk 中文文档

规范地址：https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/

版本：1\.1\.11
npm 元数据更新时间：2026-05-14T17:25:40.859Z
中文译文更新时间：2026-11-09T16:43:47.841Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40circle-fin/w3s-pw-web-sdk
原文对照：https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/?lang=original
项目主页：https://github.com/circlefin/w3s-pw-web-sdk#readme
源码仓库：https://github.com/circlefin/w3s-pw-web-sdk

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

- 包体积（解压后）：255 kB，60 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=10\.0\.0
- 运行依赖：4 个
- 首次发布：2023-11-23T12:21:32.976Z
- 最新版本发布：2025-03-11T07:38:50.424Z
- 近 30 天下载量：28374（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 0 个）

## 中文简介

Javascript/ Typescript SDK 用于圆形可编程钱包

## 安装

```sh
npm install @circle-fin/w3s-pw-web-sdk
```

也可以使用：`pnpm add @circle-fin/w3s-pw-web-sdk`、`yarn add @circle-fin/w3s-pw-web-sdk`、`bun add @circle-fin/w3s-pw-web-sdk`

## README

# 圆形可编程钱包 Web SDK

## 目录

-   [圆形可编程钱包 Web SDK](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-circle-programmable-wallets-web-sdk)
    -   [目录](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-table-of-contents)
    -   [概览](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-overview)
    -   [安装](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-installation)
    -   [使用量](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-usage)
        -   [先决条件](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-prerequisites)
        -   [启动SDK](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-initiating-the-sdk)
    -   [文档](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-documentation)
    -   [实例](https://npmcn.com/package/%40circle-fin/w3s-pw-web-sdk/#readme-examples)

* * *

## 概览

可编程钱包Web SDK授权开发者轻松地在网络应用程序上构建Web3钱包. 使用行业标准MPC密码技术确保私人钥匙的安全以及用户资产的安全.

## 安装

```bash
$ npm install @circle-fin/w3s-pw-web-sdk
```

## 使用量

### 先决条件

报名 [圆形的 Dev 控制台](https://developers.circle.com/w3s/docs/circle-developer-account) 获取APP ID.

### 启动SDK

启动SDK的最小例子如下:

```jsx
import { W3SSdk } from '@circle-fin/w3s-pw-web-sdk'

const sdk = new W3SSdk({
  appSettings: {
    appId: '<Your App Id>'
  },
})

sdk.setAuthentication({
  userToken: '<Your user token>',
  encryptionKey: '<Your encryption key>',
})

sdk.execute(challengeId, (error, result) => {
  if (error) {
    console.log(
      `${error?.code?.toString() || 'Unknown code'}: ${
        error?.message ?? 'Error!'
      }`
    )

    return
  }

  console.log(`Challenge: ${result.type}`)
  console.log(`status: ${result.status}`)

  if (result.data) {
    console.log(`signature: ${result.data?.signature}`)
  }
})
```

## 文档

请检查access-date=中的日期值 (帮助) 下方的开发者文档,以获取轻松而平滑的用法体验.

-   [网络 SDK 文件](https://developers.circle.com/w3s/docs/web)
-   [Web SDK UI 自定义 API doc](https://developers.circle.com/w3s/docs/web-sdk-ui-customizations)

## 实例

我们提供3个前端例子,供您尝试:

-   [js-实例](https://github.com/circlefin/w3s-pw-web-sdk/tree/master/examples/js-example)
-   [反应实例](https://github.com/circlefin/w3s-pw-web-sdk/tree/master/examples/react-example)
-   [vue - 实例](https://github.com/circlefin/w3s-pw-web-sdk/tree/master/examples/vue-example)

请遵循以下步骤开始建设:

1.  克隆这回波.
2.  从 [圆形开发者控制台](https://console.circle.com/)。 。 。 .
3.  运行剧本。 请跟随示例文件夹中的 README. md 执行样本应用 .

## 常见问题

### @circle-fin/w3s-pw-web-sdk 是什么？

Javascript/ Typescript SDK 用于圆形可编程钱包

### 如何安装 @circle-fin/w3s-pw-web-sdk？

在项目目录运行 npm install @circle-fin/w3s-pw-web-sdk，或使用 pnpm add / yarn add / bun add。

### @circle-fin/w3s-pw-web-sdk 支持 TypeScript 吗？

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

### @circle-fin/w3s-pw-web-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @circle-fin/w3s-pw-web-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @circle-fin/w3s-pw-web-sdk 可以商用吗？

@circle-fin/w3s-pw-web-sdk 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @circle-fin/w3s-pw-web-sdk 的下载量有多少？

根据 npm 官方下载统计，@circle-fin/w3s-pw-web-sdk 在 2026/10/10 – 2026/11/08 这 30 天内被下载 28,374 次，日均约 946 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @circle-fin/w3s-pw-web-sdk 还在维护吗？

最新版本 1\.1\.11 发布于 2025/03/11（1\.7 年前）；至今共发布 28 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/11/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。