record transaction fees (#10715)

closes: #10578

## Description

Adds the fee `split` to the Disbursed status of TransactionRecord.

Also updates tests to have a marshaller that is capable of marshaling brands in the split.


### Security Considerations
Gives a read-only marshaller to StatusManager.

### Scaling Considerations
a little more data recorded on disbursement. Since that's a terminal state it will be retained until the GC action is run in a core-eval (or we are able to delete upon completion)

### Documentation Considerations
updated types

### Testing Considerations
CI

### Upgrade Considerations
not deployed

packages/fast-usdc/src/exos/settler.js

@@ -260,7 +260,7 @@ export const prepareSettler = (
           repayer.repay(settlingSeat, split);
 
           // update status manager, marking tx `SETTLED`
-          statusManager.disbursed(txHash);
+          statusManager.disbursed(txHash, split);
         },
         /**
          * @param {EvmHash} txHash

packages/fast-usdc/src/exos/status-manager.js

@@ -1,14 +1,15 @@
-import { M } from '@endo/patterns';
-import { Fail, makeError, q } from '@endo/errors';
+import { makeTracer } from '@agoric/internal';
 import { appendToStoredArray } from '@agoric/store/src/stores/store-utils.js';
+import { AmountKeywordRecordShape } from '@agoric/zoe/src/typeGuards.js';
+import { Fail, makeError, q } from '@endo/errors';
 import { E } from '@endo/eventual-send';
-import { makeTracer, pureDataMarshaller } from '@agoric/internal';
+import { M } from '@endo/patterns';
+import { PendingTxStatus, TerminalTxStatus, TxStatus } from '../constants.js';
 import {
   CctpTxEvidenceShape,
   EvmHashShape,
   PendingTxShape,
 } from '../type-guards.js';
-import { PendingTxStatus, TerminalTxStatus, TxStatus } from '../constants.js';
 
 /**
  * @import {MapStore, SetStore} from '@agoric/store';
@@ -48,6 +49,7 @@ const pendingTxKeyOf = evidence => {
 /**
  * @typedef {{
  *  log?: LogFn;
+ *  marshaller: ERef<Marshaller>;
  * }} StatusManagerPowers
  */
 
@@ -66,6 +68,7 @@ export const prepareStatusManager = (
   zone,
   txnsNode,
   {
+    marshaller,
     log = makeTracer('Advancer', true),
   } = /** @type {StatusManagerPowers} */ ({}),
 ) => {
@@ -102,14 +105,25 @@ export const prepareStatusManager = (
   /**
    * @param {EvmHash} txId
    * @param {TransactionRecord} record
+   * @returns {Promise<void>}
    */
-  const publishTxnRecord = (txId, record) => {
+  const publishTxnRecord = async (txId, record) => {
     const txNode = E(txnsNode).makeChildNode(txId, {
       sequence: true, // avoid overwriting other output in the block
     });
-    void E(txNode).setValue(
-      JSON.stringify(pureDataMarshaller.toCapData(record)),
-    );
+
+    // XXX awkward for publish* to update a store, but it's temporary
+    if (record.status && TerminalTxStatus[record.status]) {
+      // UNTIL https://github.com/Agoric/agoric-sdk/issues/7405
+      // Queue it for deletion later because if we deleted it now the earlier
+      // writes in this block would be wiped. For now we keep track of what to
+      // delete when we know it'll be another block.
+      storedCompletedTxs.add(txId);
+    }
+
+    const capData = await E(marshaller).toCapData(record);
+
+    await E(txNode).setValue(JSON.stringify(capData));
   };
 
   /**
@@ -124,22 +138,6 @@ export const prepareStatusManager = (
     );
   };
 
-  /**
-   * @param {CctpTxEvidence['txHash']} hash
-   * @param {TxStatus} status
-   */
-  const publishStatus = (hash, status) => {
-    // Don't await, just writing to vstorage.
-    void publishTxnRecord(hash, harden({ status }));
-    if (TerminalTxStatus[status]) {
-      // UNTIL https://github.com/Agoric/agoric-sdk/issues/7405
-      // Queue it for deletion later because if we deleted it now the earlier
-      // writes in this block would be wiped. For now we keep track of what to
-      // delete when we know it'll be another block.
-      storedCompletedTxs.add(hash);
-    }
-  };
-
   /**
    * Ensures that `txHash+chainId` has not been processed
    * and adds entry to `seenTxs` set.
@@ -164,7 +162,7 @@ export const prepareStatusManager = (
     publishEvidence(txHash, evidence);
     if (status !== PendingTxStatus.Observed) {
       // publishEvidence publishes Observed
-      publishStatus(txHash, status);
+      void publishTxnRecord(txHash, harden({ status }));
     }
   };
 
@@ -187,7 +185,7 @@ export const prepareStatusManager = (
     ];
     const txpost = { ...tx, status };
     pendingTxs.set(key, harden([...prefix, txpost, ...suffix]));
-    publishStatus(tx.txHash, status);
+    void publishTxnRecord(tx.txHash, harden({ status }));
   }
 
   return zone.exo(
@@ -212,7 +210,9 @@ export const prepareStatusManager = (
           M.undefined(),
         ),
       ),
-      disbursed: M.call(EvmHashShape).returns(M.undefined()),
+      disbursed: M.call(EvmHashShape, AmountKeywordRecordShape).returns(
+        M.undefined(),
+      ),
       forwarded: M.call(M.opt(EvmHashShape), M.string(), M.nat()).returns(
         M.undefined(),
       ),
@@ -313,9 +313,13 @@ export const prepareStatusManager = (
        * Mark a transaction as `DISBURSED`
        *
        * @param {EvmHash} txHash
+       * @param {import('./liquidity-pool.js').RepayAmountKWR} split
        */
-      disbursed(txHash) {
-        publishStatus(txHash, TxStatus.Disbursed);
+      disbursed(txHash, split) {
+        void publishTxnRecord(
+          txHash,
+          harden({ split, status: TxStatus.Disbursed }),
+        );
       },
 
       /**
@@ -327,7 +331,7 @@ export const prepareStatusManager = (
        */
       forwarded(txHash, nfa, amount) {
         if (txHash) {
-          publishStatus(txHash, TxStatus.Forwarded);
+          void publishTxnRecord(txHash, harden({ status: TxStatus.Forwarded }));
         } else {
           // TODO store (early) `Minted` transactions to check against incoming evidence
           log(

packages/fast-usdc/src/fast-usdc.contract.js

@@ -112,6 +112,7 @@ export const contract = async (zcf, privateArgs, zone, tools) => {
   const statusManager = prepareStatusManager(
     zone,
     E(storageNode).makeChildNode(TXNS_NODE),
+    { marshaller },
   );
 
   const { USDC } = terms.brands;

packages/fast-usdc/src/types.ts

@@ -9,6 +9,7 @@ import type { Amount } from '@agoric/ertp';
 import type { CopyRecord, Passable } from '@endo/pass-style';
 import type { PendingTxStatus, TxStatus } from './constants.js';
 import type { FastUsdcTerms } from './fast-usdc.contract.js';
+import type { RepayAmountKWR } from './exos/liquidity-pool.js';
 
 export type EvmHash = `0x${string}`;
 export type EvmAddress = `0x${string & { length: 40 }}`;
@@ -40,6 +41,7 @@ export interface CctpTxEvidence {
  */
 export interface TransactionRecord extends CopyRecord {
   evidence?: CctpTxEvidence;
+  split?: RepayAmountKWR;
   status: TxStatus;
 }
 

packages/fast-usdc/test/exos/advancer.test.ts

@@ -12,6 +12,7 @@ import { type ZoeTools } from '@agoric/orchestration/src/utils/zoe-tools.js';
 import { q } from '@endo/errors';
 import { Far } from '@endo/pass-style';
 import type { TestFn } from 'ava';
+import { makeTracer } from '@agoric/internal';
 import { PendingTxStatus } from '../../src/constants.js';
 import { prepareAdvancer } from '../../src/exos/advancer.js';
 import type { SettlerKit } from '../../src/exos/settler.js';
@@ -26,6 +27,8 @@ import {
 } from '../mocks.js';
 import { commonSetup } from '../supports.js';
 
+const trace = makeTracer('AdvancerTest', false);
+
 const LOCAL_DENOM = `ibc/${denomHash({
   denom: 'uusdc',
   channelId:
@@ -50,6 +53,7 @@ const createTestExtensions = (t, common: CommonSetup) => {
   const statusManager = prepareStatusManager(
     rootZone.subZone('status-manager'),
     storageNode.makeChildNode('txns'),
+    { marshaller: common.commonPrivateArgs.marshaller },
   );
 
   const mockAccounts = prepareMockOrchAccounts(rootZone.subZone('accounts'), {
@@ -74,7 +78,7 @@ const createTestExtensions = (t, common: CommonSetup) => {
   };
   const mockZoeTools = Far('MockZoeTools', {
     localTransfer(...args: Parameters<ZoeTools['localTransfer']>) {
-      console.log('ZoeTools.localTransfer called with', args);
+      trace('ZoeTools.localTransfer called with', args);
       return localTransferVK.vow;
     },
   });
@@ -99,7 +103,7 @@ const createTestExtensions = (t, common: CommonSetup) => {
   const notifyAdvancingResultCalls: NotifyArgs[] = [];
   const mockNotifyF = Far('Settler Notify Facet', {
     notifyAdvancingResult: (...args: NotifyArgs) => {
-      console.log('Settler.notifyAdvancingResult called with', args);
+      trace('Settler.notifyAdvancingResult called with', args);
       notifyAdvancingResultCalls.push(args);
     },
   });
@@ -167,7 +171,7 @@ test.beforeEach(async t => {
 test('updates status to ADVANCING in happy path', async t => {
   const {
     extensions: {
-      services: { advancer, feeTools, statusManager },
+      services: { advancer, feeTools },
       helpers: { inspectLogs, inspectNotifyCalls },
       mocks: { mockPoolAccount, resolveLocalTransferV },
     },
@@ -235,7 +239,7 @@ test('updates status to OBSERVED on insufficient pool funds', async t => {
     brands: { usdc },
     bootstrap: { storage },
     extensions: {
-      services: { makeAdvancer, statusManager },
+      services: { makeAdvancer },
       helpers: { inspectLogs },
       mocks: { mockPoolAccount, mockNotifyF },
     },
@@ -283,13 +287,14 @@ test('updates status to OBSERVED if makeChainAddress fails', async t => {
   const {
     bootstrap: { storage },
     extensions: {
-      services: { advancer, statusManager },
+      services: { advancer },
       helpers: { inspectLogs },
     },
   } = t.context;
 
   const evidence = MockCctpTxEvidences.AGORIC_UNKNOWN_EUD();
   await advancer.handleTransactionEvent(evidence);
+  await eventLoopIteration();
 
   t.deepEqual(
     storage.getDeserialized(`fun.txns.${evidence.txHash}`),
@@ -310,7 +315,7 @@ test('calls notifyAdvancingResult (AdvancedFailed) on failed transfer', async t
   const {
     bootstrap: { storage },
     extensions: {
-      services: { advancer, feeTools, statusManager },
+      services: { advancer, feeTools },
       helpers: { inspectLogs, inspectNotifyCalls },
       mocks: { mockPoolAccount, resolveLocalTransferV },
     },
@@ -363,14 +368,15 @@ test('updates status to OBSERVED if pre-condition checks fail', async t => {
   const {
     bootstrap: { storage },
     extensions: {
-      services: { advancer, statusManager },
+      services: { advancer },
       helpers: { inspectLogs },
     },
   } = t.context;
 
   const evidence = MockCctpTxEvidences.AGORIC_NO_PARAMS();
 
   await advancer.handleTransactionEvent(evidence);
+  await eventLoopIteration();
 
   t.deepEqual(
     storage.getDeserialized(`fun.txns.${evidence.txHash}`),

packages/fast-usdc/test/exos/settler.test.ts

@@ -4,6 +4,7 @@ import type { TestFn } from 'ava';
 import { eventLoopIteration } from '@agoric/internal/src/testing-utils.js';
 import fetchedChainInfo from '@agoric/orchestration/src/fetched-chain-info.js';
 import type { Zone } from '@agoric/zone';
+import { defaultMarshaller } from '@agoric/internal/src/storage-test-utils.js';
 import { PendingTxStatus } from '../../src/constants.js';
 import { prepareSettler } from '../../src/exos/settler.js';
 import { prepareStatusManager } from '../../src/exos/status-manager.js';
@@ -48,7 +49,7 @@ const makeTestContext = async t => {
   const statusManager = prepareStatusManager(
     zone.subZone('status-manager'),
     common.commonPrivateArgs.storageNode.makeChildNode('txns'),
-    { log },
+    { marshaller: defaultMarshaller, log },
   );
   const { zcf, callLog } = mockZcf(zone.subZone('Mock ZCF'));
 
@@ -239,7 +240,7 @@ test('happy path: disburse to LPs; StatusManager removes tx', async t => {
     { evidence: cctpTxEvidence, status: 'OBSERVED' },
     { status: 'ADVANCING' },
     { status: 'ADVANCED' },
-    { status: 'DISBURSED' },
+    { split: expectedSplit, status: 'DISBURSED' },
   ]);
 
   // Check deletion of DISBURSED transactions