# @aragon/osx-commons-contracts 中文文档

规范地址：https://npmcn.com/package/%40aragon/osx-commons-contracts/

版本：1\.4\.0
npm 元数据更新时间：2025-05-09T12:19:55.073Z
中文译文更新时间：2026-11-06T13:31:59.809Z
软件包许可：AGPL-3\.0-or-later

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

原始 npm 页面：https://www.npmjs.com/package/%40aragon/osx-commons-contracts
原文对照：https://npmcn.com/package/%40aragon/osx-commons-contracts/?lang=original
项目主页：https://github.com/aragon/osx-commons#readme
源码仓库：https://github.com/aragon/osx-commons

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

- 包体积（解压后）：113 kB，36 个文件
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2024-01-04T13:26:10.477Z
- 最新版本发布：2025-02-03T14:06:12.874Z
- 近 30 天下载量：5007（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

Aragon OSx 包含公共公用事业的合同包

## 安装

```sh
npm install @aragon/osx-commons-contracts
```

也可以使用：`pnpm add @aragon/osx-commons-contracts`、`yarn add @aragon/osx-commons-contracts`、`bun add @aragon/osx-commons-contracts`

## README

# 阿拉贡 OSx 共同合同

这个软件包包含了Solity智能合同,供OSx框架使用并用于插件开发. 关于审计信息,参见 [根级 README.md 中的“ 审计” 部分](https://npmcn.com/package/%40aragon/README.md#audits)。 。 。 .

## 项目

这个 `contracts` 文件夹包括下列团结合同和库:

```markdown
.
├── dao
│ └── IDAO.sol
├── permission
│ ├── PermissionLib.sol
│ ├── auth
│ │ ├── DaoAuthorizable.sol
│ │ ├── DaoAuthorizableUpgradeable.sol
│ │ └── auth.sol
│ └── condition
│ ├── IPermissionCondition.sol
│ ├── PermissionCondition.sol
│ └── PermissionConditionUpgradeable.sol
├── plugin
│ ├── IPlugin.sol
│ ├── Plugin.sol
│ ├── PluginCloneable.sol
│ ├── PluginUUPSUpgradeable.sol
│ ├── extensions
│ │ ├── governance
│ │ │ └── Addresslist.sol
│ │ ├── membership
│ │ │ └── IMembership.sol
│ │ └── proposal
│ │ ├── IProposal.sol
│ │ ├── Proposal.sol
│ │ └── ProposalUpgradeable.sol
│ └── setup
│ ├── IPluginSetup.sol
│ ├── PluginSetup.sol
│ └── PluginUpgradeableSetup.sol
└── utils
├── deployment
│ ├── ProxyFactory.sol
│ └── ProxyLib.sol
├── math
│ ├── BitMap.sol
│ ├── Ratio.sol
│ └── UncheckedMath.sol
└── versioning
├── IProtocolVersion.sol
├── ProtocolVersion.sol
└── VersionComparisonLib.sol
```

对于 **插件开发**,查找在 `plugin` 文件夹和代理服务器 `utils/deployment` 文件夹.

单位 `contracts`,第一次运行

```sh
yarn install
```

### 大楼

首先与

```sh
yarn build
```

这也会产生类型链绑定. 在你的智能合同的开发过程中, 变化会产生 装入已改变的型链绑定。 您可以删除过时的构建和类型链相关文件

```sh
yarn clean
```

这将执行 `yarn typechain` 再来一次 为方便起见 `yarn clean && yarn build`。 。 。 .

### 测试

为了测试你的合同,运行

```sh
yarn test
```

### 线性

将固态和类型脚本代码全部与

```sh
yarn lint
```

或单独使用

```sh
yarn lint:sol
```

财务报告和审定财务报表

```sh
yarn lint:ts
```

### 覆盖范围

生成代码覆盖报告

```sh
yarn coverage
```

### 天然气报告

请参看每个试验的气体使用量和每个方法的平均气体使用量

```sh
REPORT_GAS=true yarn test
```

,您可以永久启用气体报告,方法是设置 `REPORT_GAS=true` 输入 `.env` 文档.

## 常见问题

### @aragon/osx-commons-contracts 是什么？

Aragon OSx 包含公共公用事业的合同包

### 如何安装 @aragon/osx-commons-contracts？

在项目目录运行 npm install @aragon/osx-commons-contracts，或使用 pnpm add / yarn add / bun add。

### @aragon/osx-commons-contracts 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/aragon\_\_osx-commons-contracts 是否存在。

### @aragon/osx-commons-contracts 可以商用吗？

@aragon/osx-commons-contracts 使用 AGPL-3\.0-or-later 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @aragon/osx-commons-contracts 的下载量有多少？

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

### @aragon/osx-commons-contracts 还在维护吗？

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

