@acryl/ledger 中文文档教程

Question

Acryl sign data by ledger in browser

Install

$ npm install --save @acryl/ledger

Usage

Create connection

const AcrylLedger = require('@acryl/ledger');
const ledger = new AcrylLedger();

AcrylLedger 可以有可选参数。

    import TransportNodeHid from '@ledgerhq/hw-transport-node-u2f';

    const options = {
        debug: true, //boolean,
        openTimeout: 3000, //number,
        listenTimeout: 30000, //number,
        exchangeTimeout: 30000, //number,
        networkCode: 65, //number,
        transport: TransportNodeHid
    };

    const ledger = new AcrylLedger(options);

Where:

debug 是否启用二进制交换日志。 openTimeout 是等待连接的延迟数（以毫秒为单位）。
listenTimeout 是等待 U2F 设备监听请求的延迟数（以毫秒为单位）。
exchangeTimeout 是交换调用的超时（以毫秒为单位）。 只有一些传输可能会实现它。 （例如 U2F）。
networkCode 是 Acryl 网络代码（65 - 对于 mainet）
transport 是 U2F 传输实现。 （默认为 hw-transport-u2f）

• @ledgerhq/hw-transport-u2f
• @ledgerhq/hw-transport-webusb
• @ledgerhq/hw-transport-web-ble
• @ledgerhq/hw-transport-http

阅读有关传输的信息

AcrylLedger API

• probeDevice

  probeDevice(): Promise。 如果设备可用且准备就绪，则 Promise 返回 true。

    const canIUse = async () => {
        return await ledger.probeDevice();
    }
  

• tryConnect

  tryConnect()：Promise<>。 重新连接到传输和初始化分类帐库。

  ```js 常量 isLedgerReady = async () => { 尝试 { 返回 await ledger.tryConnect(); } 抓住 (e) { ///…错误处理程序 } };

• getUserDataById

  getUserDataById(id): Promise<用户>。 从分类帐中获取用户，其中用户是： { id: number, path: string, acrylAddress: string, publicKey: string }

  id - 是从 0 开始的数字
  路径 - 是内部分类帐格式的字符串
  acrylAddress - 是 base58 格式的字符串
  publicKey - 是 base58 格式的字符串

  ledger.getUserDataById(id)
      .then(
          (user) => {...},
          (err) => {...}
      );
  

• signTransaction

  Sign acryl transaction bytes (ledger show detailed transaction info)

      ledger.signTransaction(userId, asset, data)
  

  userId - number
  数据 - Array数字形式 0 到 255 asset - {precision: number, …}

  结果是带有 base58 格式签名字符串的 Promise

• signSomeData

  签署任何字节（账本不能显示详细信息）

    ledger.signSomeData(userId, data)
  

  userId - number
  data - Arraynumber form 0 to 255

  Result is Promise with signature string in base58 format

• signRequest

  签署任何字节（账本不能显示详细信息）

    ledger.signRequest(userId, data)
  

  userId - number
  data - Arraynumber form 0 to 255

  结果是 Promise with base58 format signature string

• signMessage

  Sign any string (ledger can't show detail info)

  ledger.signMessage(userId, data)
  

  userId - number
  data - string

  结果是带有 base58 格式签名字符串的 Promise