基本查询接口

介绍

在创建 HyMatrix 实例时，可选择性传递 debug, accid, signer, privateKey, arJWK，甚至任何参数都不进行传递，也可进行 基础查询API 的调用。

例如：

const hyMatrix = new HyMatrix()
hyMatrix.info().then(console.log)

const processId = 'GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8'
const messageId = 'vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig'
hyMatrix.getResult(messageId).then(console.log)

info

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

示例

const hyMatrix = new HyMatrix()
hyMatrix.info().then(console.log)

{
  "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"
  }
}

更多消息请前往 /info

getResult

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

参数

字段	是否必需	描述
processId	YES	`processId`：process 地址
messageId	YES	`messageId`：发起交易后获取的 `id`

示例

const hyMatrix = new HyMatrix()

const processId = 'GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8'
const messageId = 'vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig'
hyMatrix.getResult(messageId).then(console.log)

{
  "Nonce": "14",
  "Timestamp": "1753857762472",
  "Item-Id": "vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig",
  "From-Process": "GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8",
  "Pushed-For": "vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig",
  "Messages": [
    {
      "Sequence": "10",
      "Target": "0xfc65E09Ef6674DdB4D8a6f3b6a6c8D9d55d67716",
      "Data": "\u001b[90mYou transferred \u001b[34m100\u001b[90m to \u001b[32m_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo\u001b[0m",
      "Tags": [
        {
          "name": "Data-Protocol",
          "value": "ao"
        },
        {
          "name": "Variant",
          "value": "ao.TN.1"
        },
        {
          "name": "Type",
          "value": "Message"
        },
        {
          "name": "Reference",
          "value": "10"
        },
        {
          "name": "Action",
          "value": "Debit-Notice"
        },
        {
          "name": "Quantity",
          "value": "100"
        },
        {
          "name": "Recipient",
          "value": "_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo"
        }
      ]
    },
    {
      "Sequence": "11",
      "Target": "_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo",
      "Data": "\u001b[90mYou received \u001b[34m100\u001b[90m from \u001b[32m0xfc65E09Ef6674DdB4D8a6f3b6a6c8D9d55d67716\u001b[0m",
      "Tags": [
        {
          "name": "Data-Protocol",
          "value": "ao"
        },
        {
          "name": "Variant",
          "value": "ao.TN.1"
        },
        {
          "name": "Type",
          "value": "Message"
        },
        {
          "name": "Reference",
          "value": "11"
        },
        {
          "name": "Sender",
          "value": "0xfc65E09Ef6674DdB4D8a6f3b6a6c8D9d55d67716"
        },
        {
          "name": "Action",
          "value": "Credit-Notice"
        },
        {
          "name": "Quantity",
          "value": "100"
        }
      ]
    }
  ],
  "Spawns": [],
  "Assignmengts": null,
  "Output": {
    "data": "",
    "print": true,
    "prompt": "\u001b[32m\u001b[90m@\u001b[34maos-2.0.1\u001b[90m[Inbox:\u001b[31m\u001b[90m]\u001b[0m> "
  },
  "Data": "",
  "Error": ""
}

更多消息请前往 /getResult

getResults

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

参数

查询字段	是否必需	描述
processId	YES	`processId`：process 地址
limit	YES	查询的数量

示例

const hyMatrix = new HyMatrix()

const processId = 'GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8'
hyMatrix.getResults(processId, 10).then(console.log)

{
  "edges": [
    {
      "cursor": "eyJ0aW1lc3RhbXAiOjE3NTQwMjE2MTY1NTYsIm9yZGluYXRlIjoxOCwiY3JvbiI6IjEtMTAtbWludXRlcyIsInNvcnQiOiJBU0MifQ",
      "node": {
        "Nonce": "18",
        "Timestamp": "1754021616556",
        "Item-Id": "0UmV2VvVkWQncmXa1R2CjEXePmZCNCcV83DBSsD63ps",
        "From-Process": "GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8",
        "Pushed-For": "0UmV2VvVkWQncmXa1R2CjEXePmZCNCcV83DBSsD63ps",
        "Messages": [
          {
            "Sequence": "17",
            "Target": "0xfc65E09Ef6674DdB4D8a6f3b6a6c8D9d55d67716",
            "Data": "\u001b[90mYou transferred \u001b[34m100\u001b[90m to \u001b[32m_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo\u001b[0m",
            "Tags": [
              {
                "name": "Data-Protocol",
                "value": "ao"
              },
              {
                "name": "Variant",
                "value": "ao.TN.1"
              },
              {
                "name": "Type",
                "value": "Message"
              },
              {
                "name": "Reference",
                "value": "17"
              },
              {
                "name": "Action",
                "value": "Debit-Notice"
              },
              {
                "name": "Quantity",
                "value": "100"
              },
              {
                "name": "Recipient",
                "value": "_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo"
              }
            ]
          },
          {
            "Sequence": "18",
            "Target": "_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo",
            "Data": "\u001b[90mYou received \u001b[34m100\u001b[90m from \u001b[32m0xfc65E09Ef6674DdB4D8a6f3b6a6c8D9d55d67716\u001b[0m",
            "Tags": [
              {
                "name": "Data-Protocol",
                "value": "ao"
              },
              {
                "name": "Variant",
                "value": "ao.TN.1"
              },
              {
                "name": "Type",
                "value": "Message"
              },
              {
                "name": "Reference",
                "value": "18"
              },
              {
                "name": "Sender",
                "value": "0xfc65E09Ef6674DdB4D8a6f3b6a6c8D9d55d67716"
              },
              {
                "name": "Action",
                "value": "Credit-Notice"
              },
              {
                "name": "Quantity",
                "value": "100"
              }
            ]
          }
        ],
        "Spawns": [],
        "Assignmengts": null,
        "Output": {
          "data": "",
          "print": true,
          "prompt": "\u001b[32m\u001b[90m@\u001b[34maos-2.0.1\u001b[90m[Inbox:\u001b[31m\u001b[90m]\u001b[0m> "
        },
        "Data": "",
        "Error": ""
      }
    },
    // ...
  ]
}

更多消息请前往 /getResults

getMessage

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

参数

字段	是否必需	描述
messageId	YES	`messageId`：发起交易后获取的 `id`

示例

const hyMatrix = new HyMatrix()

const messageId = 'vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig'
hyMatrix.getMessage(messageId).then(console.log)

{
  "signatureType": 3,
  "signature": "ad21YuS8X3iZXcAyGJoFr0X6-FuHvR391LlxrY47J6sxCWeUtABfzuwWf4uRmhAVw-rbcZqyjo28ZPWe_9B9CRw",
  "owner": "BBTIm0IztpJRvpiRLfiSxckjR-1e5BRfqFXcFdIs5uekXvJu7v5CME1ahX6uAXKJvYrMbIEVJ-LDnIYcwAe1aW4",
  "target": "GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8",
  "anchor": "",
  "tags": [
    {
      "name": "SDK-Timestamp",
      "value": "1753857761734"
    },
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Message"
    },
    {
      "name": "Action",
      "value": "Transfer"
    },
    {
      "name": "Recipient",
      "value": "_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo"
    },
    {
      "name": "Quantity",
      "value": "100"
    }
  ],
  "data": "",
  "id": "vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig",
  "tagsBy": "DhpTREstVGltZXN0YW1wGjE3NTM4NTc3NjE3MzQaRGF0YS1Qcm90b2NvbAhoeW14DlZhcmlhbnQMdjAuMS4wCFR5cGUOTWVzc2FnZQxBY3Rpb24QVHJhbnNmZXISUmVjaXBpZW50Vl9xcmhwNF9jLWpsMUl3TEtjd2xER01DcXMzQng3M2VKZXB0QWhZTjl3Tm8QUXVhbnRpdHkGMTAwAA"
}

更多消息请前往 /getMessage

getMessageByNonce

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

参数

字段	是否必需	描述
processId	YES	`processId`：process 地址
nonce	YES	随机数，交易信息中的随机数

示例

const hyMatrix = new HyMatrix()

const processId = 'GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8'
const nonce = 14
hyMatrix.getMessageByNonce(processId, nonce).then(console.log)

{
  "signatureType": 3,
  "signature": "ad21YuS8X3iZXcAyGJoFr0X6-FuHvR391LlxrY47J6sxCWeUtABfzuwWf4uRmhAVw-rbcZqyjo28ZPWe_9B9CRw",
  "owner": "BBTIm0IztpJRvpiRLfiSxckjR-1e5BRfqFXcFdIs5uekXvJu7v5CME1ahX6uAXKJvYrMbIEVJ-LDnIYcwAe1aW4",
  "target": "GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8",
  "anchor": "",
  "tags": [
    {
      "name": "SDK-Timestamp",
      "value": "1753857761734"
    },
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Message"
    },
    {
      "name": "Action",
      "value": "Transfer"
    },
    {
      "name": "Recipient",
      "value": "_qrhp4_c-jl1IwLKcwlDGMCqs3Bx73eJeptAhYN9wNo"
    },
    {
      "name": "Quantity",
      "value": "100"
    }
  ],
  "data": "",
  "id": "vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig",
  "tagsBy": "DhpTREstVGltZXN0YW1wGjE3NTM4NTc3NjE3MzQaRGF0YS1Qcm90b2NvbAhoeW14DlZhcmlhbnQMdjAuMS4wCFR5cGUOTWVzc2FnZQxBY3Rpb24QVHJhbnNmZXISUmVjaXBpZW50Vl9xcmhwNF9jLWpsMUl3TEtjd2xER01DcXMzQng3M2VKZXB0QWhZTjl3Tm8QUXVhbnRpdHkGMTAwAA"
}

更多消息请前往 /getMessageByNonce

getAssignByNonce

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

参数

字段	是否必需	描述
processId	YES	`processId`：process 地址
nonce	YES	随机数，交易信息中的随机数

示例

const hyMatrix = new HyMatrix()

const processId = 'GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8'
const nonce = 14
hyMatrix.getAssignByNonce(processId, nonce).then(console.log)

{
  "signatureType": 3,
  "signature": "6Jo8HM8mqv8YVb-lcFWf_W4_dUxFAYrf0f-P5Vsjqlp8Ie7Abh1D-bCxY0j6VwjmLtxGKMkNc_BpX2MPwEtvohs",
  "owner": "BKhc8fzcrT9QVrWp4i6RTpke9C5vNb5XjJX18LgrnRzCYGDZcIXztIrR-0hBb_mzF3pjqfl4tMyJ_bGzAWKrqFs",
  "target": "",
  "anchor": "",
  "tags": [
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Assignment"
    },
    {
      "name": "Process",
      "value": "GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8"
    },
    {
      "name": "Message",
      "value": "vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig"
    },
    {
      "name": "Nonce",
      "value": "14"
    },
    {
      "name": "Timestamp",
      "value": "1753857762468"
    }
  ],
  "data": "",
  "id": "igsAKUQ0uGkm6f8o9hEAnQ2-fpEr1b3WpGXWtIwoFUM",
  "tagsBy": "DhpEYXRhLVByb3RvY29sCGh5bXgOVmFyaWFudAx2MC4xLjAIVHlwZRRBc3NpZ25tZW50DlByb2Nlc3NWR3V1SDF3Q09CYXRHLUpvS3U0Mk5rSk1DN0N4LXJqRDhGNUVFSUNMVE5QOA5NZXNzYWdlVnZERG93RTNOck5LZkF5WnRmRUdhVExya09ocjNEREIyRF8tVnMyMlo4aWcKTm9uY2UEMTQSVGltZXN0YW1wGjE3NTM4NTc3NjI0NjgA"
}

更多消息请前往 /getAssignByNonce

getAssignByMessage

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

参数

字段	是否必需	描述
messageId	YES	`messageId`：发起交易后获取的 `id`

示例

const hyMatrix = new HyMatrix()

const messageId = 'vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig'
hyMatrix.getAssignByMessage(messageId).then(console.log)

{
  "signatureType": 3,
  "signature": "6Jo8HM8mqv8YVb-lcFWf_W4_dUxFAYrf0f-P5Vsjqlp8Ie7Abh1D-bCxY0j6VwjmLtxGKMkNc_BpX2MPwEtvohs",
  "owner": "BKhc8fzcrT9QVrWp4i6RTpke9C5vNb5XjJX18LgrnRzCYGDZcIXztIrR-0hBb_mzF3pjqfl4tMyJ_bGzAWKrqFs",
  "target": "",
  "anchor": "",
  "tags": [
    {
      "name": "Data-Protocol",
      "value": "hymx"
    },
    {
      "name": "Variant",
      "value": "v0.1.0"
    },
    {
      "name": "Type",
      "value": "Assignment"
    },
    {
      "name": "Process",
      "value": "GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8"
    },
    {
      "name": "Message",
      "value": "vDDowE3NrNKfAyZtfEGaTLrkOhr3DDB2D_-Vs22Z8ig"
    },
    {
      "name": "Nonce",
      "value": "14"
    },
    {
      "name": "Timestamp",
      "value": "1753857762468"
    }
  ],
  "data": "",
  "id": "igsAKUQ0uGkm6f8o9hEAnQ2-fpEr1b3WpGXWtIwoFUM",
  "tagsBy": "DhpEYXRhLVByb3RvY29sCGh5bXgOVmFyaWFudAx2MC4xLjAIVHlwZRRBc3NpZ25tZW50DlByb2Nlc3NWR3V1SDF3Q09CYXRHLUpvS3U0Mk5rSk1DN0N4LXJqRDhGNUVFSUNMVE5QOA5NZXNzYWdlVnZERG93RTNOck5LZkF5WnRmRUdhVExya09ocjNEREIyRF8tVnMyMlo4aWcKTm9uY2UEMTQSVGltZXN0YW1wGjE3NTM4NTc3NjI0NjgA"
}

更多消息请前往 /getAssignByMessage

getNode

查询账户下节点信息

参数

字段	是否必需	描述
accid	NO	`accid`：用户地址

示例

const accid = ''
const hyMatrix = new HyMatrix({
  accid: accid,
  debug: true
})
hyMatrix.getNode().then(console.log)
hyMatrix.getNode(accid).then(console.log)

{
  "Acc-Id": "0xCD1Ef67a57a7c03BFB05F175Be10e3eC79821138",
  "Name": "permadao",
  "Role": "follower",
  "Desc": "permadao test node",
  "URL": "https://hymx.permadao.io"
}

更多消息请前往 /getNode

getNodes

获取所有节点信息。

示例

const hyMatrix = new HyMatrix()

hyMatrix.getNodes().then(console.log)

{
  "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"
  },
  //...
}

更多消息请前往 /getNodes

getNodesByProcess

查询某个进程的节点信息

参数

字段	是否必需	描述
processId	YES	`processId`：process 地址

示例

const hyMatrix = new HyMatrix()

const processId = 'GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8'
hyMatrix.getNodesByProcess(processId).then(console.log)

[
  {
    "Acc-Id": "0xCD1Ef67a57a7c03BFB05F175Be10e3eC79821138",
    "Name": "permadao",
    "Role": "follower",
    "Desc": "permadao test node",
    "URL": "https://hymx.permadao.io"
  },
  //...
]

更多消息请前往 /getNodesByProcess

getProcesses

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

参数

查询字段	是否必需	描述
accid	NO	`accid`：用户地址

示例

const accid = ''
const hyMatrix = new HyMatrix({
  accid: accid,
  debug: true
})
hyMatrix.getProcesses().then(console.log)
hyMatrix.getProcesses(accid).then(console.log)

[
  "GuuH1wCOBatG-JoKu42NkJMC7Cx-rjD8F5EEICLTNP8",
  //...
]

更多消息请前往 /getProcesses

balanceOf

查询账号下的余额

参数

字段	是否必需	描述
accid	NO	`accid`：用户地址

示例

const accid = ''
const hyMatrix = new HyMatrix({
  accid: accid,
  debug: true
})

hyMatrix.balanceOf().then(console.log)
hyMatrix.balanceOf(accid).then(console.log)

"0"

更多消息请前往 /balanceOf

stakeOf

查询账号下质押金额

参数

字段	是否必需	描述
accid	NO	`accid`：用户地址

示例

const accid = ''
const hyMatrix = new HyMatrix({
  accid: accid,
  debug: true
})

hyMatrix.stakeOf().then(console.log)
hyMatrix.stakeOf(accid).then(console.log)

"0"

更多消息请前往 /stakeOf

介绍​

info​

示例​

返回​

getResult​

参数​

示例​

返回​

getResults​

参数​

示例​

返回​

getMessage​

参数​

示例​

返回​

getMessageByNonce​

参数​

示例​

返回​

getAssignByNonce​

参数​

示例​

返回​

getAssignByMessage​

参数​

示例​

返回​

getNode​

参数​

示例​

返回​

getNodes​

示例​

返回​

getNodesByProcess​

参数​

示例​

返回​

getProcesses​

参数​

示例​

返回​

balanceOf​

参数​

示例​

返回​

stakeOf​

参数​

示例​

返回​

介绍