Compass TSS API Skills#

TSS 跨链服务 API 技能文档 Base URL: https://tss-api.chainservice.io Version: 1.0

---

概述#

Compass TSS API 是一套跨链交易查询服务接口，提供跨链交易记录查询、链上扫描高度获取、Pending 交易列表等功能。

---

数据模型#

CrossData#

跨链交易基础数据结构。

字段类型说明示例chainstring链标识""``chain_and_gas_limitstring链及 Gas 限制""``heightinteger区块高度81507414``is_memoizedboolean是否已缓存false``log_indexinteger日志索引1``order_idstring订单 ID""``timestampinteger时间戳（Unix）1767097427``topicstring事件主题""``tx_hashstring交易哈希""

CrossSet#

跨链交易完整数据集合，描述一笔跨链交易在各链上的状态。

字段类型说明srcCrossData源链交易relayCrossData中继链交易relay_signedCrossData中继签名交易（前端可忽略）destCrossData目标链交易map_destCrossData映射目标交易order_idstring订单 IDstatusinteger跨链状态码status_strstring跨链状态描述nowinteger当前时间戳

StatusOfCross（跨链状态枚举）#

值名称说明0StatusOfInit初始化1StatusOfPending等待处理2StatusOfSend已发送3StatusOfCompleted已完成4StatusOfFailed失败

---

API 接口#

1. 获取当前扫描最高高度#

根据 chainId 获取当前扫描有交易的最高区块高度。

• Method: GET
• Path: /cross/chain/height
• Tags: 交易记录

请求参数

参数位置类型必填说明chainIdquerystring是链 ID

响应

200 OK

json

{
  "height": "string"
}

示例

bash

curl -X GET "https://tss-api.chainservice.io/cross/chain/height?chainId=1"

---

2. 获取高度对应的交易集群#

根据 chainId 和区块高度获取该高度下的交易 orderId 集合。

• Method: GET
• Path: /cross/chain/height/orders
• Tags: 交易记录

请求参数

参数位置类型必填说明chainIdquerystring是链 ID（如 1）heightquerystring是区块高度（如 12245）

响应

200 OK

json

{
  "height": "string",
  "set": ["orderId_1", "orderId_2"]
}

示例

bash

curl -X GET "https://tss-api.chainservice.io/cross/chain/height/orders?chainId=1&height=12245"

---

3. 根据高度区间获取交易列表#

根据 chainId 和起止高度查询区间内的所有跨链交易。

• Method: GET
• Path: /cross/height/range/txs
• Tags: 交易记录

请求参数

参数位置类型必填说明chainIdquerystring是链 IDstartHeightquerystring是起始高度endHeightquerystring是结束高度

响应

200 OK

返回 CrossSet 数组：

json

[
  {
    "data": {
      "src": { ... },
      "relay": { ... },
      "dest": { ... },
      "order_id": "string",
      "status": 0,
      "status_str": "string",
      "now": 0
    }
  }
]

示例

bash

curl -X GET "https://tss-api.chainservice.io/cross/height/range/txs?chainId=1&startHeight=1000&endHeight=2000"

---

4. 通过 orderId 获取交易记录#

根据跨链订单 ID 查询完整的交易记录。

• Method: GET
• Path: /cross/order
• Tags: 交易记录

请求参数

参数位置类型必填说明orderIdquerystring是跨链订单 ID

响应

200 OK

json

{
  "data": {
    "src": { ... },
    "relay": { ... },
    "relay_signed": { ... },
    "dest": { ... },
    "map_dest": { ... },
    "order_id": "string",
    "status": 3,
    "status_str": "completed",
    "now": 1767097427
  }
}

示例

bash

curl -X GET "https://tss-api.chainservice.io/cross/order?orderId=your_order_id"

---

5. 获取 Pending 交易列表#

根据 chainId 获取当前处于 Pending 状态的交易列表。

• Method: GET
• Path: /cross/pending/tx
• Tags: 交易记录

请求参数

参数位置类型必填说明chainIdquerystring是链 ID

响应

200 OK

json

{
  "txs": ["tx_hash_1", "tx_hash_2"]
}

示例

bash

curl -X GET "https://tss-api.chainservice.io/cross/pending/tx?chainId=1"

---

6. 通过 txHash 获取交易记录#

根据交易哈希查询跨链交易记录。

• Method: GET
• Path: /cross/tx
• Tags: 交易记录

请求参数

参数位置类型必填说明txquerystring是交易哈希（txHash）

响应

200 OK

json

{
  "data": {
    "src": { ... },
    "relay": { ... },
    "relay_signed": { ... },
    "dest": { ... },
    "map_dest": { ... },
    "order_id": "string",
    "status": 3,
    "status_str": "completed",
    "now": 1767097427
  }
}

示例

bash

curl -X GET "https://tss-api.chainservice.io/cross/tx?tx=0xYourTransactionHash"

---

错误码#

HTTP 状态码说明200请求成功400请求参数错误

---

接口总览#

#方法路径说明1GET/cross/chain/height获取当前扫描最高高度2GET/cross/chain/height/orders获取高度对应的交易集群3GET/cross/height/range/txs根据高度区间获取交易列表4GET/cross/order通过 orderId 获取交易记录5GET/cross/pending/tx获取 Pending 交易列表6GET/cross/tx通过 txHash 获取交易记录