@agoric/zoe 0.26.3-dev-7e4a2e1.0 → 0.26.3-dev-b13743a.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/zoe",
-  "version": "0.26.3-dev-7e4a2e1.0+7e4a2e1",
+  "version": "0.26.3-dev-b13743a.0+b13743a",
   "description": "Zoe: the Smart Contract Framework for Offer Enforcement",
   "type": "module",
   "main": "./src/zoeService/zoe.js",
@@ -43,17 +43,17 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/base-zone": "0.1.1-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/ertp": "0.16.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/internal": "0.3.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/notifier": "0.6.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/store": "0.9.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/swingset-liveslots": "0.10.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/swingset-vat": "0.32.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/time": "0.3.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/vat-data": "0.5.3-dev-7e4a2e1.0+7e4a2e1",
-    "@agoric/zone": "0.2.3-dev-7e4a2e1.0+7e4a2e1",
+    "@agoric/assert": "0.6.1-dev-b13743a.0+b13743a",
+    "@agoric/base-zone": "0.1.1-dev-b13743a.0+b13743a",
+    "@agoric/ertp": "0.16.3-dev-b13743a.0+b13743a",
+    "@agoric/internal": "0.3.3-dev-b13743a.0+b13743a",
+    "@agoric/notifier": "0.6.3-dev-b13743a.0+b13743a",
+    "@agoric/store": "0.9.3-dev-b13743a.0+b13743a",
+    "@agoric/swingset-liveslots": "0.10.3-dev-b13743a.0+b13743a",
+    "@agoric/swingset-vat": "0.32.3-dev-b13743a.0+b13743a",
+    "@agoric/time": "0.3.3-dev-b13743a.0+b13743a",
+    "@agoric/vat-data": "0.5.3-dev-b13743a.0+b13743a",
+    "@agoric/zone": "0.2.3-dev-b13743a.0+b13743a",
     "@endo/bundle-source": "^3.1.0",
     "@endo/captp": "^4.0.4",
     "@endo/common": "^1.1.0",
@@ -68,7 +68,7 @@
     "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
-    "@agoric/kmarshal": "0.1.1-dev-7e4a2e1.0+7e4a2e1",
+    "@agoric/kmarshal": "0.1.1-dev-b13743a.0+b13743a",
     "@endo/init": "^1.0.4",
     "ava": "^5.3.0",
     "c8": "^9.1.0",
@@ -139,7 +139,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 84.73
+    "atLeast": 84.88
   },
-  "gitHead": "7e4a2e141e00cd3a47185591b57188c8d98c2310"
+  "gitHead": "b13743a2cccf0cb63a412b54384435596d4e81ea"
 }

package/src/contractFacet/types-ambient.d.ts

@@ -6,13 +6,6 @@ type IssuerOptionsRecord = import('@agoric/ertp').IssuerOptionsRecord;
 type Completion = any;
 type ZCFMakeEmptySeatKit = (exit?: ExitRule | undefined) => ZcfSeatKit;
 
-type MakeInvitation = <Result>(
-  offerHandler: OfferHandler<Result>,
-  description: string,
-  customDetails?: object,
-  proposalShape?: Pattern,
-) => Promise<Invitation<R, A>>;
-
 /**
  * Zoe Contract Facet
  *
@@ -60,7 +53,12 @@ type ZCF<CT extends unknown = Record<string, unknown>> = {
    * getting in the `customDetails`. `customDetails` will be
    * placed in the details of the invitation.
    */
-  makeInvitation: MakeInvitation;
+  makeInvitation: <R, A = undefined>(
+    offerHandler: OfferHandler<ERef<R>, A>,
+    description: string,
+    customDetails?: object,
+    proposalShape?: Pattern,
+  ) => Promise<Invitation<R, A>>;
   shutdown: (completion: Completion) => void;
   shutdownWithFailure: ShutdownWithFailure;
   getZoeService: () => ERef<ZoeService>;
@@ -164,21 +162,20 @@ type ZCFMint<K extends AssetKind = AssetKind> = {
  * normally an instanceof Error.
  */
 type ZCFSeatFail = (reason: unknown) => Error;
-/**
- * The brand is used for filling in an empty amount if the `keyword`
- * is not present in the allocation
- */
-type ZCFGetAmountAllocated = (
-  keyword: Keyword,
-  brand?: Brand<AssetKind> | undefined,
-) => Amount<any>;
 type ZCFSeat = {
   exit: (completion?: Completion) => void;
   fail: ZCFSeatFail;
   getSubscriber: () => Promise<Subscriber<Allocation>>;
   hasExited: () => boolean;
   getProposal: () => ProposalRecord;
-  getAmountAllocated: ZCFGetAmountAllocated;
+  /**
+   * @param brand used for filling in an empty amount if the `keyword`
+   * is not present in the allocation
+   */
+  getAmountAllocated: <B extends Brand>(
+    keyword: Keyword,
+    brand?: B,
+  ) => B extends Brand<infer K> ? Amount<K> : Amount;
   getCurrentAllocation: () => Allocation;
   /**
    * @deprecated Use atomicRearrange instead
@@ -210,14 +207,14 @@ type ZcfSeatKit = {
   zcfSeat: ZCFSeat;
   userSeat: ERef<UserSeat>;
 };
-type HandleOffer<OR extends unknown> = (
+type HandleOffer<OR extends unknown, OA> = (
   seat: ZCFSeat,
-  offerArgs?: object,
+  offerArgs?: OA,
 ) => OR;
-type OfferHandler<OR extends unknown = unknown> =
-  | HandleOffer<OR>
+type OfferHandler<OR extends unknown = unknown, OA = never> =
+  | HandleOffer<OR, OA>
   | {
-      handle: HandleOffer<OR>;
+      handle: HandleOffer<OR, OA>;
     };
 type ContractMeta = {
   customTermsShape?: CopyRecord<any> | undefined;
@@ -246,3 +243,11 @@ type ContractStartFnResult<PF, CF> = {
 };
 type ContractOf<S> = import('../zoeService/utils').ContractOf<S>;
 type AdminFacet = import('../zoeService/utils').AdminFacet<any>;
+
+declare const OfferReturn: unique symbol;
+declare const OfferArgs: unique symbol;
+type Invitation<R = unknown, A = undefined> = Payment<'set'> & {
+  // because TS is structural, without this the generic is ignored
+  [OfferReturn]?: R;
+  [OfferArgs]?: A;
+};

package/src/contractFacet/zcfSeat.js

@@ -189,15 +189,22 @@ export const createSeatManager = (
         return hasExited(self);
       },
 
+      /**
+       * @type {ZCFSeat['getAmountAllocated']}
+       */
       getAmountAllocated(keyword, brand) {
         const { self } = this;
         assertActive(self);
         const currentAllocation = getCurrentAllocation(self);
         if (currentAllocation[keyword] !== undefined) {
+          // @ts-expect-error cast
           return currentAllocation[keyword];
         }
-        brand || Fail`A brand must be supplied when the keyword is not defined`;
+        if (!brand) {
+          throw Fail`A brand must be supplied when the keyword is not defined`;
+        }
         const assetKind = getAssetKindByBrand(brand);
+        // @ts-expect-error cast
         return AmountMath.makeEmpty(brand, assetKind);
       },
       getCurrentAllocation() {

package/src/contractFacet/zcfZygote.js

@@ -321,7 +321,8 @@ export const makeZCFZygote = async (
         customDetails,
         proposalShape,
       );
-      return invitationP;
+      // rely on the ZCF type signature
+      return /** @type {any} */ (invitationP);
     },
     // Shutdown the entire vat and give payouts
     shutdown: completion => {

package/src/contractSupport/prepare-ownable.js

@@ -20,7 +20,7 @@ const TransferProposalShape = M.splitRecord({
 /**
  * @template {(string | symbol)[]} MN Method names
  * @param {import('@agoric/base-zone').Zone} zone
- * @param {MakeInvitation} makeInvitation
+ * @param {ZCF['makeInvitation']} makeInvitation
  *   A function with the same behavior as `zcf.makeInvitation`.
  *   A contract will normally just extract it from its own zcf using the
  *   argument expression
@@ -34,7 +34,7 @@ const TransferProposalShape = M.splitRecord({
  *   The method names of the underlying exo class that should be represented
  *   by transparently-forwarding methods of the wrapping ownable object.
  * @param {OwnableOptions} [options]
- * @returns {<U>(underlying: U) => Pick<U, MN[number]> & {makeTransferInvitation: () => Invitation}}
+ * @returns {<U>(underlying: U) => Pick<U, MN[number]> & {makeTransferInvitation: () => Invitation<U>}}
  */
 export const prepareOwnable = (
   zone,

package/src/contractSupport/zoeHelpers.js

@@ -176,12 +176,11 @@ export const depositToSeatSuccessMsg = `Deposit and reallocation successful.`;
  * The `amounts` and `payments` records must have corresponding
  * keywords.
  *
- * @template {object} [OR=unknown]
  * @param {ZCF} zcf
  * @param {ZCFSeat} recipientSeat
  * @param {AmountKeywordRecord} amounts
  * @param {PaymentPKeywordRecord} payments
- * @returns {Promise<OR>} `Deposit and reallocation successful.`
+ * @returns {Promise<string>} `Deposit and reallocation successful.`
  */
 export const depositToSeat = async (zcf, recipientSeat, amounts, payments) => {
   !recipientSeat.hasExited() || Fail`The recipientSeat cannot have exited.`;

package/src/contracts/auction/firstPriceLogic.js

@@ -22,7 +22,6 @@ export const calcWinnerAndClose = (zcf, sellSeat, bidSeats) => {
   for (const bidSeat of bidSeats) {
     if (!bidSeat.hasExited()) {
       activeBidsCount += 1n;
-      /** @type {Amount<'nat'>} */
       const bid = bidSeat.getAmountAllocated('Bid', bidBrand);
       // bidSeat is added in time order, in case of a tie, we privilege the earlier.
       // So the later bidder will need a strictly greater bid to win the auction.

package/src/contracts/auction/secondPriceLogic.js

@@ -23,7 +23,6 @@ export const calcWinnerAndClose = (zcf, sellSeat, bidSeats) => {
   bidSeats.forEach(bidSeat => {
     if (!bidSeat.hasExited()) {
       activeBidsCount += 1n;
-      /** @type {Amount<'nat'>} */
       const bid = bidSeat.getAmountAllocated('Bid', bidBrand);
       // If the bid is greater than the highestBid, it's the new highestBid
       if (AmountMath.isGTE(bid, highestBid, bidBrand)) {

package/src/contracts/loan/borrow.js

@@ -37,7 +37,10 @@ export const makeBorrowInvitation = (zcf, config) => {
       want: { Loan: null },
     });
 
-    const collateralGiven = borrowerSeat.getAmountAllocated('Collateral');
+    const collateralGiven = borrowerSeat.getAmountAllocated(
+      'Collateral',
+      borrowerSeat.getProposal().give.Collateral.brand,
+    );
     const loanWanted = borrowerSeat.getProposal().want.Loan;
     const loanBrand = zcf.getTerms().brands.Loan;
 

package/src/types.js

@@ -43,9 +43,3 @@
  *
  * @typedef {AmountKeywordRecord} Allocation
  */
-
-/**
- * @template {object} [R=unknown] Offer result
- * @template {object} [A=never] Offer args
- * @typedef {Payment<'set'>} Invitation
- */

package/src/zoeService/types.js

@@ -108,7 +108,7 @@
 
 /**
  * @callback GetInvitationDetails
- * @param {ERef<Invitation>} invitation
+ * @param {ERef<Invitation<any, any>>} invitation
  * @returns {Promise<InvitationDetails>}
  */
 
@@ -148,7 +148,7 @@
  */
 
 /**
- * @typedef {<Args, Result>(
+ * @typedef {<Result, Args = undefined>(
  *   invitation: ERef<Invitation<Result, Args>>,
  *   proposal?: Proposal,
  *   paymentKeywordRecord?: PaymentPKeywordRecord,