配置 - OpenZeppelin 文档

配置

概述

大多数配置文件应该位于 ./config 目录下，包括签名器配置，位于 ./config/keys 目录下。 请确保所有配置文件都有合适的访问权限（对于 ./config/keys/*，我们建议权限为 0500）。

环境变量配置 (.env)

这为中继器应用程序定义了一些基本配置：

复制示例环境变量文件，并根据你的需要更新值

cp .env.example .env

下表列出了环境变量及其默认值。

环境变量配置示例

.env 文件配置示例：

RUST_LOG=DEBUG
CONFIG_DIR=./config
CONFIG_FILE_NAME=config.json
WEBHOOK_SIGNING_KEY=e1d42480-6f74-4d0b-85f4-b7f0bb690fae
API_KEY=5eefd216-0e44-4ca7-b421-2925f90d30d5
RATE_LIMIT_RPS=100
RATE_LIMIT_BURST_SIZE=300
METRICS_ENABLED=true
METRICS_PORT=8081
REDIS_URL=redis://localhost:6379
REDIS_CONNECTION_TIMEOUT_MS=10000
RPC_TIMEOUT_MS=10000
PROVIDER_MAX_RETRIES=3
PROVIDER_RETRY_BASE_DELAY_MS=100
PROVIDER_RETRY_MAX_DELAY_MS=2000
PROVIDER_MAX_FAILOVERS=3
ENABLE_SWAGGER=false
KEYSTORE_PASSPHRASE=your_keystore_passphrase

主配置文件 (config.json)

此文件可以存在于任何目录中，但默认位置为 ./config/config.json。

复制示例配置文件，并根据你的需要更新值

cp config/config.example.json config/config.json

此文件中的关键部分包括：

• 签名器：定义交易签名方法。

• 通知：设置状态警报

• 中继器：配置网络、通知渠道、策略和签名器。

• 网络：定义区块链网络配置。

• 插件：配置插件。

1. 签名器

交易签名器负责在将交易提交到区块链网络之前对其进行加密签名。signers 数组必须包含至少一个有效的签名器配置。

有关配置所有支持的签名器类型的全面详细信息，包括：

• 本地密钥库文件签名器

• HashiCorp Vault（secret、cloud 和 transit）

• Cloud KMS providers (Google Cloud, AWS)

• Turnkey 签名器

• 安全最佳实践和故障排除

请参阅专门的 Signers Configuration 指南。

2. 通知

• notifications 数组，应包含至少一个有效的配置：

"notifications": [\
  {\
    "id": "notification-test",\
    "type": "webhook",\
    "url": "https://webhook.site/f95cf78d-742d-4b21-88b7-d683e6fd147b",\
    "signing_key": {\
      "type": "env",\
      "value": "WEBHOOK_SIGNING_KEY"\
    }\
  }\
]

可用配置字段

3. 中继器

• relayers 数组，包含至少一个有效的中继器配置：

"relayers": [\
  {\
    "id": "solana-testnet",\
    "name": "Solana Testnet",\
    "paused": false,\
    "notification_id": "notification-test",\
    "signer_id": "local-signer",\
    "network_type": "solana",\
    "network": "testnet",\
    "custom_rpc_urls": [\
      {\
        "url": "https://primary-rpc.example.com",\
        "weight": 2  // 权重越高，将更多请求路由到此端点。该值必须是介于 0 到 100（含）之间的整数。\
      },\
      {\
        "url": "https://backup-rpc.example.com",\
        "weight": 1\
      }\
    ],\
    "policies": {\
      "allowed_programs": [\
          "11111111111111111111111111111111",\
          "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",\
          "BPFLoaderUpgradeab1e11111111111111111111111"\
        ]\
    }\
  }\
]

可用配置字段

策略

RPC URL 配置

中继器支持两种配置 RPC URL 的方式：

1. 公共 RPC URL：这些是网络提供的默认 RPC 端点。它们会根据网络配置自动选择。

2. 自定义 RPC URL：你可以使用中继器配置中的 custom_rpc_urls 字段指定自定义 RPC URL。可以为每个 URL 配置一个可选权重，以实现高可用性：

"custom_rpc_urls": [\
  {\
    "url": "https://primary-rpc.example.com",\
    "weight": 2  // 权重越高，将更多请求路由到此端点。该值必须是介于 0 到 100（含）之间的整数。\
  },\
  {\
    "url": "https://secondary-rpc.example.com",\
    "weight": 100, // 允许的最大权重\
  },\
  {\
    "url": "https://backup-rpc.example.com"  // 未指定权重，默认为 100\
  },\
  {\
    "url": "https://backup2-rpc.example.com",\
    "weight": 0, // 值为 0 会禁用端点。\
  }\
]

当你想要以下操作时，这非常有用： \ 使用你自己的带有负载平衡的 RPC 节点 \ 使用付费服务提供商以获得更好的可靠性和性能 \* 覆盖默认的公共 RPC URL \ 访问自定义网络端点 \ 配置具有不同权重的主端点和备用端点

当两者都可用时，中继器将： 1. 首先尝试使用 custom_rpc_urls（如果已配置）。 2. 如果未配置自定义 URL，则回退到公共 RPC URL。

为了向后兼容，仍然支持字符串数组：

"custom_rpc_urls": ["https://your-rpc.example.com"]

4. 插件

有关如何编写插件的更多信息，请参阅 Plugins 页面。

• plugins 数组，包含插件配置：

"plugins": [\
  {\
    "id": "my-plugin",\
    "path": "my-plugin.ts"\
  }\
]

可用配置字段

5. 网络

你可以通过以下方式配置网络：

• 在单独的 JSON 文件中（建议以获得更好的组织）

• 直接在你的主 config.json 中

有关全面的网络配置详细信息，包括：

• 网络字段参考

• 所有网络类型的配置示例

• 网络继承

• 特殊标签及其行为

• 最佳实践和故障排除

请参阅专门的 Network Configuration 指南。

配置文件示例

使用密钥库签名器的 evm 和 solana 中继器定义的完整 config/config.json 示例：

{
  "relayers": [\
    {\
      "id": "sepolia-example",\
      "name": "Sepolia Example",\
      "network": "sepolia",\
      "paused": false,\
      "notification_id": "notification-example",\
      "signer_id": "local-signer",\
      "network_type": "evm",\
      "custom_rpc_urls": [\
        {\
          "url": "https://primary-rpc.example.com",\
          "weight": 2\
        },\
        {\
          "url": "https://backup-rpc.example.com",\
          "weight": 1\
        }\
      ],\
      "policies": {\
        "gas_price_cap": 30000000000000,\
        "eip1559_pricing": true\
      }\
    },\
    {\
      "id": "solana-example",\
      "name": "Solana Example",\
      "network": "devnet",\
      "paused": false,\
      "notification_id": "notification-example",\
      "signer_id": "local-signer",\
      "network_type": "solana",\
      "custom_rpc_urls": [\
        {\
          "url": "https://primary-solana-rpc.example.com",\
          "weight": 2\
        },\
        {\
          "url": "https://backup-solana-rpc.example.com",\
          "weight": 1\
        }\
      ],\
      "policies": {\
        "fee_payment_strategy": "user",\
        "min_balance": 0,\
        "allowed_tokens": [\
          {\
            "mint": "Gh9ZwEmdLJ8DscKNTkTqPbNwLNNBjuSzaG9Vp2KGtKJr",\
            "max_allowed_fee": 100000000\
          },\
          {\
            "mint": "So11111111111111111111111111111111111111112"\
          }\
        ]\
      }\
    },\
    {\
      "id": "solana-mainnet-example",\
      "name": "Solana Mainnet Example",\
      "network": "mainnet-beta",\
      "paused": false,\
      "notification_id": "notification-example",\
      "signer_id": "local-signer",\
      "network_type": "solana",\
      "custom_rpc_urls": ["https://your-private-solana-rpc.example.com"],\
      "policies": {\
        "fee_payment_strategy": "user",\
        "min_balance": 0,\
        "swap_config": {\
          "cron_schedule": "0 0 * * * *",\
          "min_balance_threshold": 0,\
          "strategy": "jupiter-ultra"\
        },\
        "allowed_tokens": [\
          {\
            "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",\
            "max_allowed_fee": 100000000,\
            "swap_config": {\
              "min_amount": 0,\
              "max_amount": 0,\
              "retain_min_amount": 0\
            }\
          },\
          {\
            "mint": "So11111111111111111111111111111111111111112"\
          }\
        ]\
      }\
    }\
  ],
  "notifications": [\
    {\
      "id": "notification-example",\
      "type": "webhook",\
      "url": "https://webhook.site/1384d4d9-21b1-40a0-bcd1-d3f3b66be955",\
      "signing_key": {\
        "type": "env",\
        "value": "WEBHOOK_SIGNING_KEY"\
      }\
    }\
  ],
  "signers": [\
    {\
      "id": "local-signer",\
      "type": "local",\
      "config": {\
        "path": "config/keys/local-signer.json",\
        "passphrase": {\
          "type": "env",\
          "value": "KEYSTORE_PASSPHRASE"\
        }\
      }\
    }\
  ],
  "networks": [\
    {\
      "average_blocktime_ms": 12000,\
      "chain_id": 11155111,\
      "explorer_urls": [\
        "https://api-sepolia.etherscan.io/api",\
        "https://sepolia.etherscan.io"\
      ],\
      "features": [\
        "eip1559"\
      ],\
      "is_testnet": true,\
      "network": "sepolia",\
      "required_confirmations": 6,\
      "rpc_urls": [\
        "https://sepolia.drpc.org",\
        "https://1rpc.io/sepolia",\
        "https://ethereum-sepolia-rpc.publicnode.com",\
        "https://ethereum-sepolia-public.nodies.app"\
      ],\
      "symbol": "ETH",\
      "tags": [\
        "deprecated"\
      ],\
      "type": "evm"\
    },\
    {\
      "type": "solana",\
      "network": "devnet",\
      "rpc_urls": ["https://api.devnet.solana.com"],\
      "explorer_urls": ["https://explorer.solana.com?cluster=devnet"],\
      "average_blocktime_ms": 400,\
      "is_testnet": true\
    },\
    {\
      "type": "solana",\
      "network": "mainnet-beta",\
      "rpc_urls": ["https://api.mainnet-beta.solana.com"],\
      "explorer_urls": ["https://explorer.solana.com"],\
      "average_blocktime_ms": 400,\
      "is_testnet": false\
    }\
  ]
}

← 快速入门

签名器 →

• 原文链接： docs.openzeppelin.com/re...
• 登链社区 AI 助手，为大家转译优秀英文文章，如有翻译不通的地方，还请包涵～