@argonprotocol/mainchain

中文文档
1.6.0发布于 2026/11/15MITTypeScriptESM + CJS构建来源已验证近 30 天下载 6.9万

访问 Argon 主链 apis 的客户端 .

中文使用文档
文档目录5 节
  1. 安装
  2. 客户端使用
  3. 工资保护者
  4. 电灯同步
  5. 网关活动流量证明

这是Argon协议的 Node.js 客户端(https://argonprotocol.org 请检查url=值 (帮助)) (中文(简体) ). 其内容如下: 核心特征:

  1. 一个打字程序为Argon协议生成了 RPC 客户端 .
  2. 用于保护工资免受通货膨胀或通货紧缩的“保护者”类别 阿贡.

安装

npm install @argonprotocol/mainchain

客户端使用

要创建客户端, 您可以使用 getClient(host) 函数。 这个会回来的 输入到 argon apis 的客户端对象.

工资保护者

如果你想保护工资免受阿尔贡的通货膨胀或通货紧缩的影响,就有一个 WageProtector 可以使用的类。 你可以一次使用它:

const { WageProtector } = require('@argonprotocol/mainchain');
const basePrice = 1_000_000n; // 1 Argon
const protector = await WageProtector.create(client);
const protectedPrice = protector.getProtectedWage(basePrice);

或者您可以订阅更改( 例如, 跟踪一系列有效的 cpi 调整 ):

const { WageProtector } = require('@argonprotocol/mainchain');
const basePrice = 1_000_000n; // 1 Argon
const { unsubscribe } = await WageProtector.subscribe(client, protectedPrice => {
  console.log(`Protected price: ${protectedPrice.getProtectedWage(basePrice)}`);
});

每个 WageProtector 例如,有Argon目标价格和美元价格的细节 创建.

interface IArgonCpiSnapshot {
  // The target price of the argon as a fixed point number (18 decimals)
  argonUsdTargetPrice: bigint;
  // The current price of the argon as a fixed point number (18 decimals)
  argonUsdPrice: bigint;
  // The block hash in which the cpi was finalized
  finalizedBlock: Uint8Array;
  // The tick that the cpi applies to
  tick: bigint;
}

电灯同步

当构建信标同步或拖曳交易时通过执行源 :

const transactions = await getNextEthereumBeaconSyncTxs(client, beaconApiUrl, {
  executionRpcUrl,
});

Gloas轻客户头包含执行块散列而不是有效载荷头. 这个 执行 RPC 提供匹配的标题字节,客户端对照散列检查. 最初的Gloas有效载荷头反应可以省略执行源. 历史标题 升级到只散列格式也需要它. getEthereumBeaconSyncBootstrapTx 接受相同的建议 第三辩相.

现有核查国与Gloas一起迁移。 一旦发现它的版本和时代, 治理可以称为 setGloasFork 作为根,而不重设检查站、委员会或锚. 这一呼吁保留了更早的叉子,并拒绝对Gloas历史的修改.

网关活动流量证明

发现,存储-目击捕捉,接力准备是单独的操作. Apps自己的缓冲, 排程、RPC倒置和提交:

  1. 打电话 discoverMissingGatewayActivityLocators(...) 附有最终执行块号+ 最小的网关活动不关你的事。 如果您已缓存已最后确定定位器, 请通过 afterLocatorIndex 只获取新后缀.
  2. 在你收集时 缓存在应用程序中的最后定位块.
  3. 若为 supportsGatewayActivityStorageProofs(client) 是真的,打电话 captureGatewayActivityStorageProofs(...) 对最近一个被埋设了地雷的行刑区 仍然有状态。 此操作不需要Argon客户端或保留锚. 它捕捉到 在一个选中位置 eth_getProof 要求并核实它们与该块的状态根.
  4. 缓存应用程序中返回的丰富定位器记录 。 他们的证人群不能最终确定 然而;将最终定位器记录分开保存,以便在重置后可以替换证人.
  5. 打电话 buildGatewayActivityProof(...) 包含存储运行时间的缓存抓取, 或 plain 发现只接收运行时间的定位器 。 它倾向于在支持时存储,选择 最接近保留了锚,并附着了有界限的祖先路径. 存储中继准备 而不是寻找证人、日志或合同状态 每个载荷都证明有一个完整的定位器.
  6. 向 proveGatewayActivity(...) 和储存的有效载荷(由 locatorIndex 内 payload.proof改为: proveGatewayActivityStorage(...)保留任何 deferredLocators 为了以后的尝试。 替换包含在 recaptureLocators 使用一个 新的行刑区块:他们成为孤儿,或者在被保留锚的祖先束缚之外.

用于明确的证明选择,使用 buildGatewayActivityReceiptProofPayloads(...) 已发现 定位器或 buildGatewayActivityStorageProofs(...) 与俘获的定位器。 能力是 独立; 运行时间可以接受任一格式.

const captures = await captureGatewayActivityStorageProofs({
  executionClient,
  executionBlock: await executionClient.getBlock({ blockTag: 'latest' }),
  gatewayAddress,
  locators,
});
// Persist captures in the app, then prepare relay transactions when anchors become available.
const result = await buildGatewayActivityProof(client, {
  executionClient,
  gatewayAddress,
  locators: captures,
});

储存证明包括全部定位器的活动记录及其 activityRootSeed,即使当 最后证明的"非斯" 属于该定位器。 仅 payload.activities 财务报告和审定财务报表 payload.gatewayActivityNonceRange 描述新应用的后缀。 没有靴子调用或存储 需要最后一个位置的散列.

仅收件包含并不能使日志成为下一个网关活动 。 不可解码或不相关 网关日志被拒绝, 不缺少同步; 解码的活动必须拥有下一个 毗连无相. 与本地商业状态相冲突的下一个有效活动可以暂停同步 . 在修复该状态后,一个操作员可以从当前非ce中解禁并重建. 存储 证书仍然认证了全位定位符,但不再使用它已经使用的前缀。 若为 在完成最后活动后, 过期清理失败, 仅靠闲置不会重试 : 之后在经过认证的块边界上成功处理的活动块重新清理.

被推迟的定位器正在等待失踪的前辈或执行锚. 一个定位器 超过运行时的验证能力是配置/支持错误,而不是延迟工作:等待 不能让它适合。 这种流动针对合同的每块128个活动上限。 托盘 完整性检查覆盖了硬盖、最大大小的事件、编码的证明字节和提供者 重量.

客户端库不保存长寿定位器或证人缓存. App -side代码应该拥有它, 范围为最后一个已证实的网关定位器与最新收集的已定稿的网关定位器之间的范围 以利亚街 保留尚未停靠 Argon 的定位器,并通过缓存 定位器进入网关验证大楼 和行刑长回填计划.

版本与发布记录

@argonprotocol/mainchain 共发布 297 个版本,首次发布于 2024/08/28;过去 12 个月发布了 220 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.6.0latest2026/11/151 天前
1.5.2-dev.96d18beedev2026/11/133 天前
1.5.2-dev.4f5b015c2026/11/124 天前
1.5.2-dev.085c3add2026/11/115 天前
1.5.2-dev.c911d6132026/11/115 天前
1.5.2-dev.247195a52026/11/105 天前

关于 @argonprotocol/mainchain 的常见问题

@argonprotocol/mainchain 是什么?

访问 Argon 主链 apis 的客户端 .

如何安装 @argonprotocol/mainchain?

在项目目录运行 npm install @argonprotocol/mainchain,或使用 pnpm add / yarn add / bun add。

@argonprotocol/mainchain 支持 TypeScript 吗?

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

@argonprotocol/mainchain 支持 ESM 还是 CommonJS?

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

@argonprotocol/mainchain 可以商用吗?

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

@argonprotocol/mainchain 的下载量有多少?

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

@argonprotocol/mainchain 还在维护吗?

最新版本 1.6.0 发布于 2026/11/15(1 天前);至今共发布 297 个版本,其中过去 12 个月发布了 220 个;首次发布于 2024/08/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。