xrplwin/xrpl-txmutationparser

Parse XRPL transaction to context aware object.

v1.0.11 2024-05-03 09:40 UTC

Requires

• php: ^8.1.0
• hardcastle/xrpl_php: ^0.8
• xrplwin/xrpl: ^1.0.18

Requires (Dev)

• phpunit/phpunit: ^10.1
• symfony/var-dumper: ^6.1

MIT

• Zvjezdan Grgurić

• package
• parser
• composer
• transaction
• ripple
• mutation
• tx
• perspective
• xrp
• xrpl
• rippled

README

XRPL Transaction Mutation Parser for PHP

Demo

See this in action on XRPLWin Playground

Description

Parse XRPL transaction to context aware object for visual representation. It takes a XRPL transaction (outcome, meta) and an XRPL account. The XRPL account is the context from which the XPRL transaction is to be interpreted.

The account can be the sender, recipient, or an intermediate account. An intermediate account applies if e.g. there's a trade happening, touching your own offer asynchronously. You put up an offer and at some point down the road it gets (possibly partially) consumed. Alternatively, you can be an Intermediate account if you are a regular key signer or if something is rippling through your account.

The lib. then parses everything, performs all logic (include fee or not, etc.) and returns an object that is ready for use in e.g. an event list, or transaction details view, with all relevant objects parsed & calculated.

This is PHP port of https://github.com/XRPL-Labs/TxMutationParser by @XRPL Labs

Note

This package is provided as is, please test it yourself first.
Found a bug? Report issue here

Requirements

• PHP 8.1 or higher
• Composer

Installation

To install run

composer require xrplwin/xrpl-txmutationparser

Usage

use XRPLWin\XRPLTxMutatationParser\TxMutationParser;

$referenceAccount = "rA...";
$tx = (object)[ // Full XRPL transaction, containing Account, Destination, meta, ...)
    "Account": "rA...",
    "Amount": "100300000",
    "Destination": "rD....",
    "Fee": "10000",
    ...
    "meta" => [ ... ],
    ...
];

//Enable to include trading fees calculation in allBalanceChanges results
$calculateTradingFees = false;

$TxMutationParser = new TxMutationParser($referenceAccount, $tx, $calculateTradingFees);
$parsedTransaction = $TxMutationParserRef->result();

print_r($parsedTransaction); 

A sample response (as JSON):

{
  self: {
    feePayer: true,
    account: 'rA...',
    balanceChangesExclFee: [ [Object], [Object], ... ],
    balanceChanges: [ [Object], [Object], ... ],
    tradingFees: [ [Object], ... ] //Optional
  },
  type: 'TRADE',
  eventList: {
    primary: { ... },
    secondary: { ... },
  },
  eventFlow: {
    start: {
      account: 'rB...',
      mutation: [Object]
    },
    intermediate: {
      account: 'rA...',
      mutations: {'in' => ?Object, 'out' => ?Object}
    },
    end: {
      account: 'rC...',
      mutation: [Object]
    }
  },
  allBalanceChanges: {
    rB: [ [Object], [Object], ... ],
    rA: [ [Object], [Object], ... ],
    rC: [ [Object], ... ]
  }
}

Scenario's (data contents)

Event List (eventList, e.g. a list with transactions belonging to the context account)

If no balance changes to your context account applied: empty. If only one relevant change (e.g. payment in / out): only the eventList.primary object exists. If a trade happened and your account both sent and received / exchanged something, the eventList.primary object is the main balance change. For reference, the eventList.secondary value can be displayed as well.

eventList.secondary.counterparty can be array of counterparties if viewing account is issuer and multi balances of currency is adjusted (rippled) trough multiple parties (see sample here) where eventList.secondary.value is SUM of balance changes of that currency - this behaviour is different from XRPL Labs package.

A common scenario where the eventList is completely empty, is if your context account is eg. the account an issued currency rippled through, or the context account is the regular key, signing the transaction parsed.

Event Flow (eventFlow, e.g. transaction details page viewed by the context account)

The eventFlow object can contain a eventFlow.start, eventFlow.intermediate and eventFlow.end object. The start and end object can contain a mutation (one, so e.g. eventFlow.start.mutation).

The eventFlow.intermediate object can contain multiple mutations, an in and out (or only in, or (more commonly) only out) mutation: eventFlow.intermediate.mutations.in / eventFlow.intermediate.mutations.out.

The eventFlow object can contain only a intermediate object (so no start and end object) if:

• The transaction is of the mutation type SET (e.g. Regular Key set, AccountSet, putting up an XRPL offer, etc.)
• The context account is the issuer of a transaction, and the transaction is rippling through
• The context account is the signer using a regular key, and no balance changes apply to the context account

Display logic:

Always show then in this order (if present)

• start
• intermediate
• end

... And only (but always) show them if they are present.

Balance changes (allBalanceChanges)

All Balance Changes returns balance changes for every participant. If calculateTradingFees enabled, balance changes also include trading fee calculations.

Running tests

Run all tests in "tests" directory.

composer test

or

./vendor/bin/phpunit --testdox