rpc-doc: A repository from Wisdom

一、基本说明

1.0 区块确认完成

通过事务的哈希值查询确认区块数，并且确认是否已经完成，我们认为往后确定2区块即可表示已经完成。无论什么事务，都要等待至少2个区块确认才算完成

1.1 返回格式

{"message":"","data":[],"statusCode":int}
* message：描述
* data   ：数据
* statusCode：      
   
{
    2000 正确
    2100 已确认
    2200 未确认
    5000 错误
    6000 格式错误
    7000 校验错误
    8000 异常
}

1.2 事务类型

编号	交易类型	说明型
0	0x00	coinbase事务
1	0x01	WDC转账
2	0x02	投票
3	0x03	存证事务
7	0x07	规则部署
8	0x08	规则调用
9	0x09	申请孵化
10	0x0a	获取利息收益
11	0x0b	获取分享收益
12	0x0c	提取本金
13	0x0d	撤回投票
14	0x0e	抵押
15	0x0f	撤回抵押

二、节点RPC

1）基本RPC

1.0 获取Nonce

Function:sendNonce
POST/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/sendNonce
Parameter：pubkeyhash(String)
Demo:
    POST http://00.000.00.000:19585/sendNonce
    POST data:
        pubkeyhash=0000000000000000000000000000000000000000
Response Body:
    {"message":"","data":[],"statusCode":int}
	data:Nonce(Long)

1.1 获取余额

Function:sendBalance
POST/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/sendBalance
Parameter：pubkeyhash(十六进制字符串)
Demo:
    POST http://00.000.00.000:19585/sendBalance
    POST data:
        pubkeyhash=0000000000000000000000000000000000000000
Response Body:
    {"message":"","data":[],"statusCode":int}
	data:balance(Long)

1.2 广播事务

Function:sendTransaction
POST/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/sendTransaction
Parameter：traninfo(十六进制字符串)
Demo:
    POST http://00.000.00.000:19585/sendTransaction
    POST data:
    traninfo=000000000000000000000000000000000000000000000000000000000000000000
Response Body:
    {"message":"","data":[],"statusCode":int}

1.3 查询当前区块高度

Function:height
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/height
Parameter:
Demo:
    GET http://00.000.00.000:19585/height
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:height(Long)

1.4 根据事务哈希获得所在区块哈希以及高度

Function:blockHash
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/blockHash
Parameter：traninfo(十六进制字符串)
Demo:
    GET http://00.000.00.000:19585/blockHash?txHash=0000000000000000000000000000000000000000000000000000
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
        {
        "blockHash":区块哈希(十六进制字符串), 
        "height":区块高度(Long)
        }

1.5 根据事务哈希获得区块确认状态

Function:transactionConfirmed
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/transactionConfirmed
Parameter：txHash(十六进制字符串)
Demo:
    GET http://00.000.00.000:19585/transactionConfirmed?txHash=0000000000000000000000000000000000000000
Response Body:
    {"message":"","data":[],"statusCode":int}
    data: status(int)

1.6 根据区块高度获取事务列表（V0.0.9有修改）

Function:getTransactionHeight
POST/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/getTransactionHeight
Parameter：height(int)
Demo:
    POST http://00.000.00.000:19585/getTransactionHeight
    POST data:
        height=100
Response Body:
   [ {
  "transactionHash" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "version" : 1,
  "type" : 1,
  "nonce" : 8,
  "from" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "gasPrice" : 4,
  "amount" : 100000000,
  "payload" : "",
  "to" : "xxxxxxxxxxxxxxxxxxxxx",
  "signature" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "blockHash" : "xxxxxxxxxxxxxxxxxxxxx",
  "fee" : 200000,
  "blockHeight" : xxxxxxx
} ]
*此接口默认查询的是转账事务，如有异常直接报400

1.7 通过事务哈希获取事务

Function:transaction
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/transaction
Parameter：路径变量,直接传入事务哈希
Demo:
        GET http://00.000.00.000:19585/transaction/0000000000000000000000000000000000000000000000000000000000000
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
      "transactionHash": "e75d61e1b872f67cccc37c4a5b354d21dd90a20f04a41a8536b9b6a1b30ccf41", // 事务哈希
      "version": 1, // 事务版本 默认为 0
      "type": 0,  // 事务类型 0 是 coinbase 1 是 转账
      "nonce": 5916, // nonce 值，用于防止重放攻击
      "from": "0000000000000000000000000000000000000000000000000000000000000000", // 发送者的公钥， 用于验证签名
      "gasPrice": 0, // gasPrice 用于计算手续费
      "amount": 2000000000, // 交易数量，单位是 brain
      "payload": null, // payload(存证事务：UTF-8编码、其余事务：十六进制字符串) 用于数据存证，一般填null
      "to": "08f74cb61f41f692011a5e66e3c038969eb0ec75", // 接收者的地址
      "signature": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", // 签名
      "blockHash": "e2ccac56f58adb3f2f77edd96645931fac93dd058e7da21421d95f2ac9cc44ac", // 事务所在区块的哈希
      "fee": 0,  // 手续费
      "blockHeight": 13026 // 事务所在区块高度

1.8 通过区块哈希获取事务列表（V0.0.9有修改）

Function:getTransactionBlcok
POST/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/getTransactionBlcok
Parameter：blockhash(十六进制字符串)
Demo:
    POST http://00.000.0.000:19585/getTransactionBlcok
    POST data:
        blockhash=00000000000000000000000000000000000000000000000000000000000000000
Response Body:
    [ {
	  "transactionHash" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	  "version" : 1,
	  "type" : 1,
	  "nonce" : 8,
	  "from" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	  "gasPrice" : 4,
	  "amount" : 100000000,
	  "payload" : "",
	  "to" : "xxxxxxxxxxxxxxxxxx",
	  "signature" :"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	  "blockHash" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	  "fee" : 200000,
	  "blockHeight" : xxxxxx
	} ]
*此接口默认查询的是转账事务，如有异常直接报400

1.9 通过地址查询与地址相关的转入转出事务(V0.0.9有修改已禁用)

Function:getTxrecordFromAddress
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/getTxrecordFromAddress
Parameter：address
Demo:
    GET http://192.168.0.103:19585/getTxrecordFromAddress?address=1xxxxxxxxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
        "tx_hash":"000000000000000000000000000000000000000000000000000000000000",//事务哈希
        "amount":100000,//金额
        "height":100,//区块高度
        "from":"1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//发起者地址
        "to":"1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//接收者者地址
        "block_hash":"f672350016ca08243c27b28824ec0b4eb2cc21014db9e7461a4bc7fe4f823e95",//区块哈希
        "datetime":"2019-07-24 00:29:15",//区块时间
        "type":"-"//"-" 是 转出 ，"+" 是 转入

2.0 通过地址查询事务内存池

Function:getPoolAddress
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/getPoolAddress
Parameter：address
Demo:
    GET http://00.000.0.000:19585/getPoolAddress?address=1xxxxxxxxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
       "pool":"PendingTransPool",//内存池名称
       "tranhaxh":"000000000000000000000000000000000000000000000000000000000000000",//事务哈希
       "type":1,//事务类型(详见基本说明1.2)
       "nonce":40,//当前事务nonce
       "from":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,,0,0,0,0,0,0,0],//发送者公钥字节数组
       "fromhash":"0000000000000000000000000000000000000",//发送者公钥哈希
       "amount":100000000,//金额
       "to":"0000000000000000000000000000000",//接收者公钥哈希
       "state":0,//状态 0 是 待确认，1 是 已引用，2 是 已确认
       "datatime":"2019-07-24 09:32:43",//区块时间
       "height":0//区块高度

2.1 获取节点版本信息

Function:version
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/version
Parameter:
Demo:
    GET http://00.000.0.000:19585/version
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         "character" 1. default：默认 2. exchange：交易所
         "version" 版本

2.2 获取用户信息

Function:account
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/account/{account}
Parameter:公钥哈希/地址
Demo:
    GET http://00.000.0.000:19585/account/1CRXnUJx9Tq4ZpNkkueeKFxCbYg1E4uTCt
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         {
          "publicKeyHash": "7d4d105a3fc6db71d35ed654b1b7aab73d8fa50d",//公钥哈希
          "address": "1CRXnUJx9Tq4ZpNkkueeKFxCbYg1E4uTCt",//地址
          "nonce": 1,//序号
          "balance": "1.0E9 WDC",//余额
          "incubateCost": "0.0 WDC",//孵化本金
          "mortgage": "0.0 WDC",//抵押数
          "votes": "0.0 WDC"//投票数（未衰减）
        }

2.3 通过区块哈希、高度获取区块详情

Function:block
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/block/{block}
Parameter:区块高度/区块哈希
Demo:
    GET http://00.000.0.000:19585/block/da4254a981cd6836c238d8037011e7b46bd33d4d5f8ffc57cc1f7eb34c753800
Response Body:
    {
    "blockSize": 131454,//区块大小
    "blockHash": "da4254a981cd6836c238d8037011e7b46bd33d4d5f8ffc57cc1f7eb34c753800",//区块哈希
    "nVersion": 0,//版本
    "hashPrevBlock"://父区块 "fdb6e09ba62d95a659ea8e0dc482a45b73492fe2e8536118ed9d99f4969bfdcc",
    "hashMerkleRoot"://梅克尔根 "16c48ac542a0ff5371eb8dc45ed1c7bb73a822cb002eb1b31aabbdfeeb37a903",
    "hashMerkleState"://梅克尔状态 "ea00c4de2445d0b05ad016dc08b2d9cd98e2babf54a38677112255b07c013bdc",
    "hashMerkleIncubate"://孵化梅克尔状态 "0000000000000000000000000000000000000000000000000000000000000000",
    "nHeight": 1808666,//高度
    "nTime": 1587622316,//时间
    "nBits": "000031c5e93c30fc2f3bb425a53bb3a2a32f4655dbaf03a216d85e40e6ccfeae",//目标难度
    "nNonce": "191ede9b61a79133b34513a03f18cf5f0de0e04fa1c90ab8cb79b951521317bd",//序号
    "blockNotice": null,//备注
    "body": [//区块里的事务
    {
      "transactionHash"://事务哈希 "588359a4ec2e075b8ebac68a898ea4f0dd6090790b4e5ef199bd31ba53a8252a",
      "version": 1,//版本
      "type": 0,//类型
      "nonce": 38000,//序号
      "from": "0000000000000000000000000000000000000000000000000000000000000000",//事务构建者
      "gasPrice": 0,//手续费单价
      "amount": 666666666,//金额
      "payload": "",
      "to": "c8d332229b604872e8ebc85d419b8761855305d5",//接收者公钥哈希
      "signature": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",//签名
      "blockHash": "da4254a981cd6836c238d8037011e7b46bd33d4d5f8ffc57cc1f7eb34c753800",//区块哈希
      "fee": 0,
      "blockHeight": 1808666//区块高度
    }
  ]
}

2.4 查询事务列表

Function:internal/getTxrecordFromAddress
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/block/{block}
Parameter:
      from(String)，//发送者的公钥（必填）
      to(String)， //接收者的公钥哈希（必填，但from和to至少有一个或全部）
      offset(int), //跳过多少个数据开始显示（非必填）
      limit(int), //单页显示的数目（非必填）
      type(int) //事务类型（非必填，看个人需求）
Demo:
    GET http://00.000.0.000:19585//internal/getTxrecordFromAddress?from=0000000000000000000000000000000000000000000000000000000000000000&to=000000000000000000000000&type=1
Response Body://对应的事务
    [ {
  "transactionHash" : "3fb0bd9930a40be9057286c04e36d01bc73c32aa30bbbb36cf6e31bb53f7250a",//事务哈希
  "version" : 1,//版本
  "type" : 2,//事务类型
  "nonce" : 18,//序号
  "from" : "960199e757bc6cd5817c85d9b195f45d329035f77345525c328e4e3fa26a080c",//发起者
  "gasPrice" : 10,//手续费单价
  "amount" : 20000000000,//金额
  "payload" : "",
  "to" : "35496d2e44382a04f3a88ce1d6e4d3e72fd4ef82",//接收方
  "signature" : "41d96ff1321b50a924b208a6a873ca208a0e74e1c3749d98aeeaa41ac4db55593e120ef1b64d7b31f5fe4ec57dcc8d4b8e76924f24af9c002b6e98a7f4dc0d0a",//签名
  "blockHash" : "7457534db6623b3089407067388f8ce4d9fd2908305029f3b7b0e1964c5a9afc",//区块哈希
  "fee" : 200000,//手续费
  "blockHeight" : 1345022//区块高度
}, {
  "transactionHash" : "f702818d745b2f536fe979c9fdc6755743b05c3c23b60017667bda8938f50263",
  "version" : 1,
  "type" : 2,
  "nonce" : 198,
  "from" : "6c4b9809fcf3c324dc412c8cfae1408138d6474068aea8b4dcbd80800e3f8ae9",
  "gasPrice" : 10,
  "amount" : 27300000000000,
  "payload" : "",
  "to" : "35496d2e44382a04f3a88ce1d6e4d3e72fd4ef82",
  "signature" : "9c1d52840419f7b41577759e98b9837347a5459d9af1b3f36d3675ba2de06bccbdb23fed5d4f1e0e0465290f9603a8beaca3baa5158bd07803cd7735f5fb6c0f",
  "blockHash" : "fede050c17540ca950cd6dddbc9c2a0dc54f9004336664aeff626a5153d736ef",
  "fee" : 200000,
  "blockHeight" : 1360180
} ]
}

2.5 查看事务是否上链

Function:transactionConfirmed
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/transactionConfirmed
Parameter:
Demo:
    GET http://00.000.0.000:19585/transactionConfirmed?txHash=00000000000000000000000000000
Response Body:
    {"message":"","data":[],"statusCode":int}

2）智能合约相关RPC

1.0 查询合约的详细信息

Function:ParseContractTx
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/ParseContractTx
Parameter:txhash（事务哈希）
Demo:
    GET http://00.000.0.000:19585/ParseContractTx/?txhash=xxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         {
            "code": "XXXX",//资产代码
            "offering": 100000000,//期初发行额度
            "totalamount": 100000000,//发行总量
            "createuser": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//规则创建者的公钥
            "owner": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//规则所有者的公钥
            "allowincrease": 1,//是否允许增发 1表示允许，0表示不允许
            "info": "",//详情
            "createuserAddress": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//规则创建者的地址
            "ownerAddress": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"//规则所有者的地址
        }

1.1 查询合约的RLP编码

Function:RLPContractTx
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/RLPContractTx
Parameter:txhash（事务哈希）
Demo:
    GET http://00.000.0.000:19585/RLPContractTx/?txhash=xxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         {
          ********************************************（RLP编码）
        }

1.2 查询相应账户的指定资产余额

Function:TokenBalance
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/TokenBalance
Parameter:address（地址）、code（资产编码）
Demo:
    GET http://00.000.0.000:19585/TokenBalance/?address=xxxxxxxxxxxx&code=xxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         {
          balance
        }

1.3 通过合约地址查询资产定义的详细信息

Function:ParseAssetAddress
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/ParseAssetAddress
Parameter:address（合约地址）
Demo:
    GET http://00.000.0.000:19585/ParseAssetAddress/?address=xxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         {
            "code": "XXXX",//资产代码
	    "offering": 100000000,//期初发行额度
	    "totalamount": 100000000,//发行总量
	    "createuser": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//规则创建者的公钥
	    "owner": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//规则所有者的公钥
	    "allowincrease": 1,//是否允许增发 1表示允许，0表示不允许
	    "info": "",//详情
	    "createuserAddress": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//规则创建者的地址
	    "ownerAddress": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"//规则所有者的地址
        }

1.4 查询地址类型

Function:AddressType
GET/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/AddressType
Parameter:address（合约地址）
Demo:
    GET http://00.000.0.000:19585/AddressType/?address=xxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         {
            1//资产定义
            2//多签
            3//锁定时间哈希
            4//锁定高度哈希
        }

1.5 查询多种资产约（针对普通地址、多签地址）

Function:TokenListBalance
POST/HTTP/1.1/Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Request URL: http://00.000.0.000:19585/TokenListBalance
Parameter:address（String地址）,codes（用“，”拼接的code）
Demo:
    POST http://00.000.0.000:19585/TokenListBalance/?address=xxxxxxxxxxxx&codes=xxxxxxxxxxxxxxxxxxxxx
Response Body:
    {"message":"","data":[],"statusCode":int}
    data:
         {
          "code":balance
        }

WisedomChainGroup/rpc-doc

一、 基本说明

二、节点RPC

1） 基本RPC

1.0 获取Nonce

1.1 获取余额

1.2 广播事务

1.3 查询当前区块高度

1.4 根据事务哈希获得所在区块哈希以及高度

1.5 根据事务哈希获得区块确认状态

1.6 根据区块高度获取事务列表（V0.0.9有修改）

1.7 通过事务哈希获取事务

1.8 通过区块哈希获取事务列表（V0.0.9有修改）

1.9 通过地址查询与地址相关的转入转出事务(V0.0.9有修改已禁用)

2.0 通过地址查询事务内存池

2.1 获取节点版本信息

2.2 获取用户信息

2.3 通过区块哈希、高度获取区块详情

2.4 查询事务列表

2.5 查看事务是否上链

2）智能合约相关RPC

1.0 查询合约的详细信息

1.1 查询合约的RLP编码

1.2 查询相应账户的指定资产余额

1.3 通过合约地址查询资产定义的详细信息

1.4 查询地址类型

1.5 查询多种资产约（针对普通地址、多签地址）

一、基本说明

1）基本RPC