RPC

Docs about ChainX specific RPC APIs.

可以通过

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "rpc_methods",
  "params": []
}

获取所有可用的 RPC 方法，以 x 开头的为 ChainX 特有的 RPC 方法，其他 RPC 由 Substrate 框架原生提供。

Assets

`xassets_getAssets`

Parameters: []

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xassets_getAssets",
  "params": []
}

Response:

{
  "jsonrpc": "2.0",
  "result": {
    "1": {
      "balance": {
        "Locked": "0",
        "Reserved": "0",
        "ReservedDexSpot": "0",
        "ReservedWithdrawal": "0",
        "Usable": "23058037208"
      },
      "info": {
        "chain": "Bitcoin",
        "decimals": 8,
        "desc": "ChainX's Cross-chain Bitcoin",
        "token": "XBTC",
        "tokenName": "ChainX Bitcoin"
      },
      "isOnline": true,
      "restrictions": {
        "bits": 32
      }
    }
  },
  "id": 1
}

`xassets_getAssetsByAccount`

Parameters: [AccountId]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xassets_getAssetsByAccount",
  "params": ["5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4"]
}

Response:

{
  "jsonrpc": "2.0",
  "result": {
    "1": {
      "Locked": "0",
      "Reserved": "0",
      "ReservedDexSpot": "0",
      "ReservedWithdrawal": "0",
      "Usable": "210558966"
    }
  },
  "id": 1
}

Staking

`xstaking_getValidators`

获取所有验证人。

Parameters: []

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xstaking_getValidators",
  "params": []
}

Response:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "account": "5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4", // 节点账户地址
      "isChilled": false, // 是否退选，false 表示没有退选
      "isValidating": true, // 是否正在参与出块
      "lastChilled": 0, // 节点上一次退选高度。如果为 null, 表示节点从未退选过。
      "lastTotalVoteWeight": "15052283706149193236", // 节点票龄上一次更新时累计的总票龄
      "lastTotalVoteWeightUpdate": 189717, // 节点总票龄上一次更新高度
      "referralId": "HashQuark", // 用于跨链挖矿的推荐人渠道ID
      "registeredAt": 0, // 节点注册高度
      "rewardPotAccount": "5Q7qY67db3n9wwXoEwmsjq3VkrSkMiHD26LaTrAYgFNTnpjL", // 节点奖池账户
      "rewardPotBalance": "698200755775", // 节点奖池余额
      "selfBonded": "2752054904694", // 节点自抵押金额
      "totalNomination": "26005907097205" // 节点总得票数
    }
  ],
  "id": 1
}

`xstaking_getValidatorByAccount`

获取单个验证人信息。

Parameters: [AccountId]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xstaking_getValidatorByAccount",
  "params": ["5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4"]
}

Response:

{
  "jsonrpc": "2.0",
  "result": {
    "account": "5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4",
    "isChilled": false,
    "isValidating": true,
    "lastChilled": 0,
    "lastTotalVoteWeight": "15052283706149193236",
    "lastTotalVoteWeightUpdate": 189717,
    "referralId": "HashQuark",
    "registeredAt": 0,
    "rewardPotAccount": "5Q7qY67db3n9wwXoEwmsjq3VkrSkMiHD26LaTrAYgFNTnpjL",
    "rewardPotBalance": "698200755775",
    "selfBonded": "2752054904694",
    "totalNomination": "26005907097205"
  },
  "id": 1
}

`xstaking_getDividendByAccount`

获取用户的投票分红。

Parameters: [AccountId]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xstaking_getDividendByAccount",
  "params": ["5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4"]
}

Response:

{
  "jsonrpc": "2.0",
  "result": {
    "5Pjajd12o9hVixBPRPHZEdjsrct3NZp9Ge7QP4PiSivQrBZa": "158905", // key 为该用户投票的验证人地址，value 为对应的Staking分红奖励。
    "5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4": "257865635289",
    "5VJPK9vpjfw2HjvgGdX56zuTi6Pr7vGvYbyN5CWEZyYaby7w": "42847"
  },
  "id": 1
}

`xstaking_getNominationByAccount`

获取用户的投票信息, 包括投票金额，票龄等。

Parameters: [AccountId]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xstaking_getNominationByAccount",
  "params": ["5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4"]
}

Response:

{
  "jsonrpc": "2.0",
  "result": {
    "5Pjajd12o9hVixBPRPHZEdjsrct3NZp9Ge7QP4PiSivQrBZa": {
      "lastVoteWeight": "2368000000000",
      "lastVoteWeightUpdate": 0,
      "nomination": "0",
      "unbondedChunks": []
    },
    "5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4": {
      "lastVoteWeight": "5039840899021026894",
      "lastVoteWeightUpdate": 0,
      "nomination": "2752054904694",
      "unbondedChunks": []
    },
    "5VJPK9vpjfw2HjvgGdX56zuTi6Pr7vGvYbyN5CWEZyYaby7w": {
      "lastVoteWeight": "450000000000",
      "lastVoteWeightUpdate": 0,
      "nomination": "0",
      "unbondedChunks": []
    }
  },
  "id": 1
}

DEX

`xspot_getTradingPairs`

获取所有交易对信息。

Parameters: []

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xspot_getTradingPairs",
  "params": []
}

Response:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "baseCurrency": 0, // PCX/BTC -> PCX
      "highestBid": "0", // 当前最高价
      "id": 0, // 交易对ID
      "lastUpdated": 0, // 最新成交对价更新高度
      "latestPrice": "100000", // 最新成交价
      "lowestAsk": "0", // 当前最低价
      "maxValidBid": "0", // 最高有效买入价
      "minValidAsk": "100", // 最低有效卖出价
      "pipDecimals": 9, // 交易对精度
      "quoteCurrency": 1, // PCX/BTC -> BTC
      "tickDecimals": 2, // 单跳精度
      "tradable": true // 交易对可正常交易
    }
  ],
  "id": 1
}

`xspot_getOrdersByAccount`

获取用户订单列表。

Parameters: [AccountId, page_index, page_size]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xspot_getOrdersByAccount",
  "params": ["5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4", 0, 100]
}

Response:

`xspot_getDepth`

获取交易对盘口附近深度。

Parameters: [pair_id, depth_size]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xspot_getDepth",
  "params": [0, 10]
}

Response:

Mining Asset

`xminingasset_getMiningAssets`

获取所有参与挖矿的跨链资产。

Parameters: []

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xminingasset_getMiningAssets",
  "params": []
}

Response:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "assetId": 1, // 跨链资产ID
      "lastTotalMiningWeight": "23491518002714020", // 上一次更新的总挖矿权重
      "lastTotalMiningWeightUpdate": 188250, // 上一次总挖矿权重更新高度
      "miningPower": 400, // 资产挖矿算力
      "rewardPot": "5RVjEbHJak6YQDwujo78pRH9V8WVoM3CYn3Ub7BhnMLs9Yx8", // 奖池地址
      "rewardPotBalance": "470655234171" // 奖池金额
    }
  ],
  "id": 1
}

`xminingasset_getDividendByAccount`

获取跨链挖矿用户的挖矿利息。

Parameters: [AccountId]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xminingasset_getDividendByAccount",
  "params": ["5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4"]
}

Response:

{
  "jsonrpc": "2.0",
  "result": {
    // key 为用户的跨链资产ID
    "1": {
      "insufficientStake": "0", // 跨链挖矿用户需要在staking中抵押相应资产才能提息，如果 insufficientStake 不为0，表示用户还需要在staking中抵押更多才能提息
      "other": "1742250653", // 用户跨链挖矿总利息的10%归推荐人，如果没有推荐人则归为财库
      "own": "15680255878" // 用户最终能领取的跨链挖矿利息
    }
  },
  "id": 1
}

`xminingasset_getMinerLedgerByAccount`

获取跨链挖矿用户的挖矿记录。

Parameters: [AccountId]

Request:

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "xminingasset_getNominationByAccount",
  "params": ["5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4"]
}

Response:

{
  "jsonrpc": "2.0",
  "result": {
    // key 为跨链资产ID
    "1": {
      "lastClaim": null, // 上一次提息高度，null 表示还从未提过息
      "lastMiningWeight": "831778601884312", // 上一次挖矿总票龄
      "lastMiningWeightUpdate": 0 // 上一次挖矿总票龄更新高度
    }
  },
  "id": 1
}

Gateway

`xgatewaycommon_boundAddrs`

Get bound addrs of an accountid

Parameter: [AccountId, Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewaycommon_boundAddrs",
    "params":["5QPPvMtpstjYm1srogvjfbNzzo1NaUqF1wJzynZkvS9KrSMS"]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "Bitcoin":["3J1oPTKHZAK21mfgYQ8AEhuyCNRyn9ZLtJ"]
    },
    "id": 1
}

`xgatewaycommon_withdrawalLimit`

Get withdrawal limit(minimal_withdrawal&fee) for an AssetId

Parameter: [AssetId, Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewaycommon_withdrawalLimit",
    "params":[1] // the AssetId of X-BTC is 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "fee":"100000",
      "minimalWithdrawal":"150000"
    },
    "id": 1
}

`xgatewaycommon_verifyWithdrawal`

Use the params to verify whether the withdrawal apply is valid. Notice those params is same as the params for call XGatewayCommon::withdraw(...), including checking address is valid or something else. Front-end should use this rpc to check params first, then could create the extrinsic.

Parameter: [AssetId, u64, String, String, Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewaycommon_verifyWithdrawal",
    "params":[
      1, // the AssetId of XBTC is 1
      500000, // value
      "3J1oPTKHZAK21mfgYQ8AEhuyCNRyn9ZLtJ", // bitcoin address
      "",// memo
    ]
}

Response:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

`xgatewaycommon_trusteeMultisigs`

Return the trustee multisig address for all chain.

Parameter: [Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewaycommon_trusteeMultisigs",
    "params":[]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "Bitcoin":"5QbRFQrfFEikrdckCwJq9LAQoh5kNPCHN9uu55WZcEPeRvE4"
    },
    "id": 1
}

`xgatewaycommon_bitcoinTrusteeProperties`

Return bitcoin trustee for current session(e.g. trustee hot/cold address and else).

Parameter: [AccountId, Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewaycommon_bitcoinTrusteeProperties",
    "params":["5Pjajd12o9hVixBPRPHZEdjsrct3NZp9Ge7QP4PiSivQrBZa"]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "about":"buildlinks",
      "coldEntity":"0x02c179b0e69b342bf295200fa072bd2a4e956a2b74d7319c256946bc349c67d209",
      "hotEntity":"0x034d3e7f87e69c6c71df6052b44f9ed99a3d811613140ebf09f8fdaf904a2e1de8"
    },
    "id": 1
}

`xgatewaycommon_bitcoinTrusteeSessionInfo`

Return bitcoin trustee for current session

Parameter: [Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewaycommon_bitcoinTrusteeSessionInfo",
    "params":[]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "coldAddress":{
        "addr":"37DzisAW8DpyY2oqAfT3NfEwpG3SFVUUoR","redeemScript":"0x542103615bee4a2f2e80605be8730dc9630b002ad83b068a902df03b155797357030f721037f8d0b44a282a89352b238b2d09f996df290aa65e0a95e6c99a445072ce390ce210281687791324c3d99d9bd39370baf4c138b1e1670a9939a406e3ac22577e39c00210386b58f51da9b37e59c40262153173bdb59d7e4e45b73994b99eec4d964ee7e88210299b5c30667f2e80ddccbac8d112e52387fa1056ef2510c0b7a627215eb0a45502102c179b0e69b342bf295200fa072bd2a4e956a2b74d7319c256946bc349c67d20956ae"
      },
      "hotAddress":{
        "addr":"3LrrqZ2LtZxAcroVaYKgM6yDeRszV2sY1r","redeemScript":"0x542102e2b2720a9e54617ba87fca287c3d7f9124154d30fa8dc9cd260b6b254e1d7aea210219fc860933a1362bc5e0a0bbe1b33a47aedf904765f4a85cd166ba1d767927ee2102b921cb319a14c6887b12cee457453f720e88808a735a578d6c57aba0c74e5af32102df92e88c4380778c9c48268460a124a8f4e7da883f80477deaa644ced486efc6210346aa7ade0b567b34182cacf9444deb44ee829e14705dc87175107dd09d5dbf4021034d3e7f87e69c6c71df6052b44f9ed99a3d811613140ebf09f8fdaf904a2e1de856ae"
      },
      "threshold":4,
      "trusteeList":[
        "5SY3yajabLKYcuxPjXwLMc7p6WDC4Tv1H3sVMx6Hmjtxycji",
        "5V7ygyZ53psrNSFgT3n7Xnxd6r7eC6bga3eA4W8KYEs75ZeC",
        "5ReDj2o2xRQowpcrRdrCq3hR4cj1dJgj239dGMHnB9QzAnPa",
        "5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4",
        "5QpTfTDYSLWkuVEvRqEcugQtFZnhE3qyJLCzwGQgdzNRpiSQ",
        "5Pjajd12o9hVixBPRPHZEdjsrct3NZp9Ge7QP4PiSivQrBZa"
      ]
    },
    "id": 1
}

`xgatewaycommon_bitcoinGenerateTrusteeSessionInfo`

Try to generate bitcoin trustee info for a list of candidates. (this api is used to check the trustee info which would be generated by those candidates)

Parameter: [Vec<AccountId>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewaycommon_bitcoinGenerateTrusteeSessionInfo",
    "params":[
        "5SY3yajabLKYcuxPjXwLMc7p6WDC4Tv1H3sVMx6Hmjtxycji",
        "5V7ygyZ53psrNSFgT3n7Xnxd6r7eC6bga3eA4W8KYEs75ZeC",
        "5ReDj2o2xRQowpcrRdrCq3hR4cj1dJgj239dGMHnB9QzAnPa",
        "5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4",
        "5QpTfTDYSLWkuVEvRqEcugQtFZnhE3qyJLCzwGQgdzNRpiSQ",
        "5Pjajd12o9hVixBPRPHZEdjsrct3NZp9Ge7QP4PiSivQrBZa"
    ]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "coldAddress":{
        "addr":"37DzisAW8DpyY2oqAfT3NfEwpG3SFVUUoR","redeemScript":"0x542103615bee4a2f2e80605be8730dc9630b002ad83b068a902df03b155797357030f721037f8d0b44a282a89352b238b2d09f996df290aa65e0a95e6c99a445072ce390ce210281687791324c3d99d9bd39370baf4c138b1e1670a9939a406e3ac22577e39c00210386b58f51da9b37e59c40262153173bdb59d7e4e45b73994b99eec4d964ee7e88210299b5c30667f2e80ddccbac8d112e52387fa1056ef2510c0b7a627215eb0a45502102c179b0e69b342bf295200fa072bd2a4e956a2b74d7319c256946bc349c67d20956ae"
      },
      "hotAddress":{
        "addr":"3LrrqZ2LtZxAcroVaYKgM6yDeRszV2sY1r","redeemScript":"0x542102e2b2720a9e54617ba87fca287c3d7f9124154d30fa8dc9cd260b6b254e1d7aea210219fc860933a1362bc5e0a0bbe1b33a47aedf904765f4a85cd166ba1d767927ee2102b921cb319a14c6887b12cee457453f720e88808a735a578d6c57aba0c74e5af32102df92e88c4380778c9c48268460a124a8f4e7da883f80477deaa644ced486efc6210346aa7ade0b567b34182cacf9444deb44ee829e14705dc87175107dd09d5dbf4021034d3e7f87e69c6c71df6052b44f9ed99a3d811613140ebf09f8fdaf904a2e1de856ae"
      },
      "threshold":4,
      "trusteeList":[
        "5SY3yajabLKYcuxPjXwLMc7p6WDC4Tv1H3sVMx6Hmjtxycji",
        "5V7ygyZ53psrNSFgT3n7Xnxd6r7eC6bga3eA4W8KYEs75ZeC",
        "5ReDj2o2xRQowpcrRdrCq3hR4cj1dJgj239dGMHnB9QzAnPa",
        "5RjfjwXjzJtVd6EiTCG3RsJmUM9h4FgocswJyAaLvuBicwE4",
        "5QpTfTDYSLWkuVEvRqEcugQtFZnhE3qyJLCzwGQgdzNRpiSQ",
        "5Pjajd12o9hVixBPRPHZEdjsrct3NZp9Ge7QP4PiSivQrBZa"
      ]
    },
    "id": 1
}

`xgatewayrecords_withdrawalList`

Return current withdraw list(include Applying and Processing withdraw state)

Parameter: [Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewayrecords_withdrawalList",
    "params":[]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "0":{
        "addr":"39WkLFHVp5fzFqzQanNPKryWi4QypRgqmB",
        "applicant":"5SZWXKrihcv69iVXFpktGhTBB4oTx29W47TUhvHB2ZtY5i9t",
        "assetId":1,
        "balance":"1000000",
        "ext":"test new trustee tools, this withdrawal is created by buildlinks.",
        "height":304808,
        "state":"Processing"
      },
      "1":{
        "addr":"1Ar7GpT3bYbqw1w6esU5embS24X2Jb7dGM",
        "applicant":"5TEsk4nRDF1fT1Kv7Pn5dz2JTAXe4D6zWstd6aXfch4pWnee",
        "assetId":1,
        "balance":"11038400",
        "ext":"",
        "height":305328,
        "state":"Applying"
      },
      ...
    },
    "id": 1
}

`xgatewayrecords_withdrawalListByChain`

Return current withdraw list for a chain(include Applying and Processing withdraw state)

Parameter: [Chain, Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewayrecords_withdrawalListByChain",
    "params":["Bitcoin"]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "0":{
        "addr":"39WkLFHVp5fzFqzQanNPKryWi4QypRgqmB",
        "applicant":"5SZWXKrihcv69iVXFpktGhTBB4oTx29W47TUhvHB2ZtY5i9t",
        "assetId":1,
        "balance":"1000000",
        "ext":"test new trustee tools, this withdrawal is created by buildlinks.",
        "height":304808,
        "state":"Processing"
      },
      "1":{
        "addr":"1Ar7GpT3bYbqw1w6esU5embS24X2Jb7dGM",
        "applicant":"5TEsk4nRDF1fT1Kv7Pn5dz2JTAXe4D6zWstd6aXfch4pWnee",
        "assetId":1,
        "balance":"11038400",
        "ext":"",
        "height":305328,
        "state":"Applying"
      },
      ...
    },
    "id": 1
}

`xgatewayrecords_pendingWithdrawalListByChain`

Return current pending withdraw list for a chain

Parameter: [Chain, Option<BlockHash>]

Request:

{
    "id":1,
    "jsonrpc":"2.0",
    "method":"xgatewayrecords_pendingWithdrawalListByChain",
    "params":["Bitcoin"]
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
      "0":{
        "addr":"39WkLFHVp5fzFqzQanNPKryWi4QypRgqmB",
        "applicant":"5SZWXKrihcv69iVXFpktGhTBB4oTx29W47TUhvHB2ZtY5i9t",
        "assetId":1,
        "balance":"1000000",
        "ext":"test new trustee tools, this withdrawal is created by buildlinks.",
        "height":304808,
        "state":"Processing"
      },
      "1":{
        "addr":"1Ar7GpT3bYbqw1w6esU5embS24X2Jb7dGM",
        "applicant":"5TEsk4nRDF1fT1Kv7Pn5dz2JTAXe4D6zWstd6aXfch4pWnee",
        "assetId":1,
        "balance":"11038400",
        "ext":"",
        "height":305328,
        "state":"Applying"
      },
      ...
    },
    "id": 1
}

最后修改 21.04.2022: update (4a1b36b)