Skip to content

Latest commit

 

History

History
157 lines (137 loc) · 6.29 KB

4-APP Native SPEC.md

File metadata and controls

157 lines (137 loc) · 6.29 KB
Raw

APP监听消息接口规范

  • 系统消息注册

    • 默认消息监听：kylindapp://method_path?params=paramsBase64String
    • 具体钱包注册自己的监听，但要以 kylindapp_ 开头，比如:
      • kylindapp_meetone://
      • kylindapp_tokenpacket:// 注：

  • method_path: 调用方法名，比如 transfer, wallet/get_account

  • params: 调用参数，格式如下：paramsJson.toString("utf-8").base64String()

  • 钱包回调接口

钱包完成DApp的调用以后，会发起此回调，回调参数中除了下面给出的参数外，还会根据不同接口传递其他参数。

    dappxxx://kylin/callback?params=paramsBase64String

    PARAMS:
        code: Int 错误信息代码，0表示成功
        msg: String, 其他信息
        path: String, 处理请求的调用路径，比如 wallet/login/request
        platformid: String e.g.wallet4bixin
        authorization: String 将dapp发起请求时所携带的authorization参数原样返回做认证

注：

  • dappxxx: 为dapp客户端自身注册的scheme。为调用协议接口中的cb参数。

  • 支付接口

kylindapp://pay?params=paramsBase64String

PARAMS:
    v: kylinv1, 协议版本
    from: String 支付账户，可选参数
    to: String 接收币的目的账户,
    tokenid: tokens_info.json 中的每个数字资产的唯一标识
    num: String 支付数量
    memo: String 转账备注，可选参数
    msg: String, 其他信息，可用作钱包信息呈现，可选参数
    actionid: 当前支付订单ID，可选参数
    userid: 用户身份ID，可选参数
    dappsymbol: dapps_info.json 中DApp全网唯一的symbol字段, 可选参数
    authorization: String 认证，格式为 accesskey + ":" + signature
    cb: 指定回调scheme

CALLBACK: 回调接口，回调参数至少包含如下参数：
    txid: String, 转账id
    actionid: String, 传递过来的参数actionid

钱包支付时需要在交易备注中添加如下形式信息:

{"from":"","to":"","actionid":"","msg":""}

注：

  • actionid：填写支付参数中的 actionid

  • from: 填写支付用户在钱包系统中的userid，可选参数

  • to: 填写支付参数中的userid，可选参数

  • msg: 其他信息，可选参数

  • 请求登录授权

由于存在安装多个钱包的情况，所以需要先看用户使用哪个钱包打开，钱包根据dappsymbol获取DApp相关信息，提醒用户是否确认登录，用户只需在钱包选择一个已导入钱包账号进行授权登录.

kylindapp://wallet/login?params=paramsBase64String

PARAMS:
    v: kylinv1, 协议版本
    tokenid: tokens_info.json 中的每个数字资产的唯一标识，此处需要指定tokenid主要是为了针对用户不同币种授权的安全隔离
    dappsymbol: dapps_info.json 中DApp全网唯一的symbol字段
    authorization: String 认证，格式为 accesskey + ":" + signature
    cb: 指定回调scheme

CALLBACK: 回调接口，回调参数至少包含如下参数：
    accountinfo: Dictionary 获取到的钱包账号信息

注：

  • accountinfo：获取到的钱包账号信息，可能根据不同的公链有不同的字段返回，但是必须包含以下字段：

    • tokenid: tokens_info.json 中的每个数字资产的唯一标识
    • accountname: String 用户在钱包系统中的userid。如eos中为其eos账号名，eth为公钥地址
    • pubkeys: 针对EOS，需要给出该账户对应的 public keys，比如 {"owner":"xxxxx","active":"xxxx"}
    • nickname: String 昵称，可选参数
    • avatar: String 头像url地址，可选参数
    • balance: double 对应tokenid主代币可用余额，可选参数
    • extra: Dictionary 钱包可选附加信息，可选参数

  • 获取钱包签名

由于存在安装多个钱包的情况，所以需要先看用户使用哪个钱包打开，钱包根据dappsymbol获取DApp相关信息，提醒用户是否确认授予签名.

kylindapp://wallet/sign?params=paramsBase64String

PARAMS:
    v: kylinv1, 协议版本
    tokenid: tokens_info.json 中的每个数字资产的唯一标识
    accountname: String 提供签名的钱包账号在钱包系统中的userid。如eos中为其eos账号名，eth为公钥地址
    customdata: String, 自定义签名附加字段，可选参数
    msg: String, 其他信息，可用作钱包信息呈现，可选参数
    dappsymbol: dapps_info.json 中DApp全网唯一的symbol字段, 可选参数
    authorization: String 认证，格式为 accesskey + ":" + signature
    cb: 指定回调scheme
        
CALLBACK: 回调接口，回调参数至少包含如下参数：
    sign: String 钱包签名

  • 执行合约

由于EOS以及其众多衍生链支持更丰富的智能合约功能，该接口就是可以针对合法的action进行签名并执行。

kylindapp://contract?params=paramsBase64String

PARAMS:
    v: kylinv1, 协议版本
    tokenid: tokens_info.json 中的每个数字资产的唯一标识
    dappsymbol: dapps_info.json 中DApp全网唯一的symbol字段, 可选参数
    authorization: String 认证，格式为 accesskey + ":" + signature
    account: 当前帐号
    address: 当前帐号对应的公钥地址，钱包会拿该地址对应的私钥进行签名
    options: 合约options，可选参数
    actionid: 当前标识该此次调用的ID，可选参数
    msg: String, 其他信息，可用作钱包信息呈现，可选参数
    cb: 指定回调scheme
    actions: 合法的EOS action格式数据，具体格式见备注
        
CALLBACK: 回调接口，回调参数至少包含如下参数：
    txid: String, 合约操作id
    actionid: String, 传递过来的参数actionid

注:

  • actions 格式:
    [
        {
            account: "eosio.token",
            name: "transfer",
            authorization: [{
                actor: "aaaabbbbcccc",
                permission: "active"
            }],
            data: {
                from: "aaaabbbbcccc",
                to: "itokenpocket",
                quantity: "1.3000 EOS",
                memo: "something to say"
            }
        }
    ]

钱包调用合约时根据需要，在交易备注中添加如下形式信息:

{"from":"","actionid":"","msg":""}

注：

  • actionid：填写参数中的 actionid
  • from: 发起合约操作账号名称，可选参数
  • msg: 其他信息，可选参数