@iota/transaction-converter
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-beta.30 • Public • Published

    @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

    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 the transactions 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 the signatureMessageFragment field of the transaction trytes, use the extractJSON() method.

    Returns: Trytes | Array.<Trytes> - Transaction trytes
    Example

    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 the transaction 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 the asTransactionObjects() method.

    To get a transaction's trytes from the Tangle, use the getTrytes() method.

    Returns: Transaction - transactionObject - A transaction object
    Example

    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 the getTrytes() 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

    Install

    npm i @iota/transaction-converter

    DownloadsWeekly Downloads

    290

    Version

    1.0.0-beta.30

    License

    MIT

    Unpacked Size

    122 kB

    Total Files

    39

    Last publish

    Collaborators

    • brord
    • rubenkoch
    • domschiener
    • lexerr
    • martyniota
    • nothingismagick
    • laumair
    • iota_ci