@agoric/zoe 0.27.0-upgrade-20-dev-ef71cfd.0 → 0.27.0-upgrade-19-devnet-dev-5428c4d.0

package/src/zoeService/makeInvitation.d.ts

@@ -2,5 +2,4 @@ export function prepareInvitationKit(baggage: import("@agoric/vat-data").Baggage
     invitationIssuer: globalThis.Issuer<"set", InvitationDetails>;
     invitationKit: globalThis.IssuerKit<"set", InvitationDetails>;
 };
-import type { InvitationDetails } from '@agoric/zoe';
 //# sourceMappingURL=makeInvitation.d.ts.map

package/src/zoeService/makeInvitation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"makeInvitation.d.ts","sourceRoot":"","sources":["makeInvitation.js"],"names":[],"mappings":"AAmBO,8CAHI,OAAO,kBAAkB,EAAE,OAAO,mBAClC,OAAO,sBAAsB,EAAE,mBAAmB,GAAG,SAAS;;;EA+BxE;uCAzCoD,aAAa"}
+{"version":3,"file":"makeInvitation.d.ts","sourceRoot":"","sources":["makeInvitation.js"],"names":[],"mappings":"AAgBO,8CAHI,OAAO,kBAAkB,EAAE,OAAO,mBAClC,OAAO,sBAAsB,EAAE,mBAAmB,GAAG,SAAS;;;EA+BxE"}

package/src/zoeService/makeInvitation.js

@@ -4,9 +4,6 @@ import { Fail, q } from '@endo/errors';
 import { provideDurableMapStore } from '@agoric/vat-data';
 import { AssetKind, hasIssuer, prepareIssuerKit } from '@agoric/ertp';
 import { InvitationElementShape } from '../typeGuards.js';
-/**
- * @import {FeeIssuerConfig, InvitationDetails} from '@agoric/zoe';
- */
 
 /**
  * Not deprecated because the first use below is still correct.

package/src/zoeService/offer/offer.d.ts

@@ -1,3 +1,2 @@
 export function makeOfferMethod(offerDataAccess: any): Offer;
-import type { Offer } from '@agoric/zoe';
 //# sourceMappingURL=offer.d.ts.map

package/src/zoeService/offer/offer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"offer.d.ts","sourceRoot":"","sources":["offer.js"],"names":[],"mappings":"AAeO,6DA0DN;2BA7DuB,aAAa"}
+{"version":3,"file":"offer.d.ts","sourceRoot":"","sources":["offer.js"],"names":[],"mappings":"AAaO,6DA0DN"}

package/src/zoeService/offer/offer.js

@@ -9,9 +9,7 @@ import { cleanProposal } from '../../cleanProposal.js';
 import { burnInvitation } from './burnInvitation.js';
 import { makeInvitationQueryFns } from '../invitationQueries.js';
 
-/**
- * @import {Offer} from '@agoric/zoe';
- */
+import '../internal-types.js';
 
 export const makeOfferMethod = offerDataAccess => {
   /** @type {Offer} */

package/src/zoeService/originalZoeSeat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"originalZoeSeat.d.ts","sourceRoot":"","sources":["originalZoeSeat.js"],"names":[],"mappings":";;;;;;;;;;AA4BA;;;;;;;;;;GAGG;;;;;;;;;;;;AA+CI,oDAHI,OAAO,kBAAkB,EAAE,OAAO,yBAClC,MAAM,UAAU,CAAC,GAAG,CAAC,QAoR/B"}
+{"version":3,"file":"originalZoeSeat.d.ts","sourceRoot":"","sources":["originalZoeSeat.js"],"names":[],"mappings":";;;;;;;;;;AA6BA;;;;;;;;;;GAGG;;;;;;;;;;;;AA+CI,oDAHI,OAAO,kBAAkB,EAAE,OAAO,yBAClC,MAAM,UAAU,CAAC,GAAG,CAAC,QAoR/B"}

package/src/zoeService/originalZoeSeat.js

@@ -7,6 +7,7 @@ import { makePromiseKit } from '@endo/promise-kit';
 import { NonNullish } from '@agoric/internal';
 
 import { satisfiesWant } from '../contractFacet/offerSafety.js';
+import '../types-ambient.js';
 import '../internal-types.js';
 import {
   AmountKeywordRecordShape,

package/src/zoeService/startInstance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"startInstance.d.ts","sourceRoot":"","sources":["startInstance.js"],"names":[],"mappings":"AAkCO,uDANI,IAAI,CAAC,iBAAiB,EAAE,+BAA+B,GAAG,oBAAoB,CAAC,oBAC/E,MAAM,IAAI,CAAC,SAAS,CAAC,uBACrB,CAAC,EAAE,EAAE,MAAM,KAAK,SAAS,cACzB,OAAO,GACL,OAAO,YAAY,EAAE,aAAa,CAqW9C;+BA7WgD,sBAAsB;6BAF7C,kBAAkB"}
+{"version":3,"file":"startInstance.d.ts","sourceRoot":"","sources":["startInstance.js"],"names":[],"mappings":"AAoCO,uDANI,IAAI,CAAC,iBAAiB,EAAE,+BAA+B,GAAG,oBAAoB,CAAC,oBAC/E,MAAM,IAAI,CAAC,SAAS,CAAC,uBACrB,CAAC,EAAE,EAAE,MAAM,KAAK,SAAS,cACzB,OAAO,GACL,OAAO,YAAY,EAAE,aAAa,CAqW9C;+BA7WgD,sBAAsB;6BAF7C,kBAAkB"}

package/src/zoeService/startInstance.js

@@ -19,6 +19,8 @@ import {
   InstanceAdminShape,
 } from '../typeGuards.js';
 
+// import '../internal-types.js';
+
 /**
  * @import {Baggage} from '@agoric/vat-data';
  * @import {LegacyWeakMap, WeakMapStore} from '@agoric/store';

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

@@ -1 +1,227 @@
+/**
+ * Zoe provides a framework for deploying and working with smart
+ * contracts. It is accessed as a long-lived and well-trusted service
+ * that enforces offer safety for the contracts that use it. Zoe has a
+ * single `invitationIssuer` for the entirety of its lifetime. By
+ * having a reference to Zoe, a user can get the `invitationIssuer`
+ * and thus validate any `invitation` they receive from someone else.
+ *
+ * Zoe has two different facets: the public Zoe service and the
+ * contract facet (ZCF). Each contract instance has a copy of ZCF
+ * within its vat. The contract and ZCF never have direct access to
+ * the users' payments or the Zoe purses.
+ */
+type ZoeService = {
+    /**
+     * Zoe has a single `invitationIssuer` for the entirety of its
+     * lifetime. By having a reference to Zoe, a user can get the
+     * `invitationIssuer` and thus validate any `invitation` they receive
+     * from someone else. The mint associated with the invitationIssuer
+     * creates the ERTP payments that represent the right to interact with
+     * a smart contract in particular ways.
+     */
+    getInvitationIssuer: GetInvitationIssuer;
+    install: InstallBundle;
+    installBundleID: InstallBundleID;
+    startInstance: import("./utils.js").StartInstance;
+    offer: Offer;
+    getPublicFacet: import("./utils.js").GetPublicFacet;
+    getIssuers: GetIssuers;
+    getBrands: GetBrands;
+    getTerms: import("./utils.js").GetTerms;
+    getOfferFilter: GetOfferFilter;
+    getInstallationForInstance: GetInstallationForInstance;
+    getInstance: GetInstance;
+    getInstallation: GetInstallation;
+    /**
+     *   Return an object with the instance, installation, description, invitation
+     *   handle, and any custom properties specific to the contract.
+     */
+    getInvitationDetails: GetInvitationDetails;
+    getFeeIssuer: GetFeeIssuer;
+    getConfiguration: GetConfiguration;
+    getBundleIDFromInstallation: GetBundleIDFromInstallation;
+    /**
+     *   Return the pattern (if any) associated with the invitationHandle that a
+     *   proposal is required to match to be accepted by zoe.offer().
+     */
+    getProposalShapeForInvitation: (invitationHandle: InvitationHandle) => import("@endo/patterns").Pattern | undefined;
+};
+type GetInvitationIssuer = () => Promise<Issuer<"set", InvitationDetails>>;
+type GetFeeIssuer = () => Promise<Issuer<"nat">>;
+type GetConfiguration = () => {
+    feeIssuerConfig: FeeIssuerConfig;
+};
+type GetIssuers = (instance: import("./utils.js").Instance<any>) => Promise<IssuerKeywordRecord>;
+type GetBrands = (instance: import("./utils.js").Instance<any>) => Promise<BrandKeywordRecord>;
+type GetOfferFilter = (instance: import("./utils.js").Instance<any>) => string[];
+type SetOfferFilter = (instance: Instance, strings: string[]) => any;
+type GetInstallationForInstance = (instance: import("./utils.js").Instance<any>) => Promise<Installation>;
+type GetInstance = (invitation: ERef<Invitation>) => Promise<import("./utils.js").Instance<any>>;
+type GetInstallation = (invitation: ERef<Invitation>) => Promise<Installation>;
+type GetInvitationDetails = (invitation: ERef<Invitation<any, any>>) => Promise<InvitationDetails>;
+/**
+ * Create an installation by safely evaluating the code and
+ * registering it with Zoe. Returns an installation.
+ */
+type InstallBundle = (bundle: Bundle | SourceBundle, bundleLabel?: string | undefined) => Promise<Installation>;
+/**
+ * Create an installation from a Bundle ID. Returns an installation.
+ */
+type InstallBundleID = (bundleID: BundleID, bundleLabel?: string | undefined) => Promise<Installation>;
+/**
+ * Verify that an alleged Installation is real, and return the Bundle ID it
+ * will use for contract code.
+ */
+type GetBundleIDFromInstallation = (allegedInstallation: ERef<Installation>) => Promise<BundleID>;
+/**
+ * To redeem an invitation, the user normally provides a proposal (their
+ * rules for the offer) as well as payments to be escrowed by Zoe.  If
+ * either the proposal or payments would be empty, indicate this by
+ * omitting that argument or passing undefined, rather than passing an
+ * empty record.
+ *
+ * The proposal has three parts: `want` and `give` are used by Zoe to
+ * enforce offer safety, and `exit` is used to specify the particular
+ * payout-liveness policy that Zoe can guarantee. `want` and `give`
+ * are objects with keywords as keys and amounts as values.
+ * `paymentKeywordRecord` is a record with keywords as keys, and the
+ * values are the actual payments to be escrowed. A payment is
+ * expected for every rule under `give`.
+ */
+type Offer = <Result, Args = undefined>(invitation: ERef<Invitation<Result, Args>>, proposal?: Proposal, paymentKeywordRecord?: PaymentPKeywordRecord, offerArgs?: Args) => Promise<UserSeat<Result>>;
+/**
+ * Zoe uses seats to access or manipulate offers. They let contracts and users
+ * interact with them. Zoe has two kinds of seats. ZCFSeats are used within
+ * contracts and with zcf methods. UserSeats represent offers external to Zoe
+ * and the contract. The party who exercises an invitation and sends the offer()
+ * message to Zoe gets a UserSeat that can check payouts' status or retrieve the
+ * result of processing the offer in the contract. This varies, but examples are
+ * a string and an invitation for another seat.
+ *
+ * Also, a UserSeat can be handed to an agent outside Zoe and the contract,
+ * letting them query or monitor the current state, access the payouts and
+ * result, and, if it's allowed for this seat, call tryExit().
+ *
+ * Since anyone can attempt to exit the seat if they have a reference to it, you
+ * should only share a UserSeat with trusted parties.
+ *
+ * UserSeat includes queries for the associated offer's current state and an
+ * operation to request that the offer exit, as follows:
+ */
+type UserSeat<OR extends unknown = unknown> = {
+    getProposal: () => Promise<ProposalRecord>;
+    /**
+     * returns a promise for a KeywordPaymentRecord containing all the payouts from
+     * this seat. The promise will resolve after the seat has exited.
+     */
+    getPayouts: () => Promise<PaymentPKeywordRecord>;
+    /**
+     * returns a promise for the Payment corresponding to the indicated keyword.
+     * The promise will resolve after the seat has exited. If there is no payment
+     * corresponding to the keyword, an error will be thrown. (It used to return
+     * undefined.)
+     */
+    getPayout: (keyword: Keyword) => Promise<Payment<any, any>>;
+    getOfferResult: () => Promise<OR>;
+    /**
+     * Note: Only works if the seat's `proposal` has an `OnDemand` `exit` clause. Zoe's
+     * offer-safety guarantee applies no matter how a seat's interaction with a
+     * contract ends. Under normal circumstances, the participant might be able to
+     * call `tryExit()`, or the contract might do something explicitly. On exiting,
+     * the seat holder gets its current `allocation` and the `seat` can no longer
+     * interact with the contract.
+     */
+    tryExit?: (() => void) | undefined;
+    /**
+     * Returns true if the seat has exited, false if it is still active.
+     */
+    hasExited: () => Promise<boolean>;
+    /**
+     * returns 1 if the proposal's
+     * want clause was satisfied by the final allocation, otherwise 0. This is
+     * numeric to support a planned enhancement called "multiples" which will allow
+     * the return value to be any non-negative number. The promise will resolve
+     * after the seat has exited.
+     */
+    numWantsSatisfied: () => Promise<0 | 1>;
+    /**
+     * return a promise for the final allocation. The promise will resolve after the
+     * seat has exited.
+     */
+    getFinalAllocation: () => Promise<Allocation>;
+    /**
+     * returns a subscriber that
+     * will be notified when the seat has exited or failed.
+     */
+    getExitSubscriber: () => Subscriber<Completion>;
+};
+type Proposal = Partial<ProposalRecord>;
+type ProposalRecord = {
+    give: AmountKeywordRecord;
+    want: AmountKeywordRecord;
+    exit: ExitRule;
+};
+/**
+ * The keys are keywords, and the values are amounts. For example:
+ * { Asset: AmountMath.make(assetBrand, 5n), Price:
+ * AmountMath.make(priceBrand, 9n) }
+ */
+type AmountKeywordRecord = Record<Keyword, import("@agoric/ertp/src/types.js").AnyAmount>;
+type Waker = {
+    wake: () => void;
+};
+type OnDemandExitRule = {
+    onDemand: null;
+};
+type WaivedExitRule = {
+    waived: null;
+};
+type AfterDeadlineExitRule = {
+    afterDeadline: {
+        timer: import("@agoric/time").TimerService;
+        deadline: import("@agoric/time").Timestamp;
+    };
+};
+/**
+ * The possible keys are 'waived', 'onDemand', and 'afterDeadline'.
+ * `timer` and `deadline` only are used for the `afterDeadline` key.
+ * The possible records are:
+ * `{ waived: null }`
+ * `{ onDemand: null }`
+ * `{ afterDeadline: { timer :Timer<Deadline>, deadline :Deadline } }`
+ */
+type ExitRule = OnDemandExitRule | WaivedExitRule | AfterDeadlineExitRule;
+type Instance = import("./utils.js").Instance<any>;
+type ZCFSpec = {
+    bundleCap: import("@agoric/swingset-vat").BundleCap;
+} | {
+    name: string;
+} | {
+    id: BundleID;
+};
+/**
+ * Opaque type for a JSONable source bundle
+ */
+type SourceBundle = Record<string, any>;
+type PaymentPKeywordRecord = Record<Keyword, ERef<Payment<any>>>;
+type PaymentKeywordRecord = Record<Keyword, Payment<any>>;
+type InvitationDetails = {
+    installation: Installation;
+    instance: import("./utils.js").Instance<any>;
+    handle: InvitationHandle;
+    description: string;
+    customDetails?: Record<string, any> | undefined;
+};
+type Installation<SF = any> = import("./utils.js").Installation<SF>;
+type InstallationStart<I extends Installation> = import("./utils.js").InstallationStart<I>;
+type FeeIssuerConfig = {
+    name: string;
+    assetKind: AssetKind;
+    displayInfo: DisplayInfo;
+};
+type ZoeFeesConfig = {
+    getPublicFacetFee: NatValue;
+};
+type FeeMintAccess = Handle<"feeMintAccess">;
 //# sourceMappingURL=types-ambient.d.ts.map

package/src/zoeService/types-ambient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types-ambient.d.ts","sourceRoot":"","sources":["types-ambient.js"],"names":[],"mappings":""}
+{"version":3,"file":"types-ambient.d.ts","sourceRoot":"","sources":["types-ambient.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;yBAmBc,mBAAmB;aASnB,aAAa;qBACb,eAAe;mBACf,OAAO,YAAY,EAAE,aAAa;WAClC,KAAK;oBACL,OAAO,YAAY,EAAE,cAAc;gBACnC,UAAU;eACV,SAAS;cACT,OAAO,YAAY,EAAE,QAAQ;oBAC7B,cAAc;gCACd,0BAA0B;iBAC1B,WAAW;qBACX,eAAe;;;;;0BACf,oBAAoB;kBAGpB,YAAY;sBACZ,gBAAgB;iCAChB,2BAA2B;;;;;mCAC3B,CAAC,gBAAgB,EAAE,gBAAgB,KAAK,OAAO,gBAAgB,EAAE,OAAO,GAAG,SAAS;;iCAOrF,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;0BAKzC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;8BAKtB;IACR,eAAe,EAAE,eAAe,CAAC;CAClC;6BAKO,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,KAChC,OAAO,CAAC,mBAAmB,CAAC;4BAK9B,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,KAChC,OAAO,CAAC,kBAAkB,CAAC;iCAK7B,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,KAChC,MAAM,EAAE;iCAKV,QAAQ,WACR,MAAM,EAAE;6CAKR,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,KAChC,OAAO,CAAC,YAAY,CAAC;gCAKvB,IAAI,CAAC,UAAU,CAAC,KACd,OAAO,CAAC,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;oCAK7C,IAAI,CAAC,UAAU,CAAC,KACd,OAAO,CAAC,YAAY,CAAC;yCAKvB,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KACxB,OAAO,CAAC,iBAAiB,CAAC;;;;;8BAW5B,MAAM,GAAG,YAAY,uCAEnB,OAAO,CAAC,YAAY,CAAC;;;;kCAUvB,QAAQ,uCAEN,OAAO,CAAC,YAAY,CAAC;;;;;yDASvB,IAAI,CAAC,YAAY,CAAC,KAChB,OAAO,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;aAIjB,CAAC,MAAM,EAAE,IAAI,GAAG,SAAS,EACjC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAC1C,QAAQ,CAAC,EAAE,QAAQ,EACnB,oBAAoB,CAAC,EAAE,qBAAqB,EAC5C,SAAS,CAAC,EAAE,IAAI,KACX,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;cAsCZ,EAAE;iBAEX,MAAM,OAAO,CAAC,cAAc,CAAC;;;;;gBAC7B,MAAM,OAAO,CAAC,qBAAqB,CAAC;;;;;;;eAGpC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;oBAKhD,MAAM,OAAO,CAAC,EAAE,CAAC;;;;;;;;;qBACX,IAAI;;;;eAOV,MAAM,OAAO,CAAC,OAAO,CAAC;;;;;;;;uBAEtB,MAAM,OAAO,CAAC,CAAC,GAAC,CAAC,CAAC;;;;;wBAKlB,MAAM,OAAO,CAAC,UAAU,CAAC;;;;;uBAGzB,MAAM,UAAU,CAAC,UAAU,CAAC;;gBAK7B,OAAO,CAAC,cAAc,CAAC;sBAEvB;IAAC,IAAI,EAAE,mBAAmB,CAAC;IAC1B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,IAAI,EAAE,QAAQ,CAAA;CACd;;;;;;2BAID,MAAM,CAAC,OAAO,EAAE,OAAO,2BAA2B,EAAE,SAAS,CAAC;;UAS7D,MAAM,IAAI;;;cAKV,IAAI;;;YAKJ,IAAI;;;mBAKJ;QAAC,KAAK,EAAE,OAAO,cAAc,EAAE,YAAY,CAAC;QAAC,QAAQ,EAAE,OAAO,cAAc,EAAE,SAAS,CAAA;KAAC;;;;;;;;;;gBAIzF,gBAAgB,GAAG,cAAc,GAAG,qBAAqB;gBAWzD,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC;eAIlC;IAAC,SAAS,EAAE,OAAO,sBAAsB,EAAE,SAAS,CAAA;CAAE,GAAG;IAAC,IAAI,EAAE,MAAM,CAAA;CAAC,GAAG;IAAC,EAAE,EAAE,QAAQ,CAAA;CAAC;;;;oBAIxF,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;6BAKnB,MAAM,CAAC,OAAO,EAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;4BAClC,MAAM,CAAC,OAAO,EAAC,OAAO,CAAC,GAAG,CAAC,CAAC;;kBAK3B,YAAY;cACZ,OAAO,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC;YAClC,gBAAgB;iBAChB,MAAM;;;kBAKN,EAAE,UACH,OAAO,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC;uBAItB,CAAC,SAAf,YAAa,IACd,OAAO,YAAY,EAAE,iBAAiB,CAAC,CAAC,CAAC;;UAKxC,MAAM;eACN,SAAS;iBACT,WAAW;;;uBAKX,QAAQ;;qBAIT,MAAM,CAAC,eAAe,CAAC"}

package/src/zoeService/types-ambient.js

@@ -1,5 +1,328 @@
-/** @file @deprecated */
+// @jessie-check
 
-console.error(
-  'NOTICE: src/zoeService/types-ambient.js no longer provides types; use explicit imports or the top level `/exported.js`',
-);
+/// <reference types="ses" />
+
+/**
+ * @typedef {object} ZoeService
+ *
+ * Zoe provides a framework for deploying and working with smart
+ * contracts. It is accessed as a long-lived and well-trusted service
+ * that enforces offer safety for the contracts that use it. Zoe has a
+ * single `invitationIssuer` for the entirety of its lifetime. By
+ * having a reference to Zoe, a user can get the `invitationIssuer`
+ * and thus validate any `invitation` they receive from someone else.
+ *
+ * Zoe has two different facets: the public Zoe service and the
+ * contract facet (ZCF). Each contract instance has a copy of ZCF
+ * within its vat. The contract and ZCF never have direct access to
+ * the users' payments or the Zoe purses.
+ *
+ * @property {GetInvitationIssuer} getInvitationIssuer
+ *
+ * Zoe has a single `invitationIssuer` for the entirety of its
+ * lifetime. By having a reference to Zoe, a user can get the
+ * `invitationIssuer` and thus validate any `invitation` they receive
+ * from someone else. The mint associated with the invitationIssuer
+ * creates the ERTP payments that represent the right to interact with
+ * a smart contract in particular ways.
+ *
+ * @property {InstallBundle} install
+ * @property {InstallBundleID} installBundleID
+ * @property {import('./utils.js').StartInstance} startInstance
+ * @property {Offer} offer
+ * @property {import('./utils.js').GetPublicFacet} getPublicFacet
+ * @property {GetIssuers} getIssuers
+ * @property {GetBrands} getBrands
+ * @property {import('./utils.js').GetTerms} getTerms
+ * @property {GetOfferFilter} getOfferFilter
+ * @property {GetInstallationForInstance} getInstallationForInstance
+ * @property {GetInstance} getInstance
+ * @property {GetInstallation} getInstallation
+ * @property {GetInvitationDetails} getInvitationDetails
+ *   Return an object with the instance, installation, description, invitation
+ *   handle, and any custom properties specific to the contract.
+ * @property {GetFeeIssuer} getFeeIssuer
+ * @property {GetConfiguration} getConfiguration
+ * @property {GetBundleIDFromInstallation} getBundleIDFromInstallation
+ * @property {(invitationHandle: InvitationHandle) => import('@endo/patterns').Pattern | undefined} getProposalShapeForInvitation
+ *   Return the pattern (if any) associated with the invitationHandle that a
+ *   proposal is required to match to be accepted by zoe.offer().
+ */
+
+/**
+ * @callback GetInvitationIssuer
+ * @returns {Promise<Issuer<'set', InvitationDetails>>}
+ */
+
+/**
+ * @callback GetFeeIssuer
+ * @returns {Promise<Issuer<'nat'>>}
+ */
+
+/**
+ * @callback GetConfiguration
+ * @returns {{
+ *   feeIssuerConfig: FeeIssuerConfig,
+ * }}
+ */
+
+/**
+ * @callback GetIssuers
+ * @param {import('./utils.js').Instance<any>} instance
+ * @returns {Promise<IssuerKeywordRecord>}
+ */
+
+/**
+ * @callback GetBrands
+ * @param {import('./utils.js').Instance<any>} instance
+ * @returns {Promise<BrandKeywordRecord>}
+ */
+
+/**
+ * @callback GetOfferFilter
+ * @param {import('./utils.js').Instance<any>} instance
+ * @returns {string[]}
+ */
+
+/**
+ * @callback SetOfferFilter
+ * @param {Instance} instance
+ * @param {string[]} strings
+ */
+
+/**
+ * @callback GetInstallationForInstance
+ * @param {import('./utils.js').Instance<any>} instance
+ * @returns {Promise<Installation>}
+ */
+
+/**
+ * @callback GetInstance
+ * @param {ERef<Invitation>} invitation
+ * @returns {Promise<import('./utils.js').Instance<any>>}
+ */
+
+/**
+ * @callback GetInstallation
+ * @param {ERef<Invitation>} invitation
+ * @returns {Promise<Installation>}
+ */
+
+/**
+ * @callback GetInvitationDetails
+ * @param {ERef<Invitation<any, any>>} invitation
+ * @returns {Promise<InvitationDetails>}
+ */
+
+// TODO remove support for source bundles, leaving only support for hash bundles.
+// https://github.com/Agoric/agoric-sdk/issues/4565
+/**
+ * @callback InstallBundle
+ *
+ * Create an installation by safely evaluating the code and
+ * registering it with Zoe. Returns an installation.
+ *
+ * @param {Bundle | SourceBundle} bundle
+ * @param {string} [bundleLabel]
+ * @returns {Promise<Installation>}
+ */
+
+// TODO consolidate installBundleID into install.
+// https://github.com/Agoric/agoric-sdk/issues/4974
+/**
+ * @callback InstallBundleID
+ *
+ * Create an installation from a Bundle ID. Returns an installation.
+ *
+ * @param {BundleID} bundleID
+ * @param {string} [bundleLabel]
+ * @returns {Promise<Installation>}
+ */
+
+/**
+ * @callback GetBundleIDFromInstallation
+ *
+ * Verify that an alleged Installation is real, and return the Bundle ID it
+ * will use for contract code.
+ *
+ * @param {ERef<Installation>} allegedInstallation
+ * @returns {Promise<BundleID>}
+ */
+
+/**
+ * @typedef {<Result, Args = undefined>(
+ *   invitation: ERef<Invitation<Result, Args>>,
+ *   proposal?: Proposal,
+ *   paymentKeywordRecord?: PaymentPKeywordRecord,
+ *   offerArgs?: Args,
+ *   ) => Promise<UserSeat<Result>>
+ * } Offer
+ *
+ * To redeem an invitation, the user normally provides a proposal (their
+ * rules for the offer) as well as payments to be escrowed by Zoe.  If
+ * either the proposal or payments would be empty, indicate this by
+ * omitting that argument or passing undefined, rather than passing an
+ * empty record.
+ *
+ * The proposal has three parts: `want` and `give` are used by Zoe to
+ * enforce offer safety, and `exit` is used to specify the particular
+ * payout-liveness policy that Zoe can guarantee. `want` and `give`
+ * are objects with keywords as keys and amounts as values.
+ * `paymentKeywordRecord` is a record with keywords as keys, and the
+ * values are the actual payments to be escrowed. A payment is
+ * expected for every rule under `give`.
+ */
+
+/**
+ * Zoe uses seats to access or manipulate offers. They let contracts and users
+ * interact with them. Zoe has two kinds of seats. ZCFSeats are used within
+ * contracts and with zcf methods. UserSeats represent offers external to Zoe
+ * and the contract. The party who exercises an invitation and sends the offer()
+ * message to Zoe gets a UserSeat that can check payouts' status or retrieve the
+ * result of processing the offer in the contract. This varies, but examples are
+ * a string and an invitation for another seat.
+ *
+ * Also, a UserSeat can be handed to an agent outside Zoe and the contract,
+ * letting them query or monitor the current state, access the payouts and
+ * result, and, if it's allowed for this seat, call tryExit().
+ *
+ * Since anyone can attempt to exit the seat if they have a reference to it, you
+ * should only share a UserSeat with trusted parties.
+ *
+ * UserSeat includes queries for the associated offer's current state and an
+ * operation to request that the offer exit, as follows:
+ *
+ * @see {@link https://docs.agoric.com/zoe/api/zoe.html#userseat-object}}
+ * @template {object} [OR=unknown]
+ * @typedef {object} UserSeat
+ * @property {() => Promise<ProposalRecord>} getProposal
+ * @property {() => Promise<PaymentPKeywordRecord>} getPayouts
+ * returns a promise for a KeywordPaymentRecord containing all the payouts from
+ * this seat. The promise will resolve after the seat has exited.
+ * @property {(keyword: Keyword) => Promise<Payment<any, any>>} getPayout
+ * returns a promise for the Payment corresponding to the indicated keyword.
+ * The promise will resolve after the seat has exited. If there is no payment
+ * corresponding to the keyword, an error will be thrown. (It used to return
+ * undefined.)
+ * @property {() => Promise<OR>} getOfferResult
+ * @property {() => void} [tryExit]
+ * Note: Only works if the seat's `proposal` has an `OnDemand` `exit` clause. Zoe's
+ * offer-safety guarantee applies no matter how a seat's interaction with a
+ * contract ends. Under normal circumstances, the participant might be able to
+ * call `tryExit()`, or the contract might do something explicitly. On exiting,
+ * the seat holder gets its current `allocation` and the `seat` can no longer
+ * interact with the contract.
+ * @property {() => Promise<boolean>} hasExited
+ * Returns true if the seat has exited, false if it is still active.
+ * @property {() => Promise<0|1>} numWantsSatisfied returns 1 if the proposal's
+ * want clause was satisfied by the final allocation, otherwise 0. This is
+ * numeric to support a planned enhancement called "multiples" which will allow
+ * the return value to be any non-negative number. The promise will resolve
+ * after the seat has exited.
+ * @property {() => Promise<Allocation>} getFinalAllocation
+ * return a promise for the final allocation. The promise will resolve after the
+ * seat has exited.
+ * @property {() => Subscriber<Completion>} getExitSubscriber returns a subscriber that
+ * will be notified when the seat has exited or failed.
+ */
+
+/**
+ * @typedef {Partial<ProposalRecord>} Proposal
+ *
+ * @typedef {{give: AmountKeywordRecord,
+ *            want: AmountKeywordRecord,
+ *            exit: ExitRule
+ *           }} ProposalRecord
+ */
+
+/**
+ * @typedef {Record<Keyword, import('@agoric/ertp/src/types.js').AnyAmount>} AmountKeywordRecord
+ *
+ * The keys are keywords, and the values are amounts. For example:
+ * { Asset: AmountMath.make(assetBrand, 5n), Price:
+ * AmountMath.make(priceBrand, 9n) }
+ */
+
+/**
+ * @typedef {object} Waker
+ * @property {() => void} wake
+ */
+
+/**
+ * @typedef {object} OnDemandExitRule
+ * @property {null} onDemand
+ */
+
+/**
+ * @typedef {object} WaivedExitRule
+ * @property {null} waived
+ */
+
+/**
+ * @typedef {object} AfterDeadlineExitRule
+ * @property {{timer: import('@agoric/time').TimerService, deadline: import('@agoric/time').Timestamp}} afterDeadline
+ */
+
+/**
+ * @typedef {OnDemandExitRule | WaivedExitRule | AfterDeadlineExitRule} ExitRule
+ *
+ * The possible keys are 'waived', 'onDemand', and 'afterDeadline'.
+ * `timer` and `deadline` only are used for the `afterDeadline` key.
+ * The possible records are:
+ * `{ waived: null }`
+ * `{ onDemand: null }`
+ * `{ afterDeadline: { timer :Timer<Deadline>, deadline :Deadline } }`
+ */
+
+/**
+ * @typedef {import('./utils.js').Instance<any>} Instance
+ */
+
+/**
+ * @typedef {{bundleCap: import('@agoric/swingset-vat').BundleCap } | {name: string} | {id: BundleID}} ZCFSpec
+ */
+
+/**
+ * @typedef {Record<string, any>} SourceBundle
+ * Opaque type for a JSONable source bundle
+ */
+
+/**
+ * @typedef {Record<Keyword,ERef<Payment<any>>>} PaymentPKeywordRecord
+ * @typedef {Record<Keyword,Payment<any>>} PaymentKeywordRecord
+ */
+
+/**
+ * @typedef {object} InvitationDetails
+ * @property {Installation} installation
+ * @property {import('./utils.js').Instance<any>} instance
+ * @property {InvitationHandle} handle
+ * @property {string} description
+ * @property {Record<string, any>} [customDetails]
+ */
+
+/**
+ * @template [SF=any] contract start function
+ * @typedef {import('./utils.js').Installation<SF>} Installation
+ */
+
+/**
+ * @template {Installation} I
+ * @typedef {import('./utils.js').InstallationStart<I>} InstallationStart
+ */
+
+/**
+ * @typedef {object} FeeIssuerConfig
+ * @property {string} name
+ * @property {AssetKind} assetKind
+ * @property {DisplayInfo} displayInfo
+ */
+
+/**
+ * @typedef {object} ZoeFeesConfig
+ * @property {NatValue} getPublicFacetFee
+ */
+
+/**
+ * @typedef {Handle<'feeMintAccess'>} FeeMintAccess
+ */