feat: Deserialize AztecAddress when contract's view function returns it in Aztec.js #3641

yarn-project/end-to-end/src/shared/cross_chain_test_harness.ts

@@ -104,8 +104,7 @@ export async function deployAndInitializeTokenAndBridgeContracts(
     throw new Error(`Token admin is not ${owner}`);
   }
 
-  // TODO(#3641) - Fix deserialization and compare AztecAddress directly
-  if ((await bridge.methods.token().view()).inner !== token.address.toBigInt()) {
+  if (!(await bridge.methods.token().view()).equals(token.address)) {
     throw new Error(`Bridge token is not ${token.address}`);
   }
 

yarn-project/foundation/src/abi/decoder.ts

@@ -1,10 +1,12 @@
+import { AztecAddress } from '../aztec-address/index.js';
 import { Fr } from '../fields/index.js';
 import { ABIParameter, type ABIType, ABIVariable, FunctionArtifact } from './abi.js';
+import { isAztecAddressStruct } from './utils.js';
 
 /**
  * The type of our decoded ABI.
  */
-export type DecodedReturn = bigint | boolean | DecodedReturn[] | { [key: string]: DecodedReturn };
+export type DecodedReturn = bigint | boolean | AztecAddress | DecodedReturn[] | { [key: string]: DecodedReturn };
 
 /**
  * Decodes return values from a function call.
@@ -38,6 +40,10 @@ class ReturnValuesDecoder {
       }
       case 'struct': {
         const struct: { [key: string]: DecodedReturn } = {};
+        if (isAztecAddressStruct(abiType)) {
+          return new AztecAddress(this.getNextField().toBuffer());
+        }
+
         for (const field of abiType.fields) {
           struct[field.name] = this.decodeReturn(field.type);
         }