@secux/protocol-transaction

SecuX Hardware Wallet transcation related protocol API

Usage

import { EllipticCurve, SecuxTransactionTool } from "@secux/protocol-transaction";

First, create instance of ITransport

• Web Usb
• Web Bluetooth
• React Native Bluetooth

Examples

1. Query publickey from SecuX Hardware Wallet

const data = SecuxTransactionTool.getPublickey("m/44'/0'/0'/0/0", EllipticCurve.SECP256K1);
const response = await device.Exchange(data);
const publickey = SecuxTransactionTool.resolvePublickey(
    response, 
    EllipticCurve.SECP256K1,
    true // SECP256K1 compress flag
);

2. Query extended publickey from SecuX Hardware Wallet

const data = SecuxTransactionTool.getXPublickey("m/44'/0'/0'/0/0");
const response = await device.Exchange(data);
const xpub = SecuxTransactionTool.resolveXPublickey(response, "m/44'/0'/0'/0/0");

API Reference

Protocol layer of transaction related method

Kind: global class

• SecuxTransactionTool
  • .resolveResponse(response) ⇒ IAPDUResponse
  • .getPublickey(path, curve) ⇒ communicationData
  • .resolvePublickey(response, curve, compressed) ⇒ string
  • .getXPublickey(path) ⇒ communicationData
  • .resolveXPublickey(response, path) ⇒ string
  • .signTransaction(path, tx, [option]) ⇒ communicationData
  • .resolveSignature(response) ⇒ string
  • .signTransactionList(paths, txs, [otpion]) ⇒ communicationData
  • .resolveSignatureList(response) ⇒ Array.<string>
  • .signRawTransaction(path, tx, [option]) ⇒ communicationData
  • .signRawTransactionList(paths, txs, [confirm], [otpion]) ⇒ communicationData
  • .signMessage(path, msg, [option]) ⇒ communicationData
  • .signTypedMessage(path, typedMessageHash, [option]) ⇒ communicationData
  • .txPrepare(path, inputId, tx, confirm, [isToken]) ⇒ communicationData
  • .txBegin(amount, toAddress, [showConfirm]) ⇒ communicationData
  • .txEnd() ⇒ communicationData
  • .txSign(inputId) ⇒ communicationData

SecuxTransactionTool.resolveResponse(response) ⇒ IAPDUResponse

Resolve response from device.

Returns: IAPDUResponse - response object

SecuxTransactionTool.getPublickey(path, curve) ⇒ communicationData

Query publickey (uncompressed) command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.resolvePublickey(response, curve, compressed) ⇒ string

Reslove publickey from SecuX device.

Returns: string - publickey (base64 encoded)

SecuxTransactionTool.getXPublickey(path) ⇒ communicationData

Query extended publickey command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.resolveXPublickey(response, path) ⇒ string

Reslove extended publickey from SecuX device.

Returns: string - xpub

SecuxTransactionTool.signTransaction(path, tx, [option]) ⇒ communicationData

Sign a hashed transcation command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.resolveSignature(response) ⇒ string

Reslove signature from SecuX device.

Returns: string - signature (base64 encoded)

SecuxTransactionTool.signTransactionList(paths, txs, [otpion]) ⇒ communicationData

Sign hashed transactions command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.resolveSignatureList(response) ⇒ Array.<string>

Reslove signature from SecuX device.

Returns: Array.<string> - signature array of base64 string

SecuxTransactionTool.signRawTransaction(path, tx, [option]) ⇒ communicationData

Sign a transcation command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.signRawTransactionList(paths, txs, [confirm], [otpion]) ⇒ communicationData

Sign transactions command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.signMessage(path, msg, [option]) ⇒ communicationData

Sign message command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.signTypedMessage(path, typedMessageHash, [option]) ⇒ communicationData

Sign typed message command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.txPrepare(path, inputId, tx, confirm, [isToken]) ⇒ communicationData

Deprecated

Send utxo command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.txBegin(amount, toAddress, [showConfirm]) ⇒ communicationData

Deprecated

Begin signing command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.txEnd() ⇒ communicationData

Deprecated

End signing command.

Returns: communicationData - data for sending to device

SecuxTransactionTool.txSign(inputId) ⇒ communicationData

Deprecated

Sign command.

Returns: communicationData - data for sending to device

IAPDUResponse

Properties

StatusCode

Properties

TransactionType

Properties

EllipticCurve

Properties

TransactionOption

Properties

© 2018-21 SecuX Technology Inc.

authors:
andersonwu@secuxtech.com