# @fiatconnect/fiatconnect-sdk 中文文档

规范地址：https://npmcn.com/package/%40fiatconnect/fiatconnect-sdk/

版本：0\.5\.168
npm 元数据更新时间：2026-11-14T00:06:24.733Z
中文译文更新时间：2026-11-14T16:46:59.150Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：180 kB，51 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：9 个
- peer 依赖：@valora/react-native-cookies ^6\.2\.3
- 首次发布：2022-05-16T16:46:23.484Z
- 最新版本发布：2026-11-14T00:06:24.337Z
- 近 30 天下载量：2404（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：188（近 12 个月 12 个）

## 中文简介

一个钱包与 FiatConnect API 集成的助手库

## 安装

```sh
npm install @fiatconnect/fiatconnect-sdk
```

也可以使用：`pnpm add @fiatconnect/fiatconnect-sdk`、`yarn add @fiatconnect/fiatconnect-sdk`、`bun add @fiatconnect/fiatconnect-sdk`

## README

# 无线连接- sdk

一个轻量级 Typescript 帮助库,用于钱包或 Dapps 与 FiatConnect 兼容 API 集成.

## 基本用途

要开始, 请从您的项目安装库 :

```console
yarn add @fiatconnect/fiatconnect-sdk
```

下一个,初始化 a `FiatConnectClient` 任何需要访问 FiatConnect API 在您的密码库。 见示例 页:1 [瓦罗拉钱包](https://github.com/valora-inc/wallet/blob/61cb017439c7e606d6c09d6a276584d15a857968/src/fiatconnect/clients.ts#L34) 财务报告和审定财务报表 [FiatConnect 验证测试](https://github.com/fiatconnect/validate/blob/main/validations/kyc.test.ts#L18)。 。 。 .

从那里,您可以使用一个方法访问任何 FiatConnenct 端点 `FiatConnectClient` 举个例子 有一个 一个完全转帐的方便例子 [此验证测试](https://github.com/fiatconnect/validate/blob/63995bd10c160c0ed7a82a7a4c505ae5a9743246/validations/transfer.test.ts#L50)。 。 。 .

### 经认证的终点

注意一些FiatConnect端点需要认证才能被访问. 你可以在菲亚特康内特读取 认证 [这里](https://github.com/fiatconnect/specification/blob/main/fiatconnect-api.md#331-sign-in-with-ethereum)。 。 。 .

FiatConnect SDK 处理认证时使用一个 `signingFunction` 作为参数在 `FiatConnectClient` 建筑师。 这个 `FiatConnectClient` 实例使用签名函数来签名 SIWE 信件,并登录到 当 :

-   页:1 `login` 明确引用方法
-   对需要认证的端点使用任何方法(用户还没有有效的会话)

钱包可能或不希望每次SIWE消息签名时都会需要PIN,或者只是部分时间. 它们可以执行 无论他们有什么偏好,都写下 `signingFunction` 相应.

### 访问多个 FiatConnect 供应商

在大多数情况下,客户希望与多家FiatConnect供应商融合. 然而,值得注意的是 `FiatConnectClient` 类交易只与单一提供者。 这样可以更方便地分开会议 cookie和供应商特定配置数据(Base URL等).

例如如何管理多种 使用 FiatConnect SDK 的编码库中的 FiatConnect 提供者,您可以参考 [瓦罗拉钱包](https://github.com/valora-inc/wallet/blob/61cb017439c7e606d6c09d6a276584d15a857968/src/fiatconnect/clients.ts#L11), (中文(简体) ), 将一个对象存储在内存映射提供者 ID 到 FiatConnectClient 实例中。 存在着许多类似的可能性.

## 使用沙盒服务器进行测试

在编写本报告时,三家公司提供符合菲亚特康纳的沙盒API: [瓦罗拉](https://valoraapp.com/), (中文(简体) ), [阿尔法要塞](https://www.alphafortress.com/),以及 [比特玛](https://bitmama.io/)。 。 。 .

如果你想测试一个符合FiatConnect的沙盒服务器, 你可以问其中一家公司 [打开 解析器](https://discord.gg/yR5hFEVcRz) 与您共享 API 证书。 特别是,您需要一个基础 URL和 客户端 API 密钥,可用于即时化的 FiatConnectClient.

或者,如果你想更重地使用 一个沙盒服务器(例如CI),您可以使用 [api 启动器](https://github.com/fiatconnect/api-starter)。 。 。 .

## 正在测试

```console
yarn test
```

## 捐款

我们欢迎以 " 问题与公关 " 为形式作出的贡献。 见 [捐款额](https://npmcn.com/package/%40fiatconnect/fiatconnect-sdk/CONTRIBUTING.md)。如果您有想法 FiatConnect SDK,你想与其他开发商讨论,你可以联系我们 [FiatConnect Discord 磁盘](https://discord.gg/yR5hFEVcRz)。 。 。 .

### 出版

-   发布更新是自动通过 [语义释放](https://github.com/semantic-release/semantic-release)。 。 。 . 记住要用 [常规承诺](https://www.conventionalcommits.org/en/v1.0.0/) 或者你的公关将被拒绝(因为) 合并它会搅乱更改日志和版本号).

## 常见问题

### @fiatconnect/fiatconnect-sdk 是什么？

一个钱包与 FiatConnect API 集成的助手库

### 如何安装 @fiatconnect/fiatconnect-sdk？

在项目目录运行 npm install @fiatconnect/fiatconnect-sdk，或使用 pnpm add / yarn add / bun add。

### @fiatconnect/fiatconnect-sdk 支持 TypeScript 吗？

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

### @fiatconnect/fiatconnect-sdk 支持 ESM 还是 CommonJS？

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

### @fiatconnect/fiatconnect-sdk 可以商用吗？

@fiatconnect/fiatconnect-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fiatconnect/fiatconnect-sdk 的下载量有多少？

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

### @fiatconnect/fiatconnect-sdk 还在维护吗？

最新版本 0\.5\.168 发布于 2026/11/14（今天）；至今共发布 188 个版本，其中过去 12 个月发布了 12 个；首次发布于 2022/05/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。