Circle 的智能合同平台节点JS SDK
这个SDK为Circle的"智能合同"平台API提供了方便访问,用于由NodeJS所写的应用程序. API 参考文献 圆形 Web3 API 文件。 。 。 .
安装
以 :
npm install @circle-fin/smart-contract-platform --save
或者说
pnpm add @circle-fin/smart-contract-platform
使用量
-
生成 API 密钥, 如果您还没有, 在 Web3 服务控制台。当向 Circle 的 API 提出请求时,此 API 密钥将被用于认证和授权.
-
在 Circle 后注册一个实体 开发者控制的快速启动。该步骤确保您的账户正确设置,以便与 Circle 的 API 交互.
-
在你的代码中,导入工厂
initiateSmartContractPlatformClient使用您的 API 密钥和实体密钥初始化客户端 :const { initiateSmartContractPlatformClient } = require('@circle-fin/smart-contract-platform') const client = initiateSmartContractPlatformClient({ apiKey: '<your-api-key>', entitySecret: '<your-entity-secret>', })或者说
import { initiateSmartContractPlatformClient } from '@circle-fin/smart-contract-platform' const client = initiateSmartContractPlatformClient({ apiKey: '<your-api-key>', entitySecret: '<your-entity-secret>', }) -
与客户交互 :
const response = await client.deployContract({ name: 'First Contract', description: 'My first hello world contract', walletId: '004735f6-d9fc-44f8-933c-672cdf3d240d', abiJson: "[\n\t{\n\t\t'inputs': [],\n\t\t'stateMutability': 'nonpayable',\n\t\t'type': 'constructor'\n\t},\n\t...", bytecode: '0x60806040523480156200001157600080fd5b50604051806040...', constructorParameters: ['TICK', 10000], feeLevel: 'MEDIUM', }) console.log(response.data)
我们建议通过官方阅读 文档 财务报告和审定财务报表 快速启动指南 (b) 确保顺利设置和使用经验.
配置
客户端接受以下配置参数:
| 选项 | 需求 | 说明 |
|---|---|---|
apiKey | [x] (中文(简体) ) | 用于对 Circle API 认证的 Api 密钥 . |
entitySecret | [x] (中文(简体) ) | 您配置的实体秘密 。 你可以跟着 快速启动 来设置它. |
baseUrl | [ | 覆盖默认的可选基址 : https://api.circle.com。 。 。 . |
storage | [ | 为持续数据选择自定义存储解决方案 。 如果得不到任何信息,我们将回到记忆中. |
userAgent | [ | 可选自定义用户代理请求头. 如果提供的话, 我们将将其预置为默认用户代理头 . |
需要帮忙还是有问题?
这里有一些有用的链接,如果你遇到任何问题或对这个SDK有疑问:
- 📖 开始:检查我们的官方开发者控制的钱包QuickStart.
- 🎮 加入我们的Discord社区:接触、学习和协作.
- 🛎 访问 Help-Desk 页面:潜入所编的FAQ和向导.
- 📧 直接电子邮件我们总是一个信息离开.
- 📖 读取文件:检查我们的开发者文档.
编码愉快!