@stellar-expert/tx-meta-effects-parser 7.0.0-rc.20 → 7.0.0-rc.21

package/package.json

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

package/src/aggregation/events-analyzer.js

@@ -1,6 +1,7 @@
 const {StrKey, encodeMuxedAccount, encodeMuxedAccountToAddress} = require('@stellar/stellar-base')
 const effectTypes = require('../effect-types')
-const {xdrParseScVal, xdrParseAsset, isContractAddress} = require('../parser/tx-xdr-parser-utils')
+const {xdrParseScVal, xdrParseAsset} = require('../parser/tx-xdr-parser-utils')
+const {isContractAddress, validateAmount} = require('../parser/normalization')
 const {mapSacContract} = require('./sac-contract-mapper')
 
 const EVENT_TYPES = {
@@ -155,7 +156,7 @@ class EventsAnalyzer {
                         amount = amount.amount
                     }
                 }
-                if (typeof amount !== 'string')
+                if (validateAmount(amount, false) === null)
                     return null
                 if (to === from) //self transfer - nothing happens
                     return // TODO: need additional checks
@@ -190,8 +191,9 @@ class EventsAnalyzer {
                         amount = amount.amount
                     }
                 }
-                if (typeof amount !== 'string')
+                if (validateAmount(amount, false) === null)
                     return null
+                validateAmount(amount)
                 const asset = this.getAssetFromEventTopics(topics, contract)
                 this.effectsAnalyzer.mint(asset, amount)
                 if (isContractAddress(asset) || isContractAddress(to)) {
@@ -204,7 +206,7 @@ class EventsAnalyzer {
                     return //throw new Error('Non-standard event')
                 const from = xdrParseScVal(topics[1])
                 const amount = processEventBodyValue(body.data())
-                if (typeof amount !== 'string')
+                if (validateAmount(amount, false) === null)
                     return null
                 const asset = this.getAssetFromEventTopics(topics, contract)
                 if (isContractAddress(asset) || isContractAddress(from)) {
@@ -218,7 +220,7 @@ class EventsAnalyzer {
                     return //throw new Error('Non-standard event')
                 const from = xdrParseScVal(topics[topics[2]?._arm === 'address' ? 2 : 1])
                 const amount = processEventBodyValue(body.data())
-                if (typeof amount !== 'string')
+                if (validateAmount(amount, false) === null)
                     return null
                 const asset = this.getAssetFromEventTopics(topics, contract)
                 if (StrKey.isValidContract(from)) { //transfer tokens from account only in case of contract assets to avoid double debits

package/src/aggregation/sac-contract-mapper.js

@@ -1,6 +1,6 @@
 const TtlCache = require('../cache/ttl-cache')
-const {toStellarAsset} = require('../parser/tx-xdr-parser-utils')
 const {contractIdFromAsset} = require('../parser/contract-preimage-encoder')
+const {toStellarAsset} = require('../parser/normalization')
 
 const sacCache = new TtlCache()
 
@@ -17,7 +17,7 @@ function mapSacContract(effectsAnalyzer, contractAddress, classicAsset) {
     const {network, sacMap} = effectsAnalyzer
     if (!sacMap)
         return false
-    const prevMapping = sacMap[contractAddress]
+    const prevMapping = sacMap.get(contractAddress)
     if (prevMapping) {
         return prevMapping === classicAsset
     }
@@ -37,7 +37,7 @@ function mapSacContract(effectsAnalyzer, contractAddress, classicAsset) {
     } else if (contractAddress !== fromCache)
         return false //check whether validated contract from cache matches the asset
     if (sacMap) {
-        sacMap[contractAddress] = classicAsset
+        sacMap.set(contractAddress, classicAsset)
     }
     return true
 }

package/src/effects-analyzer.js

@@ -1,5 +1,6 @@
 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 {contractIdFromPreimage} = require('./parser/contract-preimage-encoder')
@@ -42,7 +43,7 @@ class EffectsAnalyzer {
         }
         this.network = network
         if (mapSac) {
-            this.sacMap = {}
+            this.sacMap = new Map()
         }
     }
 
@@ -64,7 +65,7 @@ class EffectsAnalyzer {
      */
     network
     /**
-     * @type {{}}
+     * @type {Map<string,string>}
      * @readonly
      */
     sacMap
@@ -261,7 +262,10 @@ class EffectsAnalyzer {
     setTrustLineFlags() {
         if (!this.changes.length)
             return
-        const trustAsset = xdrParseAsset(this.operation.asset || {code: this.operation.assetCode, issuer: normalizeAddress(this.source)})
+        const trustAsset = xdrParseAsset(this.operation.asset || {
+            code: this.operation.assetCode,
+            issuer: normalizeAddress(this.source)
+        })
         const change = this.changes.find(ch => ch.type === 'trustline' && ch.before.asset === trustAsset)
         if (!change)
             return
@@ -1051,6 +1055,10 @@ class EffectsAnalyzer {
             }
     }
 
+    /**
+     * @return {String|null}
+     * @private
+     */
     retrieveOpContractId() {
         const funcValue = this.operation.func._value._attributes
         if (funcValue) {
@@ -1063,11 +1071,16 @@ class EffectsAnalyzer {
         return null
     }
 
+    /**
+     *
+     * @param assetOrContract
+     * @return {*}
+     */
     resolveAsset(assetOrContract) {
         if (!assetOrContract.startsWith('C') || !this.sacMap)
             return assetOrContract
         //try to resolve using SAC map
-        return this.sacMap[assetOrContract] || assetOrContract
+        return this.sacMap.get(assetOrContract) || assetOrContract
     }
 }
 
@@ -1100,17 +1113,6 @@ function processFeeChargedEffect(tx, source, chargedAmount, feeBump = false) {
     return res
 }
 
-function normalizeAddress(address) {
-    const prefix = address[0]
-    if (prefix === 'G')
-        return address
-    if (prefix !== 'M')
-        throw new TypeError('Expected ED25519 or Muxed address')
-    const rawBytes = StrKey.decodeMed25519PublicKey(address)
-    return StrKey.encodeEd25519PublicKey(rawBytes.subarray(0, 32))
-}
-
-
 /**
  * @param {String} action
  * @param {String} type
@@ -1137,18 +1139,4 @@ function encodeSponsorshipEffectName(action, type) {
     return effectTypes[`${type}Sponsorship${actionKey}`]
 }
 
-function validateAmount(amount) {
-    if (amount < 0)
-        throw new TxMetaEffectParserError('Negative balance change amount: ' + amount.toString())
-    return amount
-}
-
-/**
- * @param largeInt
- * @return {String}
- */
-function parseLargeInt(largeInt) {
-    return largeInt._value.toString()
-}
-
 module.exports = {EffectsAnalyzer, processFeeChargedEffect}

package/src/index.js

@@ -177,7 +177,7 @@ function parseTxOperationsMeta({
             }
             const analyzer = new EffectsAnalyzer(params)
             operation.effects = analyzer.analyze()
-            if (analyzer.sacMap && !isEmptyObject(analyzer.sacMap)) {
+            if (analyzer.sacMap && analyzer.sacMap.size > 0) {
                 operation.sacMap = analyzer.sacMap
             }
             if (isSorobanInvocation) {
@@ -204,12 +204,6 @@ function ensureXdrInputType(value, xdrType) {
     return xdrType.fromXDR(value, typeof value === 'string' ? 'base64' : 'raw')
 }
 
-function isEmptyObject(obj) {
-    for (const key in obj)
-        return false
-    return true
-}
-
 /**
  * @typedef {{}} ParsedTxOperationsMetadata
  * @property {Transaction|FeeBumpTransaction} tx - Parsed transaction object

package/src/parser/normalization.js

@@ -0,0 +1,73 @@
+const {StrKey, Asset} = require('@stellar/stellar-base')
+const {TxMetaEffectParserError} = require('../errors')
+
+/**
+ * @param {String} address
+ * @return {String}
+ */
+function normalizeAddress(address) {
+    const prefix = address[0]
+    if (prefix === 'G')
+        return address
+    if (prefix !== 'M')
+        throw new TypeError('Expected ED25519 or Muxed address')
+    const rawBytes = StrKey.decodeMed25519PublicKey(address)
+    return StrKey.encodeEd25519PublicKey(rawBytes.subarray(0, 32))
+}
+
+
+/**
+ * @param {String} address
+ * @return {Boolean}
+ */
+function isContractAddress(address) {
+    return address.length === 56 && address[0] === 'C'
+}
+
+/**
+ * @param {String} asset
+ * @return {Asset}
+ */
+function toStellarAsset(asset) {
+    if (asset === 'XLM')
+        return Asset.native()
+    if (asset.includes('-')) {
+        const [code, issuer] = asset.split('-')
+        return new Asset(code, issuer)
+    }
+    throw new TypeError('Unsupported asset format ' + asset)
+}
+
+/**
+ * @param {String} amount
+ * @param {Boolean} [throwIfInvalid]
+ * @return {String|null}
+ */
+function validateAmount(amount, throwIfInvalid = true) {
+    let parsed
+    try {
+        if (typeof amount !== 'string')
+            throw new TypeError('Invalid amount type')
+        parsed = BigInt(amount)
+    } catch (e) {
+        if (!throwIfInvalid)
+            return null
+        throw new TxMetaEffectParserError('Invalid amount: ' + amount)
+    }
+    if (parsed < 0n) {
+        if (!throwIfInvalid)
+            return null
+        throw new TxMetaEffectParserError('Negative effect amount: ' + amount)
+    }
+    return amount
+}
+
+/**
+ * @param largeInt
+ * @return {String}
+ */
+function parseLargeInt(largeInt) {
+    return largeInt._value.toString()
+}
+
+module.exports = {normalizeAddress, isContractAddress, toStellarAsset, validateAmount, parseLargeInt}

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

@@ -1,28 +1,6 @@
-const {xdr, StrKey, LiquidityPoolId, Asset, scValToBigInt, encodeMuxedAccount, encodeMuxedAccountToAddress} = require('@stellar/stellar-base')
+const {xdr, StrKey, LiquidityPoolId, scValToBigInt, encodeMuxedAccount, encodeMuxedAccountToAddress} = 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
@@ -317,7 +295,5 @@ module.exports = {
     xdrParseTradeAtom,
     xdrParseSignerKey,
     xdrParsePrice,
-    xdrParseScVal,
-    isContractAddress,
-    toStellarAsset
+    xdrParseScVal
 }