fix: zoe start using patterns

packages/wallet/api/src/findOrMakeInvitation.js

@@ -10,7 +10,7 @@ const assertFirstCapASCII = str => {
   const firstCapASCII = /^[A-Z][a-zA-Z0-9_$]*$/;
   assert(
     firstCapASCII.test(str),
-    X`The string ${q(str)} must be ascii and must start with a capital letter.`,
+    X`The string ${q(str)} must be an ascii identifier starting with upper case.`,
   );
   assert(
     str !== 'NaN' && str !== 'Infinity',

packages/zoe/src/cleanProposal.js

@@ -1,21 +1,20 @@
 // @ts-check
 
 import { assert, details as X, q } from '@agoric/assert';
-import { mustBeComparable } from '@agoric/same-structure';
 import { isNat } from '@agoric/nat';
 import { AmountMath, getAssetKind } from '@agoric/ertp';
 import { assertRecord } from '@agoric/marshal';
+import { assertPattern } from '@agoric/store';
 import {
   isOnDemandExitRule,
   isWaivedExitRule,
   isAfterDeadlineExitRule,
 } from './typeGuards.js';
+import { arrayToObj, assertSubset } from './objArrayConversion.js';
 
 import '../exported.js';
 import './internal-types.js';
 
-import { arrayToObj, assertSubset } from './objArrayConversion.js';
-
 const firstCapASCII = /^[A-Z][a-zA-Z0-9_$]*$/;
 
 // We adopt simple requirements on keywords so that they do not accidentally
@@ -33,7 +32,7 @@ export const assertKeywordName = keyword => {
     firstCapASCII.test(keyword),
     X`keyword ${q(
       keyword,
-    )} must be ascii and must start with a capital letter.`,
+    )} must be an ascii identifier starting with upper case.`,
   );
   assert(
     keyword !== 'NaN' && keyword !== 'Infinity',
@@ -48,6 +47,7 @@ const assertKeysAllowed = (allowedKeys, record) => {
   const keys = Object.getOwnPropertyNames(record);
   assertSubset(allowedKeys, keys);
   // assert that there are no symbol properties.
+  // TODO unreachable: already rejected as unpassable
   assert(
     Object.getOwnPropertySymbols(record).length === 0,
     X`no symbol properties allowed`,
@@ -95,6 +95,7 @@ export const cleanKeywords = keywordRecord => {
   const keywords = Object.getOwnPropertyNames(keywordRecord);
 
   // Insist that there are no symbol properties.
+  // TODO unreachable: already rejected as unpassable
   assert(
     Object.getOwnPropertySymbols(keywordRecord).length === 0,
     X`no symbol properties allowed`,
@@ -177,7 +178,7 @@ const rootKeysAllowed = harden(['want', 'give', 'exit']);
  * @returns {ProposalRecord}
  */
 export const cleanProposal = (proposal, getAssetKindByBrand) => {
-  mustBeComparable(proposal);
+  assertPattern(proposal);
   assertKeysAllowed(rootKeysAllowed, proposal);
 
   // We fill in the default values if the keys are undefined.

packages/zoe/src/contractSupport/index.js

@@ -26,6 +26,7 @@ export * from './statistics.js';
 export {
   defaultAcceptanceMsg,
   swap,
+  fitProposalPattern,
   assertProposalShape,
   assertIssuerKeywords,
   satisfies,

packages/zoe/src/contractSupport/zoeHelpers.js

@@ -5,7 +5,7 @@ import { assert, details as X } from '@agoric/assert';
 import { sameStructure } from '@agoric/same-structure';
 import { E } from '@agoric/eventual-send';
 import { makePromiseKit } from '@agoric/promise-kit';
-
+import { fit } from '@agoric/store';
 import { AssetKind } from '@agoric/ertp';
 import { satisfiesWant } from '../contractFacet/offerSafety.js';
 
@@ -100,6 +100,18 @@ export const swapExact = (zcf, leftSeat, rightSeat) => {
  * @property {Partial<Record<keyof ProposalRecord['exit'], null>>} [exit]
  */
 
+/**
+ * Check the seat's proposal against `proposalPattern`.
+ * If the client submits an offer which does not match
+ * these expectations, the seat will be exited (and payments refunded).
+ *
+ * @param {ZCFSeat} seat
+ * @param {Pattern} proposalPattern
+ */
+export const fitProposalPattern = (seat, proposalPattern) =>
+  // TODO remove this harden, obligating our caller to harden.
+  fit(seat.getProposal(), harden(proposalPattern));
+
 /**
  * Check the seat's proposal against an `expected` record that says
  * what shape of proposal is acceptable.

packages/zoe/src/contracts/coveredCall.js

@@ -1,10 +1,11 @@
 // @ts-check
 
 import { assert } from '@agoric/assert';
+import { M, fit } from '@agoric/store';
 import '../../exported.js';
 
 // Eventually will be importable from '@agoric/zoe-contract-support'
-import { assertProposalShape, swapExact } from '../contractSupport/index.js';
+import { swapExact } from '../contractSupport/index.js';
 import { isAfterDeadlineExitRule } from '../typeGuards.js';
 
 /**
@@ -27,8 +28,10 @@ import { isAfterDeadlineExitRule } from '../typeGuards.js';
  * different brands can be escrowed under different keywords. The
  * proposal must have an exit record with the key "afterDeadline":
  * {
- *    give: { ... }, want: { ... }, exit: {afterDeadline: { deadline:
- *    time, timer: myTimer }
+ *    give: { ... },
+ *    want: { ... },
+ *    exit: {
+ *      afterDeadline: { deadline: time, timer: myTimer }
  *    },
  * }
  *
@@ -70,7 +73,7 @@ const start = zcf => {
 
   /** @type {OfferHandler} */
   const makeOption = sellSeat => {
-    assertProposalShape(sellSeat, { exit: { afterDeadline: null } });
+    fit(sellSeat.getProposal(), M.split({ exit: { afterDeadline: M.any() } }));
     const sellSeatExitRule = sellSeat.getProposal().exit;
     assert(
       isAfterDeadlineExitRule(sellSeatExitRule),

packages/zoe/src/typeGuards.js

@@ -1,9 +1,38 @@
 // @ts-check
 
-/**
- * @param {ExitRule} exit
- * @returns {exit is OnDemandExitRule}
- */
+import { AmountPattern } from '@agoric/ertp';
+import { M } from '@agoric/store';
+
+export const ExitOnDemandPattern = harden({ onDemand: null });
+
+export const ExitWaivedPattern = harden({ waived: null });
+
+export const ExitAfterDeadlinePattern = harden({
+  afterDeadline: { timer: M.remotable(), deadline: M.nat() },
+});
+
+export const ExitRulePattern = M.or(
+  ExitOnDemandPattern,
+  ExitWaivedPattern,
+  ExitAfterDeadlinePattern,
+);
+
+export const KeywordRecordPatternOf = valuePatt =>
+  M.recordOf(M.string(), valuePatt);
+
+export const AmountKeywordRecordPattern = KeywordRecordPatternOf(AmountPattern);
+
+export const PatternKeywordRecordPattern = KeywordRecordPatternOf(M.pattern());
+
+export const ProposalPattern = M.partial(
+  {
+    want: M.or(undefined, PatternKeywordRecordPattern),
+    give: M.or(undefined, AmountKeywordRecordPattern),
+    exit: M.or(undefined, ExitRulePattern),
+  },
+  {},
+);
+
 export const isOnDemandExitRule = exit => {
   const [exitKey] = Object.getOwnPropertyNames(exit);
   return exitKey === 'onDemand';