fixup! start pushing want patterns into zoe

Author: erights

packages/ERTP/src/typeGuards.js

@@ -2,7 +2,7 @@
 
 import { M, matches, getInterfaceGuardPayload } from '@endo/patterns';
 /**
- * @import {AmountValue, Amount, AmountValueHasBound, AmountValueBound, AmountBound, Ratio} from './types.js'
+ * @import {AmountValue, Amount, AmountValueHasBound, AmountValueBound, AmountBound, Ratio, NatValue} from './types.js'
  * @import {TypedPattern} from '@agoric/internal'
  * @import {CopyBag, CopySet, Pattern} from '@endo/patterns';
  */
@@ -117,8 +117,8 @@ harden(RatioShape);
 /**
  * Returns true if value is a Nat bigint.
  *
- * @param {AmountValue} value
- * @returns {value is import('./types.js').NatValue}
+ * @param {AmountValueBound} value
+ * @returns {value is NatValue}
  */
 export const isNatValue = value => matches(value, NatValueShape);
 harden(isNatValue);

packages/zoe/exported.d.ts

@@ -10,8 +10,6 @@ import {
   AmountKeywordRecord as _AmountKeywordRecord,
   ContractMeta as _ContractMeta,
   Handle as _Handle,
-  Installation as _Installation,
-  Instance as _Instance,
   Invitation as _Invitation,
   InvitationAmount as _InvitationAmount,
   IssuerKeywordRecord as _IssuerKeywordRecord,
@@ -26,6 +24,11 @@ import {
   ZoeService as _ZoeService,
 } from './src/types-index.js';
 
+import {
+  Installation as _Installation,
+  Instance as _Instance,
+} from './src/zoeService/utils.js';
+
 declare global {
   // @ts-ignore TS2666: Exports and export assignments are not permitted in module augmentations.
   export {
@@ -35,7 +38,7 @@ declare global {
     _FeeIssuerConfig as FeeIssuerConfig,
     _Handle as Handle,
     _Installation as Installation,
-    _Instance as Instance,
+    // _Instance as Instance,
     _Invitation as Invitation,
     _InvitationAmount as InvitationAmount,
     _IssuerKeywordRecord as IssuerKeywordRecord,

packages/zoe/src/contractFacet/offerSafety.js

@@ -1,5 +1,9 @@
 import { AmountMath } from '@agoric/ertp';
 
+/**
+ * @import { AmountKeywordRecord, AmountBoundKeywordRecord } from '../zoeService/types.js'
+ */
+
 /**
  * Helper to perform satisfiesWant and satisfiesGive. Is
  * allocationAmount greater than or equal to requiredAmount for every
@@ -9,19 +13,19 @@ import { AmountMath } from '@agoric/ertp';
  * isOfferSafe will still be boolean. When we have Multiples, satisfiesWant and
  * satisfiesGive will tell how many times the offer was matched.
  *
- * @param {AmountKeywordRecord} giveOrWant
+ * @param {AmountBoundKeywordRecord} giveOrWant
  * @param {AmountKeywordRecord} allocation
  * @returns {0|1}
  */
 const satisfiesInternal = (giveOrWant = {}, allocation) => {
-  const isGTEByKeyword = ([keyword, requiredAmount]) => {
+  const isGTEByKeyword = ([keyword, requiredAmountBound]) => {
     // If there is no allocation for a keyword, we know the giveOrWant
     // is not satisfied without checking further.
     if (allocation[keyword] === undefined) {
       return 0;
     }
     const allocationAmount = allocation[keyword];
-    return AmountMath.isGTE(allocationAmount, requiredAmount) ? 1 : 0;
+    return AmountMath.isGTE(allocationAmount, requiredAmountBound) ? 1 : 0;
   };
   return Object.entries(giveOrWant).every(isGTEByKeyword) ? 1 : 0;
 };

packages/zoe/src/contractFacet/types.ts

@@ -16,15 +16,14 @@ import type {
   AmountKeywordRecord,
   ExitRule,
   FeeMintAccess,
-  Instance,
   InvitationDetails,
   Keyword,
   ProposalRecord,
   StandardTerms,
   UserSeat,
   ZoeService,
 } from '../types-index.js';
-import type { ContractStartFunction } from '../zoeService/utils.js';
+import type { ContractStartFunction, Instance } from '../zoeService/utils.js';
 
 /**
  * Any passable non-thenable. Often an explanatory string.

packages/zoe/src/contractSupport/ratio.js

@@ -104,7 +104,7 @@ export const makeRatioFromAmounts = (numeratorAmount, denominatorAmount) => {
  * @returns {Amount<'nat'>}
  */
 const multiplyHelper = (amount, ratio, divideOp) => {
-  AmountMath.coerce(amount.brand, amount);
+  amount = AmountMath.coerce(amount.brand, amount);
   assertIsRatio(ratio);
   amount.brand === ratio.denominator.brand ||
     Fail`amount's brand ${q(amount.brand)} must match ratio's denominator ${q(

packages/zoe/src/contracts/auction/firstPriceLogic.js

@@ -11,8 +11,7 @@ export const calcWinnerAndClose = (zcf, sellSeat, bidSeats) => {
     want: { Ask: minBid },
   } = sellSeat.getProposal();
 
-  /** @type {Brand<'nat'>} */
-  const bidBrand = minBid.brand;
+  const bidBrand = /** @type {Brand<'nat'>} */ (minBid.brand);
   const emptyBid = AmountMath.makeEmpty(bidBrand);
 
   let highestBid = emptyBid;

packages/zoe/src/contracts/auction/secondPriceLogic.js

@@ -11,8 +11,7 @@ export const calcWinnerAndClose = (zcf, sellSeat, bidSeats) => {
     want: { Ask: minBid },
   } = sellSeat.getProposal();
 
-  /** @type {Brand<'nat'>} */
-  const bidBrand = minBid.brand;
+  const bidBrand = /** @type {Brand<'nat'>} */ (minBid.brand);
   const emptyBid = AmountMath.makeEmpty(bidBrand);
 
   let highestBid = emptyBid;

packages/zoe/src/contracts/loan/borrow.js

@@ -2,6 +2,7 @@ import { assert, Fail } from '@endo/errors';
 import { E } from '@endo/eventual-send';
 import { Far } from '@endo/marshal';
 import { makePromiseKit } from '@endo/promise-kit';
+import { M, mustMatch } from '@endo/patterns';
 import { AmountMath } from '@agoric/ertp';
 
 import {
@@ -16,6 +17,10 @@ import { calculateInterest, makeDebtCalculator } from './updateDebt.js';
 import { makeCloseLoanInvitation } from './close.js';
 import { makeAddCollateralInvitation } from './addCollateral.js';
 
+/**
+ * @import {NatAmount} from '@agoric/ertp';
+ */
+
 /** @type {MakeBorrowInvitation} */
 export const makeBorrowInvitation = (zcf, config) => {
   const {
@@ -28,7 +33,9 @@ export const makeBorrowInvitation = (zcf, config) => {
   } = config;
 
   // We can only lend what the lender has already escrowed.
-  const maxLoan = lenderSeat.getAmountAllocated('Loan');
+  const maxLoan = /** @type {NatAmount} */ (
+    lenderSeat.getAmountAllocated('Loan')
+  );
 
   /** @type {OfferHandler} */
   const borrow = async borrowerSeat => {
@@ -43,7 +50,10 @@ export const makeBorrowInvitation = (zcf, config) => {
         borrowerSeat.getProposal().give.Collateral.brand
       ),
     );
-    const loanWanted = borrowerSeat.getProposal().want.Loan;
+    const loanWanted = /** @type {NatAmount} */ (
+      borrowerSeat.getProposal().want.Loan
+    );
+    mustMatch(loanWanted.value, M.nat());
     const loanBrand = zcf.getTerms().brands.Loan;
 
     // The value of the collateral in the Loan brand

packages/zoe/src/internal-types.js

@@ -2,8 +2,9 @@
 /// <reference types="@agoric/ertp/exported" />
 
 /**
- * @import {Allocation, AnyTerms, BrandKeywordRecord, Completion, ContractStartFn, InvitationHandle, PaymentPKeywordRecord, UserSeat, ZoeIssuerRecord} from '@agoric/zoe';
  * @import {Pattern} from '@endo/patterns';
+ * @import {IssuerRecord} from '@agoric/ertp';
+ * @import {Allocation, AnyTerms, BrandKeywordRecord, Completion, ContractStartFn, InvitationHandle, PaymentPKeywordRecord, UserSeat, ZoeIssuerRecord} from '@agoric/zoe';
  */
 
 /**
@@ -196,7 +197,7 @@
 /**
  * @template {AssetKind} [K=AssetKind]
  * @typedef {object} ZoeMint
- * @property {() => import('@agoric/ertp').IssuerRecord<K>} getIssuerRecord
+ * @property {() => IssuerRecord<K>} getIssuerRecord
  * @property {(totalToMint: Amount<K>) => void} mintAndEscrow
  * @property {(totalToBurn: Amount<K>) => void} withdrawAndBurn
  * Note that the burning is asynchronous, and so may not have happened by

packages/zoe/src/types.ts

@@ -1,12 +1,6 @@
-import type {
-  Issuer,
-  Brand,
-  AssetKind,
-  DisplayInfo,
-  AnyAmount,
-} from '@agoric/ertp';
+import type { ERef } from '@endo/eventual-send';
 import type { RemotableObject } from '@endo/pass-style';
-import type { Key } from '@endo/patterns';
+import type { Issuer, Brand } from '@agoric/ertp';
 
 /**
  * Alias for RemotableObject
@@ -24,10 +18,7 @@ export type Keyword = string;
  */
 export type InvitationHandle = Handle<'Invitation'>;
 export type IssuerKeywordRecord = Record<Keyword, Issuer<any>>;
-export type IssuerPKeywordRecord = Record<
-  Keyword,
-  import('@endo/far').ERef<Issuer<any>>
->;
+export type IssuerPKeywordRecord = Record<Keyword, ERef<Issuer<any>>>;
 export type BrandKeywordRecord = Record<Keyword, Brand<any>>;
 export type StandardTerms = {
   /**