feat(wallet): add support for building tx with metadata

Author: mkazlauskas

packages/wallet/package.json

@@ -22,7 +22,7 @@
     "lint:fix": "eslint --fix --ignore-path ../../.eslintignore \"**/*.ts\"",
     "prepack": "yarn build",
     "test": "jest -c ./jest.config.js",
-    "test:e2e": "jest -c ./e2e.jest.config.js",
+    "test:e2e": "jest -c ./e2e.jest.config.js --runInBand",
     "test:debug": "DEBUG=true yarn test"
   },
   "devDependencies": {

packages/wallet/src/SingleAddressWallet.ts

@@ -194,6 +194,7 @@ export class SingleAddressWallet implements Wallet {
       utxo: new Set(utxo)
     });
     const { body, hash } = await createTransactionInternals({
+      auxiliaryData: props.auxiliaryData,
       certificates: props.certificates,
       changeAddress,
       inputSelection,
@@ -256,14 +257,14 @@ export class SingleAddressWallet implements Wallet {
             buildTx: async (inputSelection) => {
               this.#logger.debug('Building TX for selection constraints', inputSelection);
               const txInternals = await createTransactionInternals({
+                auxiliaryData: props.auxiliaryData,
                 certificates: props.certificates,
                 changeAddress,
                 inputSelection,
                 validityInterval,
                 withdrawals: props.withdrawals
               });
-              // TODO: add auxiliaryData support
-              return coreToCsl.tx(await this.finalizeTx(txInternals, undefined, true));
+              return coreToCsl.tx(await this.finalizeTx(txInternals, props.auxiliaryData, true));
             },
             protocolParameters
           });

packages/wallet/src/Transaction/createTransactionInternals.ts

@@ -12,9 +12,11 @@ export type CreateTxInternalsProps = {
   validityInterval: Cardano.ValidityInterval;
   certificates?: Cardano.Certificate[];
   withdrawals?: Cardano.Withdrawal[];
+  auxiliaryData?: Cardano.AuxiliaryData;
 };
 
 export const createTransactionInternals = async ({
+  auxiliaryData,
   changeAddress,
   withdrawals,
   certificates,
@@ -38,8 +40,10 @@ export const createTransactionInternals = async ({
     validityInterval,
     withdrawals
   };
+  const cslBody = coreToCsl.txBody(body, auxiliaryData);
+
   return {
     body,
-    hash: Cardano.TransactionId(Buffer.from(CSL.hash_transaction(coreToCsl.txBody(body)).to_bytes()).toString('hex'))
+    hash: Cardano.TransactionId(Buffer.from(CSL.hash_transaction(cslBody).to_bytes()).toString('hex'))
   };
 };

packages/wallet/src/types.ts

@@ -8,6 +8,7 @@ export type InitializeTxProps = {
   outputs?: Set<Cardano.TxOut>;
   certificates?: Cardano.Certificate[];
   withdrawals?: Cardano.Withdrawal[];
+  auxiliaryData?: Cardano.AuxiliaryData;
   options?: {
     validityInterval?: Cardano.ValidityInterval;
   };

packages/wallet/test/e2e/SingleAddressWallet/metadata.test.ts

@@ -0,0 +1,46 @@
+import { Cardano, util } from '@cardano-sdk/core';
+import { SingleAddressWallet } from '../../../src';
+import { assetProvider, keyAgentReady, stakePoolSearchProvider, timeSettingsProvider, walletProvider } from '../config';
+import { filter, firstValueFrom, map } from 'rxjs';
+
+describe('SingleAddressWallet/metadata', () => {
+  let wallet: SingleAddressWallet;
+  let ownAddress: Cardano.Address;
+
+  beforeAll(async () => {
+    wallet = new SingleAddressWallet(
+      { name: 'Test Wallet' },
+      {
+        assetProvider,
+        keyAgent: await keyAgentReady,
+        stakePoolSearchProvider,
+        timeSettingsProvider,
+        walletProvider
+      }
+    );
+    ownAddress = (await firstValueFrom(wallet.addresses$))[0].address;
+  });
+
+  afterAll(() => wallet.shutdown());
+
+  test('can submit tx with metadata and then query it', async () => {
+    const auxiliaryData: Cardano.AuxiliaryData = {
+      body: {
+        blob: new Map([[123n, '1234']])
+      }
+    };
+    const txInternals = await wallet.initializeTx({
+      auxiliaryData,
+      outputs: new Set([{ address: ownAddress, value: { coins: 1_000_000n } }])
+    });
+    const outgoingTx = await wallet.finalizeTx(txInternals, auxiliaryData);
+    await wallet.submitTx(outgoingTx);
+    const loadedTx = await firstValueFrom(
+      wallet.transactions.history.outgoing$.pipe(
+        map((txs) => txs.find((tx) => tx.id === outgoingTx.id)),
+        filter(util.isNotNil)
+      )
+    );
+    expect(loadedTx.auxiliaryData).toEqual(auxiliaryData);
+  });
+});