Circle 的用户控制钱包节点JS SDK
这个SDK为Circle的用户控制钱包API提供方便访问,用于被写入NodeJS的应用程序. API 参考文献 圆形 Web3 API 文件。 。 。 .
安装
以 :
npm install @circle-fin/user-controlled-wallets --save
或者说
pnpm add @circle-fin/user-controlled-wallets
使用量
-
生成 API 密钥, 如果您还没有, 在 Web3 服务控制台。当向 Circle 的 API 提出请求时,此 API 密钥将被用于认证和授权.
-
跟着我们 由用户控制快速启动。该步骤确保您充分掌握 Circle 用户控制钱包的概念.
-
在你的代码中,导入工厂
initiateUserControlledWalletsClient使用您的 API 密钥和实体密钥初始化客户端 :const { initiateUserControlledWalletsClient } = require('@circle-fin/user-controlled-wallets') const client = initiateUserControlledWalletsClient({ apiKey: '<your-api-key>' })或者说
import { initiateUserControlledWalletsClient } from '@circle-fin/user-controlled-wallets' const client = initiateUserControlledWalletsClient({ apiKey: '<your-api-key>' }) -
与客户交互 :
const response = await client.createTransaction({ userToken: 'dummy-user-token', amount: ['0.01'], destinationAddress: '0xa51c9c604b79a0fadbfed35dd576ca1bce71da0a', tokenId: '738c8a6d-8896-46d1-b2cb-083600c1c69b', walletId: 'a635d679-4207-4e37-b12e-766afb9b3892', fee: { type: 'level', config: { feeLevel: 'HIGH', }, }, }) console.log(response.data?.challengeId)
配置
客户端接受以下配置参数:
| 选项 | 需求 | 说明 |
|---|---|---|
apiKey | [x] (中文(简体) ) | 用于对 Circle API 认证的 Api 密钥 . |
baseUrl | [ | 覆盖默认的可选基址 : https://api.circle.com。 。 。 . |
storage | [ | 为持续数据选择自定义存储解决方案 。 如果得不到任何信息,我们将回到记忆中. |
userAgent | [ | 可选自定义用户代理请求头. 如果提供的话, 我们将将其预置为默认用户代理头 . |
需要帮忙还是有问题?
这里有一些有用的链接,如果你遇到任何问题或对这个SDK有疑问:
- 📖 开始:检查一下我们官方的用户控制钱包QuickStart.
- 🎮 加入我们的Discord社区:接触、学习和协作.
- 🛎 访问 Help-Desk 页面:潜入所编的FAQ和向导.
- 📧 直接电子邮件我们总是一个信息离开.
- 📖 读取文件:检查我们的开发者文档.
编码愉快!