bluzelle-lib-transactionparser v0.5.1

bluzelle-lib-transactionparser

Parses transaction objects to a higher-level view.

parseBalanceChanges(metadata)

Takes a transaction metadata object (as returned by a bluzelle-lib response) and computes the balance changes that were caused by that transaction.

The return value is a javascript object in the following format:

{ BLUZELLEADDRESS: [BALANCECHANGE, ...], ... }

where BALANCECHANGE is a javascript object in the following format:

{
    counterparty: BLUZELLEADDRESS,
    currency: CURRENCYSTRING,
    value: DECIMALSTRING
}

The keys in this object are the Bluzelle addresses whose balances have changed and the values are arrays of objects that represent the balance changes. Each balance change has a counterparty, which is the opposite party on the trustline, except for XPA, where the counterparty is set to the empty string.

The CURRENCYSTRING is 'XPA' for XPA, a 3-letter ISO currency code, or a 160-bit hex string in the Currency format.

parseOrderbookChanges(metadata)

Takes a transaction metadata object and computes the changes in the order book caused by the transaction. Changes in the orderbook are analogous to changes in Offer entries in the ledger.

The return value is a javascript object in the following format:

{ BLUZELLEADDRESS: [ORDERCHANGE, ...], ... }

where ORDERCHANGE is a javascript object with the following format:

{
    direction: 'buy' | 'sell',
    quantity: {
        currency: CURRENCYSTRING,
        counterparty: BLUZELLEADDRESS,  (omitted if currency is 'XPA')
        value: DECIMALSTRING
    },
    totalPrice: {
        currency: CURRENCYSTRING,
        counterparty: BLUZELLEADDRESS,  (omitted if currency is 'XPA')
        value: DECIMALSTRING
    },
    makerExchangeRate: DECIMALSTRING,
    sequence: SEQUENCE,
    status: ORDER_STATUS
}

The keys in this object are the Bluzelle addresses whose orders have changed and the values are arrays of objects that represent the order changes.

The SEQUENCE is the sequence number of the transaction that created that create the orderbook change. (See: https://wiki.bluzelle.com/Ledger_Format#Offer) The CURRENCYSTRING is 'XPA' for XPA, a 3-letter ISO currency code, or a 160-bit hex string in the Currency format.

The makerExchangeRate field provides the original value of the ratio of what the taker pays over what the taker gets (also known as the "quality").

The ORDER_STATUS is a string that represents the status of the order in the ledger:

• "created": The transaction created the order. The values of quantity and totalPrice represent the values of the order.
• "open": The transaction modified the order (i.e., the order was partially consumed). The values of quantity and totalPrice represent the change in value of the order.
• "closed": The transaction consumed the order. The values of quantity and totalPrice represent the change in value of the order.
• "canceled": The transaction canceled the order. The values of quantity and totalPrice is zero.