无线连接- sdk
一个轻量级 Typescript 帮助库,用于钱包或 Dapps 与 FiatConnect 兼容 API 集成.
基本用途
要开始, 请从您的项目安装库 :
yarn add @fiatconnect/fiatconnect-sdk
下一个,初始化 a FiatConnectClient 任何需要访问 FiatConnect API 在您的密码库。 见示例
页:1 瓦罗拉钱包
财务报告和审定财务报表 FiatConnect 验证测试。 。 。 .
从那里,您可以使用一个方法访问任何 FiatConnenct 端点 FiatConnectClient 举个例子 有一个
一个完全转帐的方便例子 此验证测试。 。 。 .
经认证的终点
注意一些FiatConnect端点需要认证才能被访问. 你可以在菲亚特康内特读取 认证 这里。 。 。 .
FiatConnect SDK 处理认证时使用一个 signingFunction 作为参数在 FiatConnectClient
建筑师。 这个 FiatConnectClient 实例使用签名函数来签名 SIWE 信件,并登录到
当 :
- 页:1
login明确引用方法 - 对需要认证的端点使用任何方法(用户还没有有效的会话)
钱包可能或不希望每次SIWE消息签名时都会需要PIN,或者只是部分时间. 它们可以执行
无论他们有什么偏好,都写下 signingFunction 相应.
访问多个 FiatConnect 供应商
在大多数情况下,客户希望与多家FiatConnect供应商融合. 然而,值得注意的是
FiatConnectClient 类交易只与单一提供者。 这样可以更方便地分开会议
cookie和供应商特定配置数据(Base URL等).
例如如何管理多种 使用 FiatConnect SDK 的编码库中的 FiatConnect 提供者,您可以参考 瓦罗拉钱包, (中文(简体) ), 将一个对象存储在内存映射提供者 ID 到 FiatConnectClient 实例中。 存在着许多类似的可能性.
使用沙盒服务器进行测试
在编写本报告时,三家公司提供符合菲亚特康纳的沙盒API: 瓦罗拉, (中文(简体) ), 阿尔法要塞,以及 比特玛。 。 。 .
如果你想测试一个符合FiatConnect的沙盒服务器, 你可以问其中一家公司 打开 解析器 与您共享 API 证书。 特别是,您需要一个基础 URL和 客户端 API 密钥,可用于即时化的 FiatConnectClient.
或者,如果你想更重地使用 一个沙盒服务器(例如CI),您可以使用 api 启动器。 。 。 .
正在测试
yarn test
捐款
我们欢迎以 " 问题与公关 " 为形式作出的贡献。 见 捐款额。如果您有想法 FiatConnect SDK,你想与其他开发商讨论,你可以联系我们 FiatConnect Discord 磁盘。 。 。 .