# @colony/colony-js 中文文档

规范地址：https://npmcn.com/package/%40colony/colony-js/

版本：8\.1\.0
npm 元数据更新时间：2025-01-30T14:04:14.410Z
中文译文更新时间：2026-11-10T11:52:35.486Z
软件包许可：GPL-3\.0-only

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

原始 npm 页面：https://www.npmjs.com/package/%40colony/colony-js
原文对照：https://npmcn.com/package/%40colony/colony-js/?lang=original
项目主页：https://docs.colony.io/develop
源码仓库：https://github.com/JoinColony/colonyJS

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

- 包体积（解压后）：28.2 MB，1650 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^18 \|\| ^20 \|\| ^22
- 运行依赖：3 个
- peer 依赖：ethers ^5\.1\.3
- 首次发布：2020-04-13T14:03:10.139Z
- 最新版本发布：2025-01-30T14:04:14.210Z
- 近 30 天下载量：3798（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：210（近 12 个月 0 个）

## 中文简介

QQ 殖民地类型参考执行

## 安装

```sh
npm install @colony/colony-js
```

也可以使用：`pnpm add @colony/colony-js`、`yarn add @colony/colony-js`、`bun add @colony/colony-js`

## README

QQ 殖民地类型参考执行

![](https://raw.githubusercontent.com/JoinColony/brand/v1.0.0/logo_js.svg)

# `@colony/colony-js`

communityJS是一个 JavaScript 库,具有简单和可预测的接口,用于应用程序层集成 [殖民地网络](https://github.com/JoinColony/colonyNetwork) 智能合约. 为了了解更多殖民地,你可以去参观 [殖民地.io](https://colony.io/) 或读取 [白皮书](https://colony.io/whitepaper.pdf)。 。 。 .

## 文档

[点击这里获取文件 !](https://docs.colony.io/colonyjs)

你应该看看 `getColonyNetworkClient` 函数在 `ColonyNetworkClient` 和延长殖民地合同文件 `clients/Colony/ColonyClientVX`。 。 。 .

## 开始

```typescript
import { providers, utils, Wallet } from 'ethers';
import { getColonyNetworkClient, ColonRpcEndpoint, Id, Network, Tokens } from '@colony/colony-js';

const { formatEther } = utils;

const provider = new providers.JsonRpcProvider(ColonyRpcEndpoint.ArbitrumOne);

const start = async () => {
  // Get a wallet instance
  const wallet = new Wallet(
    // This is a random private key (don't use this one for anything else and _definitely_ do not send valuables to the corresponding address)
    '0x0355596cdb5e5242ad082c4fe3f8bbe48c9dba843fe1f99dd8272f487e70efae',
    provider,
  );

  // Check out the logs to see the wallet address
  console.log('Wallet Address:', wallet.address);

  // Get a network client instance for ArbitrumOne Chain
  const networkClient = getColonyNetworkClient(
    Network.ArbitrumOne,
    wallet,
  );

  // Let's connect to the Meta Colony
  const metaColonyClient = await networkClient.getMetaColonyClient()
  // And check out it's CLNY funding
  const funding = await metaColonyClient.getFundingPotBalance(Id.RootPot, Tokens.ArbitrumOne.CLNY);
  // We can also see its address
  const { address } = metaColonyClient;
  console.info(`${formatEther(funding)} CLNY in root domain of MetaColony with address: ${address}`);
};

start();
```

## 太复杂了? 需要更多的指导吗?

尝试 [殖民地 SDK](https://docs.colony.io/colonysdk)。 。 。 .

## 许可证

GPL-3.0 (英语)

## 常见问题

### @colony/colony-js 是什么？

QQ 殖民地类型参考执行

### 如何安装 @colony/colony-js？

在项目目录运行 npm install @colony/colony-js，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：ethers（^5\.1\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @colony/colony-js 支持 TypeScript 吗？

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

### @colony/colony-js 支持 ESM 还是 CommonJS？

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

### @colony/colony-js 需要什么版本的 Node\.js？

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

### @colony/colony-js 可以商用吗？

@colony/colony-js 使用 GPL-3\.0-only 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @colony/colony-js 的下载量有多少？

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

### @colony/colony-js 还在维护吗？

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