@stellar-expert/tx-meta-effects-parser 8.0.0 → 8.2.0

package/README.MD

@@ -108,7 +108,8 @@ parseTxOperationsMeta({
   source: 'GBKP…YDLI',
   asset: 'XLM',
   bid: '10000',
-  charged: '100'
+  charged: '100',
+  balance: '99999999900'
 }
 ```
 </td>
@@ -152,7 +153,7 @@ parseTxOperationsMeta({
 <sub><code>accountDebited</code></sub>
 </td>
 <td><sub>CreateAccountOp, AccountMergeOp, PaymentOp, PathPaymentStrictReceiveOp,
-PathPaymentStrictSendOp, CreateClaimableBalanceOp, ClawbackOp</sub></td>
+PathPaymentStrictSendOp, CreateClaimableBalanceOp, ClawbackOp, InvokeHostFunctionOp</sub></td>
 <td>
 
 ```js
@@ -160,7 +161,8 @@ PathPaymentStrictSendOp, CreateClaimableBalanceOp, ClawbackOp</sub></td>
   type: 'accountDebited',
   source: 'GBKP…YDLI',
   asset: 'XLM',
-  amount: '1000000000'
+  amount: '1000000000',
+  balance: '199999999900'
 }
 ```
 </td>
@@ -172,7 +174,7 @@ PathPaymentStrictSendOp, CreateClaimableBalanceOp, ClawbackOp</sub></td>
 </td>
 <td><sub>CreateAccountOp, AccountMergeOp, PaymentOp, PathPaymentStrictReceiveOp,
 PathPaymentStrictSendOp, ClaimClaimableBalanceOp, ClawbackOp, 
-ClawbackClaimableBalance, InflationOp</sub></td>
+ClawbackClaimableBalance, InflationOp, InvokeHostFunctionOp</sub></td>
 <td>
 
 ```js
@@ -180,7 +182,8 @@ ClawbackClaimableBalance, InflationOp</sub></td>
   type: 'accountCredited',
   source: 'GBWC…DXHN',
   asset: 'XLM',
-  amount: '1000000000'
+  amount: '1000000000',
+  balance: '299999999900'
 }
 ```
 </td>
@@ -412,7 +415,7 @@ ClawbackClaimableBalance, InflationOp</sub></td>
 <sub><code>assetMinted</code></sub>
 </td>
 <td><sub>PaymentOp, PathPaymentStrictReceiveOp, PathPaymentStrictSendOp, CreateClaimableBalanceOp,
-ManageBuyOfferOp, ManageSellOfferOp, CreatePassiveOfferOp, DepositLiquidityOp</sub></td>
+ManageBuyOfferOp, ManageSellOfferOp, CreatePassiveOfferOp, DepositLiquidityOp, InvokeHostFunctionOp</sub></td>
 <td>
 
 ```js
@@ -432,8 +435,7 @@ ManageBuyOfferOp, ManageSellOfferOp, CreatePassiveOfferOp, DepositLiquidityOp</s
 <sub><code>assetBurned</code></sub>
 </td>
 <td><sub>PaymentOp, PathPaymentStrictReceiveOp, PathPaymentStrictSendOp, CreateClaimableBalanceOp, ManageBuyOfferOp, ManageSellOfferOp,
-CreatePassiveOfferOp, WithdrawLiquidityOp, ClawbackOp,
-ClaimClaimableBalanceOp</sub></td>
+CreatePassiveOfferOp, WithdrawLiquidityOp, ClawbackOp, ClaimClaimableBalanceOp, InvokeHostFunctionOp</sub></td>
 <td>
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar-expert/tx-meta-effects-parser",
-  "version": "8.0.0",
+  "version": "8.2.0",
   "description": "Low-level effects parser for Stellar transaction results and meta XDR",
   "main": "src/index.js",
   "scripts": {

package/src/effects-analyzer.js

@@ -2,7 +2,12 @@ const {StrKey, hash, xdr, nativeToScVal} = require('@stellar/stellar-base')
 const effectTypes = require('./effect-types')
 const {validateAmount, normalizeAddress, parseLargeInt} = require('./parser/normalization')
 const {parseLedgerEntryChanges} = require('./parser/ledger-entry-changes-parser')
-const {xdrParseAsset, xdrParseAccountAddress, xdrParseScVal} = require('./parser/tx-xdr-parser-utils')
+const {
+    xdrParseAsset,
+    xdrParseAccountAddress,
+    xdrParseScVal,
+    xdrParseSacBalanceChange
+} = require('./parser/tx-xdr-parser-utils')
 const {contractIdFromPreimage} = require('./parser/contract-preimage-encoder')
 const {generateContractCodeEntryHash} = require('./parser/ledger-key')
 const {analyzeSignerChanges} = require('./aggregation/signer-changes-analyzer')
@@ -803,33 +808,6 @@ class EffectsAnalyzer {
         this.addEffect(effect)
     }
 
-    processContractBalance(effect) {
-        const parsedKey = xdr.ScVal.fromXDR(effect.key, 'base64')
-        if (parsedKey._arm !== 'vec')
-            return
-        const keyParts = parsedKey._value
-        if (!(keyParts instanceof Array) || keyParts.length !== 2)
-            return
-        if (keyParts[0]._arm !== 'sym' || keyParts[1]._arm !== 'address' || keyParts[0]._value.toString() !== 'Balance')
-            return
-        const account = xdrParseScVal(keyParts[1])
-        const balanceEffects = this.effects.filter(e => (e.type === effectTypes.accountCredited || e.type === effectTypes.accountDebited) && e.source === account && e.asset === effect.owner)
-        if (balanceEffects.length !== 1) //we can set balance only when we found 1-1 mapping, if there are several balance changes, we can't establish balance relation
-            return
-        if (effect.type === effectTypes.contractDataRemoved) { //balance completely removed - this may be a reversible operation if the balance simply expired
-            balanceEffects[0].balance = '0'
-            return
-        }
-        const value = xdr.ScVal.fromXDR(effect.value, 'base64')
-        if (value._arm !== 'map')
-            return
-        const parsedValue = xdrParseScVal(value)
-        if (typeof parsedValue.clawback !== 'boolean' || typeof parsedValue.authorized !== 'boolean' || typeof parsedValue.amount !== 'string')
-            return
-        //set transfer effect balance
-        balanceEffects[0].balance = parsedValue.amount
-    }
-
     processContractChanges({action, before, after}) {
         const {kind, owner: contract, keyHash} = after
         let effect = {
@@ -906,7 +884,13 @@ class EffectsAnalyzer {
                 break
         }
         this.addEffect(effect)
-        this.processContractBalance(effect)
+        const tokenBalance = xdrParseSacBalanceChange(effect.type, key, after?.value, before?.value)
+        if (tokenBalance) {
+            const balanceEffects = this.effects.filter(e => e.source === tokenBalance.address &&
+                (e.type === effectTypes.accountCredited || e.type === effectTypes.accountDebited) &&
+                (e.asset === effect.owner || e.asset === this.sacMap?.get(effect.owner)))
+            balanceEffects[balanceEffects.length - 1].balance = tokenBalance.balance //set latest transfer effect balance
+        }
     }
 
     processContractCodeChanges({type, action, before, after}) {

package/src/index.js

@@ -129,6 +129,9 @@ function parseTxOperationsMeta({
             effect.source = (before || after).address
             res.effects.push(effect)
         }
+        if (feeEffect.source === after.address) {
+            feeEffect.balance = after.balance
+        }
         if (isFeeBump && protocol === 20 && before.balance !== after.balance) { //bump fee calculation bug in protocol v20
             const currentFee = BigInt(feeEffect.charged)
             const diff = BigInt(after.balance) - BigInt(before.balance)

package/src/parser/tx-xdr-parser-utils.js

@@ -1,5 +1,13 @@
-const {xdr, StrKey, LiquidityPoolId, scValToBigInt, encodeMuxedAccount, encodeMuxedAccountToAddress} = require('@stellar/stellar-base')
+const {
+    xdr,
+    StrKey,
+    LiquidityPoolId,
+    scValToBigInt,
+    encodeMuxedAccount,
+    encodeMuxedAccountToAddress
+} = require('@stellar/stellar-base')
 const {TxMetaEffectParserError} = require('../errors')
+const effectTypes = require('../effect-types')
 
 /**
  * Parse account address from XDR representation
@@ -285,6 +293,36 @@ function xdrParseScVal(value, treatBytesAsContractId = false) {
     }
 }
 
+function xdrParseSacBalanceChange(changeEventType, key, value) {
+    const parsedKey = xdr.ScVal.fromXDR(key, 'base64')
+    if (parsedKey._arm !== 'vec')
+        return null
+    const keyParts = parsedKey._value
+    if (!(keyParts instanceof Array) || keyParts.length !== 2)
+        return null
+    if (keyParts[0]._arm !== 'sym' || keyParts[1]._arm !== 'address' || keyParts[0]._value.toString() !== 'Balance')
+        return null
+    const res = {
+        address: xdrParseScVal(keyParts[1]),
+        balance: changeEventType===effectTypes.contractDataRemoved?
+            '0':
+            retrieveBalanceFromStateData(value)
+    }
+    if (res.balance === undefined)
+        return null
+    return res
+}
+
+function retrieveBalanceFromStateData(value) {
+    const xdrVal = xdr.ScVal.fromXDR(value, 'base64')
+    if (xdrVal._arm !== 'map')
+        return undefined
+    const parsedValue = xdrParseScVal(xdrVal)
+    if (typeof parsedValue.amount !== 'string')
+        return undefined
+    return parsedValue.amount
+}
+
 module.exports = {
     xdrParseAsset,
     xdrParseAccountAddress,
@@ -295,5 +333,6 @@ module.exports = {
     xdrParseTradeAtom,
     xdrParseSignerKey,
     xdrParsePrice,
-    xdrParseScVal
+    xdrParseScVal,
+    xdrParseSacBalanceChange
 }