@stellar-expert/tx-meta-effects-parser 5.6.5 → 5.7.0

package/package.json

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

package/src/aggregation/events-analyzer.js

@@ -67,7 +67,7 @@ class EventsAnalyzer {
         const opContractId = this.effectsAnalyzer.retrieveOpContractId()
         //diagnostic events
         for (const evt of diagnosticEvents) {
-            if (!processSystemEvents && !evt.inSuccessfulContractCall())
+            if (!processSystemEvents && !(evt.inSuccessfulContractCall() || this.effectsAnalyzer.processFailedOpEffects))
                 continue //throw new UnexpectedTxMetaChangeError({type: 'diagnostic_event', action: 'failed'})
             //parse event
             const event = evt.event()

package/src/effects-analyzer.js

@@ -6,11 +6,11 @@ const {analyzeSignerChanges} = require('./aggregation/signer-changes-analyzer')
 const {contractIdFromPreimage} = require('./parser/contract-preimage-encoder')
 const EventsAnalyzer = require('./aggregation/events-analyzer')
 const AssetSupplyAnalyzer = require('./aggregation/asset-supply-analyzer')
-const {UnexpectedTxMetaChangeError, TxMetaEffectParserError} = require('./errors')
 const {mapSacContract} = require('./aggregation/sac-contract-mapper')
+const {UnexpectedTxMetaChangeError, TxMetaEffectParserError} = require('./errors')
 
 class EffectsAnalyzer {
-    constructor({operation, meta, result, network, events, diagnosticEvents, mapSac, processSystemEvents}) {
+    constructor({operation, meta, result, network, events, diagnosticEvents, mapSac, processSystemEvents, processFailedOpEffects}) {
         //set execution context
         if (!operation.source)
             throw new TxMetaEffectParserError('Operation source is not explicitly defined')
@@ -20,6 +20,7 @@ class EffectsAnalyzer {
         this.changes = parseLedgerEntryChanges(meta)
         this.source = this.operation.source
         this.events = events
+        this.processFailedOpEffects = processFailedOpEffects
         if (diagnosticEvents?.length) {
             this.diagnosticEvents = diagnosticEvents
             if (processSystemEvents) {
@@ -103,10 +104,7 @@ class EffectsAnalyzer {
         //calculate minted/burned assets
         new AssetSupplyAnalyzer(this).analyze()
         //process state data changes in the end
-        for (const change of this.changes)
-            if (change.type === 'contractData') {
-                this.processContractDataChanges(change)
-            }
+        this.processStateChanges()
         return this.effects
     }
 
@@ -813,7 +811,7 @@ class EffectsAnalyzer {
         this.addEffect(effect)
     }
 
-    processContractDataChanges({action, before, after}) {
+    processContractStateEntryChanges({action, before, after}) {
         const {owner, key, durability} = after || before
         const effect = {
             type: '',
@@ -924,6 +922,13 @@ class EffectsAnalyzer {
             }
     }
 
+    processStateChanges() {
+        for (const change of this.changes)
+            if (change.type === 'contractData') {
+                this.processContractStateEntryChanges(change)
+            }
+    }
+
     retrieveOpContractId() {
         const funcValue = this.operation.func._value._attributes
         if (funcValue) {

package/src/index.js

@@ -18,10 +18,11 @@ const effectTypes = require('./effect-types')
  * @param {String|Buffer|xdr.TransactionMeta} [meta] - Base64-encoded tx envelope meta
  * @param {Boolean} [mapSac] - Whether to create a map SAC->Asset
  * @param {Boolean} [processSystemEvents] - Emit effects for contract errors and resource stats
+ * @param {Boolean} [processFailedOpEffects] - Whether to generate operation effects for failed/rejected transactions
  * @param {Number} [protocol] - Specific Stellar protocol version for the executed transaction
  * @return {ParsedTxOperationsMetadata}
  */
-function parseTxOperationsMeta({network, tx, result, meta, mapSac = false, processSystemEvents = false, protocol}) {
+function parseTxOperationsMeta({network, tx, result, meta, mapSac = false, processSystemEvents = false, processFailedOpEffects = false, protocol}) {
     if (!network)
         throw new TypeError(`Network passphrase argument is required.`)
     if (typeof network !== 'string')
@@ -96,7 +97,8 @@ function parseTxOperationsMeta({network, tx, result, meta, mapSac = false, proce
     const {success, opResults} = parseTxResult(parsedResult)
     if (!success || isFeeBump && !feeBumpSuccess) {
         res.failed = true
-        return res
+        if (!processFailedOpEffects)
+            return res
     }
 
     //retrieve operations result metadata
@@ -128,11 +130,12 @@ function parseTxOperationsMeta({network, tx, result, meta, mapSac = false, proce
     //analyze operation effects for each operation
     for (let i = 0; i < parsedTx.operations.length; i++) {
         const operation = parsedTx.operations[i]
-        if (success) {
+        if (success || processFailedOpEffects) {
             const params = {
                 operation,
-                meta: opMeta[i]?.changes(),
-                result: opResults[i], network
+                meta: opMeta[i]?.changes() || [],
+                result: opResults[i], network,
+                processFailedOpEffects
             }
             const isSorobanInvocation = operation.type === 'invokeHostFunction'
             //only for Soroban contract invocation
@@ -142,8 +145,6 @@ function parseTxOperationsMeta({network, tx, result, meta, mapSac = false, proce
                 params.diagnosticEvents = sorobanMeta.diagnosticEvents()
                 params.mapSac = mapSac
                 params.processSystemEvents = processSystemEvents
-                //process fee stats
-
             }
             const analyzer = new EffectsAnalyzer(params)
             operation.effects = analyzer.analyze()