feat(vats): Mock ERTP face on mock orch assets

packages/orchestration/package.json

@@ -48,6 +48,7 @@
     "@agoric/zone": "^0.2.2",
     "@endo/base64": "^1.0.9",
     "@endo/errors": "^1.2.8",
+    "@endo/eventual-send": "^1.2.8",
     "@endo/far": "^1.1.9",
     "@endo/marshal": "^1.6.2",
     "@endo/patterns": "^1.4.7",

packages/orchestration/src/mock-orch-ertp/mock-ertp/internal-typeGuards.js

@@ -0,0 +1,65 @@
+import { M } from '@endo/patterns';
+
+import { AmountShape, PaymentShape, PurseShape } from '@agoric/ertp';
+import { AnyNatAmountShape } from '../../typeGuards.js';
+import { mockIssuerInterfaces } from './typeGuards.js';
+import { MockOrchAccountShape } from '../mock-orch/typeGuards.js';
+
+export const RecoverySetShape = M.remotable('RecoverySet');
+export const RecoveryFacetShape = M.remotable('RecoverFacet');
+
+export const PaymentLedgerEntryShape = harden({
+  keyShape: PaymentShape,
+  valueShape: AnyNatAmountShape,
+});
+
+export const PaymentRecoveryEntryShape = harden({
+  keyShape: PaymentShape,
+  valueShape: RecoveryFacetShape,
+});
+
+/**
+ * @param {Pattern} [brandShape]
+ * @param {Pattern} [assetKindShape]
+ * @param {Pattern} [amountShape]
+ */
+export const mockIssuerInterfacesPlus = (
+  brandShape = undefined,
+  assetKindShape = undefined,
+  amountShape = AmountShape,
+) => {
+  const {
+    IssuerI,
+    MintI,
+    PaymentI,
+    PurseIKit: MockPurseIKit,
+  } = mockIssuerInterfaces(brandShape, assetKindShape, amountShape);
+
+  const RecoveryFacetI = M.interface('RecoveryFacet', {
+    initPayment: M.call(PaymentShape).returns(),
+    deletePayment: M.call(PaymentShape).returns(),
+    getRecoverySetStore: M.call().returns(RecoverySetShape),
+    getCurrentEncumberedBalance: M.call().returns(amountShape),
+    encumber: M.call(amountShape).returns(),
+    unencumber: M.call(amountShape).returns(),
+    getOrchAcct: M.call().returns(M.eref(MockOrchAccountShape)),
+  });
+
+  const MockPurseIKitPlus = {
+    ...MockPurseIKit,
+    recoveryFacet: RecoveryFacetI,
+  };
+
+  const IssuerAdminI = M.interface('MockIssuerAdmin', {
+    makePurse: M.call(M.eref(MockOrchAccountShape)).returns(PurseShape),
+  });
+
+  return harden({
+    IssuerI,
+    MintI,
+    PaymentI,
+    PurseIKit: MockPurseIKitPlus,
+    IssuerAdminI,
+  });
+};
+harden(mockIssuerInterfacesPlus);

packages/orchestration/src/mock-orch-ertp/mock-ertp/internal-types.ts

@@ -0,0 +1,56 @@
+import type { ERef } from '@endo/eventual-send'
+
+import type { WeakMapStore, SetStore } from '@agoric/store';
+
+import type { Payment, Amount } from '@agoric/ertp';
+import type { MockOrchAccount } from '../mock-orch/types.ts';
+import type { MockPurse } from './types.js';
+
+export type PaymentLedgerMap = WeakMapStore<Payment, Amount>;
+
+export type RecoverySet = SetStore<Payment>;
+
+export type RecoveryFacet = {
+  /**
+   *
+   */
+  initPayment: (payment: Payment) => void;
+
+  /**
+   *
+   */
+  deletePayment: (payment: Payment) => void;
+
+  /**
+   * Awkward name because `getRecoverSet` is already a method of purse that
+   * return a copySet.
+   */
+  getRecoverySetStore: () => RecoverySet;
+
+  /**
+   * Get the amount contained in all payments still in the recoverySet at
+   * this moment
+   */
+  getCurrentEncumberedBalance: () => Amount;
+
+  /**
+   *
+   */
+  encumber: (amount: Amount) => void;
+
+  /**
+   *
+   */
+  unencumber: (amount: Amount) => void;
+
+  /**
+   *
+   */
+  getOrchAcct: () => ERef<MockOrchAccount>;
+};
+
+export type PaymentRecoveryMap = WeakMapStore<Payment, RecoveryFacet>;
+
+export type MockIssuerAdmin = {
+  makePurse: (orchAcctP: ERef<MockOrchAccount>) => MockPurse;
+};