Merge pull request #498 from multiversx/return-data-8

 Recover return data of smart contract (new implementation)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-core",
-  "version": "13.7.0",
+  "version": "13.8.0",
   "description": "MultiversX SDK for JavaScript and TypeScript",
   "author": "MultiversX",
   "homepage": "https://multiversx.com",

src/interfaceOfNetwork.ts

@@ -53,6 +53,7 @@ export interface IContractResultItem {
     data: string;
     returnMessage: string;
     logs: ITransactionLogs;
+    previousHash?: string;
 }
 
 export interface IContractQueryResponse {

src/smartcontracts/resultsParser.spec.ts

@@ -1,21 +1,17 @@
+import BigNumber from "bignumber.js";
+import { assert } from "chai";
+import { Address } from "../address";
+import { IAddress } from "../interface";
 import {
     ContractQueryResponse,
     ContractResultItem,
     ContractResults,
+    TransactionEventData,
     TransactionEventOnNetwork,
     TransactionEventTopic,
     TransactionLogsOnNetwork,
     TransactionOnNetwork,
-    TransactionEventData,
 } from "../networkProviders";
-import BigNumber from "bignumber.js";
-import { assert } from "chai";
-import * as fs from "fs";
-import path from "path";
-import { Address } from "../address";
-import { IAddress } from "../interface";
-import { ITransactionOnNetwork } from "../interfaceOfNetwork";
-import { LogLevel, Logger } from "../logger";
 import { loadAbiRegistry } from "../testutils";
 import { ArgSerializer } from "./argSerializer";
 import { ResultsParser } from "./resultsParser";
@@ -258,10 +254,7 @@ describe("test smart contract results parser", () => {
 
         let bundle = parser.parseUntypedOutcome(transaction);
         assert.deepEqual(bundle.returnCode, ReturnCode.Ok);
-        assert.equal(
-            bundle.returnMessage,
-            "@too much gas provided for processing: gas provided = 596384500, gas used = 733010",
-        );
+        assert.equal(bundle.returnMessage, "ok");
         assert.deepEqual(bundle.values, []);
     });
 
@@ -383,47 +376,4 @@ describe("test smart contract results parser", () => {
         assert.deepEqual(bundle.b, new BigNumber(43));
         assert.deepEqual(bundle.c, new BigNumber(44));
     });
-
-    // This test should be enabled manually and run against a set of sample transactions.
-    // 2022-04-03: test ran against ~1800 transactions sampled from devnet.
-    it.skip("should parse real-world contract outcomes", async () => {
-        let oldLogLevel = Logger.logLevel;
-        Logger.setLevel(LogLevel.Trace);
-
-        let folder = path.resolve(process.env["SAMPLES"] || "SAMPLES");
-        let samples = loadRealWorldSamples(folder);
-
-        for (const [transaction, _] of samples) {
-            console.log("Transaction:", transaction.hash.toString());
-
-            let bundle = parser.parseUntypedOutcome(transaction);
-
-            console.log("Return code:", bundle.returnCode.toString());
-            console.log("Return message:", bundle.returnMessage);
-            console.log("Num values:", bundle.values.length);
-            console.log("=".repeat(80));
-
-            assert.include(KnownReturnCodes, bundle.returnCode.valueOf());
-        }
-
-        Logger.setLevel(oldLogLevel);
-    });
-
-    function loadRealWorldSamples(folder: string): [ITransactionOnNetwork, string][] {
-        let transactionFiles = fs.readdirSync(folder);
-        let samples: [ITransactionOnNetwork, string][] = [];
-
-        for (const file of transactionFiles) {
-            let txHash = path.basename(file, ".json");
-            let filePath = path.resolve(folder, file);
-            let jsonContent: string = fs.readFileSync(filePath, { encoding: "utf8" });
-            let json = JSON.parse(jsonContent);
-            let payload = json["data"]["transaction"];
-            let transaction = TransactionOnNetwork.fromProxyHttpResponse(txHash, payload);
-
-            samples.push([transaction, jsonContent]);
-        }
-
-        return samples;
-    }
 });

src/smartcontracts/resultsParser.ts

@@ -284,12 +284,10 @@ export class ResultsParser {
         }
 
         let { returnCode, returnDataParts } = this.sliceDataFieldInParts(eventTooMuchGas.data);
-        let lastTopic = eventTooMuchGas.getLastTopic();
-        let returnMessage = lastTopic?.toString() || returnCode.toString();
 
         return {
             returnCode: returnCode,
-            returnMessage: returnMessage,
+            returnMessage: returnCode.toString(),
             values: returnDataParts,
         };
     }
@@ -355,6 +353,25 @@ export class ResultsParser {
             }
         }
 
+        // Additional fallback heuristics (alter search constraints):
+        for (const resultItem of transaction.contractResults.items) {
+            let writeLogWithReturnData = resultItem.logs.findSingleOrNoneEvent(WellKnownEvents.OnWriteLog, (event) => {
+                const addressIsContract = event.address.bech32() == contractAddress.toBech32();
+                return addressIsContract;
+            });
+
+            if (writeLogWithReturnData) {
+                const { returnCode, returnDataParts } = this.sliceDataFieldInParts(writeLogWithReturnData.data);
+                const returnMessage = returnCode.toString();
+
+                return {
+                    returnCode: returnCode,
+                    returnMessage: returnMessage,
+                    values: returnDataParts,
+                };
+            }
+        }
+
         return null;
     }
 

src/testdata/README.md

@@ -0,0 +1,111 @@
+# Testdata
+
+## Files `transactions.mainnet.json`
+
+Transactions were sampled from the mainnet BigQuery dataset:
+
+```sql
+DECLARE
+  TIMESTAMP_START DATE DEFAULT '2024-09-01';
+DECLARE
+  TIMESTAMP_END DATE DEFAULT '2024-09-03';
+  -- Contract execute, with success
+  (
+  SELECT
+    `_id`,
+    'execute_success' `kind`
+  FROM
+    `multiversx-blockchain-etl.crypto_multiversx_mainnet_eu.transactions`
+  WHERE
+    DATE(`timestamp`) >= TIMESTAMP_START
+    AND DATE(`timestamp`) <= TIMESTAMP_END
+    AND `isScCall` = TRUE
+    AND ARRAY_LENGTH(`esdtValues`) = 0
+    AND `status` = 'success'
+    AND RAND() < 0.25
+  LIMIT
+    250 )
+UNION ALL
+  -- Contract execute, with error
+  (
+  SELECT
+    `_id`,
+    'execute_error' `kind`
+  FROM
+    `multiversx-blockchain-etl.crypto_multiversx_mainnet_eu.transactions`
+  WHERE
+    DATE(`timestamp`) >= TIMESTAMP_START
+    AND DATE(`timestamp`) <= TIMESTAMP_END
+    AND `isScCall` = TRUE
+    AND ARRAY_LENGTH(`esdtValues`) = 0
+    AND `status` = 'fail'
+    AND RAND() < 0.25
+  LIMIT
+    250 )
+UNION ALL
+  -- Contract transfer & execute, with success
+  (
+  SELECT
+    `_id`,
+    'transfer_execute_success' `kind`
+  FROM
+    `multiversx-blockchain-etl.crypto_multiversx_mainnet_eu.transactions`
+  WHERE
+    DATE(`timestamp`) >= TIMESTAMP_START
+    AND DATE(`timestamp`) <= TIMESTAMP_END
+    AND `isScCall` = TRUE
+    AND ARRAY_LENGTH(`esdtValues`) > 0
+    AND `status` = 'success'
+    AND RAND() < 0.25
+  LIMIT
+    250 )
+UNION ALL
+  -- Contract transfer & execute, with error
+  (
+  SELECT
+    `_id`,
+    'transfer_execute_error' `kind`
+  FROM
+    `multiversx-blockchain-etl.crypto_multiversx_mainnet_eu.transactions`
+  WHERE
+    DATE(`timestamp`) >= TIMESTAMP_START
+    AND DATE(`timestamp`) <= TIMESTAMP_END
+    AND `isScCall` = TRUE
+    AND ARRAY_LENGTH(`esdtValues`) > 0
+    AND `status` = 'fail'
+    AND RAND() < 0.25
+  LIMIT
+    250)
+UNION ALL
+  -- Relayed, with success
+  (
+  SELECT
+    `_id`,
+    'relayed_success' `kind`
+  FROM
+    `multiversx-blockchain-etl.crypto_multiversx_mainnet_eu.transactions`
+  WHERE
+    DATE(`timestamp`) >= TIMESTAMP_START
+    AND DATE(`timestamp`) <= TIMESTAMP_END
+    AND `isRelayed` = TRUE
+    AND `status` = 'success'
+    AND RAND() < 0.25
+  LIMIT
+    50)
+UNION ALL
+  -- Relayed, with failure
+  (
+  SELECT
+    `_id`,
+    'relayed_error' `kind`
+  FROM
+    `multiversx-blockchain-etl.crypto_multiversx_mainnet_eu.transactions`
+  WHERE
+    DATE(`timestamp`) >= TIMESTAMP_START
+    AND DATE(`timestamp`) <= TIMESTAMP_END
+    AND `isRelayed` = TRUE
+    AND `status` = 'fail'
+    AND RAND() < 0.25
+  LIMIT
+    50)
+```