@stellar-expert/tx-meta-effects-parser 7.0.0 → 8.1.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
@@ -535,7 +537,7 @@ ClaimClaimableBalanceOp</sub></td>
 {
   type: 'liquidityPoolCreated',
   source: 'GBWC…DXHN',
-  pool: '52a8…76f8',
+  pool: 'LA7F…HJLT',
   reserves: [
     {
       asset: 'XLM',
@@ -565,7 +567,7 @@ ClaimClaimableBalanceOp</sub></td>
 {
   type: 'liquidityPoolUpdated',
   source: 'GBWC…DXHN',
-  pool: '52a8…76f8',
+  pool: 'LA7F…HJLT',
   reserves: [
     {
       asset: 'XLM',
@@ -595,7 +597,7 @@ ClaimClaimableBalanceOp</sub></td>
 {
   type: 'liquidityPoolDeposited',
   source: 'GBWC…DXHN',
-  pool: '52a8…76f8',
+  pool: 'LA7F…HJLT',
   assets: [
     {
       asset: 'XLM',
@@ -625,7 +627,7 @@ ClaimClaimableBalanceOp</sub></td>
 {
   type: 'liquidityPoolWithdrew',
   source: 'GBWC…DXHN',
-  pool: '52a8…76f8',
+  pool: 'LA7F…HJLT',
   assets: [
     {
       asset: 'XLM',
@@ -655,7 +657,7 @@ ClaimClaimableBalanceOp</sub></td>
 {
   type: 'liquidityPoolRemoved',
   source: 'GBWC…DXHN',
-  pool: '52a8…76f8'
+  pool: 'LA7F…HJLT'
 }
 ```
 
@@ -792,7 +794,7 @@ ClaimClaimableBalanceOp</sub></td>
   type: 'claimableBalanceCreated',
   source: 'GBWC…DXHN',
   sponsor: 'GBWC…DXHN',
-  balance: '7aba…6f9d',
+  balance: 'BDKD…F75Y',
   asset: 'XLM',
   amount: '1000000000',
   claimants: [
@@ -821,7 +823,7 @@ ClaimClaimableBalanceOp</sub></td>
   type: 'claimableBalanceRemoved',
   source: 'GBKP…YDLI',
   sponsor: 'GBWC…DXHN',
-  balance: '7aba…6f9d',
+  balance: 'BDKD…F75Y',
   asset: 'XLM',
   amount: '1000000000',
   claimants: [
@@ -1198,61 +1200,6 @@ ClaimClaimableBalanceOp</sub></td>
 </td>
 </tr>
 
-<tr>
-<td>
-<sub><code>liquidityPoolSponsorshipCreated</code></sub>
-</td>
-<td><sub>ChangeThrustOp</sub></td>
-<td>
-
-```js
-{
-  type: 'liquidityPoolSponsorshipCreated',
-  source: 'GBWC…DXHN',
-  sponsor: 'GBWC…DXHN'
-}
-```
-
-</td>
-</tr>
-
-<tr>
-<td>
-<sub><code>liquidityPoolSponsorshipUpdated</code></sub>
-</td>
-<td><sub>RevokeSponsorshipOp</sub></td>
-<td>
-
-```js
-{
-  type: 'liquidityPoolSponsorshipUpdated',
-  source: 'GBWC…DXHN',
-  sponsor: 'GDNP…CMXH',
-  prevSponsor: 'GBWC…DXHN'
-}
-```
-
-</td>
-</tr>
-
-<tr>
-<td>
-<sub><code>liquidityPoolSponsorshipRemoved</code></sub>
-</td>
-<td><sub>RevokeSponsorshipOp</sub></td>
-<td>
-
-```js
-{
-  type: 'liquidityPoolSponsorshipRemoved',
-  source: 'GBWC…DXHN',
-  prevSponsor: 'GBWC…DXHN'
-}
-```
-
-</td>
-</tr>
-
 <tr>
 <td>
 <sub><code>contractCodeUploaded</code></sub>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar-expert/tx-meta-effects-parser",
-  "version": "7.0.0",
+  "version": "8.1.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,13 @@ 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,
+    xdrParseSacBalance,
+    xdrParseTokenBalance
+} = 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')
@@ -344,14 +350,14 @@ class EffectsAnalyzer {
     }
 
     liquidityPoolDeposit() {
-        const {liquidityPoolId} = this.operation
-        const change = this.changes.find(ch => ch.type === 'liquidityPool' && ch.action === 'updated' && ch.after.pool === liquidityPoolId)
+        const pool = StrKey.encodeLiquidityPool(Buffer.from(this.operation.liquidityPoolId, 'hex'))
+        const change = this.changes.find(ch => ch.type === 'liquidityPool' && ch.action === 'updated' && ch.after.pool === pool)
         if (!change) //tx failed
             return
         const {before, after} = change
         this.addEffect({
             type: effectTypes.liquidityPoolDeposited,
-            pool: this.operation.liquidityPoolId,
+            pool,
             assets: after.asset.map((asset, i) => ({
                 asset,
                 amount: (after.amount[i] - before.amount[i]).toString()
@@ -362,7 +368,7 @@ class EffectsAnalyzer {
     }
 
     liquidityPoolWithdraw() {
-        const pool = this.operation.liquidityPoolId
+        const pool = StrKey.encodeLiquidityPool(Buffer.from(this.operation.liquidityPoolId, 'hex'))
         const change = this.changes.find(ch => ch.type === 'liquidityPool' && ch.action === 'updated' && ch.before.pool === pool)
         if (!change) //tx failed
             return
@@ -481,7 +487,7 @@ class EffectsAnalyzer {
                 asset: claimedOffer.asset
             }
             if (claimedOffer.poolId) {
-                trade.pool = claimedOffer.poolId.toString('hex')
+                trade.pool = StrKey.encodeLiquidityPool(claimedOffer.poolId)
             } else {
                 trade.offer = claimedOffer.offerId
                 trade.seller = claimedOffer.account
@@ -803,33 +809,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 +885,15 @@ class EffectsAnalyzer {
                 break
         }
         this.addEffect(effect)
-        this.processContractBalance(effect)
+        const tokenBalance = xdrParseTokenBalance(effect)
+        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)))
+            if (balanceEffects.length !== 1)
+                return //we can set balance only when we found 1-1 mapping, if there are several balance changes, we can't establish balance relation
+            balanceEffects[0].balance = tokenBalance.balance //set 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/ledger-entry-changes-parser.js

@@ -1,6 +1,12 @@
 const {StrKey} = require('@stellar/stellar-base')
 const {TxMetaEffectParserError, UnexpectedTxMetaChangeError} = require('../errors')
-const {xdrParseAsset, xdrParseAccountAddress, xdrParseClaimant, xdrParsePrice, xdrParseSignerKey} = require('./tx-xdr-parser-utils')
+const {
+    xdrParseAsset,
+    xdrParseAccountAddress,
+    xdrParseClaimant,
+    xdrParsePrice,
+    xdrParseSignerKey
+} = require('./tx-xdr-parser-utils')
 const {generateContractStateEntryHash, generateContractCodeEntryHash} = require('./ledger-key')
 
 /**
@@ -176,8 +182,7 @@ function parseTrustlineEntry(value) {
             asset = xdrParseAsset(trustlineAsset)
             break
         case 3:
-            asset = trustlineEntryXdr.asset().liquidityPoolId().toString('hex')
-            //data.liquidityPoolUseCount = trustlineEntryXdr.liquidityPoolUseCount()
+            asset = StrKey.encodeLiquidityPool(trustlineEntryXdr.asset().liquidityPoolId())
             break
         default:
             throw new TxMetaEffectParserError(`Unsupported trustline type ` + trustlineType)
@@ -219,7 +224,7 @@ function parseLiquidityPoolEntry(value) {
     const params = body.params()
     return {
         entry: 'liquidityPool',
-        pool: liquidityPoolEntryXdr.liquidityPoolId().toString('hex'),
+        pool: StrKey.encodeLiquidityPool(liquidityPoolEntryXdr.liquidityPoolId()),
         asset: [xdrParseAsset(params.assetA()), xdrParseAsset(params.assetB())],
         fee: params.fee(),
         amount: [body.reserveA().toString(), body.reserveB().toString()],
@@ -247,7 +252,7 @@ function parseOfferEntry(value) {
 function parseClaimableBalanceEntry(value) {
     const claimableBalanceXdr = value.value()
     const data = {
-        balanceId: Buffer.from(claimableBalanceXdr.balanceId().value()).toString('hex'),
+        balanceId: StrKey.encodeClaimableBalance(claimableBalanceXdr.balanceId().value()),
         entry: 'claimableBalance',
         asset: xdrParseAsset(claimableBalanceXdr.asset()),
         amount: claimableBalanceXdr.amount().toString(),

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,31 @@ function xdrParseScVal(value, treatBytesAsContractId = false) {
     }
 }
 
+function xdrParseTokenBalance({type, 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
+    let balance = '0'
+    if (type !== effectTypes.contractDataRemoved) { //TODO: handle evicted entries separately
+        const xdrVal = xdr.ScVal.fromXDR(value, 'base64')
+        if (xdrVal._arm !== 'map')
+            return null
+        const parsedValue = xdrParseScVal(xdrVal)
+        if (typeof parsedValue.amount !== 'string')
+            return null
+        balance = parsedValue.amount
+    }
+    return {
+        address: xdrParseScVal(keyParts[1]),
+        balance
+    }
+}
+
 module.exports = {
     xdrParseAsset,
     xdrParseAccountAddress,
@@ -295,5 +328,6 @@ module.exports = {
     xdrParseTradeAtom,
     xdrParseSignerKey,
     xdrParsePrice,
-    xdrParseScVal
+    xdrParseScVal,
+    xdrParseTokenBalance
 }