# @circle-fin/provider-borrow-service 中文文档

规范地址：https://npmcn.com/package/%40circle-fin/provider-borrow-service/

版本：1\.0\.5
npm 元数据更新时间：2026-11-05T17:19:20.224Z
中文译文更新时间：2026-11-09T16:48:32.073Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40circle-fin/provider-borrow-service
原文对照：https://npmcn.com/package/%40circle-fin/provider-borrow-service/?lang=original

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

- 包体积（解压后）：2.3 MB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：9 个
- 首次发布：2026-09-30T12:36:25.670Z
- 最新版本发布：2026-11-05T17:19:20.048Z
- 近 30 天下载量：9136（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

借款Kit圆形贷款后端供应商

## 安装

```sh
npm install @circle-fin/provider-borrow-service
```

也可以使用：`pnpm add @circle-fin/provider-borrow-service`、`yarn add @circle-fin/provider-borrow-service`、`bun add @circle-fin/provider-borrow-service`

## README

# 借款服务提供者

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

借款服务提供人界定了借款包和 用于 Circle 借款服务的默认 HTTP 执行,涵盖 贷款清单(`getLoans`),部分还款(`repay`, (中文(简体) ), `getRepayQuote`),贷款 位置改为(`getPosition`),抵押品管理(`addCollateral`, (中文(简体) ), `withdrawCollateral`以报应盟誓`claimRewards`, (中文(简体) ), `getRewards`),以及 `registerWebhook`。 。 。 .

`registerWebhook` 建造EIP-712 `WebhookRegistration` 输入的数据, 通过连接的适配器获取签名并提交签名 登记核查(包括EIP-1271智能支持) 合同账户)。 这是一个没有权限的客户签名的流程,没有 上链交易,没有 API 密钥.

向注册的URL发送健康带通知 最少一次:同一过境点可不止一次抵达。 重写 通知内容 `event_id`,这在一次过境的重复中是稳定的.

## 安装

```bash
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`; 见 [配置](https://npmcn.com/package/%40circle-fin/provider-borrow-service/#readme-configuration) 见下文.

```typescript
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`,在 (签名).

```typescript
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所示):

```typescript
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许可证获得许可. 联系人 [支助](https://help.circle.com/s/submit-ticket) 详细情况.

## 常见问题

### @circle-fin/provider-borrow-service 是什么？

借款Kit圆形贷款后端供应商

### 如何安装 @circle-fin/provider-borrow-service？

在项目目录运行 npm install @circle-fin/provider-borrow-service，或使用 pnpm add / yarn add / bun add。

### @circle-fin/provider-borrow-service 支持 TypeScript 吗？

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

### @circle-fin/provider-borrow-service 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @circle-fin/provider-borrow-service 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @circle-fin/provider-borrow-service 可以商用吗？

@circle-fin/provider-borrow-service 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @circle-fin/provider-borrow-service 的下载量有多少？

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

### @circle-fin/provider-borrow-service 还在维护吗？

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