ceramicnetwork/ceramic-anchor-service

Ceramic锚定服务 - PoC

Ceramic锚定服务是根据Ceramic https://github.com/ceramicnetwork/specs 实现的锚定服务PoC（概念验证）。该实现目前使用***，但设计为无关架构，可通过添加模块轻松扩展以支持其他。

核心功能与特性

• 无关设计：核心架构不依赖特定，可通过模块扩展支持多种***
• CID锚定管理：支持创建、查询CID锚定请求，跟踪请求状态（PENDING、PROCESSING、FAILED、COMPLETED）
• RESTful API接口：提供标准化API用于锚定请求管理、链ID查询及服务健康检查
• IPFS集成：需本地运行IPFS节点以支持IPLD文档处理

使用场景与适用范围

适用于Ceramic网络生态中需要将文档CID锚定到***的场景，为去中心化应用提供可信的数据源锚定服务，确保数据完整性和时间戳验证。

前置条件

运行服务前需安装 Node.js。

安装与配置

配置文件

配置文件位于 ./config 目录下。

构建与启动步骤

1. 本地启动IPFS节点
2. 执行以下命令构建并启动应用：

bash
docker-compose up -d
npm run build
npm run start

RESTful API

默认在 http://localhost:3000/api/v0/ 启用RESTful API。

创建锚定请求

创建CID锚定请求。

• URL：/requests
• 方法：POST
• 数据参数：
  • 内容：

    json
    {
      "cid": "bafyreihgmyh2srmmyiw7fdihrc2lw2uodvpxb2hbpyxo7w2jlqizga6pne",
      "docId": "doc_875c56f9-9d5d-4031-8d3d-d171a91b15aa" 
    }
    

• 成功响应：
  • 状态码：201
  • 内容：

    json
    {
      "id": "06a483c9-eb73-4e08-a019-7b5665588172",
      "status": "PENDING",
      "message": "Request is pending.",
      "cid": "bafyreihgmyh2srmmyiw7fdihrc2lw2uodvpxb2hbpyxo7w2jlqizga6pne",
      "docId": "doc_875c56f9-9d5d-4031-8d3d-d171a91b15aa",
      "createdAt": 1586438625,
      "updatedAt": 1586438625,
      "scheduledAt": 1586438625
    }
    

获取CID锚定请求信息

查询指定CID的锚定请求状态。

• URL：/requests/:cid
• 方法：GET
• URL参数：
  • 必填：cid=[string]（需查询的CID）
• 数据参数：无
• 成功响应 - PENDING状态：
  • 状态码：200
  • 内容：

    json
    {
      "id": "06a483c9-eb73-4e08-a019-7b5665588172",
      "status": "PENDING",
      "message": "Request is pending.",
      "cid": "bafyreihgmyh2srmmyiw7fdihrc2lw2uodvpxb2hbpyxo7w2jlqizga6pne",
      "docId": "doc_875c56f9-9d5d-4031-8d3d-d171a91b15aa",
      "createdAt": 1586438625,
      "updatedAt": 1586438625,
      "scheduledAt": 1586438625
    }
    

• 成功响应 - PROCESSING状态：
  • 状态码：200
  • 内容：

    json
    {
      "id": "06a483c9-eb73-4e08-a019-7b5665588172",
      "status": "PROCESSING",
      "message": "Request is processing.",
      "cid": "bafyreihgmyh2srmmyiw7fdihrc2lw2uodvpxb2hbpyxo7w2jlqizga6pne",
      "docId": "doc_875c56f9-9d5d-4031-8d3d-d171a91b15aa",
      "createdAt": "2020-04-08T12:10:06.000Z",
      "updatedAt": "2020-04-08T12:10:07.000Z"
    }
    

• 成功响应 - FAILED状态：
  • 状态码：200
  • 内容：

    json
    {
      "id": "06a483c9-eb73-4e08-a019-7b5665588172",
      "status": "FAILED",
      "message": "Request failed. Staled request.",
      "cid": "bafyreihgmyh2srmmyiw7fdihrc2lw2uodvpxb2hbpyxo7w2jlqizga6pne",
      "docId": "doc_875c56f9-9d5d-4031-8d3d-d171a91b15aa",
      "createdAt": 1586438625,
      "updatedAt": 1586438625
    }
    

• 成功响应 - COMPLETED状态：
  • 状态码：200
  • 内容：

    json
    {
      "id": "06a483c9-eb73-4e08-a019-7b5665588172",
      "status": "COMPLETED",
      "message": "CID successfully anchored.",
      "cid": "bafyreihgmyh2srmmyiw7fdihrc2lw2uodvpxb2hbpyxo7w2jlqizga6pne",
      "docId": "doc_875c56f9-9d5d-4031-8d3d-d171a91b15aa",
      "createdAt": 1586438625,
      "updatedAt": 1586438625,
      "anchorRecord": {
        "cid": "bafyreicq6rwooyi2dk24p52nutgysi4gpu2lvoeilooekqypk4h4f32wpy",
        "content": {
          "path": "L/L",
          "prev": "bafyreihgmyh2srmmyiw7fdihrc2lw2uodvpxb2hbpyxo7w2jlqizga6pne",
          "proof": "bafyreid3fjhoybtbgzdt2afdrxzikprbmgvufn3z7oavodd37k2tnof5ry"
        }
      }
    }
    

• 错误响应 - NOT FOUND：
  • 状态码：404
  • 内容：{ error : "Request doesn't exist" }（指定CID无锚定请求）
• 错误响应 - BAD REQUEST：
  • 状态码：400
  • 内容：{ error : "error message" }（请求格式错误或缺少必要参数）

获取链ID

返回配置的***CAIP-2链ID。

• URL：/service-info/chainid
• 方法：GET
• 成功响应：
  • 状态码：200
  • 内容：

    json
    {
      "chainId": "eip155:1"
    }
    

健康检查

检查锚定服务健康状态。

• URL：/healthcheck
• 方法：GET
• 成功响应：
  • 状态码：200
• 错误响应：
  • 状态码：503

IPFS资源管理器可视化

以下为IPLD文档结构可视化说明：

• 请求CID的IPLD文档结构
• 锚定记录的IPLD文档结构
• 锚定证明的IPLD文档结构

运行测试

测试文件位于 test 目录，执行以下命令运行测试：

bash
npm run test

如需生成测试覆盖率报告：

bash
npm run coverage

维护者

https://github.com/simonovic86

构建工具

• Node.js - v13.7.0
• TypeScript - v3.8.3
• SQLite

许可证

Apache-2.0 OR MIT

开发团队

由 3Box 团队开发。