@acryl/signature-adapter 中文文档教程

Question

JS library for signing data

Installation

$ npm install --save @acryl/signature-adapter

Usage

import { SeedAdapter, SIGN_TYPE } from '@acryl/signature-adapter';
import { Money, Asset } from '@acryl/data-entities';

const asset = new Asset({
   ticker: 'ACRYL',
   id: 'ACRYL',
   name: 'Acryl',
   precision: 8,
   description: '',
   height: 0,
   timestamp: new Date('2016-04-11T21:00:00.000Z'),
   sender: '',
   quantity: 10000000000000000,
   reissuable: false
});

const transferTransactionData = {
   recipient: 'some address or alias',
   amount: Money.fromTokens(1, asset),
   attachment: 'Some attachment text less 140 bytes',
   fee: Money.fromTokens(0.001, asset)
};

const adapter = new SeedAdapter('some seed phrase with 15 or more chars');
const signable = adapter.makeSignable({
   type: SIGN_TYPE.TRANSFER,
   data: transferTransactionData
});

signable.getDataForApi().then(data => fetch('node-url', {
   method: 'POST',
   body: JSON.stringify(data)
}));

适配器用于签署数据。 有两种类型的适配器： SeedAdapter - 是一个适配器，用于在字符串表示中使用种子 LedgerAdapter - 是与 Ledger 硬件钱包一起使用的适配器

SeedAdapter

SeedAdapter 接受助记词或包含有关创建助记词信息的对象 对象结构： encryptedSeed {string} - 用密码编码的种子短语 password {string} - 加密助记词的密码 encryptionRounds {number} - 加密复杂性

要更改网络字节，请使用 @acryl/signature-generator 配置：

import { config } from '@acryl/signature-generator';

config.set('networkByte', 'K'.charCodeAt(0))

如果您使用种子短语创建 SeedAdapter，请注意短语的最小长度为 15 个字符。 有关详细信息，请参阅文档@acryl/signature-generator

使用助记词创建 SeedAdapter 的示例：

import { SeedAdapter } from '@acryl/signature-adapter';

const adapter = new SeedAdapter('some seed phrase more 15 chars');

LedgerAdapter

SeedAdapter 在创建时接受一个对象，该对象包含有关 Ledger 中的地址和钱包 ID 的信息 对象结构：

• publicKey {string} - public key for the address
• address {string} - address
• id {number} - wallet ID in Ledger

要获取用于创建 LedgerAdapter 实例的对象，有类“getUserList”的静态方法。

• getUserList(from?: number, to?: number): Promise>;

其中“from”是 Ledger 中的钱包 ID，从中开始接收数据，“to”- 完成的数字。

示例：

import { LedgerAdapter } from '@acryl/signature-adapter';

LedgerAdapter.getUserList().then(([userData]) => new LedgerAdapter(userData));

Common methods for both types of adapters

• isAvailable(): Promise\; 返回 promise，它在适配器不可用时返回错误。

• getPublicKey(): Promise\<字符串>; 返回公钥

• getAddress(): Promise\; 返回地址

• getPrivateKey(): Promise\; 返回私钥或错误如果适配器无法返回它（在 LedgerAdapter 的情况下）

• signRequest(bytes: Uint8Array): Promise\; 接受用于签名的字节数组，返回带有签名的承诺。 此方法用于签署除交易和订单之外的任何数据

• signTransaction(bytes: Uint8Array): Promise\; 接受用于签名的字节数组，返回带有签名的承诺。 该方法用于签署交易

• signOrder(bytes: Uint8Array): Promise\; 接受用于签名的字节数组，返回带有签名的承诺。 该方法用于签署订单

• signData(bytes: Uint8Array): Promise\; 接受用于签名的字节数组，返回带有签名的承诺。 此方法用于签署任何数据 由于 Ledger 上的确认显示不正确，不建议使用此方法签署交易

• getSeed(): Promise\; 返回种子短语或错误如果适配器无法返回它（在 LedgerAdapter 的情况下）

• makeSignable(signData): Signable; 接受签名数据（访问interfaces获取更多关于“ TSignData”接口）并返回 Signable 类

Signable

• getTxData(): {object} 的一个实例； 返回为签名传输的对象数据的副本

• getSignData(): Promise\

• 数据 接受签名以将其添加到签名列表。 签名列表用于“getDataForApi”方法

• getId(): Promise\; 返回带有用于签名的所有数据的散列的承诺

• sign(): Promise\; 方法启动签名并返回等待签名完成的承诺。 此方法在 Signable 类的一个实例的生命周期内仅添加一个签名。 当您再次调用它时，它会返回一个先前创建的承诺

• getSignature(): Promise\; 与 sign() 方法相同，但返回带有签名

• getBytes() 的承诺：Promise\; 返回用于签名的字节

• getMyProofs(): Promise\>; 返回属于适配器公钥的签名数组，从中创建类 Signable 的实例

• hasMySignature(): Promise\; 返回具有关于“自己的”签名存在的布尔状态的承诺（与“getMyProofs”方法中的相同）

• addMyProof(): Promise\; 此方法检查“自己”签名的存在。 如果签名存在，它返回最后一个“自己的”签名，否则它签名并返回新的签名

• getDataForApi():Promise\