借款服务提供者
借款服务提供人界定了借款包和
用于 Circle 借款服务的默认 HTTP 执行,涵盖
贷款清单(getLoans),部分还款(repay, (中文(简体) ), getRepayQuote),贷款
位置改为(getPosition),抵押品管理(addCollateral, (中文(简体) ),
withdrawCollateral以报应盟誓claimRewards, (中文(简体) ), getRewards),以及
registerWebhook。 。 。 .
registerWebhook 建造EIP-712 WebhookRegistration 输入的数据,
通过连接的适配器获取签名并提交签名
登记核查(包括EIP-1271智能支持)
合同账户)。 这是一个没有权限的客户签名的流程,没有
上链交易,没有 API 密钥.
向注册的URL发送健康带通知
最少一次:同一过境点可不止一次抵达。 重写
通知内容 event_id,这在一次过境的重复中是稳定的.
安装
npm install @circle-fin/provider-borrow-service
# or
yarn add @circle-fin/provider-borrow-service
此提供者默认包含在 @circle-fin/borrow-kit导入它
当您需要自定义提供者构建或自编自编时
借 Kit 语境 .
快速启动
说明:
@circle-fin/borrow-kit尚未公布——此示例 显示其一出船的预定用途。 在此之前,建造BorrowServiceProvider打电话registerWebhook直接用一个 已解决EVMChainDefinition; 见 配置 见下文.
import {
createBorrowKitContext,
registerWebhook,
} from "@circle-fin/borrow-kit";
import { BorrowServiceProvider } from "@circle-fin/provider-borrow-service";
import { createViemAdapterFromPrivateKey } from "@circle-fin/adapter-viem-v2";
const provider = new BorrowServiceProvider();
const context = createBorrowKitContext({ providers: [provider] });
const privateKey = process.env.PRIVATE_KEY;
if (!privateKey) throw new Error("PRIVATE_KEY is required");
const adapter = createViemAdapterFromPrivateKey({ privateKey });
const result = await registerWebhook(context, {
from: { adapter, chain: "Arc_Testnet" },
loanId: "11111111-1111-4111-8111-111111111111",
webhookUrl: "https://example.com/webhook",
});
console.log(`Registered webhook: ${result.webhookUrl}`);
配置
BorrowServiceProvider 接受构造器中的默认配置,并
每个请求的操作配置。 操作值
优先级,而省略的值继续使用构造器默认值.
API 密钥只能为 borrow 财务报告和审定财务报表 getBorrowQuote,并需要用于
getIntegratorConfig 财务报告和审定财务报表 setIntegratorConfig。所有其他 API 拒绝
请求前配置了密钥(或,用于 registerWebhook,在
(签名).
const provider = new BorrowServiceProvider({
apiKey: process.env.CIRCLE_API_KEY,
baseUrl: "https://api-staging.circle.com",
});
apiKey 取圆形 API 键(<ENV>_API_KEY:<keyId>:<keySecret>) (中文(简体) ). 遗产
KIT_KEY:<keyId>:<keySecret> 值在同一个字段中行并
认证;控制台不再发行. 这是服务器唯一的秘密
并在浏览器中被拒绝。 关闭它为无键路线.
通话 registerWebhook 直接对提供者要求解决
EVMChainDefinition 和连接的钱包地址
适配器. EVMChainDefinition 数值(例如 ArcTestnet现居
内部 @core/chains 软件包,该软件包不单独发布——
下面的片段显示到 @circle-fin/borrow-kit
(按名称解决链条,如Quick Start所示):
import { ArcTestnet } from "@core/chains";
const result = await provider.registerWebhook({
adapter,
chain: ArcTestnet,
address: "0x1234567890123456789012345678901234567890",
loanId: "11111111-1111-4111-8111-111111111111",
webhookUrl: "https://example.com/webhook",
deadline: Math.floor(Date.now() / 1000) + 300,
});
console.log(`Registered webhook: ${result.webhookUrl}`);
这个 BorrowServiceProvider 通过执行钱包范围贷款列表
GET /v1/borrowKit/loans,包括光标标记、响应验证,
重试行为和结构错误.
它还执行部分还款,并完全完成准备/报价 结束点。 重新使用呼叫器提供的单能键或生成 一个省略; 完全关闭写入生成一个。 引文请求保留 副作用自由并省略.
许可证
这个项目根据Apache 2.0许可证获得许可. 联系人 支助 详细情况.