Skip to content

Latest commit

 

History

History
679 lines (505 loc) · 21.6 KB

exchangeDocking-zh-1.0.md

File metadata and controls

679 lines (505 loc) · 21.6 KB

交易所对接指南

本文的目的主要是协助交易所上线CXC交易。

github:https://github.com/cxcblock

基本概念

CXC的账户体系采用了UTXO模型，所以上线CXC是和BTC是比较类似的。

Linux 节点部署

安装

 下载 https://github.com/cxcblock/cxcs/archive/master.zip
 解压 master.zip并进入
 为文件加执行权限 sudo chmod +x install.sh
 执行：./install.sh

启动

启动正式链节点

./cxcsz CXCChain

CLI交互方式管理节点

管理正式链节点

./cxcsi CXCChain

停止节点

停止正式链节点

./cxcsi CXCChain stop

启动时连接指定节点

./cxcsz CXCChain@ip:port

mac 节点部署

安装

 下载 https://github.com/cxcblock/cxcs/archive/master.zip
 解压 master.zip并进入
 为文件加执行权限 sudo chmod +x install.sh
 ./install.sh

启动

启动正式链节点

./cxcsz CXCChain

CLI交互方式管理节点

管理正式链节点

./cxcsi CXCChain

停止节点

停止正式链节点

./cxcsi CXCChain stop

启动时连接指定节点

./cxcsz CXCChain@ip:port

window 节点部署

安装

 下载 https://github.com/cxcblock/cxcs/archive/master.zip
 解压 master.zip并进入
 右键点击install.bat选择已管理员身份运行

启动

启动正式链节点

cxcsz.exe CXCChain

CLI交互方式管理节点

管理正式链节点

cxcsi.exe CXCChain

停止节点

停止正式链节点

cxcsi.exe CXCChain stop

启动时连接指定节点

cxcsz.exe CXCChain@ip:port

启动后将开始同步区块，同时启动RPC服务（如何使用命令可查看开发者指南文档）。

##节点启动重要参数 参数在cxcsz CXCChain 后增加 以-开头，后面跟参数名=参数值

存储目录

-datadir=/data/.cxcs

区块链端口

-port=7519

rpc命令端口

-rpcport=7518

允许调用rpc的ip

-rpcallowip=127.0.0.1

每次生成新区块触发指定shell命令，其中%s是新区块的HASH

-blocknotify='curl http://192.168.1.10:8080/cxc?blockHash=%s'

例如:

./cxcsz CXCChain -datadir=/data/.cxcs -port=7319 -rpcport=7318 -blocknotify=‘curl http://192.168.1.10:8080/cxc?blockHash=%s'

链启动后可以将启动参数写到conf配置文件中，配置文件位于/data/.cxcs/CXCChain/cxcs.conf

例如：

rpcuser=cxcsrpc
rpcpassword=5ZH88wEUMDnTQm4bBitWcSKAyXjdMNC3aYAVP6BjhwGA
port=7319
rpcport=7318
rpcallowip=127.0.0.1
blocknotify='curl http://192.168.1.10:8080/cxc?blockHash=%s'
#添加多个allowip
rpcallowip=192.168.0.100
rpcallowip=192.168.0.101
rpcallowip=192.168.0.102

设置后需重启节点。

通过以下命令可查看节点基本信息

showinfo

返回结果为

{
    "paytxfee" : "0.0001",
    "rpcport" : 7318,
    "relayfee" : "0.0001",
    "maxout" : 10000000000000000
}

其中paytxfee为当前节点的基础手续费设置，rpcport为可调用的rpc端口

如何通过rpc调用命令

  1. 确认已经将调用方IP配入allowip中

  2. 查看区块链目录下cxcs.conf中账号密码.

    如果未指定区块链目录Linux、Mac默认目录为~/.cxcs/CXCChain

    ​ Windows默认目录为C:\users\{username}\AppData\Romaming\CXCChain

  3. 向节点RPC发起HTTP请求

如下：调用setupkeypairs命令创建两个新地址

 $ curl --user cxcsrpc:Ch6iaD7aPqegYDenzkDz3ttFCaBUTzBeqsmgye5Mn98o --data-binary '{"jsonrpc": "2.0", "id":"rpccall", "method": "setupkeypairs", "configs": [2] }' -H 'content-type: text/plain;' http://127.0.0.1:7318
 
 {"result":[{"address":"address1","pubkey":"pubkey1","privkey":"pribkey1"},{"address":"address2","pubkey":"pubkey2","privkey":"privkey2"}],"error":null,"id":"rpccall"}

生成充值地址

充值地址有如下两种生成方式：

  • 方式一：动态创建CXCChain地址

    调用如下命令：

    ./cxcsi CXCChain addnewaddr

    后面将隐藏./cxcsi CXCChain.

    创建好的地址会直接导入到钱包文件中。

  • 方式二：提前批量创建钱包地址

    调用如下命令：

    setupkeypairs (count)

    其中参数count为公钥/私钥对的数量，默认为1，注意这种方式创建的地址需要通过importaddr或者importprivkey的命令将地址导入钱包，才能直接调用转账的命令或者查询未花费输出。

    例如：

    • setupkeypairs 100
    • importaddr '["ADDR1","ADDR2","ADDR3"]' false

    检测地址的有效性

    通过调用如下命令检测账户地址的有效性：

    

    • 



validaddr (address)



返回结果如下：

```json
{
  "isvalid" : true|false,           If the address is valid or not.
"address" : "address",            The address validated
  "ismine" : true|false,            If the address is yours or not
  "isscript" : true|false,          If the key is a script
  "pubkey" : "publickeyhex",        The hex value of the raw public key
  "iscompressed" : true|false,      If the address is compressed
}



若isvalid字段为false，则为无效地址。


监控用户充值


监控用户充值首先要查看区块同步情况，解析区块信息，从而确认用户是否进行充值。


查看区块同步情况


调用命令如下：


  showchain


返回结果如下：


  {
    "blocks" : 13169,
      "headers" : 14009,
      "bestblockhash" : "00c44114d67728e2ea1ba1c323aa6e4d8ef18d8ee178a6d712634c775fc56614"
  }


其中headers是区块头的数量，blocks是已同步的区块数量。


解析区块信息


调用命令如下：


showblock hash|height 4


我们采用了UTXO模型，交易所需要解析每个TX中的VOUT部分，其中value为本地资产即CXC,asset为创建的资产。有两种方式比对充值信息：


    

  1. 交易所记录下所有和自己相关的交易，作为用户充值提现的记录。如果发现在VOUT中有属于交易所的地址，则修改数据库中该充值地址的用户余额（当然也可能包含发行资产）.
    2. 

  2. 如果在VOUT中有属于交易所的地址，先在数据库中记录下充值记录，等待几个区块确认后再修改用户余额。
    3. 



showblock 10006 4


返回结果：


{
  "hash" : "00bd9796841946cfd8b38d35ec4affc41349886427b255d332b5b51987c25084",
  "miner" : "1G5Ep4YBAnDecF6MmfZt86dppWWV1ijrtH",
  "confirmations" : 16525,
  "size" : 825,
  "height" : 10006,
  "version" : 3,
  "merkleroot" : "a0d1979c1b35f1497fc05a9b9ea254fe72886fc86de63aab963944d93dfb44d7",
  "tx" : [
      {
          "txid" : "296f87e2417cc9da7695e4790b659c302ccfea2a8f4e5fc081ee82c8524f2d72",
          "version" : 1,
          "locktime" : 0,
          "vin" : [
              {
                  "coinbase" : "0216270101062f503253482f",
                  "sequence" : 4294967295
              }
          ],
          "vout" : [
              {
                  "value" : "125.0051",
                  "n" : 0,
                  "scriptPubKey" : {
                      "asm" : "OP_DUP OP_HASH160 a557146c42de964657d073a291b0474bed00ceca OP_EQUALVERIFY OP_CHECKSIG",
                      "hex" : "76a914a557146c42de964657d073a291b0474bed00ceca88ac",
                      "reqSigs" : 1,
                      "type" : "pubkeyhash",
                      "addresses" : [
                          "1G5Ep4YBAnDecF6MmfZt86dppWWV1ijrtH"
                      ]
                  }
              },
              {
                  "value" : "0.00",
                  "n" : 1,
                  "scriptPubKey" : {
                      "asm" : "OP_RETURN 53504b62473045022100ccfa18e4b1b635292144ed854884bb86d6ab167d748c94a8d7874cb0da2a57ed022005c7be4fd42bd4fa974b88ecbe5340aa7d2ea5c13b30812ff15b1a49aefd0aa4022102441ef754530a417d3f7731037081679c5368e370193394bf759922f06b90f7ed",
                      "hex" : "6a4c6f53504b62473045022100ccfa18e4b1b635292144ed854884bb86d6ab167d748c94a8d7874cb0da2a57ed022005c7be4fd42bd4fa974b88ecbe5340aa7d2ea5c13b30812ff15b1a49aefd0aa4022102441ef754530a417d3f7731037081679c5368e370193394bf759922f06b90f7ed",
                      "type" : "nulldata"
                  },
                  "data" : [
                      "53504b62473045022100ccfa18e4b1b635292144ed854884bb86d6ab167d748c94a8d7874cb0da2a57ed022005c7be4fd42bd4fa974b88ecbe5340aa7d2ea5c13b30812ff15b1a49aefd0aa4022102441ef754530a417d3f7731037081679c5368e370193394bf759922f06b90f7ed"
                  ]
              }
          ],
          "hex" : "01000000010000000000000000000000000000000000000000000000000000000000000000ffffffff0c0216270101062f503253482fffffffff022c6d7307000000001976a914a557146c42de964657d073a291b0474bed00ceca88ac0000000000000000726a4c6f53504b62473045022100ccfa18e4b1b635292144ed854884bb86d6ab167d748c94a8d7874cb0da2a57ed022005c7be4fd42bd4fa974b88ecbe5340aa7d2ea5c13b30812ff15b1a49aefd0aa4022102441ef754530a417d3f7731037081679c5368e370193394bf759922f06b90f7ed00000000"
      },
      {
          "txid" : "d8567d6f701f8a4993b99bf9c6fae872db7f599ae56f5768475ffd028e01eda0",
          "version" : 1,
          "locktime" : 0,
          "vin" : [
              {
                  "txid" : "e18eba4c79dd037d6b9c12cdde5513499ec7a2320107c0042972da19666e2afd",
                  "vout" : 0,
                  "scriptSig" : {
                      "asm" : "304402203683b86ce5146518752816b21c07f64cf3ecb54543c066c26058ad53ed4727a202201974ff1ab8e5327da8152c244ac7a5712fc4b89759a1fe3e997ab4824e44d8b601 02905735c7538bacc0512ee3d11d18345f042721d2afc7a573f2f8a8b4e8c6c4e4",
                      "hex" : "47304402203683b86ce5146518752816b21c07f64cf3ecb54543c066c26058ad53ed4727a202201974ff1ab8e5327da8152c244ac7a5712fc4b89759a1fe3e997ab4824e44d8b6012102905735c7538bacc0512ee3d11d18345f042721d2afc7a573f2f8a8b4e8c6c4e4"
                  },
                  "sequence" : 4294967295
              }
          ],
          "vout" : [
              {
                  "value" : "9.995",
                  "n" : 0,
                  "scriptPubKey" : {
                      "asm" : "OP_DUP OP_HASH160 1a3e2de85ac5c809a2ca1b451d722577029620a3 OP_EQUALVERIFY OP_CHECKSIG",
                      "hex" : "76a9141a3e2de85ac5c809a2ca1b451d722577029620a388ac",
                      "reqSigs" : 1,
                      "type" : "pubkeyhash",
                      "addresses" : [
                          "13Pm4HQqux8Z9U2CP3wQCF85gmoA9FThZg"
                      ]
                  }
              },
              {
                  "value" : "0.00",
                  "n" : 1,
                  "scriptPubKey" : {
                      "asm" : "73706b6601 OP_DROP OP_RETURN 4365646234336437663563616635613334303530302c3146774a725a32703966655670314c7076683331577a5a526f45734c526f73417350",
                      "hex" : "0573706b6601756a384365646234336437663563616635613334303530302c3146774a725a32703966655670314c7076683331577a5a526f45734c526f73417350",
                      "type" : "nulldata"
                  },
                  "data" : [
                      {
                          "text" : "Cedb43d7f5caf5a340500,1FwJrZ2p9feVp1Lpvh31WzZRoEsLRosAsP"
                      }
                  ]
              },
              {
                  "value" : "1.00",
                  "n" : 2,
                  "scriptPubKey" : {
                      "asm" : "OP_DUP OP_HASH160 a3d7208117a15691b5b4af55742fc8ff739d97a9 OP_EQUALVERIFY OP_CHECKSIG",
                      "hex" : "76a914a3d7208117a15691b5b4af55742fc8ff739d97a988ac",
                      "reqSigs" : 1,
                      "type" : "pubkeyhash",
                      "addresses" : [
                          "1FwJrZ2p9feVp1Lpvh31WzZRoEsLRosAsP"
                      ]
                  }
              }
          ],
          "hex" : "0100000001fd2a6e6619da722904c0070132a2c79e491355decd129c6b7d03dd794cba8ee1000000006a47304402203683b86ce5146518752816b21c07f64cf3ecb54543c066c26058ad53ed4727a202201974ff1ab8e5327da8152c244ac7a5712fc4b89759a1fe3e997ab4824e44d8b6012102905735c7538bacc0512ee3d11d18345f042721d2afc7a573f2f8a8b4e8c6c4e4ffffffff03f8829800000000001976a9141a3e2de85ac5c809a2ca1b451d722577029620a388ac0000000000000000410573706b6601756a384365646234336437663563616635613334303530302c3146774a725a32703966655670314c7076683331577a5a526f45734c526f7341735040420f00000000001976a914a3d7208117a15691b5b4af55742fc8ff739d97a988ac00000000"
      },
      {
          "txid" : "91b1fa629cacbf96dad2538db9fa513eb219ae4ff8ace7684abdceb1a9c0458d",
          "version" : 1,
          "locktime" : 0,
          "vin" : [
              {
                  "txid" : "013eae63651f8225f769be485979e143c2010cb39426ed91cc861dc70428aba4",
                  "vout" : 0,
                  "scriptSig" : {
                      "asm" : "30440220265d40be2197bca27d760d1b649d41c909464e9a389e6d2c09e1d06b418ff45f0220086819326c592043ff08506d9079a930b655ae3cef7948b68030daadf816e28301 02ac4cbf91dd741fb3258b817975e8e2cca014559676a44223018f493ad200ed99",
                      "hex" : "4730440220265d40be2197bca27d760d1b649d41c909464e9a389e6d2c09e1d06b418ff45f0220086819326c592043ff08506d9079a930b655ae3cef7948b68030daadf816e283012102ac4cbf91dd741fb3258b817975e8e2cca014559676a44223018f493ad200ed99"
                  },
                  "sequence" : 4294967295
              }
          ],
          "vout" : [
              {
                  "value" : "4.00",
                  "n" : 0,
                  "scriptPubKey" : {
                      "asm" : "OP_DUP OP_HASH160 f368ac0cf5174b399ab88c37ec44a895751cf25f OP_EQUALVERIFY OP_CHECKSIG",
                      "hex" : "76a914f368ac0cf5174b399ab88c37ec44a895751cf25f88ac",
                      "reqSigs" : 1,
                      "type" : "pubkeyhash",
                      "addresses" : [
                          "1PC2bMkzLyvdpqeq8mMDSK2TsymEWDMW3D"
                      ]
                  }
              },
              {
                  "value" : "5.9949",
                  "n" : 1,
                  "scriptPubKey" : {
                      "asm" : "OP_DUP OP_HASH160 1a3e2de85ac5c809a2ca1b451d722577029620a3 OP_EQUALVERIFY OP_CHECKSIG",
                      "hex" : "76a9141a3e2de85ac5c809a2ca1b451d722577029620a388ac",
                      "reqSigs" : 1,
                      "type" : "pubkeyhash",
                      "addresses" : [
                          "13Pm4HQqux8Z9U2CP3wQCF85gmoA9FThZg"
                      ]
                  }
              }
          ],
          "hex" : "0100000001a4ab2804c71d86cc91ed2694b30c01c243e1795948be69f725821f6563ae3e01000000006a4730440220265d40be2197bca27d760d1b649d41c909464e9a389e6d2c09e1d06b418ff45f0220086819326c592043ff08506d9079a930b655ae3cef7948b68030daadf816e283012102ac4cbf91dd741fb3258b817975e8e2cca014559676a44223018f493ad200ed99ffffffff0200093d00000000001976a914f368ac0cf5174b399ab88c37ec44a895751cf25f88ac94795b00000000001976a9141a3e2de85ac5c809a2ca1b451d722577029620a388ac00000000"
      }
  ],
  "time" : 1562218608,
  "nonce" : 359,
  "bits" : "2000ffff",
  "difficulty" : 5.96046447753906e-8,
  "chainwork" : "0000000000000000000000000000000000000000000000000000000000271700",
  "prevblockhash" : "00020c2bffe8027ca9e6a32c53a65725f74ee64e0593292146a47b703be15b9a",
  "nextblockhash" : "00902185d67d4df146a85eeedf4fcbcc805c791595ac872d80583e518a2d920e"
}


处理提现请求


1. 记录用户提现请求，更改余额；
2. 调用send或者sendfrom命令，向用户提现地址发送交易，具体使用方法请参考《开发者文档》；
3. 调用命令成功后将返回txid，记录在数据库中；
4. 等待区块确认后，即为提现成功。



离线交易


查询未花费输出


调用如下命令：


showunspent ( minconf maxconf addresses )




方法参数








参数
描述






minconf
区块最小确认数




maxconf
区块最大确认数




addresses
要查询的地址集合








e.g.




	showunspent 6 9999999 "[\"address1\",\"address2\"]"




返回值




	[                                         Array of json object
    {
      "txid" : "txid",                      The TXID
      "vout" : n,                           The vout value
      "address" : "address",                The address
      "account" : "account",                The associated "" for the default account
      "scriptPubKey" : "key",               The script key
      "amount" : x.xxx,                     The deal amount in yqf
      "confirmations" : n                   The number of confirms
    }
    ,...
  ]


组装交易


1.交易所通过解析区块获得地址未花费交易(unspent)指定转入对象,调用命令如下：


  setuprawdeal [{"txid":"id","vout":n},...] {"address":amount,...} ( [data] "action" )




方法参数








参数
描述






deals
交易集合




addresses
地址：数量




data
附加数据




action
默认为“”,lock（锁定钱包中的给定输入），sign（使用钱包密钥签署交易），lock,sign，send（签署并发送交易








返回值




	#若action为""或lock或send
	hex
	#若action为其他几种
	{                                                        
	  "hex": "value",                                        The raw deal with signature(s) (hex-encoded string)
	  "complete": true|false                                 If deal has a complete set of signature (0 if not)
	}


2.通过addrawchange设置找零地址以及指定交易手续费




调用命令




	addrawchange "tx-hex" "address" ( fee )




方法参数








参数
描述






tx-hex
Hex




address
找零地址




fee
手续费








e.g.




	addrawchange "HEX""ADDR"
	addrawchange "HEX""ADDR" 0.01




返回值




	hex


建议交易所的找零地址单独设置，防止解析vout找零重复！！


3.通过signrawdeal进行离线私钥签名交易




调用命令




	signrawdeal "tx-hex" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )




方法参数








参数
描述






Tx-hex
Hex




prevtxs
交易数组，可设置为[]




privatekeys
私钥数组，如果是在有私钥的节点签名，可设置为[]




sighashtype
签署类型，默认为all








返回值




	{
	  "hex": "value",                           The raw deal with signature(s) (hex-encoded string)
	  "complete": true|false                    If deal has a complete set of signature (0 if not)
	}


若complete为true，则签名成功，否则失败


4.通过sendrawdeal广播交易




调用命令




	sendrawdeal "tx-hex" ( allowhighfees )




方法参数








参数
描述






Tx-hex
签名后要广播的hex




allowhighfees
默认为false,是否允许更高的手续费








e.g.




	sendrawdeal "signedhex"




返回值




	txid


例：


#向12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX地址30个原生币(CXC)
  setuprawdeal '[{"txid":"526be568b3756124701e7d8c639dd3ffba1a40947cc2573fada996c1e08b4c89","vout":0},{"txid":"526be568b3756124701e7d8c639dd3ffba1a40947cc2573fada996c1e08b4c89","vout":1}]'  '{"12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX":{"":30}}'
  #返回 dealhex
0100000002894c8be0c196a9ad3f57c27c94401abaffd39d638c7d1e70246175b368e56b520000000000ffffffff894c8be0c196a9ad3f57c27c94401abaffd39d638c7d1e70246175b368e56b520100000000ffffffff0180c3c901000000004f76a914119b098e2e980a229e139a9ed01a469e518e6f2688ac3473706b71ef28a6c20ae4fd378fbd6eed144bfcff80969800000000000e64ad8c6ebffc4d749dbd3e1f93090f002d3101000000007500000000


设置上一步Hex的找零地址12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX 与 手续费 0.001


addrawchange 0100000002894c8be0c196a9ad3f57c27c94401abaffd39d638c7d1e70246175b368e56b520000000000ffffffff894c8be0c196a9ad3f57c27c94401abaffd39d638c7d1e70246175b368e56b520100000000ffffffff0180c3c901000000004f76a914119b098e2e980a229e139a9ed01a469e518e6f2688ac3473706b71ef28a6c20ae4fd378fbd6eed144bfcff80969800000000000e64ad8c6ebffc4d749dbd3e1f93090f002d3101000000007500000000 12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX 0.001
#返回带找零地址的dealhex2


为交易进行签名并广播交易


#使用私钥privatekey1、privatekey2对hex进行签名
signrawdeal dealhex2 '[]' '["privatekey1","privatekey2"]'
#若在含有私钥的节点进行签名广播
sendrawdeal dealhex2 
返回签名后的hex与complete字段。当complete字段为true时 代表所有unspent均被签名可以进行广播


{
    "hex" : "xxxxxxx",
    "complete" : true
}


相关命令


查询余额


使用showallbals或者showaddrbals可查询用户余额,资产最小单位为0.000001。


设置节点手续费


通过settxfee的方式可设置节点转账时的基础手续费，具体手续费还是根据字节收取手续费。