@stellar-expert/tx-meta-effects-parser 5.0.0-beta13 → 5.0.0-beta15

package/package.json

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

package/src/asset-supply-processor.js

@@ -4,20 +4,25 @@ const effectTypes = require('./effect-types')
  * Effect supply computation processor
  */
 class AssetSupplyProcessor {
-    constructor(effects) {
+    /**
+     * @param {EffectsAnalyzer} effectsAnalyzer
+     */
+    constructor(effectsAnalyzer) {
         this.assetTransfers = {}
-        this.processXlmBalances = effects.some(e => e.type === 'contractInvoked')
-        for (const effect of effects) {
-            this.processEffect(effect)
-        }
+        this.processXlmBalances = effectsAnalyzer.isContractCall
+        this.effectsAnalyzer = effectsAnalyzer
     }
 
+    /**
+     * @type {EffectsAnalyzer}
+     * @private
+     */
+    effectsAnalyzer
     /**
      * @type {Object.<String,BigInt>}
      * @private
      */
     assetTransfers
-
     /**
      * @type {Boolean}
      * @private
@@ -70,28 +75,18 @@ class AssetSupplyProcessor {
 
     /**
      * Calculate differences and generate minted/burned effects if needed
-     * @return {{}[]}
      */
-    resolve() {
-        const res = []
+    analyze() {
+        for (const effect of this.effectsAnalyzer.effects) {
+            this.processEffect(effect)
+        }
         for (const [asset, amount] of Object.entries(this.assetTransfers)) {
-            if (amount === 0n)
-                continue
-            const effect = {
-                type: effectTypes.assetMinted,
-                asset
-            }
             if (amount > 0n) {
-                effect.type = effectTypes.assetMinted
-                effect.amount = amount.toString()
-            }
-            if (amount < 0n) {
-                effect.type = effectTypes.assetBurned
-                effect.amount = (-amount).toString()
+                this.effectsAnalyzer.mint(asset, amount.toString(), true)
+            } else if (amount < 0n) {
+                this.effectsAnalyzer.burn(asset, (-amount).toString())
             }
-            res.push(effect)
         }
-        return res
     }
 
     /**

package/src/events-analyzer.js

@@ -1,5 +1,6 @@
 const {StrKey} = require('@stellar/stellar-base')
-const {xdrParseScVal} = require('./tx-xdr-parser-utils')
+const {xdrParseScVal, xdrParseAsset, isContractAddress, toStellarAsset} = require('./tx-xdr-parser-utils')
+const {contractIdFromAsset} = require('./contract-preimage-encoder')
 const effectTypes = require('./effect-types')
 
 const EVENT_TYPES = {
@@ -115,20 +116,46 @@ class EventsAnalyzer {
                     return
                 const from = xdrParseScVal(topics[1])
                 const to = xdrParseScVal(topics[2])
-                const asset = contractId //topics[3]? xdrParseScVal(topics[3]) || contractId
+                if (to === from) //self transfer - nothing happens
+                    return // TODO: need additional checks
+                const sorobanAsset = contractId
                 const amount = processEventBodyValue(body.data())
                 if (!this.matchInvocationEffect(e =>
                     (e.function === 'transfer' && matchArrays([from, to, amount], e.args)) ||
                     (e.function === 'transfer_from' && matchArrays([undefined, from, to, amount], e.args))
                 ))
                     return
-                const isSorobanAsset = isContractAddress(asset)
-                if (!isSorobanAsset || isContractAddress(from)) {
-                    this.debit(from, asset, amount)
+                let classicAsset
+                if (topics.length > 3) {
+                    classicAsset = xdrParseAsset(xdrParseScVal(topics[3]))
+                    //validate
+                    if (contractIdFromAsset(toStellarAsset(classicAsset), this.effectAnalyzer.network) !== sorobanAsset)
+                        return //not an SAC transfer
                 }
-                if (!isSorobanAsset || isContractAddress(to)) {
-                    this.credit(to, asset, amount)
+                if (classicAsset && (classicAsset.includes(from) || classicAsset.includes(to))) { //SAC transfer by asset issuer
+                    if (classicAsset.includes(from)) {
+                        this.effectAnalyzer.mint(sorobanAsset, amount)
+                        this.effectAnalyzer.credit(amount, isContractAddress(to) ? sorobanAsset : classicAsset, to)
+                    }
+                    if (classicAsset.includes(to)) {
+                        this.effectAnalyzer.debit(amount, isContractAddress(from) ? sorobanAsset : classicAsset, from)
+                        this.effectAnalyzer.burn(sorobanAsset, amount)
+                    }
+                } else { //other cases
+                    if (classicAsset && !isContractAddress(from)) { //classic asset bridged to Soroban
+                        this.effectAnalyzer.burn(classicAsset, amount)
+                        this.effectAnalyzer.mint(sorobanAsset, amount)
+                    } else {
+                        this.effectAnalyzer.debit(amount, sorobanAsset, from)
+                    }
+                    if (classicAsset && !isContractAddress(to)) { //classic asset bridged from Soroban
+                        this.effectAnalyzer.burn(sorobanAsset, amount)
+                        this.effectAnalyzer.mint(classicAsset, amount)
+                    } else {
+                        this.effectAnalyzer.credit(amount, sorobanAsset, to)
+                    }
                 }
+
             }
                 break
             case 'mint': {
@@ -143,7 +170,7 @@ class EventsAnalyzer {
                     asset: contractId,
                     amount
                 })
-                this.credit(to, contractId, amount)
+                this.effectAnalyzer.credit(amount, contractId, to)
             }
                 break
             case 'burn': {
@@ -156,12 +183,9 @@ class EventsAnalyzer {
                     (e.function === 'burn_from' && matchArrays([undefined, from, amount], e.args))
                 ))
                     return
-                this.debit(from, contractId, amount)
-                this.effectAnalyzer.addEffect({
-                    type: effectTypes.assetBurned,
-                    asset: contractId,
-                    amount
-                })
+
+                this.effectAnalyzer.debit(amount, contractId, from)
+                this.effectAnalyzer.burn(contractId, amount)
             }
                 break
             case 'clawback': {
@@ -172,12 +196,8 @@ class EventsAnalyzer {
                 const amount = processEventBodyValue(body.data())
                 if (!this.matchInvocationEffect(e => e.function === 'clawback' && matchArrays([from, amount], e.args)))
                     return
-                this.debit(from, contractId, amount)
-                this.effectAnalyzer.addEffect({
-                    type: effectTypes.assetBurned,
-                    asset: contractId,
-                    amount
-                })
+                this.effectAnalyzer.debit(amount, contractId, from)
+                this.effectAnalyzer.burn(contractId, amount)
             }
                 break
             //TODO: process token allowance, authorization approval, and admin modification for SAC contracts
@@ -214,48 +234,6 @@ class EventsAnalyzer {
         return null
     }
 
-    /**
-     * @param {String} from
-     * @param {String} asset
-     * @param {String} amount
-     * @private
-     */
-    debit(from, asset, amount) {
-        this.effectAnalyzer.debit(amount, asset, from)
-
-        //debit from account
-        //TODO: check debits of Soroban assets from account
-        //if (token.anchoredAsset)
-        //return //skip processing changes for classic assets - they are processed elsewhere
-        /*this.effectAnalyzer.addEffect({
-            type: effectTypes.accountDebited,
-            source: from,
-            asset: token.asset,
-            amount
-        })*/
-    }
-
-    /**
-     * @param {String} to
-     * @param {String} asset
-     * @param {String} amount
-     * @private
-     */
-    credit(to, asset, amount) {
-        this.effectAnalyzer.credit(amount, asset, to)
-
-        //credit account
-        //TODO: check credits of Soroban assets
-        //if (token.anchoredAsset)
-        //return //skip processing changes for classic assets - they are processed elsewhere
-        /*this.effectAnalyzer.addEffect({
-            type: effectTypes.accountCredited,
-            source: to,
-            asset: token.asset,
-            amount
-        })*/
-    }
-
     matchInvocationEffect(cb) {
         return this.effectAnalyzer.effects.find(e => e.type === effectTypes.contractInvoked && cb(e))
     }
@@ -303,8 +281,4 @@ function processEventBodyValue(value) {
     return xdrParseScVal(value) //other scValue
 }
 
-function isContractAddress(address) {
-    return address.length === 56 && address[0] === 'C'
-}
-
 module.exports = EventsAnalyzer

package/src/tx-effects-analyzer.js

@@ -15,6 +15,7 @@ class EffectsAnalyzer {
         if (!operation.source)
             throw new TxMetaEffectParserError('Operation source is not explicitly defined')
         this.operation = operation
+        this.isContractCall = this.operation.type === 'invokeHostFunction'
         this.result = result
         this.changes = parseLedgerEntryChanges(meta)
         this.source = this.operation.source
@@ -27,7 +28,7 @@ class EffectsAnalyzer {
 
     /**
      * @type {{}[]}
-     * @private
+     * @internal
      * @readonly
      */
     effects = []
@@ -60,6 +61,11 @@ class EffectsAnalyzer {
      * @readonly
      */
     source = ''
+    /**
+     * @type {boolean}
+     * @private
+     */
+    isContractCall = false
 
     analyze() {
         //find appropriate parsing method
@@ -74,13 +80,12 @@ class EffectsAnalyzer {
         //process Soroban events
         new EventsAnalyzer(this).analyze()
         //calculate minted/burned assets
-        this.processAssetSupplyEffects()
+        new AssetSupplyProcessor(this).analyze()
         //process state data changes in the end
         for (const change of this.changes)
             if (change.type === 'contractData') {
                 this.processContractDataChanges(change)
             }
-
         return this.effects
     }
 
@@ -129,6 +134,25 @@ class EffectsAnalyzer {
         this.addEffect(effect)
     }
 
+    mint(asset, amount, autoLookupPosition = false) {
+        const position = autoLookupPosition ?
+            this.effects.findIndex(e => e.asset === asset || e.assets?.find(a => a.asset === asset)) :
+            undefined
+        this.addEffect({
+            type: effectTypes.assetMinted,
+            asset,
+            amount
+        }, position)
+    }
+
+    burn(asset, amount) {
+        this.addEffect({
+            type: effectTypes.assetBurned,
+            asset,
+            amount
+        })
+    }
+
     setOptions() {
         const sourceAccount = normalizeAddress(this.source)
         const {before, after} = this.changes.find(ch => ch.type === 'account' && ch.before.address === sourceAccount)
@@ -773,15 +797,6 @@ class EffectsAnalyzer {
                     throw new UnexpectedTxMetaChangeError(change)
             }
     }
-
-    processAssetSupplyEffects() {
-        const supplyProcessor = new AssetSupplyProcessor(this.effects)
-        for (const effect of supplyProcessor.resolve()) {
-            this.addEffect(effect, effect.type === effectTypes.assetMinted ?
-                this.effects.findIndex(e => e.asset === effect.asset || e.assets?.find(a => a.asset === effect.asset)) :
-                undefined)
-        }
-    }
 }
 
 /**

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

@@ -1,6 +1,28 @@
-const {StrKey, LiquidityPoolId, scValToBigInt, xdr} = require('@stellar/stellar-base')
+const {StrKey, LiquidityPoolId, scValToBigInt, xdr, Asset} = require('@stellar/stellar-base')
 const {TxMetaEffectParserError} = require('./errors')
 
+/**
+ * @param {String} address
+ * @return {Boolean}
+ */
+function isContractAddress(address) {
+    return address.length === 56 && address[0] === 'C'
+}
+
+/**
+ * @param {String} assetDescriptor
+ * @return {Asset}
+ */
+function toStellarAsset(assetDescriptor) {
+    if (assetDescriptor === 'XLM')
+        return Asset.native()
+    if (assetDescriptor.includes('-')) {
+        const [code, issuer] = assetDescriptor.split('-')
+        return new Asset(code, issuer)
+    }
+    throw new TypeError('Unsupported asset format ' + assetDescriptor)
+}
+
 /**
  * Parse account address from XDR representation
  * @param accountId
@@ -195,12 +217,14 @@ function xdrParseAsset(src) {
     }
 
     if (typeof src === 'string') {
-        if (src === 'XLM' || src === 'native' || src.includes('-'))
+        if (src === 'XLM' || src === 'native')
             return 'XLM'//already parsed value
         if (src.includes(':')) {
             const [code, issuer] = src.split(':')
             return `${code.replace(/\0+$/, '')}-${issuer}-${code.length > 4 ? 2 : 1}`
         }
+        if (src.includes('-'))
+            return src //already parsed
         if (src.length === 64)
             return src //pool id
     }
@@ -272,5 +296,7 @@ module.exports = {
     xdrParseTradeAtom,
     xdrParseSignerKey,
     xdrParsePrice,
-    xdrParseScVal
+    xdrParseScVal,
+    isContractAddress,
+    toStellarAsset
 }