Trustblock CLI

Trustblock CLI 是一个用户友好的命令行工具，帮助您与 Trustblock 交互并发布审计报告。有关更详细的信息，请参阅 Trustblock CLI 文档。

安装

如果您已安装 cargo，您可以通过以下方式安装我们的 CLI

cargo install trustblock-cli

有关其他安装方法，请参阅

https://github.com/Trustblock-Inc/trustblock-cli/releases

用法

要查看可用的子命令，请使用 help 标志

trustblock help

要获取有关特定子命令的更多信息，请使用 --help 标志

trustblock <subcommand> --help

设置

在发布审计之前，运行以下命令以初始化 ~/.trustblock/.env 文件

trustblock init

接下来，将您的 API 密钥添加到 ~/.trustblock/.env 文件中。您可以通过在 Trustblock 网站上导航到您的个人资料并在认证后点击“编辑我的个人资料”按钮来获取 API 密钥。

注意：即使未向 .env 文件添加数据，Trustblock CLI 也可以使用，只要将所需信息作为参数传递即可。

审计发布

要发布审计，您可以附加 pdf 文件或指定 Web 审计 URL

-r, --report-pdf <AUDIT_REPORT_PDF_FILE>
-u, --report-url <AUDIT_REPORT_URL>

示例

trustblock publish-audit -a audit.json -r ./Audit_Report.pdf

trustblock publish-audit -a audit.json -u https://trustblock.run/my_audit

您可以从 https://github.com/Trustblock-Inc/trustblock-cli/blob/main/src/data/audit.json 获取一个示例 audit.json 文件。您应使用审计中的适当信息填写字段。

要包含 API 密钥和私钥

-a, --api-key

命令

• publish-audit: 将审计发布到 Trustblock。
• init：初始化 .trustblock 文件夹。
• clean：清理 .trustblock 文件夹。
• help：打印此信息或给定子命令的帮助信息。

审计 JSON 架构

{
  "project": {
    "name": String,
    "links": {
      "website": URL String,
      "twitter": URL String, (optional),
      "telegram": URL String (optional),
    },
    "contact": {
      "email": Email String
    }
  },
  "issues": {
    "FIXED": {
      "LOW": uint,
      "MEDIUM": uint,
      "HIGH": uint,
      "CRITICAL": uint
    },
    "RISK_ACCEPTED": {
      "LOW": uint,
      "MEDIUM": uint,
      "HIGH": uint,
      "CRITICAL": uint
    }
  },
    "tags": [ "TOKEN" | "FINANCE" | "COLLECTIBLES" | "GAMING" | "GOVERNANCE" | "SOCIAL" | "OTHER"],
    "contracts": [
        {
            "evmAddress": Evm Address String,
            "chain": "ETHEREUM" | "POLYGON" | "AVALANCHE" | "BNBCHAIN"
        }
    ],
    "description": {
        "summary": Markdown String
    },
    "name": String
}