search

SwapBox V2 接口文档

SwapBox多链资产智能跨链兑换聚合器，包括同链兑换、跨链兑换和跨链Bridge功能。 SwapBox对接了多个兑换通道，能尽量满足用户各种兑换需求。

hashtag
简言

SwapBox多链资产智能跨链兑换聚合器，包括同链兑换、跨链兑换和跨链Bridge功能。 SwapBox对接了多个兑换通道，能尽量满足用户各种兑换需求。

这里主要说明一下Nerve中继网络兑换通道。该链与其他区块链网络实现跨链兑换，其他链的资产或者Tokens在Nerve链注册并跨链到Nerve链后，在NerveSwap（AMM Swap & Muti-Routing）完成兑换或者直接通过Nerve跨链到目标链。再将成功兑换的资产跨链转出到目标链的账户地址上。

Nerve兑换通道当前已支持（BTC、Ethereum、BSC、Optimism、Arbitrum、Polygon …）EVM系链和非EVM链，未来会根据需要逐渐添加更多跨链支持。

Nerve兑换通道为每个已对接跨链的区块链，在Nerve链上分配了链ID(chainId)，并给其链上的资产和Tokens分配了资产ID(assetId)。(注：这里的chainId是Nerve链给其他集成的链在Nerve链上分配的chainId，区别于EVM系链本身的chainId。EVM系链的chainId会在后续接口文档返回说明的nativeId字段描述。)

每条链上的资产或者Tokens，我们都视为一种资产，其中每条链都会有一个主资产，例如Ethereum链上的代币（ETH）。主资产主要用于组装交易时，支付手续费。

我们还提供了SwapBox的js.sdk工具，用户可通过js.sdk组装跨链兑换交易。

hashtag
请求与返回

Domain : https://swapbox.ioarrow-up-right

restful访问格式：

添加请求头:

language: en // en英文， cn中文

Content-Type: application/json;charset=UTF-8

Accept: application/json

返回格式：

//成功示例
{
    "code": 0,        //返回码，0表示成功，其余表示失败
    "msg": "成功",     //返回信息
    "data": {         //返回数据
      "xxxx":xxx
    }
}
//错误示例
{
    "code": 1002,
    "msg": "xxxx错误",
    "data": null
}

hashtag
查询链配置

**详细描述：**查询Nabox当前支持的所有链的配置信息，所有应用，应该在打开DApp时，调用此接口获取链配置（链信息和主资产信息），并缓存在本地。

url: /api/config/chains //get

**参数：**无

返回：链配置列表接口

hashtag
查询兑换资产列表

详细描述：查询SwapBox支持的当前链可兑换资产列表，其中只有参数chain为必传。

当需要查询单一资产（币种）时，NULS和NERVE链的资产是通过chainId和assetId来唯一锁定一个资产，其他链（例如EVM链），查询主代币时，assetId传1即可；其余erc20token，传参数contractAddress查询。

参数bridge：默认为”false”，当只需要查询可以使用跨链桥兑换时，该值传“true”。例如ETH链的USDT，跨链到BSC上USDT。通过Bridge的兑换方式，不受滑点影响。

url: /api/config/asset //post

参数：

返回：资产信息列表

hashtag
查询兑换通道路由（支持本链兑换和跨链兑换）

详细描述：根据用户输入的链和兑换资产信息，路由各个通道可以兑换的路径，并返回路由信息。如果参数的fromChain和toChain一样，就是本链兑换

url: /api/swap/route //post

参数：

返回值：路由通道列表

hashtag
生成兑换交易（支持本链兑换和跨链兑换）

详细描述：根据用户输入的通道信息，链信息和兑换资产信息，生成未签名的发起链交易txHex。

url: /api/swap/tx/encode //post

参数：

返回值：未签名交易txHex

hashtag
提交兑换订单

详细描述：根据用户输入的链和兑换资产信息，检查合法性并创建订单。

url: /api/swap/tx/save //post

参数：

返回：订单详情

hashtag
更新订单交易Hash

详细描述：订单创建后，前端需要对路由接口返回的未签名的交易txHex进行签名并广播， 广播成功后，将交易hash更新到订单上

url: /api/swap/tx/hash/update //post

参数：

返回：订单详情

hashtag
查询Bridge通道路由（跨链Bridge）

详细描述：根据用户输入的链和发起链资产信息，路由通道可以Bridge的路径，并返回路由信息。

url: /api/bridge/route //post

参数：

返回值：路由通道列表

hashtag
生成Bridge交易（跨链Bridge）

详细描述：根据用户输入的通道信息，链信息和兑换资产信息，生成未签名的发起链交易txHex。

url: /api/bridge/tx/encode //post

参数：

返回值：未签名交易txHex

hashtag
提交Bridge订单

详细描述：根据用户输入的链和兑换资产信息，检查合法性并创建订单。

url: /api/bridge/tx/save //post

参数：

返回：订单详情

hashtag
更新订单交易Hash

详细描述：订单创建后，前端需要对路由接口返回的未签名的交易txHex进行签名并广播， 广播成功后，将交易hash更新到订单上

url: /api/bridge/tx/hash/update //post

参数：

返回：订单详情

hashtag
查询Swap和Bridge订单交易列表

详细描述：根据订单时间倒叙查询用户的所有兑换订单交易记录

url: /api/swap/txs/query //post

参数：

返回：订单交易列表

hashtag
查询Swap和Bridge订单交易详情

详细描述：根据订单号查询兑换交易详情

url: /api/swap/tx/query //post

参数：

返回：订单详情

PreviousSwapBox V1 SDKNextPayBox开放接口文档

Last updated