[sender, recipient, call])" --> M_O + M_O -. "relay" .- M_D + M_D -- "handle(origin, router,
[sender, recipient, call])" --> A_D + A_D == "interchainAccount(origin, sender)" ==> SenderAccount + SenderAccount -- "call" --> Recipient + + click A_O https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/middleware/InterchainAccountRouter.sol + click A_D https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/middleware/InterchainAccountRouter.sol + + style Sender fill:#FF0099 + style SenderAccount fill:#FF0099 + style Recipient fill:#FF0099 +``` + +## 跨链账户的工作原理 + +跨链账户允许您使用路由器（`InterchainAccountRouter`）从**链 A** 向**链 B** 进行远程调用。我们使用 [CREATE2](https://docs.openzeppelin.com/cli/2.8/deploying-with-create2) 来计算确定性的 [OwnableMulticall](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/middleware/libs/OwnableMulticall.sol) 合约地址，该合约作为您跨链调用的代理。您可以在[这里](./example-usage)探索这一点。 + +工作原理如下： + +- 您可以编码您的调用，包括目标地址、调用数据和每个调用的 `msg.value`，批量组合在一个数组中。 +- 您将编码的调用发送到**链 A** 路由器，该路由器将其中继到**链 B** 路由器。 +- 解码调用后，**链 B** 路由器检查计算的地址是否已部署。如果没有，我们部署 _OwnableMulticall_ 合约。 +- 然后路由器在 ICA 地址上执行多重调用，该地址反过来在**链 B** 上进行所需的任意调用。 + +跨链账户接口为每个 `(uint32 origin, address owner, address remoteRouter, address remoteISM)` 元组分配一个唯一的 ICA 地址。发送者拥有目标链上的该 ICA，并可以通过 `InterchainAccountRouter.callRemote()` 端点指导其进行任意函数调用。 + +对于 Hyperlane 支持的核心链，您可以使用路由器合约所有者设置的默认值。请参见 [#overrides](./overrides) 部分了解如何调用_任何_链。 + +## 接口 + +```solidity +// SPDX-License-Identifier: MIT OR Apache-2.0 +pragma solidity >=0.6.11; + +import {CallLib} from "../contracts/libs/Call.sol"; + +interface IInterchainAccountRouter { + function callRemote( + uint32 _destinationDomain, + CallLib.Call[] calldata calls + ) external returns (bytes32); + + function getRemoteInterchainAccount(uint32 _destination, address _owner) + external + view + returns (address); +} +``` + +
recipient, amount)" --> BWR + BWR -. "{recipient, amount}" .-> NWR + AU -- "transferRemote(newchain,
recipient, amount)" --> AWR + AWR -. "{recipient, amount}" .-> NWR + NWR -. "2 \* amount" .-> Recipient +``` + +## 支持的代币和协议 + +当 HWR 2.0 中每个参与链上的给定代币满足所需条件时，原生重新平衡是可能的。 + +### USDC + +- **链**：Arbitrum、Base、以太坊、OP Mainnet、Polygon PoS、Unichain、Avalanche + - 对 [Circle CCTP](https://developers.circle.com/cctp) v1/v2 和 Everclear 支持的其他链的支持将逐步推出。 + +### ETH +- **链**：Arbitrum Base、以太坊、OP Mainnet + - 对其他链的支持将基于 Everclear 部署逐步推出 + +### USDT + +- 🚧 原生重新平衡支持目前已计划 + +
+
+
+## 2. 核心
+
+接下来，让我们配置、部署和测试您自定义链的核心合约。
+
+### 初始化配置
+
+1. 从您的本地环境，将您已资助的部署者地址的私钥或助记词设置为 `HYP_KEY`。例如：`export HYP_KEY='+ 此配置在 `$HOME/.hyperlane/chains/yourchain/metadata.yaml` 的示例内容 +
+ +```yaml +# yaml-language-server: $schema=../schema.json +# 您的自定义链的元数据 + +blockExplorers: + - apiUrl: https://explorer.yourchain.com/api + apiKey: XXXX # 有助于避免合约验证 API 的速率限制 + family: etherscan #您使用的浏览器，也支持 routescan 或 blockscout + name: Chainscan + url: https://explorer.yourchain.com +blocks: + confirmations: 1 + estimateBlockTime: 1 + reorgPeriod: 0 +chainId: 171717 +displayName: Chain Name +domainId: 171717 +isTestnet: true # 可选 +name: yourchain +nativeToken: + name: Ether + symbol: ETH + decimals: 18 +protocol: ethereum +rpcUrls: + - http: https://hyper-lane-docs.rpc.caldera.xyz/http +``` + +
+
+
+### 部署合约
+
+要部署合约，运行：
+
+```bash
+hyperlane core deploy
+```
+
+使用箭头和回车从主网列表底部选择您的自定义链。所有合约部署需要几分钟时间。
+
++ 部署配置将写入 `./configs/core-config.yaml` +
+ +```yaml +# 拥有和管理已部署合约的地址。此账户具有管理员权限。 +owner: "0x16F4898F47c085C41d7Cc6b1dc72B91EA617dcBb" + +# 默认跨链安全模块 (ISM) 配置。 +defaultIsm: + #`type`: 指定 ISM 的类型。这里，它使用受信任的中继器 ism。 + type: trustedRelayerIsm + #`relayer`: 负责处理跨链消息的中继器地址。 + relayer: "0x16F4898F47c085C41d7Cc6b1dc72B91EA617dcBb" + +defaultHook: + # 指定使用默克尔树的钩子配置。 + type: merkleTreeHook + +requiredHook: + # 负责管理钩子配置的所有者地址。 + owner: "0x16F4898F47c085C41d7Cc6b1dc72B91EA617dcBb" + # 钩子的类型。这个应用协议费用机制。 + type: protocolFee + # 接收协议费用的地址。 + beneficiary: "0x16F4898F47c085C41d7Cc6b1dc72B91EA617dcBb" + # 协议允许的最大费用，以 wei 为单位。 + maxProtocolFee: "100000000000000000" + # 协议收取的当前费用，为测试目的设置为 0。 + protocolFee: "0" +``` + +
+
+
++ 在 `$HOME/.hyperlane/chains` 下，您将找到一个以您的自定义链名称命名的新文件夹，以及该文件夹内名为 `addresses.yaml` 的文件 +
+ +```yaml +staticMerkleRootMultisigIsmFactory: "0x6906cb4741d3E2322E9f9aA645DfC8AB6F122c47" +staticMessageIdMultisigIsmFactory: "0x3CE97a32d9C8294691cBd2baC09B078EDa75c429" +staticAggregationIsmFactory: "0x81f969fDBF48278Ce09685Ce48e03388B6785aF4" +staticAggregationHookFactory: "0x3d864A3c25F61E3c3A7d02e980453A6E1f0a92A6" +domainRoutingIsmFactory: "0xC4c01f7B03f0fFa77A0265C600dEF7Ad28BCa5A2" +proxyAdmin: "0xABb7175d5F123172E7B7Fa467CC9fE4C2FEdb942" +mailbox: "0x5F58d75A9caDE4e2b191313223978dF049f93b81" +interchainAccountRouter: "0x43c0745b0dE9Cb780816a24ddE63d79Ca99B5dE8" +interchainAccountIsm: "0x9C96dC8f4257413225d6B5C47d1afbafc39B269F" +validatorAnnounce: "0xE3bd39BF92DB385dE6313D6070b035bD934378CB" +testRecipient: "0xa58462b1943Be1469Ed58db690C78583BA34Fd2E" +``` + +{value - fee}" ..-> C_H + C_H -- "externalCall(metadata, message)" --> E_B_O + + end + + E_B_O -. "crosschainCall(metadata,message)" ..-> E_B_D + M_O -. "relay" ..-> M_D + + subgraph Destination Chain + Recipient + M_D[(Mailbox)] + E_B_D[(ExternalBridgeDestination)] + ISM{AbstractMessageIdAuthorizedIsm} + + M_D -- "handle(origin,sender,message)" --> Recipient + M_D -- "verify(metadata, message)" --> ISM + ISM -. "interchainSecurityModule()" .- Recipient + + E_B_D -- "verifiedMessageId(message)" --> ISM + end + + style E_B_O fill: #FF0099 + style E_B_D fill: #FF0099 +``` + +## 接口 + +在实现上述接口后，您可以通过在我们的 mailbox 中使用重载的 `dispatch` 调用来覆盖默认 hook 以及 hook metadata。 + +**在源链上：** + +- `mailbox.dispatch()` 通过 `AbstractMessageIdAuthHook.postDispatch()` 调用您的自定义 hook。 +- `_postDispatch` 检查 `latestDispatchedId` 是否是从 hook 调度的 id，以确保 mailbox 是调用 hook 的合约（因为调用 `postDispatch` 没有访问控制） +- `_sendMessageId` 调用您的自定义外部桥接逻辑，例如调用 CCIP router 合约。 + +**在目标链上：** + +- 外部桥接将调用 `verifyMessageId` 函数（该函数有访问控制）并在 `verifiedMessages` 映射中将 `messageId` 设置为 true。 +- 在接收到 relayer 的消息时，mailbox 将调用您的 ISM 合约（在您的接收者地址中指定），它检查 `verifiedMessages` 映射中的 messageId 是否为 true，并向 mailbox 返回 true，反之亦然。 + +
Alice] -->|Deposit USDC| B[yourchain:
EvmHypOwnerCollateral] + B -->|USDC Deposit into Vault| C[Ethereum:
ERC-4626 Vault] + C -->|Yield Generation| C + B ==>|Bridge| E[yourchain:
EvmHypSynthetic] + E -->|Mint Synthetic USDC| F[yourchain:
Alice] + C[Ethereum:
ERC-4626 Vault] -->|Withdraw Yield| G[Ethereum:
Vault Owner] +``` + +在此示例中，Alice 想要在 Ethereum 和 yourchain 之间桥接 USDC。收益路由将把她的 USDC 转移到收益型 ERC-4626 保险库，然后在 yourchain 上为她铸造合成 USDC。请注意，收益路由所有者可以索取从该保险库生成的收益。 + +**桥接 USDC：yourchain → Ethereum** + +```mermaid +flowchart LR + A[yourchain:
Alice] -->|Burn Synthetic USDC| B[yourchain:
EvmHypSynthetic] + B ==>|Bridge| C[Ethereum:
EvmHypOwnerCollateral] + D[Ethereum:
ERC-4626 Vault] -->|USDC Withdraw from Vault| C + C -->|Withdraw USDC| F[Ethereum:
Alice] + +``` + +当 Alice 想要桥接回 Ethereum 时，会发生相反的情况。收益路由将销毁她的合成 USDC，从 Ethereum 上的保险库提取 USDC，并返还她的 USDC。 + +### Yield Route (收益路由) 部署步骤 + +使用 Hyperlane CLI，在 Ethereum 和 yourchain 上分别部署 USDC EvmHypOwnerCollateral 和 EvmHypSynthetic 代币： + +#### 1. 运行 `hyperlane warp init` 生成 HWR 配置： + +1. 使用空格选择 `yourchain` 和 `Ethereum`，然后按回车。 +2. 对于 Ethereum，选择 `collateralVault`，接受 mailbox，并输入 yourchain 上的 USDC 保险库地址。 + - 或者，您可以选择 `collateralVaultRebase`，这是一种收益路由变体，通过增加持有量向用户分配收益。 +3. 对于 yourchain，选择 `synthetic` 并接受 mailbox。 + + - 如果您选择了 `collateralVaultRebase`，您必须将其与 `syntheticRebase` 配对 + +#### 2. 运行 `hyperlane warp deploy` 部署 HWR。 + +### 索取收益 + +根据收益路由变体，可以通过在各自的合约上调用 `HypERC4626OwnerCollateral.sweep()` 或 `HypERC4626Collateral.rebase()` 来索取收益。 + +
token to ycETH + ycETH-->>yETH: 2) transfer 100%
of receipt token + yETH-->>yETH: 3) deposit native
as collateral + yETH-->ETH: <- fast ETH transfer -> +``` + +
recipient, amount)" --> BWR + BWR -. "{recipient, amount}" .-> NWR + AU -- "transferRemote(newchain,
recipient, amount)" --> AWR + AWR -. "{recipient, amount}" .-> NWR + NWR -. "2 \* amount" .-> Recipient +``` + +### 抵押品不平衡 + +如果更多资金单向流动，路由中的其中一个链可能会用完抵押品。这种 _不平衡流动_ 会阻止提取，直到抵押品重新平衡。 + +```mermaid +flowchart + subgraph base + BWR[USDC Collateral HWR] + end + + subgraph arbitrum + AWR[USDC Collateral HWR] + end + + subgraph newchain + NWR[USDC Synthetic HWR] + NU((Recipient)) + end + + NU -- "transferRemote(arbitrum,
recipient, 2 * amount)" --> NWR + NWR -. "{recipient, 2 * amount}" .-> AWR +``` + +### 管理抵押品不平衡 + +为了维持流畅的用户体验，必须在链间平衡抵押品。HWR 2.0 引入了自动化此过程的原生再平衡功能（在支持的地方）- 抵押品自动在链间移动以解决不平衡。对于没有原生再平衡的部署，这需要手动在链间移动抵押品。 + +### 原生再平衡的要求 + +对于原生再平衡，必须满足以下要求： + +- Rebalancer Agent (再平衡代理)（监控和管理抵押品的白名单代理） +- 支持再平衡器角色的 Warp Route 合约 +- 原生/外部桥接器或协议，通常在主要链上可用。例如，USDC 的 CCTP。 + +这些组件共同创建完整的原生再平衡系统。 + +
LP, amount)" --> AWR + + AWR -. "{LP, amount}" .-> MWR + MWR -. "amount" .-> LP +``` + +这可以通过在许多抵押链上提供流动性并用单一合成资产余额表示对每个抵押品的索取权来完成。 + +### 提取流动性 + +LPs 可以通过 `transferRemote` 提取，其中 + +- `destination` 域是 HWR 为 `collateral` 类型的链 +- `recipient` 地址由 LP 控制 +- `amount` 以 `destination` 链的 `collateral` 代币计价 + +```mermaid +flowchart + LP((Liquidity Provider)) + + subgraph arbitrum + AWR[USDC Collateral HWR] + AUSDC[USDC] + end + + subgraph mychain + MWR[USDC Synthetic HWR] + end + + LP -- "transferRemote(arbitrum,
LP, amount)" --> MWR + LP -. "amount" .-> MWR + + MWR -. "{LP, amount}" .-> AWR + AWR -- "transfer(LP, amount)" --> AUSDC + AWR -. "amount" .-> LP \ No newline at end of file diff --git a/zh/docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx b/zh/docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx new file mode 100644 index 0000000..995552f --- /dev/null +++ b/zh/docs/guides/warp-routes/evm/transfer-and-call-pattern.mdx @@ -0,0 +1,109 @@ +--- +title: "转账和调用模式" +--- + +## 概述 + +**转账和调用模式** 使合约能够通过 [Hyperlane Warp Route (HWR) (跨链资产路由)](/zh/docs/protocol/warp-routes/warp-routes-overview) 桥接资产，并在资产到达后在目标链上执行操作。此模式对于操作依赖于桥接后的代币余额的情况很有用。 + +虽然 HWR 处理跨链代币转账，但此模式通过使用 [Interchain Accounts (ICA) (跨链账户)](/zh/docs/applications/interchain-account) 在目标链上执行任意逻辑来扩展其功能。 + +### 使用案例 + +一些场景包括： + +- **跨链治理**：用户必须持有特定 NFT 才能对提案进行投票。系统将 NFT 桥接到治理链，并确保投票调用在转账完成后执行。 +- **桥接抵押品**：协议将资产从 L2 发送到 L1 保险库进行抵押，然后与保险库交互。 +- **更快的 rollup 提取**：用户可以立即索取流动性，同时等待最终桥接结算。 + +## 高层架构图 + +```mermaid +flowchart TB + subgraph Origin chain + direction TB + Sender + Contract + ICA_Router_O[Interchain Account Router] + Warp_Route_O[HWR] + Mailbox_O[(Mailbox)] + end + + subgraph Destination chain + direction TB + Mailbox_D[(Mailbox)] + Warp_Route_D[HWR] + ICA_Router_D[Interchain Account Router] + ICA[Interchain Account] + Recipient + end + + Sender -->|Initiates transfer & call| Contract + Contract -->|Sends tokens| Warp_Route_O + Warp_Route_O -->|Receive tokens| Mailbox_O + Mailbox_O -. "Relay" .- Mailbox_D + Mailbox_D -->|Receive tokens| Warp_Route_D + Warp_Route_D -->|Send tokens| ICA + Contract -->|Sends execution request| ICA_Router_O + ICA_Router_O -. "Relay" .- ICA_Router_D + ICA_Router_D -->|Execute call| ICA + ICA -->|Final execution| Recipient + + click ICA_Router_O https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/middleware/InterchainAccountRouter.sol + click ICA_Router_D https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/middleware/InterchainAccountRouter.sol + + style Sender fill:#FF0099 + style ICA fill:#FF0099 + style Recipient fill:#FF0099 + +``` + +
Database)] + end + + M_O -. "indexing" .-> Relayer + M_O -. "indexing" .-> V + POS == "staking" === V + + V -- "signatures" --> aws + + subgraph Destination + Recipient + M_D[(Mailbox)] + ISM[MultisigISM] + + M_D -- "verify(metadata, [origin, sender, body])" --> ISM + M_D -- "handle(origin, sender, body)" --> Recipient + ISM -. "interchainSecurityModule()" .- Recipient + end + + Relayer -- "process()" --> M_D + + aws -. "metadata" .-> Relayer + aws -. "moduleType()" .- ISM + + POS -. "validators()" .- ISM + + click ISM https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/interfaces/isms/IMultisigIsm.sol + + style Sender fill:#efab17 + style Recipient fill:#efab17 \ No newline at end of file diff --git a/zh/docs/operate/validators/validator-signatures-aws.mdx b/zh/docs/operate/validators/validator-signatures-aws.mdx new file mode 100644 index 0000000..f460a37 --- /dev/null +++ b/zh/docs/operate/validators/validator-signatures-aws.mdx @@ -0,0 +1,81 @@ +--- +title: "AWS 签名桶设置" +description: "配置您的签名密钥和 S3 存储桶" +--- + +
| Submitter 任务 | +描述 | +
|---|---|
| Message Processor | ++ 轮询本地数据库以检查是否有任何未传递的消息，并将它们推送到 Prepare 步骤的队列。 + | +
| Prepare Task | ++ 从其队列中弹出消息，确保已支付 gas，获取任何元数据并模拟消息传递交易。如果模拟成功，消息将被推送到 Submit 步骤的队列。否则，消息将被推回 Prepare 队列。 + | +
| Submit Task | ++ 从其队列中弹出消息，并在链上发送传递交易。只要可能就会批量传递。如果广播交易没有错误，消息将被推送到 Confirm 步骤的队列。否则，消息将被推回 Prepare 队列。 + | +
| Confirm Task | ++ 等待最终确定；如果发生链重组或传递交易回滚，消息将被推回 Prepare 队列。 + | +
{value}" --> M_O + M_O -- "postDispatch(..., gasLimit)
{value}" --> IGP + end + + Relayer((Relayer)) + + M_O -. "indexing" .-> Relayer + IGP -. "value" .- Relayer + + subgraph Destination Chain + M_D[(Mailbox)] + M_D -- "handle(...)" --> Recipient + end + + Relayer -- "process{gasLimit}(...)" --> M_D +``` + +## 跨链 Gas 支付流程 + +要[传递消息](/zh/docs/reference/messaging/send)，必须在目标链上包含一笔交易，该交易使用编码的消息和 ISM 元数据调用 Mailbox `process` 函数。 + +```mermaid +flowchart LR + subgraph Origin Chain + Sender + M_O[(Mailbox)] + IGP[InterchainGasPaymaster] + Sender -- "dispatch(...)
{value}" --> M_O + M_O -- "postDispatch(..., gasLimit)
{value}" --> IGP + end + + Relayer((Relayer)) + + M_O -. "indexing" .-> Relayer + IGP -. "value" .- Relayer +``` + +为方便起见，[Relayer](/zh/docs/operate/relayer/run-relayer) 会监视已调度的消息，如果在源链上收到足够的支付，将代表消息发送者提交 process 交易。这就是_跨链 gas 支付_。 + +```mermaid +flowchart LR + Relayer((Relayer)) + + subgraph Destination Chain + M_D[(Mailbox)] + M_D -- "handle(...)" --> Recipient + end + + Relayer -- "process{gasLimit}(...)" --> M_D +``` + +由于消息可以触发任意代码执行，Relayer 必须使用 `gasLimit` 来计量 [`handle` 调用](/zh/docs/reference/messaging/receive#handle)，以便在消息调度时适当收费。 + +## InterchainGasPaymasters + +跨链 gas 支付由 `InterchainGasPaymaster` (IGP) 智能合约促成。 + +这些合约公开了 [InterchainGasPaymaster 接口](/zh/docs/reference/hooks/interchain-gas)，允许消息发送者使用源链上的原生代币向 Relayer 支付费用，以支付在目标链上传递消息的成本。 + +每个 `InterchainGasPaymaster` 合约恰好对应一个 Relayer。您可以在[地址](/zh/docs/reference/addresses/deployments/mainnet/interchainGasPaymaster)下找到 Abacus Works 的 Relayer 地址。 + +### 跨链 Gas 支付计算 + +跨链 gas 支付的计算方式如下： + +$$ +destinationTxCost = destinationGasPrice * gasLimit +$$ + +$$ +exchangeRate = \frac{originGasTokenPrice}{destinationGasTokenPrice} +$$ + +$$ +originFee = exchangeRate * destinationTxCost +$$ + +`gasLimit` 和 `exchangeRate` 分别由消息发送者和 Relayer 配置。 + +## 信任假设 + +跨链 gas 支付基于消息发送者和 Relayer 之间的社会契约。换句话说，Relayer 可能会接收跨链 gas 支付而不传递相应的消息。因此，在进行跨链 gas 支付时，建议使用与已知且信誉良好的 Relayer 相关联的 IGP 合约。 + +诚实的 Relayer 实现将履行对其 IGP 进行的任何成功 gas 支付，无论实际支付了多少代币。通过保持 [gas oracles](/zh/docs/reference/hooks/interchain-gas) 最新，Relayer 可以确保 gas 支付成功当且仅当支付了"公平"价格。 + +在 Hyperlane 协议中，对 Relayer 没有信任假设，在任何情况下，恶意 Relayer 都无法审查或伪造消息。Relayer 能做的最坏的事情就是接受支付而不传递消息。 + +## 了解更多 + +- 有关 gas 限制计算、基准测试建议、gas oracles 和目标 gas 配置的详细信息，请参阅[跨链 Gas 支付详细信息](/zh/docs/reference/hooks/interchain-gas)。 +- 有关 Relayer 设置和实现指南，请参阅 [Relayer](/zh/docs/operate/relayer/run-relayer) 部分。 diff --git a/zh/docs/protocol/core/mailbox.mdx b/zh/docs/protocol/core/mailbox.mdx new file mode 100644 index 0000000..b4d035b --- /dev/null +++ b/zh/docs/protocol/core/mailbox.mdx @@ -0,0 +1,189 @@ +--- +title: "邮箱" +description: "在 Hyperlane 中用于发送和接收跨链消息的核心智能合约接口" +--- + +import SimpleMessagingDiagram from "/snippets/core/simple-messaging-diagram.mdx"; + +Hyperlane `邮箱` 智能合约公开了用于发送和接收跨链消息的链上 API。在 Hyperlane 支持的每条链上都部署了一个 `邮箱` 合约。 + +`邮箱` 网络为开发者提供了区块链之间的连接组织，开发者利用它来创建跨链应用程序，并为其现有应用程序添加跨链功能。 + +
{value}" --> M_O + M_O -- "postDispatch(message, metadata)
{value}" --> Hook + end +``` + +这允许开发者集成第三方/原生桥接、进行额外的链承诺或要求自定义费用，同时保持一致的单次调用 Mailbox 接口。 + +
{fee}" --> R_H + M_O -. "postDispatch(metadata, ...)
{value - fee}" ..-> D_H + end +``` + +#### 示例 + +
recipient, body)" --> M_O + end + + M_O -. "2.emit dispatch(sender,
destination, recipient,
body)" .-> Relayer + + subgraph Destination + Recipient + M_D[(Mailbox)] + ISM[InterchainSecurityModule] + + M_D -. "4.interchainSecurityModule()" .-> Recipient + M_D -- "5.verify(metadata,
message)" --> ISM + M_D -- "6.handle(origin, sender,
body)" --> Recipient + end + + Relayer((Relayer)) -- "3.process(metadata,
message)" --> M_D + + style Sender fill:#efab17 + style Recipient fill:#efab17 \ No newline at end of file diff --git a/zh/docs/protocol/warp-routes/warp-routes-example-usage.mdx b/zh/docs/protocol/warp-routes/warp-routes-example-usage.mdx new file mode 100644 index 0000000..61f423c --- /dev/null +++ b/zh/docs/protocol/warp-routes/warp-routes-example-usage.mdx @@ -0,0 +1,82 @@ +--- +title: "HWR：示例用法" +description: "Hyperlane 跨链路由（HWR）定义了资产如何在链之间移动，无论是作为原生代币、合成表示还是抵押品支持的资产。路由的选择取决于资产类型和目标链上的期望行为。" +--- + +## Hyperlane 跨链路由组合 + +### 1. 原生到原生 + +此路由允许在两条都使用各自原生代币的链之间转移原生代币。 + +
{fee}" --> R_H + M_O -- "postDispatch(...)
{value - fee}" --> D_H + end +``` + +### 必需钩子 + +要查询必需钩子配置，您可以调用 `requiredHook` 函数。 + +```solidity +function requiredHook() external view returns (IPostDispatchHook); +``` + +### 默认钩子 + +要查询默认钩子配置，您可以调用 `defaultHook` 函数。 + +```solidity +function defaultHook() external view returns (IPostDispatchHook); +``` + +要在 `dispatch` 调用中使用自定义钩子覆盖默认钩子，请参见[钩子参考](/zh/docs/reference/hooks/interchain-gas)。 \ No newline at end of file diff --git a/zh/docs/reference/registries.mdx b/zh/docs/reference/registries.mdx new file mode 100644 index 0000000..9502c3c --- /dev/null +++ b/zh/docs/reference/registries.mdx @@ -0,0 +1,66 @@ +--- +title: "Hyperlane 注册表" +--- + +## 概述 + +Hyperlane 可以由任何人在任何地方部署。但是，为了使这些部署有用，它们的详细信息必须是众所周知的。注册表是链元数据、合约地址和其他与 Hyperlane 合约和工具交互的有用信息的集合。有一个由 Hyperlane 核心团队维护的[规范注册表](https://github.com/hyperlane-xyz/hyperlane-registry)。CLI、[Explorer](https://explorer.hyperlane.xyz) 和其他工具可以使用注册表数据。 + +## 规范注册表 + +Hyperlane 核心团队完成的部署的元数据和构件将在此处提供： +https://github.com/hyperlane-xyz/hyperlane-registry + +但是，我们鼓励社区成员将自己的部署添加到此规范注册表中。贡献步骤如下： + +1. Fork 并克隆注册表仓库 +2. 使用 CLI 并将 `--registry` 标志设置为克隆仓库的本地路径 +3. 根据需要执行您的命令 +4. 将更改推送到您的 fork 并创建 pull request + +## 自定义注册表 + +只要注册表符合与规范注册表相同的布局和文件模式，就可以使用任何 GitHub 仓库 URL 或本地文件路径。 + +CLI 有两个用于配置其使用的注册表的命令行参数： + +- `--registry` 标志设置主注册表，如果未设置则使用默认的 GitHub 注册表 +- `--overrides` 标志设置一个可选的附加路径，这对于强制覆盖默认数据的特定设置很有用，例如在链的元数据中使用不同的 RPC URL + +一旦您的自定义注册表添加/更新完成并经过测试，请考虑向规范注册表提交 pull request，以便其他人可以从您的部署中受益。 + +有关更多信息，请参阅 CLI 参考页面。 + +## 使用方法（Javascript 和 Typescript） + +### 安装 + +```bash +# 使用 npm +npm install @hyperlane-xyz/registry +# 或使用 yarn +yarn add @hyperlane-xyz/registry +``` + +### 获取内容 + +#### 通过包（静态） + +访问注册表数据最简单的方法是直接从包中导入所需的部分： + +```ts +// 通过基础包 +import { ethereum, ethereumAddresses } from "@hyperlane-xyz/registry"; +// 或者如果您的打包工具允许，通过子导出以获得更优化的包 +import { metadata, addresses } from "@hyperlane-xyz/registry/chains/ethereum"; +``` + +#### 通过实用工具（动态） + +如果您需要确保拥有最新数据，可以使用 `GithubRegistry` 类即时获取注册表内容。 + +```ts +import { GithubRegistry } from "@hyperlane-xyz/registry"; +const registry = new GithubRegistry(); +const chainMetadata = await registry.getMetadata(); +``` diff --git a/zh/docs/resources/audits.mdx b/zh/docs/resources/audits.mdx new file mode 100644 index 0000000..1b2572a --- /dev/null +++ b/zh/docs/resources/audits.mdx @@ -0,0 +1,69 @@ +--- +title: "审计" +--- + +### Hyperlane Q2 2025 安全审计 + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/ChainLight_Hyperlane_2Q_2025_Security_Audit_v1.0.pdf?raw=true) + +### HyperToken 审计 + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/ChainLight_Hyperlane_HyperToken_Security_Audit_v1.0.pdf?raw=true) + +### Yield Routes 审计 + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/ChainLight_Hyperlane_PR_5752_5757_Security_Audit_v1.0.pdf?raw=true) + +### Compound Staker Rewards 审计 + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/Offbeat_Security_Hyperlane_Compound_Staker_Rewards.pdf?raw=true) + +### USDT 审计 + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/ChainSecurity_Hyperlane_Superchain_USDT_audit_draft.pdf?raw=true) + +### CCIP 审计 [v5.12.0](https://github.com/hyperlane-xyz/hyperlane-monorepo/releases/tag/%40hyperlane-xyz%2Fcore%405.12.0) + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/ChainLight_Hyperlane_CCIP_Warp_Route_Security_Audit_v1.1.pdf?raw=true) + +### Hook 和 ISM 审计 + +[镜像](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/chainlight-v3.1-protocol-audit.pdf?raw=true) + +### 协议 v3 审计 + +[原文](https://github.com/trailofbits/publications/blob/master/reviews/2023-09-hyperlane-securityreview.pdf) + +[镜像](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/hyperlane-v3-protocol-audit.pdf?raw=true) + +### 协议 v2 审计 + +[原文](https://audits.hacken.io/hyperlane/sca-hyperlane-interchain-message-service-apr2023/) + +[镜像](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/hyperlane-v2-protocol-audit.pdf?raw=true) + +### 协议 v1 审计 + +[原文](https://www.fyeo.io/post/fyeo-security-assessment-of-the-hyperlane-formerly-abacus-smart-contracts-in-august-2022) + +[镜像](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/hyperlane-v1-protocol-audit.pdf?raw=true) + +### Sealevel 协议审计 + +[原文](https://github.com/sec3-service/reports/blob/master/reports/sec3_hyperlane-sealevel.pdf) + +[镜像](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/sealevel-hyperlane-audit.pdf?raw=true) + +### Sealevel 审计 - Sherlock + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/sealeval-audit-hyperlane-20250327.pdf?raw=true) + +### CosmWasm 协议审计 + +[原文](https://github.com/oak-security/audit-reports/blob/main/Hyperlane/2024-02-13%20Audit%20Report%20-%20cw-hyperlane%20v1.0.pdf) + +[镜像](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/cw-hyperlane-audit.pdf?raw=true) + +### Starknet 协议审计 + +[原文](https://github.com/hyperlane-xyz/v4-docs/blob/main/assets/starknet-hyperlane-audit-draft.pdf?raw=true) diff --git a/zh/docs/resources/faq.mdx b/zh/docs/resources/faq.mdx new file mode 100644 index 0000000..0cc8847 --- /dev/null +++ b/zh/docs/resources/faq.mdx @@ -0,0 +1,111 @@ +--- +title: "常见问题" +--- + +## 一般问题 + +**什么是 Hyperlane？** + +Hyperlane 是为模块化区块链栈构建的第一个通用且无需许可的互操作性框架。任何人都可以[部署 Hyperlane](/zh/docs/guides/chains/deploy-hyperlane) 到任何区块链环境，无论是一层、rollup 还是应用链，允许该链与已部署 Hyperlane 的任何其他链无缝通信。 + +**使用 Hyperlane 对区块链开发者有什么好处？** + +Hyperlane 为区块链和 dapp 开发者都提供了好处。 + +- 对于区块链开发者，Hyperlane 部署扩展了对用户、资产和来自已部署 Hyperlane 的其他连接区块链的宝贵状态的可访问性。 +- 对于 dapp 开发者，Hyperlane 提供跨多个区块链的无缝连接，允许开发者创建跨链网络效应和流动性，用户可以从其首选链与应用程序交互。 + +**什么是 Abacus Works？** + +Abacus Works 是致力于 Hyperlane 的法律实体名称。您可能在较旧的帖子和代码库中遇到一些对 Abacus 的引用。Hyperlane 在 2022 年秋季从 Abacus 更名为 Hyperlane。 + +**我可以用 Hyperlane 构建什么？** + +Hyperlane 的[消息传递接口](/zh/docs/protocol/core/mailbox)允许 dapp 开发者在不同链上的智能合约之间发送任意字节。这可以用来创建跨链应用程序，即跨越多个链的 dapp。 + +为了灵感，看看一些构建在 Hyperlane 之上的预构建应用程序，包括： + +- **Hyperlane Warp 路由 (HWR)**：让用户将代币从一条链移动到另一条链。 +- **跨链账户**：让用户进行跨链函数调用。 +- **跨链查询**：让用户进行跨链视图调用。 + +**我是开发者。我的团队如何使用 Hyperlane 构建？** 如果您正在阅读此 FAQ，您已经找到了文档，这是一个很好的开始地方。也就是说，我们知道在实施过程中会出现问题，我们很乐意在您的路上帮助您。Hyperlane 社区在 [Discord](https://discord.gg/hyperlane) 中定期活跃。来自开发者的反馈直接影响产品路线图。 + +## 技术问题 + +### 消息传递 + +**当我在 Hyperlane 上发送消息时会发生什么？** + +有关更多详细信息，请参见[发送](/zh/docs/reference/messaging/send)和[接收](/zh/docs/reference/messaging/receive)页面。总结： + +1. 应用程序在源链上调用 `dispatch()` 函数，将消息插入邮箱的默克尔树中。 +2. Hyperlane 中继器观察调度的消息并为接收者的跨链安全模块（ISM）组装元数据。 +3. 中继器通过调用 `Mailbox.process()` 将消息传递给接收者。 +4. 邮箱使用接收者的 ISM 验证消息并调用 `recipient.handle()` 传递消息。 + +**如何查看我发送的消息状态？** + +将地址或交易哈希粘贴到 [Hyperlane 消息浏览器](https://explorer.hyperlane.xyz/) 的搜索栏中，查看消息状态和历史的详细信息。 + +如果消息因某种原因发送失败，将有错误消息指示可能出了什么问题。有关更多信息，请参见[浏览器调试](/zh/docs/reference/explorer/explorer-debugging)。 + +**使用 Hyperlane 发送跨链消息意味着实时聊天和文本吗？** + +不，Hyperlane 是一个旨在允许不同链上的智能合约相互交互的协议。当我们提到消息传递时，它是智能合约之间发送任意字节，而不是点对点或文本消息传递。 + +对于聊天用例，请考虑 [XMTP](https://xmtp.org/)、[Push](https://push.org/) 或 [Orbis](https://useorbis.com/)。 + +**Hyperlane 是代币桥吗？** + +不完全是。Hyperlane 是一个通用消息传递（GMP）协议，允许区块链之间的通信。代币桥只是可以构建在 Hyperlane 之上的众多应用程序类型之一！ + +### 部署 + +**Hyperlane 部署在哪里？** + +已知部署的列表可以在[合约地址](/zh/docs/reference/addresses/deployments/mailbox)页面找到。 + +### 高级主题 + +**Hyperlane 如何保护？** + +Hyperlane 由其模块化安全栈保护，具有跨链安全模块（ISM）功能。开发者可以配置各种预构建的 ISM，将它们相互组合，甚至根据其应用程序的需求创建自定义 ISM。模块化的安全方法确保 Hyperlane 将继续跟上安全模型的最新行业进展。 + +**Hyperlane 有多少验证器，谁运营它们？** + +验证器的数量取决于跨链安全模块（ISM）配置。默认 ISM 使用特定的验证器集，您可以在[这里](/zh/docs/reference/addresses/validators/mainnet-default-ism-validators)查看阈值、运营商和地址等详细信息。 + +**我们如何确保消息完整性？** + +Hyperlane 的消息安全由跨链安全模块（ISM）配置驱动。默认情况下，消息依赖于默认 ISM 的验证器集，需要验证器的法定人数签署以确保安全。在验证器泄露的不太可能事件中，消息的安全性可能受到影响。但是，开发者有灵活性配置自己的 ISM，使他们能够定制和加强安全模型以适应其应用程序的需求。 + +**源链是否接收交易是否在目标链上执行的确认？** + +目前，源链不会自动接收来自目标链的执行确认。但是，通过在目标链上自定义 `handle` 函数可以添加此功能。有关更多信息，请参考 [handle 函数](/zh/docs/reference/messaging/receive#handle)。 + +**为什么出站消息 ID 存储在默克尔树中？** + +出站消息 ID 存储在默克尔树中以有效跟踪和验证消息。这种机制确保验证器可以准确检测和签署创建的新消息。 + +**`为什么验证器调用 MerkleTreeHook.latestCheckpoint()？`** + +验证器使用 [`MerkleTreeHook.latestCheckpoint()`](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/5e9b8ba7ab0f54e92b3cf32806fae95eb23ad0f8/solidity/contracts/hooks/MerkleTreeHook.sol#L49) 函数来确定何时需要索引新交易。这种轮询机制确保验证器可以立即开始签署新消息，而无需回填整个树。 + +## 社区和贡献[](#community--contributions) + +**我如何加入 Hyperlane 社区？** + +您可以加入 [Discord](https://discord.gg/hyperlane) 或在 [Twitter](https://x.com/hyperlane) 上关注 Hyperlane，在那里您可以找到不断增长的开发者和爱好者社区，讨论跨链未来。 + +**我有兴趣为 Hyperlane 工作。我在哪里可以看到职位空缺？** + +在[这里](https://jobs.lever.co/Hyperlane)查看我们的开放职位。 + +**我如何贡献改进此文档？** + +您可以通过[文档仓库](https://github.com/hyperlane-xyz/v3-docs)直接提交 PR 来编辑此文档。 + +**我在哪里可以获得支持或询问有关 Hyperlane 的问题？** + +您可以在我们的 [Hyperlane Discord](https://discord.com/invite/hyperlane) 上获得支持和提问，社区和团队在那里活跃并准备提供帮助。 \ No newline at end of file diff --git a/zh/docs/resources/glossary.mdx b/zh/docs/resources/glossary.mdx new file mode 100644 index 0000000..edd320e --- /dev/null +++ b/zh/docs/resources/glossary.mdx @@ -0,0 +1,109 @@ +--- +title: "术语表" +--- + +## 代理 + +Hyperlane [代理](/zh/docs/protocol/agents)是读取和写入 Hyperlane 智能合约状态的链下参与者。 + +示例代理包括[验证器](/zh/docs/protocol/agents/validators)和[中继器](/zh/docs/protocol/agents/relayer)。 + +## 聚合 ISM + +[聚合 ISM](/zh/docs/protocol/ISM/standard-ISMs/aggregation-ISM) 是一种跨链安全模块，通过要求 `n` 个 [ISM](/zh/docs/resources/glossary#interchain-security-module) 中的 `m` 个验证特定跨链消息，从许多 ISM 聚合安全性。 + +## 检查点 + +检查点是一个（默克尔根，索引）元组，对应于特定时间点[邮箱](/zh/docs/resources/glossary#mailbox)增量默克尔树的状态。 + +[验证器](/zh/docs/resources/glossary#validator)的检查点签名用于[多重签名 ISM](/zh/docs/resources/glossary#multisig-ism)。 + +## 抵押品链 + +对于 [Hyperlane Warp 路由](/zh/docs/resources/glossary#warp-route)，将[抵押品代币](/zh/docs/resources/glossary#collateral-token)存入 Warp 路由的链。 + +## 抵押品代币 + +对于 [Hyperlane Warp 路由](/zh/docs/resources/glossary#warp-route)，存入[抵押品链](/zh/docs/resources/glossary#collateral-chain)以在远程[合成链](/zh/docs/resources/glossary#synthetic-chain)上创建包装代币的代币。 + +## 默认 ISM + +如果消息接收者没有指定自己的 ISM，将用于验证入站消息的[跨链安全模块](/zh/docs/resources/glossary#interchain-security-module)。 + +## 域 + +特定链的唯一标识符，Hyperlane 协议用它来确定消息的源和目标。 + +可能与 EVM 链 ID 相同，但并非总是如此。有关已知 Hyperlane 域 ID 的列表，请参见[域](/zh/docs/reference/domains/)。 + +## 跨链账户 (ICA) + +允许用户进行跨链智能合约调用的[中间件](/zh/docs/resources/glossary#middleware)智能合约。 + +例如，DAO 可以使用跨链账户拥有远程链上的合约。 + +有关更多信息，请参见[跨链账户](/zh/docs/applications/interchain-account)。 + +## 跨链 Gas 支付主 + +由[中继器](/zh/docs/resources/glossary#relayer)部署的智能合约，接受源链上的支付以在目标链上传递消息。 + +有关更多信息，请参见[跨链 Gas 支付](/zh/docs/protocol/core/interchain-gas-payment) + +## 跨链查询 (IQS) + +允许用户进行跨链视图调用的[中间件](/zh/docs/resources/glossary#middleware)智能合约。 + +例如，智能合约可以使用跨链查询从远程链查找预言机汇率或代币余额。 + +## 跨链安全模块 (ISM)[](#interchain-security-module-ism "Direct link to Interchain Security Module (ISM)") + +[跨链安全模块](/zh/docs/protocol/ISM/modular-security) (ISM) 是为 Hyperlane 的跨链[邮箱](/zh/docs/protocol/core/mailbox)提供安全性的智能合约。 + +ISM 负责验证在目标链上传递的跨链消息_确实在_源链上发送。 + +## 邮箱 + +可以说是最重要的 Hyperlane 智能合约，[邮箱](/zh/docs/protocol/core/interchain-gas-payment)公开了开发者可用于[发送](/zh/docs/reference/messaging/send)和[接收](/zh/docs/reference/messaging/receive)跨链消息的接口。 + +## 中间件[](#middleware "Direct link to Middleware") + +发送和接收消息并公开面向开发者的 API 的智能合约。开发者应使用此 API，而不是直接与[邮箱](/zh/docs/resources/glossary#mailbox)交互。 + +示例中间件包括[跨链账户-ica](/zh/docs/resources/glossary#interchain-accounts-ica)和[跨链查询-iqs](/zh/docs/resources/glossary#interchain-queries-iqs)。 + +## 多重签名 ISM + +[多重签名 ISM](/zh/docs/protocol/ISM/standard-ISMs/multisig-ISM) 是一种[跨链安全模块](/zh/docs/resources/glossary#interchain-security-module)，使用 `n` 个[验证器](/zh/docs/resources/glossary#validator)签名中的 `m` 个来验证特定跨链消息。 + +## 无需许可互操作性[](#permissionless-interoperability "Direct link to Permissionless Interoperability") + +Hyperlane 可以由任何人部署到任何链，无论是一层、rollup 还是应用链，允许该链无缝通信。Hyperlane 协议的开放设计被称为无需许可互操作性 (PI)。由 Hyperlane 核心团队以外的机构部署的链被称为"PI 链"。 + +## 中继器 + +[中继器](/zh/docs/protocol/agents/relayer)是负责将消息从其源链传递到目标链的 Hyperlane [代理](/zh/docs/resources/glossary#agent)。 + +中继器是不受信任的，任何人都可以操作中继器。 + +## 路由 ISM + +[路由 ISM](/zh/docs/protocol/ISM/standard-ISMs/routing-ISM) 是一种[跨链安全模块](/zh/docs/resources/glossary#interchain-security-module)，根据正在传递的消息委托给不同的 ISM。 + +例如，路由 ISM 可以根据消息发送的源链使用不同的 ISM。 + +## 合成链 + +对于 [Hyperlane Warp 路由](/zh/docs/resources/glossary#warp-route)，铸造包装代币的链。这些包装代币由已在[抵押品链](/zh/docs/resources/glossary#collateral-chain)上锁定的[抵押品代币](/zh/docs/resources/glossary#collateral-token)支持。 + +## 验证器 + +[验证器](/zh/docs/protocol/agents/validators)是负责证明从源链发送的消息的 Hyperlane [代理](/zh/docs/resources/glossary#agent)。 + +[多重签名 ISM](/zh/docs/resources/glossary#multisig-ism) 使用验证器签名为入站消息提供安全性。 + +## Hyperlane Warp 路由 + +[Hyperlane Warp 路由](/zh/docs/applications/warp-routes/overview)是 Hyperlane 对代币桥接概念的实现，允许您通过 Hyperlane 无需许可地将任何类似 ERC20 的资产转移到任何链。 + +阅读更多关于如何[部署 Hyperlane Warp 路由](/zh/docs/guides/quickstart/deploy-warp-route)的信息。 \ No newline at end of file diff --git a/zh/docs/resources/message-debugging.mdx b/zh/docs/resources/message-debugging.mdx new file mode 100644 index 0000000..b2a50ed --- /dev/null +++ b/zh/docs/resources/message-debugging.mdx @@ -0,0 +1,130 @@ +--- +title: "消息调试" +--- + +### + +
+
+
+## 快速开始
+
+