# @biconomy/paymaster 中文文档

规范地址：https://npmcn.com/package/%40biconomy/paymaster/

版本：3\.1\.4
npm 元数据更新时间：2025-05-13T14:46:42.472Z
中文译文更新时间：2026-11-08T01:36:33.574Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40biconomy/paymaster
原文对照：https://npmcn.com/package/%40biconomy/paymaster/?lang=original
项目主页：https://github.com/bcnmy/biconomy-client-sdk#readme
源码仓库：https://github.com/bcnmy/biconomy-client-sdk

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

- 包体积（解压后）：120 kB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2023-07-13T09:31:03.617Z
- 最新版本发布：2024-10-11T14:34:33.907Z
- 近 30 天下载量：2060（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

Bicoomy Paymaster 与 Paymaster Services 互动, 与 (vriy and sorry ) 的 Paymaster 服务互动

## 安装

```sh
npm install @biconomy/paymaster
```

也可以使用：`pnpm add @biconomy/paymaster`、`yarn add @biconomy/paymaster`、`bun add @biconomy/paymaster`

## README

# **付费主管**

ERC4337,账户抽象,引入了付费主的概念. 这些专门实体在改造EVM交易中的传统天然气支付系统方面发挥着关键作用。 作为第三方中介的付费主管具备担保某一账户的燃气费的能力,条件是满足具体预先确定的条件.

## 安装

使用 `npm` 软件包管理器

```bash
npm i @biconomy/paymaster
```

或

使用 `yarn` 软件包管理器

```bash
yarn add @biconomy/paymaster
```

**使用量**

```typescript
// This is how you create paymaster instance in your dapp's
import { IPaymaster, BiconomyPaymaster } from "@biconomy/paymaster";

// Currently this package only exports Biconomy Paymaster which acts as a Hybrid paymaster for gas abstraction. You can sponsor user transactions but can also make users pay gas in supported ERC20 tokens.

const paymaster = new BiconomyPaymaster({
  paymasterUrl: "", // you can get this value from biconomy dashboard. https://dashboard.biconomy.io
});
```

**付费管理者Url** 您可以从双相仪表板获得这个值.

下面是可以向付费人求助的方法

```typescript
export interface IHybridPaymaster<T> extends IPaymaster {
  getPaymasterAndData(userOp: Partial<UserOperation>, paymasterServiceData?: T): Promise<PaymasterAndDataResponse>;
  buildTokenApprovalTransaction(tokenPaymasterRequest: BiconomyTokenPaymasterRequest, provider: Provider): Promise<Transaction>;
  getPaymasterFeeQuotesOrData(userOp: Partial<UserOperation>, paymasterServiceData: FeeQuotesOrDataDto): Promise<FeeQuotesOrDataResponse>;
}
```

也可以建立自己的Paymaster API类,并提交 PR 或仅在账户包中提供实例 / 单独使用生成Paymaster AndData

它应该遵循界面下面.

```typescript
export interface IPaymaster {
  // Implementing class may add extra parameter (for example paymasterServiceData with it's own type) in below function signature
  getPaymasterAndData(userOp: Partial<UserOperation>): Promise<PaymasterAndDataResponse>;
  getDummyPaymasterAndData(userOp: Partial<UserOperation>): Promise<string>;
}
```

### API 方法下方可用于 Biconomy 混合付费

**获取 Paymaster 安达塔**

此函数接受 a **`Partial<UserOperation>`** 对象,包括所有属性 **`userOp`** 除外 **`signature`** 财务报告和审定财务报表 **`paymasterAndData`** 字段。 它回来了 **`paymasterAndData`** 作为《京都议定书》 **`PaymasterAndDataResponse`**

**构建 Token 核准交易**

此功能专门用于象征性的付费赞助. 此功能的主要目的是为付费人创建一个批准交易, 并随其他交易进行批发.

注:您不需要调用此函数 。 它会自动被调用为 **`buildTokenPaymasterUserOp`** 函数调用.

**获取 PaymasterFee 引用 OrData**

此功能用于根据提供的用户操作和付费主服务数据获取引用信息或付费主数据. 如果未提供明确的模式,它首先尝试赞助,然后回到支持/请求的代号的服务费报价

说明: 此函数可以返回 **付费主AndData** 也以防所有政策检查都通过.

## 常见问题

### @biconomy/paymaster 是什么？

Bicoomy Paymaster 与 Paymaster Services 互动, 与 \(vriy and sorry \) 的 Paymaster 服务互动

### 如何安装 @biconomy/paymaster？

在项目目录运行 npm install @biconomy/paymaster，或使用 pnpm add / yarn add / bun add。

### @biconomy/paymaster 支持 TypeScript 吗？

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

### @biconomy/paymaster 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @biconomy/paymaster 可以商用吗？

@biconomy/paymaster 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @biconomy/paymaster 的下载量有多少？

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

### @biconomy/paymaster 还在维护吗？

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