# @bosonprotocol/common 中文文档

规范地址：https://npmcn.com/package/%40bosonprotocol/common/

版本：1\.35\.0
npm 元数据更新时间：2026-09-08T18:48:15.990Z
中文译文更新时间：2026-11-08T11:54:51.509Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40bosonprotocol/common
原文对照：https://npmcn.com/package/%40bosonprotocol/common/?lang=original
项目主页：https://github.com/bosonprotocol/core-components/tree/main/packages/common#readme
源码仓库：https://github.com/bosonprotocol/core-components

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

- 包体积（解压后）：3.5 MB，274 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2022-04-21T12:05:48.000Z
- 最新版本发布：2026-09-08T18:48:15.579Z
- 近 30 天下载量：7333（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：617（近 12 个月 24 个）

## 中文简介

常见的配置,类型,接口和由"博森协议"核心组成部分共同拥有的公用设施.

## 安装

```sh
npm install @bosonprotocol/common
```

也可以使用：`pnpm add @bosonprotocol/common`、`yarn add @bosonprotocol/common`、`bun add @bosonprotocol/common`

## README

# `@bosonprotocol/common`

JS lib,具有由"博森议定书"核心组成部分共享的共同类型,界面和公用事业.

## 安装

```bash
npm install @bosonprotocol/common

# OR

yarn add @bosonprotocol/common
```

## 使用量

### ABIs 函数

可导入有用的 ABIs .

```js
import { abis } from "@bosonprotocol/common";

const { ProtocolDiamondABI } = abis;
```

### 默认配置

我们为多种环境提供默认配置,这些配置可用于更方便的交互.

```js
import { getDefaultConfig } from "@bosonprotocol/common";

const defaultConfigOnRopsten = getDefaultConfig("staging");
// {
//   ...otherConfigParameters,
//   subgraphUrl: "https://api.thegraph.com/subgraphs/name/bosonprotocol/ccropsten",
//   contracts: {
//     protocolDiamond: "0x5E3f5127e320aD0C38a21970E327eefEf12561E5"
//   }
// }
```

### 接口和类型

界面和类型也可以被导入. 这可能有利于执行习惯a `Web3LibAdapter` 或者说 `MetadataStorage`。 。 。 .

```ts
import { Web3LibAdapter, MetadataStorage } from "@bosonprotocol/common";

class CustomWeb3LibAdapter implements Web3LibAdapter {
  // implementation
}

class CustomMetadataStorage implements MetadataStorage {
  // implementation
}
```

#### `Web3LibAdapter`

这个 [核心数据](https://npmcn.com/packages/core-sdk/README.md) 具有以下特征:

-   网络3 lib 可知性
-   轻型
-   由可堆肥的构件组成
-   利用现有工具,例如: [类型](https://github.com/dethcrypto/TypeChain)

为了实现这些目标,我们使用适配器模式 [`Web3LibAdapter`](https://npmcn.com/package/%40bosonprotocol/common/src/types/web3-lib-adapter.ts) 是接口.

一个实例是: [`EthersAdapter`](https://npmcn.com/packages/ethers-sdk/src/ethers-adapter.ts) 目标 [醚](https://docs.ethers.io/) 图书馆.

## 常见问题

### @bosonprotocol/common 是什么？

常见的配置,类型,接口和由"博森协议"核心组成部分共同拥有的公用设施\.

### 如何安装 @bosonprotocol/common？

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

### @bosonprotocol/common 支持 TypeScript 吗？

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

### @bosonprotocol/common 支持 ESM 还是 CommonJS？

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

### @bosonprotocol/common 可以商用吗？

@bosonprotocol/common 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bosonprotocol/common 的下载量有多少？

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

### @bosonprotocol/common 还在维护吗？

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