YOYOW 交易所对接 YOYOW 指南

vianull · 2018年08月31日 · 306 次阅读
本帖已被设为精华帖!

交易所对接指南

本文主要介绍交易所对接YOYOW主链的细则。

准备工作

硬件设备

推荐的硬件配置:4GB内存,20G硬盘,两核CPU 即可

当前支持的平台:

  • Ubuntu 16.04 LTS 64 bit
  • Windows Servers 64 bit

下文以Ubuntu 16.04 为例进行介绍

服务

禁止掉默认的 time-syncing daemon(已过期) ,安装 NTPD:

sudo timedatectl set-ntp false
sudo apt-get -y install ntp

账号

https://wallet.yoyow.org 上注册一个YOYOW主网账号。指南请见:这里.

得到账号私钥。指南请见:这里. 我们总共需要3对密钥:

  • 资金密钥: 管理资金进出
  • 零钱密钥:用于收集积分来抵扣手续费
  • 备注密钥:用来加密/解密memos

基本逻辑

交易所可以使用一个或多个账号处理充值/提现。

  • 充值:给每个用户分配一个独立的、唯一的标识,如:用户在交易所平台ID,或对该ID进行hash 等. 任意用户在进行充值时,需在MEMO上填写该唯一标识。交易所因此可以知道此笔充值来自于哪位客户.
  • 提现:从交易所账号中转移资产到用户的账号中,MEMO功能也是必要的,因为用户可能的提现目标为另一家交易所。

安装

请在(此处)下载"最新版"的可执行文件。下载后,解压文件 如:

https://github.com/yoyow-org/yoyow-core/releases/download/v0.2.1-180313/yoyow-node-v0.2.1-ubuntu-20180313.tgz
https://github.com/yoyow-org/yoyow-core/releases/download/v0.2.1-180313/yoyow-client-v0.2.1-ubuntu-20180313.tgz
tar xzf yoyow-node-v0.2.1-ubuntu-20180313.tgz
tar xzf yoyow-client-v0.2.1-ubuntu-20180313.tgz

注: 请注意替换最新版本的node 与 client程序 !

启动YOYOW节点

节点程序yoyow_node需要持续运行,可选方案之一为使用screen,安装如下:

sudo apt-get -y install screen

通过 screen启动yoyow_node:

screen -S yoyow_node
./yoyow_node --rpc-endpoint 127.0.0.1:8090

注:

  1. 启动时使用 --rpc-endpoint ,我们就可以通过RPC对其进行调用. 在本例中yoyow_node将监听127.0.0.18090端口。
  2. 以下参数表示每账号保留多少条历史记录供查询,默认值是 1000 。 对交易所来说,如果充值、提现记录较多,可考虑设置成一个较大的值,比如:
max-ops-per-account = 1000

修改为

max-ops-per-account = 1000000

则会保留一百万条数据。更早的数据会从内存中被删除而无法快速查询(但仍然记录在链上)。

  1. 以下两个参数会大量减少运行需要的内存,原理是不保存与交易所账户无关的历史数据索引。
track-account = [25638]
partial-operations = true

请将 "25638" 替换成你需要的账户数字 ID 。 注: config.ini 里默认 track-account 前面有个“#”符号,需要删除。

如果需要监控多个账户,则使用如下配置:

track-account = [25638,25997]
partial-operations = true

节点程序会从P2P网络中下载数据,当数据下载完成后,console里会每3秒钟打印一则新的消息,示意如下:

789216ms th_a       application.cpp:574           handle_block         ] Got block: #355797 00056dd54878c05849e2dcd731c9ee364398b0d2 time: 2017-09-18T19:13:09 latency: 216 ms from: 27662/init8  irreversible: 355787 (-10)
792527ms th_a       application.cpp:574           handle_block         ] Got block: #355798 00056dd613f39f1ad6c0c3fdb00a56c60f44ab1c time: 2017-09-18T19:13:12 latency: 526 ms from: 499381505/yoyo499381505  irreversible: 355788 (-10)

如果需要终止节点程序,Ctrl + C 即可,或者发送 SIGINT or SIGTERM 信号给进程。执行后需要等待少许时间,节点会自动停止。

启动 YOYOW Client

初次使用

启动另一个screen ,在其中运行yoyow_client程序:

screen -S yoyow_client
./yoyow_client -s ws://127.0.0.1:8090/ -H 127.0.0.1:8091

注意:

  1. 使用 -s 来指定,连接到的节点程序的IP与端口
  2. 使用 -H 选项来开启一个HTTP-RPC服务,方便我们其他程序进行访问。如:单独处理充值/提现的脚本程序。
  3. yoyow_node 只有完成同步后,才会监听RPC端口,所以请耐心等待 yoyow_node 同步完成。
  4. 您可以启动多个client 连接同一个yoyow_node。但请注意不要使用相同的-H,会因为端口被占用而监听失败。

当第一次运行yoyow_client时,当其连接上node程序,会打印:

Please use the set_password method to initialize a new wallet before continuing
new >>>

我们需要按如下所示设置密码,程序会自动创建一个加密的钱包文件:

new >>> set_password my-password
set_password my-password
null
locked >>>

当已经存在钱包文件时,如果我们运行yoyow_client程序,它同样会显示locked >>>

此时我们需要解锁钱包:

locked >>> unlock my-password
unlock my-password
null
unlocked >>>

导入3对密钥至client,他们会被加密存储于钱包文件中,命令如下:

import_key [account_ID] [wif_private_key]

如: 您的账号ID是 123456789,且拥有了资金私钥零钱私钥备注私钥。需要执行import_key三次,每次导入1个私钥:

unlocked >>> import_key 123456789 5Hqwx3xXMYZ55Pko9nzw34234234nXHcGfNQjNEL23424w7Py
import_key 123456789 5Hqwx3xXMYZ55Pko9nzw34234234nXHcGfNQjNEL23424w7Py
2993104ms th_a       wallet.cpp:820                save_wallet_file     ] saving wallet to file wallet.json
true
unlocked >>> import_key 123456789 5JKoYzQ4sYZoDYwreyrsfsd32466MsCFNoxRE23nExaRi6SY3
import_key 123456789 5JKoYzQ4sYZoDYwreyrsfsd32466MsCFNoxRE23nExaRi6SY3
2993104ms th_a       wallet.cpp:820                save_wallet_file     ] saving wallet to file wallet.json
true
unlocked >>> import_key 123456789 5HttjgBSb45368989etfhsserVtt69cWcExteq6RktpAYXNTT
import_key 123456789 5HttjgBSb45368989etfhsserVtt69cWcExteq6RktpAYXNTT
2993104ms th_a       wallet.cpp:820                save_wallet_file     ] saving wallet to file wallet.json
true
unlocked >>>

命令: info

可以通过 info 命令,查看网络状态:

unlocked >>> info
info
{
  "head_block_num": 377867,
  "head_block_id": "0005c40b41f6d79d762b1ff81c7affc7ae82a894",
  "head_block_time": "2017-09-18T19:37:39",
  "head_block_age": "0 second old",
  "last_irreversible_block_num": 377857,
  "chain_id": "3505e367fe6cde243f2a1c39bd8e58557e23271dd6cbf4b29a8dc8c44c9af8fe",
  "participation": "100.00000000000000000",
  "active_witnesses": [[
  ...
}

命令: get_block

可通过 get_block 查看某个具体块号的相信信息. 格式如下:

get_block [block_number]

如:

unlocked >>> get_block 1

命令: get_full_account

可通过 get_full_account 命令查看某账号详细信息:

unlocked >>> get_full_account 123456789
get_full_account 123456789
{
  "account": {
    "uid": 123456789,
    ...
  },
  "statistics": {
    "owner": 123456789,
    "total_ops": 30220,
    "prepaid": 0,
    "csaf": 37424828,
    "core_balance": "44672014515",
    "core_leased_in": 0,
    ...

注: 对于接入来讲,"statistics" 数据部分比较有用

  • "csaf" 是『积分』,通过持有YOYOW产生,可以用来抵扣等额的手续费。YOYOW资产的精度为5,单位为YOYO,所以"csaf": 37424828 意味着可抵扣 374.24828 YOYO等额的手续费.
  • "core_balance" 是账号资产的『余额』. "core_balance": "44672014515" 意为该账号余额有 446,720.14515 YOYO.
  • 请留意:若返回值内的数字大于2^32,将会有引号将其引住。如上例中core_balance的值有引号而csaf的值没有

命令 transfer

transfer 命令可以用来转移资产,格式如下:

transfer [from] [to] [amount] YOYO [memo] [broadcast]

如:

unlocked >>> transfer 123456789 987654321 1.2345 YOYO "thisismemo" true

Note:

  • amount 最多只能有5位精度.
  • 如果设置 broadcasttrue, 则签名过的交易会被广播至P2P网络;若为 false 则用来测试,不广播。

命令: get_transaction_id

可以使用 get_transaction_id 命令得到一笔交易的hash值. 格式如下:

get_transaction_id [transaction_in_json]

这个命令在接入中也是很有用的.

命令: get_relative_account_history

可以使用 get_relative_account_history 命令来查看某账号的操作历史,格式如下:

get_relative_account_history [account] [operation_type] [start] [limit] [end]

如:

unlocked >>> get_relative_account_history 123456789 null 1 10 10
unlocked >>> get_relative_account_history 123456789 0 11 10 20

注:

  • 对于 operation_type, 值为 null 时,则返回所有操作类型;为 0 时可获得所有transfer操作.
  • 对于 end, 值为 0 时,可得到最多的最近操作记录.
  • 返回结果的数量会在end - start 范围之内;如果limit值比end - start 要小,则返回满足的条件的最新操作记录。
  • 返回结果的排序方式为: 最新的优先

命令: collect_csaf

可以使用 collect_csaf 命令来收集积分,可用于抵扣各操作的手续费。格式如下:

collect_csaf [from_account] [to_account] [amount] YOYO [broadcast]

如:

unlocked >>> collect_csaf 123456789 123456789 10 YOYO true

注:

  • 如果该账号内有一定数量的YOYO,它将随着时间自动积累积分。积累的速度与账号余额间呈线性关系。通常对于交易所而言,积累的积分足够支付日常手续费用。
  • 积分需要通过该命令领取后才能使用
  • 尽管在底层实现上,账号里的资产(如余额、零钱)同样可以用来支付手续费,但是当前yoyow_client的实现上会只尝试进行积分抵扣手续费(raw-transaction signing除外).如果账号中没有足够的积分,多数的命令会失败。所以保持账号中一定数量的积分是很有必要的。

如何关闭

在Ubuntu下,可以Ctrl + D 来关闭client

通过 HTTP-RPC 接入Client

当 HTTP-RPC 开启的时候,我们可以通过HTTP-RPC 来连接client。所有的上述命令都是可用的,如:

curl -d '{"jsonrpc": "2.0", "method": "info", "params": [], "id": 1}' http://127.0.0.1:8091/rpc
curl -d '{"jsonrpc": "2.0", "method": "transfer", "params": [123456789,123456789,"1","YOYO",null,true], "id": 1}' http://127.0.0.1:8091/rpc
curl -d '{"jsonrpc": "2.0", "method": "get_relative_account_history", "params": [123456789,0,1,10,10], "id": 1}' http://127.0.0.1:8091/rpc

注:

  • 使用 http 协议
  • 请求 /rpc 路径,而不是 /
  • 与交互式CLI不同,HTTP-RPC调用采用json格式
  • 在所有request中,amount 的精度都是5;在response里,amount没有小数点,其数值被乘以了10^5
  • 金额的传入,金额建议使用字符串。建议使用普通的小数格式,比如"12345.6789",如果使用科学计数法的格式比如1.23456789E4这种可能会有问题

处理充值

检查节点状态

通过info命令,得到last_irreversible_block_num.在这个值之前的区块才是可信区块

检查账号历史

  1. 首先,使用 get_relative_account_history 命令/API 来得到最新的 sequence number:
curl -d '{"jsonrpc": "2.0", "method": "get_relative_account_history", "params": [123456789,0,0,1,0], "id": 1}' http://127.0.0.1:8091/rpc

在返回值中,如果response["result"]为空,则意为该账号下目前没有充值进来;若不为空,则,可以取response["result"][0]["sequence"]作为maximum_sequence

如果maximum_sequence比上次存储的最新sequence值更大,则意为有最新的充值记录需要处理

  1. 使用get_relative_account_history命令/API 来检查最新记录。如: 如自行记录的sequence 值为100,maximum_sequence 为200,则我们可以从101开始,请求100个记录,至200结束,参考命令如下:
curl -d '{"jsonrpc": "2.0", "method": "get_relative_account_history", "params": [123456789,0,101,100,200], "id": 1}' http://127.0.0.1:8091/rpc

返回值中, result=response["result"], 则result为数组. 若数组为空,则意味着没有最新的充值请求。若不为空, 则数组的第N个元素 result[N] 格式应该如下:

    {
      "memo": "a1b2c3d4",
      "description": "Transfer 100 YOYO from 204501630 to 123456789 -- Memo: a1b2c3d4   (Fee: 0.20898 YOYO)",
      "sequence": 101,
      "op": {
        "op": [
          0,
          {
            "fee": {
              "total": {
                "amount": 20898,
                "asset_id": 0
              },
              "options": {
                "from_balance": {
                  "amount": 20898,
                  "asset_id": 0
                }
              }
            },
            "from": 204501630,
            "to": 123456789,
            "amount": {
              "amount": 10000000,
              "asset_id": 0
            },
            "memo": {
              "from": "YYW6U528P71X6V87765245356aPBPpDwwRp7urUiXYtFLHmrXRsN3u",
              "to": "YYW5eA89yqwerhdfghrjtr3452376trtyU6LD7a1kmvwYa5h51rDxr",
              "nonce": "3457645755345345",
              "message": "0938457345937abcdef3098945"
            },
            "extensions": {
              "from_balance": {
                "amount": 10000000,
                "asset_id": 0
              },
              "to_balance": {
                "amount": 10000000,
                "asset_id": 0
              }
            }
          }
        ],
        "result": [
          0,
          {
          }
        ],
        "block_timestamp": "2017-09-08T11:14:15",
        "block_num": 223355,
        "trx_in_block": 0,
        "op_in_trx": 0,
        "virtual_op": 8795
      }
    },
  • result[N]["op"]["block_num"], 若比 last_irreversible_block_num小, 意味着是可信的, 需要被处理.
  • result[N]["op"]["op"][0], 如 == 0, 则是一个transfer请求. (实际上肯定会等于0,因为请求参数里已约定只取transfer记录)
  • result[N]["op"]["op"][1]["to"], 验证是否与自身account ID 相同。若相同,即为一个充值请求。
  • result[N]["op"]["op"][1]["amount"]["asset_id"] 验证其是否 == 0, 若是,即表示该资产为YOYO
  • result[N]["op"]["op"][1]["amount"]["amount"], 该值为充值数量. 切记:该数字精度为5.
  • result[N]["memo"], 为该转账记录的MEMO信息。此处已经被解密过了,它可以用来作为充值客户的识别符。
  • 保存 result[N]["sequence"] 作为最新的sequence序号,下一次循环时需使用。
  • 保存 result[N]["op"]["trx_in_block"] 留作后续使用。
  • 使用 get_block 命令/API 来获取此次转账的txid ,如下:(记得修改params值为 block_num):
curl -d '{"jsonrpc": "2.0", "method": "get_block", "params": [160000], "id": 1}' http://127.0.0.1:8091/rpc

记录返回值为 new_response, 保存 new_response["result"]["transaction_ids"][trx_in_block] 作为本次充值的txid 留作后用.

注:

  • 为了保证可以正确解密MEMO,client 需要出于 unlocked状态。同时,memo private key 需要已导入至钱包中

处理提现强求

检查节点状态

安全起见,我们只在节点状态正常的情况下处理提现。 通过info命令/API来检验。

  • head_block_time 应当在15秒以内
  • participation 应大于 80, 意味着80%的区块生产者在线且状态正常。

检查账号资产与积分

使用 get_full_account 命令/API.

如果积分不足以支付网络手续费,请使用collect_csaf命令/API 领取更多积分。

发送资产

  1. 使用 transfer 命令/API 来发送资产.

注: 请注意资产精度.

保存返回的json值供后续使用.

  1. 获取txid通过 get_transaction_id 命令/API, 保存供后续使用.

Re-check / Follow-up

类似于充值的步骤,当发现一个新的transfer,保存txid,block num等信息供后续使用。

故障排查

每笔交易都有expiration字段。如果某笔交易因为某种原因,没有被打包到任意块中,且不可逆区块(last_irreversible_block_num)的时间戳比交易的expiration字段还要晚。则该笔交易不会打包在当前这条链上,此时尝试重新转账是安全的。

示例代码


原文链接:https://github.com/yoyow-org/yoyow-core/wiki/%E4%BA%A4%E6%98%93%E6%89%80%E5%AF%B9%E6%8E%A5%E6%8C%87%E5%8D%97%EF%BC%88%E4%B8%AD%E6%96%87%EF%BC%89#%E7%A1%AC%E4%BB%B6%E8%AE%BE%E5%A4%87

共收到 0 条回复
dposclub001 将本帖设为了精华贴 08月31日 16:23
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册