跳到主要内容

基本查询接口

URL

该 URL 为默认节点的 URL若想在其他节点上进行操作，代替即可。

https://hymatrix.ai
提示

每一个 process 都有固定的节点，需在固定节点上发交易才能成功发出。可通过 getNodesByProcess获取对应的 节点

info​

获取 HyMatrix 网络相关基本信息。例如 Protocol：名称，Variant：版本号，Node: 默认节点信息。

参数

GET https://hymatrix.ai/info

返回字段

字段描述
Protocol协议名称，此处为 "hymx"，代表 HyMatrix 协议。
Variant协议版本号，例如 "v0.1.1"，用于识别协议规范的版本。
Join-Network布尔值，是否加入网络，true 表示参与 Hymx 网络。
TokenToken 的 ProcessId。
Registry注册中心标识符或地址，用于节点注册。
Node默认 Node 节点，包含节点信息。

Node 字段描述

字段描述
Node.Acc-Id节点账户地址。
Node.Name节点名称。
Node.Role节点身份。
Node.Desc节点描述信息。
Node.URL节点可的访问 URL 地址。可通过此 URL 进行查询或发起交易。

示例

curl --location --request GET "https://hymatrix.ai/info"

返回


{
  "Protocol": "hymx",
  "Variant": "v0.1.1",
  "Join-Network": true,
  "Token": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "Registry": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
  "Node": {
    "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
    "Name": "testMainNode",
    "Role": "main",
    "Desc": "first test node",
    "URL": "https://hymatrix.ai"
  }
}

getResult​

通过已知的 processId, messageId， 获取对应的 result。

参数

GET https://hymatrix.ai/result/{{processId}}{{messageId}}
字段是否必需描述
processIdYESprocessId：process 地址
messageIdYESmessageId：发起交易后获取的 id

返回字段

字段描述
Nonce交易生成的随机数。可通过 Token processId 和 Nonce 查询交易。
Timestamp交易发生时的时间戳。
Item-Id当前交易生成的唯一标识。
From-Process
Pushed-For
MessagesMessages 包含 Sequence: 消息序号、Target: 发出交易的钱包地址，Data: 文本消息，Tags: 一组 Tag 标签。
Spawns
Assignmengts
Output输出数据
Data数据文本
Error错误信息

示例

curl --location --request GET "https://hymatrix.ai/result/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4/MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI"

返回

{
  "Nonce": "334",
  "Timestamp": "1757506515032",
  "Item-Id": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
  "From-Process": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "Pushed-For": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
  "Messages": [
    {
      "Sequence": "659",
      "Target": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F",
      "Data": "You staked 1000000000000",
      "Tags": [
        {
          "name": "Ticker",
          "value": "tAX"
        },
        {
          "name": "Action",
          "value": "Stake-Notice"
        },
        {
          "name": "Quantity",
          "value": "1000000000000"
        }
      ]
    },
    {
      "Sequence": "660",
      "Target": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
      "Tags": [
        {
          "name": "Action",
          "value": "Register"
        },
        {
          "name": "Acc-Id",
          "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
        },
        {
          "name": "Name",
          "value": "test1"
        },
        {
          "name": "Role",
          "value": "follower"
        },
        {
          "name": "Desc",
          "value": "first test node"
        },
        {
          "name": "URL",
          "value": "http://101.32.221.225:8080"
        }
      ]
    }
  ],
  "Spawns": null,
  "Assignmengts": null,
  "Output": null,
  "Data": "",
  "Error": ""
}

getResults​

通过已知的 processId， 获取对应的 result 列表信息。

参数

GET https://hymatrix.ai/results/{{processId}}?limit={{limit}}
查询字段是否必需描述
processIdYESprocessId：process 地址
limitYES查询的数量

返回字段

字段描述
edges交易记录列表，包含 curosr: 游标，node: 交易信息，包含 Nonce、Item-Id、 Messages 等

示例

curl --location --request GET "https://hymatrix.ai/results/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4?limit=1"

返回

{
  "edges": [
    {
      "cursor": "eyJ0aW1lc3RhbXAiOjE3NTc1MDY1MTUwMzIsIm9yZGluYXRlIjozMzQsImNyb24iOiIxLTEwLW1pbnV0ZXMiLCJzb3J0IjoiQVNDIn0",
      "node": {
        "Nonce": "334",
        "Timestamp": "1757506515032",
        "Item-Id": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
        "From-Process": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
        "Pushed-For": "MCPViI-PoApCqRfjHtxAiryq9pM_7zk1MkbjSSCZSqI",
        "Messages": [
          {
            "Sequence": "659",
            "Target": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F",
            "Data": "You staked 1000000000000",
            "Tags": [
              {
                "name": "Ticker",
                "value": "tAX"
              },
              {
                "name": "Action",
                "value": "Stake-Notice"
              },
              {
                "name": "Quantity",
                "value": "1000000000000"
              }
            ]
          },
          {
            "Sequence": "660",
            "Target": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
            "Tags": [
              {
                "name": "Action",
                "value": "Register"
              },
              {
                "name": "Acc-Id",
                "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
              },
              {
                "name": "Name",
                "value": "test1"
              },
              {
                "name": "Role",
                "value": "follower"
              },
              {
                "name": "Desc",
                "value": "first test node"
              },
              {
                "name": "URL",
                "value": "http://101.32.221.225:8080"
              }
            ]
          }
        ],
        "Spawns": null,
        "Assignmengts": null,
        "Output": null,
        "Data": "",
        "Error": ""
      }
    },
    // ...
  ]
}

getMessage​

通过已知的 messageId， 获取对应的 Messages 信息。

参数

GET https://hymatrix.ai/message/{{messageId}}
字段是否必需描述
messageIdYESmessageId：发起交易后获取的 id

返回字段

字段描述
signatureType签名算法类型，此处为 3，代表 RSA-PSS（Arweave 默认签名方案）。
signature发起者对该交易的签名字符串。用于验证消息来源。
owner发起交易者的钱包的编码信息。
targetprocessId
anchor''
tags一组 Tag 标签。
data签名数据 。
idMessages 标识符。
tagsBy编码后的标签信息。

示例

curl --location --request GET "https://hymatrix.ai/message/1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"

返回

{
  "signatureType": 3,
  "signature": "aBg4BXyxsKIaaNs_cJ5XsLuLbtW772EV8XCaxcDdSypIOJR38IuU-XYn8Xp4Sw4UOe3RHHTL3Q4VINBj_LtfLRs",
  "owner": "BCELKi--SONX-yQEKBsip4rFtfrkvXA92fty79n4BrpVTraktwCBPhZOlQC_jukezZ3kO1qZcdNnpfIGZVd7V-Y",
  "target": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "anchor": "",
  "tags": [
    {
      "name": "SDK-Timestamp",
      "value": "1757506904708315269"
    },
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Message"
    },
    {
      "name": "Action",
      "value": "Stake"
    },
    {
      "name": "Quantity",
      "value": "1000000000000"
    },
    {
      "name": "Registry",
      "value": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g"
    },
    {
      "name": "Acc-Id",
      "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
    },
    {
      "name": "Name",
      "value": "test1"
    },
    {
      "name": "Desc",
      "value": "first test node"
    },
    {
      "name": "URL",
      "value": "http://101.32.221.225:8080"
    }
  ],
  "data": "",
  "id": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0",
  "tagsBy": "FhpTREstVGltZXN0YW1wJjE3NTc1MDY5MDQ3MDgzMTUyNjkaRGF0YS1Qcm90b2NvbAhoeW14DlZhcmlhbnQMdjAuMS4wCFR5cGUOTWVzc2FnZQxBY3Rpb24KU3Rha2UQUXVhbnRpdHkaMTAwMDAwMDAwMDAwMBBSZWdpc3RyeVZPLTBfTzRUZ1lZbkE0Vkh3MkV0SFI2TmFmTl9aUlJsWDB1eGtiVU10bzZnDEFjYy1JZFQweGYwNDNjQ0U4QzUwMEFhYTNFQTM0OGMwQjYwMjVDRWI2RDMzNjg4MkYITmFtZQp0ZXN0MQhEZXNjHmZpcnN0IHRlc3Qgbm9kZQZVUkw0aHR0cDovLzEwMS4zMi4yMjEuMjI1OjgwODAA"
}

getMessageByNonce​

通过已知的 processId 和 nonce， 获取对应的 Messages 信息。

参数

GET https://hymatrix.ai/messageByNonce/{{processId}}/{{nonce}}
字段是否必需描述
processIdYESprocessId：process 地址
nonceYES随机数，交易信息中的随机数

返回字段

字段描述
signatureType签名算法类型，此处为 3，代表 RSA-PSS（Arweave 默认签名方案）。
signature发起者对该交易的签名字符串。用于验证消息来源。
owner发起交易者的钱包的编码信息。
targetprocessId
anchor''
tags一组 Tag 标签。
data签名数据 。
idMessages 标识符。
tagsBy编码后的标签信息。

示例

curl --location --request GET "https://hymatrix.ai/messageByNonce/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4/338"

返回

{
  "signatureType": 3,
  "signature": "aBg4BXyxsKIaaNs_cJ5XsLuLbtW772EV8XCaxcDdSypIOJR38IuU-XYn8Xp4Sw4UOe3RHHTL3Q4VINBj_LtfLRs",
  "owner": "BCELKi--SONX-yQEKBsip4rFtfrkvXA92fty79n4BrpVTraktwCBPhZOlQC_jukezZ3kO1qZcdNnpfIGZVd7V-Y",
  "target": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  "anchor": "",
  "tags": [
    {
      "name": "SDK-Timestamp",
      "value": "1757506904708315269"
    },
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Message"
    },
    {
      "name": "Action",
      "value": "Stake"
    },
    {
      "name": "Quantity",
      "value": "1000000000000"
    },
    {
      "name": "Registry",
      "value": "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g"
    },
    {
      "name": "Acc-Id",
      "value": "0xf043cCE8C500Aaa3EA348c0B6025CEb6D336882F"
    },
    {
      "name": "Name",
      "value": "test1"
    },
    {
      "name": "Desc",
      "value": "first test node"
    },
    {
      "name": "URL",
      "value": "http://101.32.221.225:8080"
    }
  ],
  "data": "",
  "id": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0",
  "tagsBy": "FhpTREstVGltZXN0YW1wJjE3NTc1MDY5MDQ3MDgzMTUyNjkaRGF0YS1Qcm90b2NvbAhoeW14DlZhcmlhbnQMdjAuMS4wCFR5cGUOTWVzc2FnZQxBY3Rpb24KU3Rha2UQUXVhbnRpdHkaMTAwMDAwMDAwMDAwMBBSZWdpc3RyeVZPLTBfTzRUZ1lZbkE0Vkh3MkV0SFI2TmFmTl9aUlJsWDB1eGtiVU10bzZnDEFjYy1JZFQweGYwNDNjQ0U4QzUwMEFhYTNFQTM0OGMwQjYwMjVDRWI2RDMzNjg4MkYITmFtZQp0ZXN0MQhEZXNjHmZpcnN0IHRlc3Qgbm9kZQZVUkw0aHR0cDovLzEwMS4zMi4yMjEuMjI1OjgwODAA"
}

getAssignByNonce​

通过已知的 processId 和 nonce， 获取对应的 Assign 列表信息。

参数

GET https://hymatrix.ai/assignmentByNonce/{{processId}}/{{nonce}}
字段是否必需描述
processIdYESprocessId：process 地址
nonceYES随机数，交易信息中的随机数

返回字段

字段描述
signatureType签名算法类型，此处为 3，代表 RSA-PSS（Arweave 默认签名方案）。
signature发起者对该交易的签名字符串。
owner发起交易者的钱包的编码信息。
target''
anchor''
tags一组 Tag 标签。
data签名数据 。
idAssign 标识符。
tagsBy编码后的标签信息。

示例

curl --location --request GET "https://hymatrix.ai/assignmentByNonce/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4/338"

返回

{
  "signatureType": 3,
  "signature": "1TzKoJzunGG38kurXqvSIjbpQr1h5GWfXrjglhn9h7Qn2vxx9iGG2pkANvV1UgdPfhQs_XdLoooGkx2PisPT5hw",
  "owner": "BEJ4yO_ZafTwXM5YzYXS_L6kCIzPJpyn1OR89jI7dRIWcSiBxRMYGM-wFdXqJW4Nla05cr6lxHLZrlIBMZxkwH0",
  "target": "",
  "anchor": "",
  "tags": [
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.2"
    },
    {
      "name": "Type",
      "value": "Assignment"
    },
    {
      "name": "Process",
      "value": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4"
    },
    {
      "name": "Message",
      "value": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"
    },
    {
      "name": "Nonce",
      "value": "338"
    },
    {
      "name": "Timestamp",
      "value": "1757506904731"
    }
  ],
  "data": "",
  "id": "DcJcM96JgSRLhgPEpWmVGidtPjbnN4xwUe28wVDxA2A",
  "tagsBy": "DhpEYXRhLVByb3RvY29sCGh5bXgOVmFyaWFudAx2MC4xLjIIVHlwZRRBc3NpZ25tZW50DlByb2Nlc3NWZkhRYnp3NmFjZzJucW1DcXpkcjJHRmFlb0d6Y1JkMHBhVlREMmtNR3lVNA5NZXNzYWdlVjFHRUpJSjJ1eFdaUVU0cXVPbnN3RE9LRTllTUhtZkxkMjVvdVJ2QW5ZWDAKTm9uY2UGMzM4ElRpbWVzdGFtcBoxNzU3NTA2OTA0NzMxAA"
}

getAssignByMessage​

通过已知的 messageId， 获取对应的 Assign 信息。

参数

GET https://hymatrix.ai/assignmentByMessage/{{messageId}}
字段是否必需描述
messageIdYESmessageId：发起交易后获取的 id

返回字段

字段描述
signatureType签名算法类型，此处为 3，代表 RSA-PSS（Arweave 默认签名方案）。
signature发起者对该交易的签名字符串。
owner发起交易者的钱包的编码信息。
target''
anchor''
tags一组 Tag 标签。
data签名数据 。
idAssign 标识符。
tagsBy编码后的标签信息。

示例

curl --location --request GET "https://hymatrix.ai/assignmentByMessage/1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"

返回

{
  "signatureType": 3,
  "signature": "1TzKoJzunGG38kurXqvSIjbpQr1h5GWfXrjglhn9h7Qn2vxx9iGG2pkANvV1UgdPfhQs_XdLoooGkx2PisPT5hw",
  "owner": "BEJ4yO_ZafTwXM5YzYXS_L6kCIzPJpyn1OR89jI7dRIWcSiBxRMYGM-wFdXqJW4Nla05cr6lxHLZrlIBMZxkwH0",
  "target": "",
  "anchor": "",
  "tags": [
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.2"
    },
    {
      "name": "Type",
      "value": "Assignment"
    },
    {
      "name": "Process",
      "value": "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4"
    },
    {
      "name": "Message",
      "value": "1GEJIJ2uxWZQU4quOnswDOKE9eMHmfLd25ouRvAnYX0"
    },
    {
      "name": "Nonce",
      "value": "338"
    },
    {
      "name": "Timestamp",
      "value": "1757506904731"
    }
  ],
  "data": "",
  "id": "DcJcM96JgSRLhgPEpWmVGidtPjbnN4xwUe28wVDxA2A",
  "tagsBy": "DhpEYXRhLVByb3RvY29sCGh5bXgOVmFyaWFudAx2MC4xLjIIVHlwZRRBc3NpZ25tZW50DlByb2Nlc3NWZkhRYnp3NmFjZzJucW1DcXpkcjJHRmFlb0d6Y1JkMHBhVlREMmtNR3lVNA5NZXNzYWdlVjFHRUpJSjJ1eFdaUVU0cXVPbnN3RE9LRTllTUhtZkxkMjVvdVJ2QW5ZWDAKTm9uY2UGMzM4ElRpbWVzdGFtcBoxNzU3NTA2OTA0NzMxAA"
}

getNode​

查询账户下节点信息

参数

GET https://hymatrix.ai/node/{{accid}}
字段是否必需描述
accidNOaccid：用户地址

返回字段

字段描述
Acc-Id节点账户地址。
Name节点名称。
Role节点身份。
Desc节点描述信息。
URL节点可的访问 URL 地址。可通过此 URL 进行查询或发起交易。

示例

curl --location --request GET "https://hymatrix.ai/node/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

返回

{
  "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
  "Name": "TestGenesisNode",
  "Role": "main",
  "Desc": "Test network genesis node",
  "URL": "https://hymatrix.ai"
}

getNodes​

获取所有节点信息。

参数

GET https://hymatrix.ai/nodes

返回字段

字段描述
Acc-Id节点账户地址。
Name节点名称。
Role节点身份。
Desc节点描述信息。
URL节点可的访问 URL 地址。可通过此 URL 进行查询或发起交易。

示例

curl --location --request GET "https://hymatrix.ai/nodes"

返回

{
  "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37": {
    "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
    "Name": "TestGenesisNode",
    "Role": "main",
    "Desc": "Test network genesis node",
    "URL": "https://hymatrix.ai"
  },
  "0x1dc6e69897A650D28190a28C945B140455315acf": {
    "Acc-Id": "0x1dc6e69897A650D28190a28C945B140455315acf",
    "Name": "Arecotest",
    "Role": "follower",
    "Desc": "first test node",
    "URL": "https://152.42.221.139:8080"
  },
  //...
}

getNodesByProcess​

查询某个进程的节点信息

参数

GET https://hymatrix.ai/nodesByProcess/{{processId}}
字段是否必需描述
processIdYESprocessId：process 地址

返回字段

字段描述
Acc-Id节点账户地址。
Name节点名称。
Role节点身份。
Desc节点描述信息。
URL节点可的访问 URL 地址。可通过此 URL 进行查询或发起交易。

示例

curl --location --request GET "https://hymatrix.ai/nodesByProcess/fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4"

返回

[
  {
    "Acc-Id": "0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37",
    "Name": "TestGenesisNode",
    "Role": "main",
    "Desc": "Test network genesis node",
    "URL": "https://hymatrix.ai"
  },
  //...
]

getProcesses​

查询账号下创建的所有进程

参数

GET https://hymatrix.ai/processes/{{accid}}
查询字段是否必需描述
accidNOaccid：用户地址

返回数据

process 数组

示例

curl --location --request GET "https://hymatrix.ai/processes/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

返回

[
  "O-0_O4TgYYnA4VHw2EtHR6NafN_ZRRlX0uxkbUMto6g",
  "fHQbzw6acg2nqmCqzdr2GFaeoGzcRd0paVTD2kMGyU4",
  //...
]

balanceOf​

查询账号下的余额

参数

GET https://hymatrix.ai/balanceof/{{accid}}
字段是否必需描述
accidNOaccid：用户地址

示例

curl --location --request GET "https://hymatrix.ai/balanceof/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

返回

"0"

stakeOf​

查询账号下质押金额

参数

GET https://hymatrix.ai/stakeOf/{{accid}}
字段是否必需描述
accidNOaccid：用户地址

示例

curl --location --request GET "https://hymatrix.ai/stakeOf/0x18b4bA4c118279b3eB60a2DB1E794Bc41AFC1D37"

返回

"0"