Aelf-bridge NPM

aelf-bridge

中文 | English

简介

为了给dApps提供与链交互的能力，同时为了保护钱包信息，隔离dApps与钱包信息，aelf-bridge可用于与钱包App之间的交互，钱包App保存有AElf的钱包信息，能够与AElf链直接交流。

此处描述的钱包App可能包括移动端(iOS/Android)原生App，桌面版应用等。

为减少与aelf-sdk之间的API差异，同构了aelf-bridge与aelf-sdk之间绝大多数的API使用逻辑

安装

aelf-bridge是AElf生态的一环，由于dApps大多为Web应用，因此提供JavaScript的版本，使用Npm作为版本管理工具。

使用版本管理工具

npm i aelf-bridge
// or
yarn add aelf-bridge

使用script标签

<script src="https://unpkg.com/aelf-bridge@latest/dist/aelf-bridge.js"></script>

使用

概述

dApp与链的通信需要通过钱包信息的保存者，这个保存者可以是任一一个实现了AElf bridge桥接协议的客户端，目前(2019.12)AElf移动端钱包提供了此项功能。

dApp多为Web应用，Web应用与端的通信方式有多种，本SDK选取了其中的两种实现：

postMessage: 由运行dApp的容器（iframe或者移动端webview）覆盖dapp的window.postMessage方法，dApp使用覆盖的方法发送消息至容器，容器同样使用postMessage方法发送消息至dApp。
WebSocket(Socket.io)：使用传统的B/S架构，通过WebSocket的方式进行通信。SDK使用Socket.io用于支持WebSocket通信，需要服务端同样支持Socket.io协议的WebSocket实现。

开发者可以根据情况选择通信方式，在开发过程中，为便于Mock和调试功能，可以使用目前提供的两种方式进行调试:

aelf-bridge-demo: 此demo使用iframe复写了dapp.html的postMessage方法，模拟了移动端的通信；
aelf-command dapp-server: aelf-command提供了一个简单的socket.io服务器，可用于aelf-bridge的socket.io的通信方式，可以先将开发的dApp的通信方式改成SOCKET.IO，并在初始化aelf-bridge实例时，指定运行aelf-command dapp-server给定的地址。这样便可以在浏览器的网络请求中看到相应的通信。

初始化

import AElfBridge from 'aelf-bridge';

// 初始化实例，初始化时可传入选项，用于指定行为，具体看下方解释
const bridgeInstance = new AElfBridge();
// 可传入选项
const bridgeInstance = new AElfBridge({
  timeout: 5000 // ms, 毫秒
});

// 初始化实例后需要进行连接，与需要通信的端交换公钥，传递appId等，如若不手动connect，发送信息前会自动建立connection
bridgeInstance.connect().then(isConnected => {
  // isConnected 为true时表示连接成功
})

选项

可传入的选项列表如下

const defaultOptions = {
  proxyType: String, // 默认为`POST_MESSAGE`，与客户端的通信方式，目前仅提供`POST_MESSAGE`和`SOCKET.IO`两种通信机制，未来还会提供`Websocket`机制。有效值可通过`AElfBridge.getProxies()`获取。
  channelType: String, // 默认为`SIGN`，请求与响应的序列化方式，即dApp与客户端互相交换公私钥，通过私钥签名，公钥验证签名信息，从而验证信息是否被篡改。另提供对称加密的方式，参数值为`ENCRYPT`，使用共享公钥进行对称加密。参数有效值通过`AElfBridge.getChannels()`获取。
  timeout: Number, // 默认为`3000`，请求的超时时间，单位为毫秒，目前只支持一个全局的超时时间。
  appId: String, // 默认为空，dApps无特殊需求的情况下不指定即可，如需指定，需要每次随机产生一个32位hex编码的id。用于与客户端通信的凭证，指定dApp ID。未指定的情况下，本library内部会进行处理，首次运行产生一个随机的32位hex编码的uuid，连接成功后存入`localStorage`，之后则从`localStorage`中取值，如无，则再产生随机id。
  endpoint: String, // 默认为空，链节点的地址，为空的情况下，客户端默认使用内部保存的主链地址，也可指定向特定的节点发送请求。
  // `POST_MESSAGE`通信方式下可选的选项
  origin: String, // 默认为`*`，`postMessage`函数的第二参数，绝大多数情况下不需要指定
  checkoutTimeout: Number, // 默认为`200`，单位毫秒，检查客户端注入的`postMessage`，绝大多数情况下不需要指定
  urlPrefix: String, // 默认为`aelf://aelf.io?params=`，序列化后的信息需要通信的协议头，用于客户端做区分，如果客户端没有特殊改变的情况下，不需要改变
  // `socket.io`通信方式下可选的选项
  socketUrl: String, // websocket连接的地址，默认为`http://localhost:50845`
  socketPath: String, // 连接地址的path，默认为空
  messageType: String // 传递socket.io消息的type，默认为`bridge`
}

获取钱包账户信息

bridgeInstance.account()

bridgeInstance.account().then(res => {
  console.log(res);
})
res = {
  "accounts": [
    {
      "name": "test",
      "address": "XxajQQtYxnsgQp92oiSeENao9XkmqbEitDD8CJKfDctvAQmH6"
    }
   ],
  "chains": [
    {
      "url": "http://13.231.179.27:8000",
      "isMainChain": true,
      "chainId": "AELF"
    },
    {
      "url": "http://52.68.97.242:8000",
      "isMainChain": false,
      "chainId": "2112"
    },
    {
      "url": "http://52.196.227.200:8000",
      "isMainChain": false,
      "chainId": "2113"
    }
  ]
}

调用链API

用于调用链节点的API. API列表可通过{链地址}/swagger/index.html查看，目前支持的API可以通过： AElfBridge.getChainApis()获取支持的列表。支持部分aelf-sdk实例下chain属性下的方法，具体支持列表可通过AElfBridge.getChainMethods()获取。

bridgeInstance.chain[methodName](params)

params参数与aelf-sdk实例下chain属性中的同名方法一致:

示例：

获取区块高度

bridgeInstance.chain.getBlockHeight().then(console.log).catch(console.log)

获取区块状态

bridgeInstance.chain.getChainStatus().then(console.log).catch(console.log)

调用合约方法(只读与发送交易)

获取合约方法
发送交易
合约只读方法

示例：

调用Token合约的Transfer方法，发起一笔转账交易

const tokenAddress = 'mS8xMLs9SuWdNECkrfQPF8SuRXRuQzitpjzghi3en39C3SRvf'; // 合约地址可通过零合约的`GetContractAddressByName`只读方法获取
bridgeInstance.chain.contractAt(tokenAddress).then(async contract => {
    const tokenInfo = await contract.GetTokenInfo.call({symbol: 'ELF'});
    const transactionId = await contract.Transfer({
          amount: "10000000000",
          to: "fasatqawag",
          symbol: "ELF",
          memo: "transfer ELF"
    });
    console.log(transactionId);
})