feat: Parse Logs and LogData from all contracts used (#720)

* setup contracts for test

* adjust contract flow

* make u8

* update tests

* refactor

* cs

* revise from pr review

Author: Cameron Manavian

.changeset/short-feet-sell.md

@@ -0,0 +1,6 @@
+---
+"@fuel-ts/abi-coder": minor
+"@fuel-ts/contract": minor
+---
+
+Adjust contract interface to parse logs from external contracts - breaking change for adding contracts to a call

packages/abi-coder/src/interface.ts

@@ -42,13 +42,21 @@ export default class Interface {
   readonly abi: ABI | null;
   readonly types: ReadonlyArray<JsonFlatAbiFragmentType>;
   readonly loggedTypes: ReadonlyArray<JsonAbiLogFragment>;
+  /*
+  Same as the `loggedTypes` above, but dedicated to external contracts
+  added via `<base-invocation-scope.ts>.addContracts()` method. This is
+  used to decode logs from contracts other than the main contract
+  we're interacting with.
+*/
+  private externalLoggedTypes: { [id: string]: ReadonlyArray<JsonAbiLogFragment> };
 
   constructor(jsonAbi: JsonAbi | JsonFlatAbi) {
     this.abi = isFlatJsonAbi(jsonAbi) ? new ABI(jsonAbi) : null;
     this.fragments = coerceFragments(ABI.unflatten(jsonAbi));
 
     this.types = this.abi ? this.abi.types : [];
     this.loggedTypes = this.abi ? this.abi.unflattenLoggedTypes() : [];
+    this.externalLoggedTypes = {};
 
     this.abiCoder = new AbiCoder();
     this.functions = {};
@@ -152,8 +160,10 @@ export default class Interface {
     return this.abiCoder.decode(fragment.outputs, bytes);
   }
 
-  decodeLog(data: BytesLike, logId: number): any {
-    const logType = this.loggedTypes.find((type) => type.logId === logId);
+  decodeLog(data: BytesLike, logId: number, receiptId: string): any {
+    const loggedTypes = this.externalLoggedTypes[receiptId] || this.loggedTypes;
+
+    const logType = loggedTypes.find((type) => type.logId === logId);
     if (!logType?.abiFragmentType) {
       throw new Error(`Log ID - ${logId} unknown`);
     }
@@ -173,4 +183,8 @@ export default class Interface {
 
     return this.abiCoder.encode(fragment.outputs, values);
   }
+
+  updateExternalLoggedTypes(id: string, loggedTypes: JsonAbiLogFragment[]) {
+    this.externalLoggedTypes[id] = loggedTypes;
+  }
 }

packages/contract/src/contracts/functions/base-invocation-scope.ts

@@ -1,6 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import type { InputValue } from '@fuel-ts/abi-coder';
-import type { ContractIdLike } from '@fuel-ts/interfaces';
 import { bn, toNumber } from '@fuel-ts/math';
 import type { Provider, CoinQuantity, TransactionRequest } from '@fuel-ts/providers';
 import { transactionRequestify, ScriptTransactionRequest } from '@fuel-ts/providers';
@@ -179,8 +178,13 @@ export class BaseInvocationScope<TReturn = any> {
     return this;
   }
 
-  addContracts(contracts: Array<ContractIdLike>) {
-    contracts.forEach((contract) => this.transactionRequest.addContract(contract));
+  addContracts(contracts: Array<Contract>) {
+    contracts.forEach((contract) => {
+      this.transactionRequest.addContract(contract.id);
+      this.contract.interface.updateExternalLoggedTypes(contract.id.toB256(), [
+        ...contract.interface.loggedTypes,
+      ]);
+    });
     return this;
   }
 

packages/contract/src/contracts/functions/invocation-results.ts

@@ -56,14 +56,15 @@ export class InvocationResult<T = any> {
     }
 
     const { contract } = this.functionScopes[0].getCallConfig();
+
     return receipts.reduce((logs, r) => {
       if (r.type === ReceiptType.LogData) {
-        return logs.concat(...contract.interface.decodeLog(r.data, r.val1.toNumber()));
+        return logs.concat(...contract.interface.decodeLog(r.data, r.val1.toNumber(), r.id));
       }
 
       if (r.type === ReceiptType.Log) {
         return logs.concat(
-          ...contract.interface.decodeLog(new U64Coder().encode(r.val0), r.val1.toNumber())
+          ...contract.interface.decodeLog(new U64Coder().encode(r.val0), r.val1.toNumber(), r.id)
         );
       }
 

packages/fuel-gauge/src/advanced-logging.test.ts

@@ -4,11 +4,14 @@ import { ScriptResultDecoderError } from 'fuels';
 import { getSetupContract } from './utils';
 
 const setupContract = getSetupContract('advanced-logging');
+const setupOtherContract = getSetupContract('advanced-logging-other-contract');
 
 let contractInstance: Contract;
+let otherContractInstance: Contract;
 
 beforeAll(async () => {
   contractInstance = await setupContract();
+  otherContractInstance = await setupOtherContract({ cache: false });
 });
 
 describe('Advanced Logging', () => {
@@ -93,4 +96,20 @@ describe('Advanced Logging', () => {
       }
     }
   });
+
+  it('can get log data from a downstream Contract', async () => {
+    const INPUT = 3;
+    const { value, logs } = await contractInstance.functions
+      .test_log_from_other_contract(INPUT, otherContractInstance.id)
+      .addContracts([otherContractInstance])
+      .call();
+
+    expect(value).toBeTruthy();
+    expect(logs).toEqual([
+      'Hello from main Contract',
+      'Hello from other Contract',
+      'Received value from main Contract:',
+      INPUT,
+    ]);
+  });
 });

packages/fuel-gauge/src/contract.test.ts

@@ -156,7 +156,7 @@ describe('Contract', () => {
     // #endregion
 
     // #region typedoc:Contract-multicall-multiple-contracts-p2
-    const scope = contract.multiCall(calls).addContracts([otherContract.id]);
+    const scope = contract.multiCall(calls).addContracts([otherContract]);
     // #endregion
 
     expect(scope.transactionRequest.getContractInputs()).toEqual([
@@ -208,9 +208,7 @@ describe('Contract', () => {
     const contract = await setupContract();
     const otherContract = await setupContract({ cache: false });
 
-    const scope = contract
-      .multiCall([contract.functions.foo(1336)])
-      .addContracts([otherContract.id]);
+    const scope = contract.multiCall([contract.functions.foo(1336)]).addContracts([otherContract]);
 
     expect(scope.transactionRequest.getContractInputs()).toEqual([
       { contractId: contract.id.toB256(), type: 1, txPointer },

packages/fuel-gauge/src/utils.ts

@@ -44,8 +44,10 @@ export const createSetupConfig =
       ...config,
     });
 
-const getFullPath = (contractName: string, next: (fullPath: string) => () => Promise<Contract>) =>
-  next(join(__dirname, `../test-projects/${contractName}/out/debug/${contractName}`));
+const getFullPath = (
+  contractName: string,
+  next: (fullPath: string) => (config?: Partial<SetupConfig>) => Promise<Contract>
+) => next(join(__dirname, `../test-projects/${contractName}/out/debug/${contractName}`));
 
 export const getSetupContract = (contractName: string) =>
   getFullPath(contractName, (fullPath: string) =>

packages/fuel-gauge/test-projects/advanced-logging-other-contract-abi/Forc.toml

@@ -0,0 +1,5 @@
+[project]
+license = "Apache-2.0"
+name = "advanced-logging-other-contract-abi"
+
+[dependencies]

packages/fuel-gauge/test-projects/advanced-logging-other-contract-abi/src/main.sw

@@ -0,0 +1,6 @@
+library advanced_logging_other_contract_abi;
+
+abi AdvancedLoggingOtherContract {
+    fn msg_from_other_contract(a:u8);
+}
+

packages/fuel-gauge/test-projects/advanced-logging-other-contract/Forc.toml

@@ -0,0 +1,6 @@
+[project]
+license = "Apache-2.0"
+name = "advanced-logging-other-contract"
+
+[dependencies]
+advanced-logging-other-contract-abi = { path = "../advanced-logging-other-contract-abi" }