@iota/transaction-converter
Methods for calculating transaction hashes and converting transaction objects to transaction trytes and back.Installation
Install using npm:npm install @iota/transaction-converter
or using yarn:
yarn add @iota/transaction-converter
API Reference
* _static_
* [.asTransactionTrytes(transactions)](#module_transaction-converter.asTransactionTrytes)
* [.asTransactionObject(transaction)](#module_transaction-converter.asTransactionObject)
* [.asTransactionObjects([hashes])](#module_transaction-converter.asTransactionObjects)
* _inner_
* [~transactionObjectsMapper(trytes)](#module_transaction-converter..transactionObjectsMapper)
transaction-converter.asTransactionTrytes(transactions)
Summary: Converts one or more transaction objects into transaction trytes.Throws:
errors.INVALID\_TRYTES
: Make sure that the object fields in thetransactions
argument contains valid trytes (A-Z or 9).
| Param | Type | Description | | --- | --- | --- | | transactions |
Transaction
\| Array.<Transaction>
| Transaction objects |This method takes one or more transaction objects and converts them into trytes.
Related methods
To get JSON data from thesignatureMessageFragment
field of the transaction trytes, use the extractJSON()
method.Returns:
Trytes
\| Array.<Trytes>
- Transaction trytesExample
let trytes = TransactionConverter.asTransactionTrytes(transactionObject);
transaction-converter.asTransactionObject(transaction)
Summary: Converts transaction trytes into a transaction object.Throws:
errors.INVALID\_TRYTES
: Make sure that the object fields in thetransaction
argument contains valid trytes (A-Z or 9).
| Param | Type | Description | | --- | --- | --- | | transaction |
Trytes
| Transaction trytes |This method takes 2,673 transaction trytes and converts them into a transaction object.
Related methods
To convert more than one transaction into an object at once, use theasTransactionObjects()
method.To get a transaction's trytes from the Tangle, use the
getTrytes()
method.Returns:
Transaction
- transactionObject - A transaction objectExample
let transactionObject = TransactionConverter.asTransactionObject(transactionTrytes);
transaction-converter.asTransactionObjects(hashes)
Summary: Converts one or more transaction trytes into transaction objects.Throws:
errors.INVALID\_TRYTES
: Make sure that transcactions contains valid trytes (A-Z or 9).
| Param | Type | Description | | --- | --- | --- | | hashes |
Array.<Hash>
| Transaction hashes |This method takes an array of transaction hashes and returns a mapper.
If any hashes are given, the mapper function maps them to their converted objects. Otherwise, all hashes are recalculated.
Related methods
To get a transaction's trytes from the Tangle, use thegetTrytes()
method.Returns:
function
- transactionObjectsMapper()
Example
let transactionObjectsMapper = TransactionConverter.asTransactionObjects([hashes]);
transaction-converter~transactionObjectsMapper(trytes)
| Param | Type | Description | | --- | --- | --- | | trytes |Array.<Trytes>
| List of transaction trytes to convert |Maps the list of given hashes to a list of converted transaction objects.
Returns:
Array.<Transaction>
- List of transaction objects with hashes