feat(ERTP): revoke used up payments

Agoric · Jul 31, 2023 · b4a3449 · b4a3449
1 parent 361e46e
commit b4a3449
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 3 deletions.
diff --git a/packages/ERTP/package.json b/packages/ERTP/package.json
@@ -52,6 +52,7 @@
   },
   "devDependencies": {
     "@endo/bundle-source": "^2.5.2",
+    "@endo/exo": "^0.2.3",
     "@fast-check/ava": "^1.1.5",
     "ava": "^5.3.0",
     "tsd": "^0.28.1"

diff --git a/packages/ERTP/src/payment.js b/packages/ERTP/src/payment.js
@@ -11,9 +11,13 @@ import { prepareExoClass } from '@agoric/vat-data';
  * @param {string} name
  * @param {Brand<K>} brand
  * @param {InterfaceGuard} PaymentI
- * @returns {() => Payment<K>}
+ * @returns {{
+ *   makePayment: () => Payment<K>,
+ *   revokePayment: (payment: Payment<K>) => boolean
+ * }}
  */
 export const preparePaymentKind = (issuerBaggage, name, brand, PaymentI) => {
+  let revokePayment;
   const makePayment = prepareExoClass(
     issuerBaggage,
     `${name} payment`,
@@ -24,7 +28,16 @@ export const preparePaymentKind = (issuerBaggage, name, brand, PaymentI) => {
         return brand;
       },
     },
+    {
+      getRevoker(revoke) {
+        revokePayment = revoke;
+      },
+    },
   );
-  return makePayment;
+  assert(revokePayment !== undefined);
+  return harden({
+    makePayment,
+    revokePayment,
+  });
 };
 harden(preparePaymentKind);
diff --git a/packages/ERTP/src/paymentLedger.js b/packages/ERTP/src/paymentLedger.js
@@ -121,7 +121,12 @@ export const preparePaymentLedger = (
     amountShape,
   );
 
-  const makePayment = preparePaymentKind(issuerBaggage, name, brand, PaymentI);
+  const { makePayment, revokePayment } = preparePaymentKind(
+    issuerBaggage,
+    name,
+    brand,
+    PaymentI,
+  );
 
   /** @type {ShutdownWithFailure} */
   const shutdownLedgerWithFailure = reason => {
@@ -198,6 +203,8 @@ export const preparePaymentLedger = (
       paymentRecoverySets.delete(payment);
       recoverySet.delete(payment);
     }
+    // @ts-expect-error The usual type param confusion
+    revokePayment(payment);
   };
 
   /** @type {(left: Amount, right: Amount) => Amount} */

diff --git a/packages/ERTP/test/unitTests/test-recovery.js b/packages/ERTP/test/unitTests/test-recovery.js
@@ -1,4 +1,5 @@
 import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';
+import { GET_INTERFACE_GUARD } from '@endo/exo';
 import { getCopySetKeys, keyEQ, makeCopySet } from '@agoric/store';
 
 import { makeIssuerKit, AmountMath } from '../../src/index.js';
@@ -67,4 +68,12 @@ test('payment recovery from mint recovery set', async t => {
   t.throws(() => bobPurse.deposit(payment2), {
     message: /was not a live payment for brand/,
   });
+  t.throws(() => payment2.getAllegedBrand(), {
+    message:
+      '"In \\"getAllegedBrand\\" method of (precious payment)" may only be applied to a valid instance: "[Alleged: precious payment]"',
+  });
+  t.throws(() => payment2[GET_INTERFACE_GUARD](), {
+    message:
+      '"In \\"[Symbol(getInterfaceGuard)]\\" method of (precious payment)" may only be applied to a valid instance: "[Alleged: precious payment]"',
+  });
 });