dappsdk v1.0.7

• en
• 中文

STARTEOS DAPP SDK hand book

• STARTEOS DAPP SDK hand book
  • installation
  • callback and Promises
  • error handling
    • Error
    • errors and codes
  • API
    • exec
    • SYSTEM
      • get Native SDK information
      • get current language setting
      • get current currency type
    • GUI
      • full screen switch
      • change status bar
      • Toast
      • Progress
      • Alert
      • Dialog
      • set to clipboard
      • scan QR code
    • CUSTOMER
      • get current wallet type
      • Fingerprint
    • EOS
      • get current wallet account
      • get current account's balance
      • get current account's information
      • get accounts
      • get balance
      • get account's information
      • transfer
      • get transaction record
    • ETH
      • transaction
• STARTEOS DAPP SDK使用文档
  • 安装
  • 回调与Promise
  • 错误处理
    • 错误
    • 错误与状态码
  • API
    • exec
    • SYSTEM
      • 获取Native SDK信息
      • 获取当前语言设置
      • 获取当前显示币种
    • GUI
      • 全屏切换
      • 更改状态栏显示
      • Toast
      • 进度
      • Alert
      • Dialog
      • 复制到剪切板
      • 扫描二维码
    • CUSTOMER
      • 获取当前钱包类型
      • 检查当前是否开启了指纹支付
    • EOS
      • 获取当前账户
      • 获取当前账户余额
      • 获取当前账户信息
      • 获取账户列表
      • 获取余额
      • 获取账户信息
      • 转账
      • 获取交易记录
    • ETH
      • 转账

installation

npm install dappsdk

ES-Module:

import dappSDK from 'dappsdk'

dappSDK.gui.showToast({message: 'Hello World!', delay: 1000})

Use SDK as normal script resource, use node_modules/dappsdk/dist/index.js:

<script type="text/javascript" src="path-to-the-sdk"></script>

window.dappSDK.gui.showToast({message: 'Hello World!', delay: 1000})

Whatever the way you import the SDK is, the window.dappSDK exists.

callback and Promises

First of all, the SDK itself does not contain any Promise library, if you need it, ensure that the window.Promise exists.

All the API could receive a callback function as optional, if callback does not exist, call the API will renturn an instance of Promise:

window.dappSDK.system.getSdkInfo({})
    .then(({version}) => alert(version));

window.dappSDK.system.getSdkInfo({}, function(err, data) {
    if(err) {
        return alert('Error: ' + err.message)
    }
    var version = data.version;
    alert(version)
})

error handling

When using the API with callback style, keep it in mind that the callback function MUST receive two parameters, first of which is an instance of Error , and the second is the result of the call, if err is truthy, the result may be undefined, so you should use error-first-callback to handle with the call:

window.dappSDK.system.getSdkInfo({}, function(err, data) {
    if(err) {
        var code = error.code;
        console.log(code);
        // if error exists, `return` makes the rest of logic not be executed.
        return alert('Error: ' + err.message)
    }
    var version = data.version;
    alert(version)
})

Error

No matter whiche style you use for callback, the error will contain 3 variables, error.message, error.code, error.extra. message is the short information about the error, code is the mapping of message in our definition, extra is the extra information of the error, and it's more detailed than the message, in most case, extra is undefined.

errors and codes

API

exec

function exec(namespace, fnName, params, [callback])

parameters:

e.g.:

window.dappSDK.exec('system', 'getSdkInfo', {}, function(data) {
    alert(data.version) //version
})

SYSTEM

namespace: system

get Native SDK information

function: getSdkInfo

params: null

output:

i.e.:

dappSDK.system.getSdkInfo({}, function(err, data) {
    if(err)
        return console.error(err);
    console.log(data)
}); 

dappSDK.system.getSdkInfo({})
    .then(data => console.log(data))
    .catch(err => console.error(err))

get current language setting

function: getLanguageSetting

params: null

output:

get current currency type

function: getSymbol

params: null

output:

GUI

namespace: gui

full screen switch

function: changeFullScreen

params:

output: null

change status bar

function: changeStatusBar

params:

output: null

Toast

function: showToast

params:

output: null

Progress

function: showProgress

params:

output: null

function: hideProgress

params: null

output: null

Alert

function: showAlert

params:

output:

Dialog

function: showDialog

params:

output:

set to clipboard

function: setClipboard

params:

output: null

scan QR code

function: scanQRCode

params: null

output:

CUSTOMER

namespace: customer

get current wallet type

function: getCurrentWalletType

params: null

output:

error:

Fingerprint

function: checkFingerprintPayment

params: null

output:

EOS

namespace: eos

get current wallet account

function: getCurrentWalletAccount

params: null

output:

error:

get current account's balance

function: getCurrentBalance

params:

output:

error:

get current account's information

function: getCurrentAccountInfo

params: null

output: the information in the chain

error:

get accounts

function: getWalletAccounts

params: null

output:

item:

error:

get balance

function: getBalance

params:

output:

error:

error:

get account's information

function: getAccountInfo

params:

output: the information in the chain

transfer

function: transfer

params:

output:

get transaction record

function: getTransactionRecord

params:

output: the information in the chain

ETH

namespace: eth

transaction

undetermined

STARTEOS DAPP SDK使用文档

• STARTEOS DAPP SDK使用文档
  • 安装
  • 回调与Promise
  • 错误处理
  • API
    • SYSTEM
      • 获取Native SDK信息
      • 获取当前语言设置
      • 获取当前显示币种
    • GUI
      • 全屏切换
      • 更改状态栏显示
      • Toast
      • Alert
      • Dialog
      • 复制到剪切板
      • 扫描二维码
    • CUSTOMER
      • 获取当前钱包类型
    • EOS
      • 获取当前账户名
      • 获取当前账户余额
      • 获取当前账户信息
      • 获取账户列表
      • 获取余额
      • 获取账户信息
      • 转账
      • 获取交易记录
    • ETH
      • 转账

安装

npm install dappsdk

ES-Module:

import dappSDK from 'dappsdk'

dappSDK.gui.showToast({message: 'Hello World!', delay: 1000})

作为普通资源加载, 使用 node_modules/dappsdk/dist/index.js:

<script type="text/javascript" src="路径"></script>

window.dappSDK.gui.showToast({message: 'Hello World!', delay: 1000})

不管你使用何种方式引入, window.dappSDK始终存在.

回调与Promise

首先, SDK本身并不附带promise, 如果你需要promise, 请确保window.Promise存在.

所有的API均有一个可选的回调函数参数, 如果这个参数不存在, 那调用这个API将返回一个 Promise 实例:

window.dappSDK.system.getSdkInfo({})
    .then(({version}) => alert(version));

window.dappSDK.system.getSdkInfo({}, function(err, data) {
    if(err) {
        return alert('Error: ' + err.message)
    }
    var version = data.version;
    alert(version)
})

错误处理

在使用callback风格调用API的时候, 注意回调函数永远接收两个参数, 第一个为错误, 第二个为请求结果, 如果存在错误, 大部分情况请求结果会为空, 所以在代码中应使用 错误优先回调 :

window.dappSDK.system.getSdkInfo({}, function(err, data) {
    if(err) {
        var code = error.code;
        console.log(code);
        // 如果错误存在, 那么return可以保证之后的代码不执行
        return alert('Error: ' + err.message)
    }
    var version = data.version;
    alert(version)
})

错误

不管使用何种风格处理异步, error 都会包含3个变量, error.message, error.code, error.extra. message 是对error的简单描述, code 是 message 的映射, extra 是 message 额外描述, 在大多数情况下, extra 为 undefined.

错误与状态码

API

exec

function exec(namespace, fnName, params, [callback])

parameters:

例:

window.dappSDK.exec('system', 'getSdkInfo', {}, function(data) {
    alert(data.version) //version
})

SYSTEM

namespace: system

获取Native SDK信息

function: getSdkInfo

params: null

output:

例:

dappSDK.system.getSdkInfo({}, function(err, data) {
    if(err)
        return console.error(err);
    console.log(data)
}); 

dappSDK.system.getSdkInfo({})
    .then(data => console.log(data))
    .catch(err => console.error(err))

获取当前语言设置

function: getLanguageSetting

params: null

output:

获取当前显示币种

function: getSymbol

params: null

output:

GUI

namespace: gui

全屏切换

function: changeFullScreen

params:

output: null

更改状态栏显示

function: changeStatusBar

params:

output: null

Toast

function: showToast

params:

output: null

进度

function: showProgress

params:

output: null

function: hideProgress

params: null

output: null

Alert

function: showAlert

params:

output:

Dialog

function: showDialog

params:

output:

复制到剪切板

function: setClipboard

params:

output: null

扫描二维码

function: scanQRCode

params: null

output:

CUSTOMER

namespace: customer

获取当前钱包类型

function: getCurrentWalletType

params: null

output:

error:

检查当前是否开启了指纹支付

function: checkFingerprintPayment

params: null

output:

EOS

namespace: eos

获取当前账户

function: getCurrentWalletAccount

params: null

output:

error:

获取当前账户余额

function: getCurrentBalance

params:

output:

error:

获取当前账户信息

function: getCurrentAccountInfo

params: null

output: 链上返回的原始数据

error:

获取账户列表

function: getWalletAccounts

params: null

output:

item:

error:

获取余额

function: getBalance

params:

output:

error:

获取账户信息

function: getAccountInfo

params:

output: 链上返回的原始数据

转账

function: transfer

params:

output:

error:

获取交易记录

function: getTransactionRecord

params:

output: 链上返回的原始数据

ETH

namespace: eth

转账

待定