@agoric/zoe 0.26.3-upgrade-18a-dev-4ee0508.0 → 0.26.3-upgrade-20-dev-086463b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/zoe",
-  "version": "0.26.3-upgrade-18a-dev-4ee0508.0+4ee0508",
+  "version": "0.26.3-upgrade-20-dev-086463b.0+086463b",
   "description": "Zoe: the Smart Contract Framework for Offer Enforcement",
   "type": "module",
   "main": "./src/zoeService/zoe.js",
@@ -43,38 +43,38 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/ertp": "0.16.3-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/internal": "0.4.0-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/notifier": "0.7.0-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/store": "0.9.3-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/swingset-liveslots": "0.10.3-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/swingset-vat": "0.33.0-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/time": "0.3.3-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/vat-data": "0.5.3-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/vow": "0.2.0-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/zone": "0.3.0-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@endo/bundle-source": "^3.5.0",
-    "@endo/captp": "^4.4.3",
-    "@endo/common": "^1.2.8",
-    "@endo/errors": "^1.2.8",
-    "@endo/eventual-send": "^1.2.8",
-    "@endo/exo": "^1.5.7",
-    "@endo/far": "^1.1.9",
-    "@endo/import-bundle": "^1.3.2",
-    "@endo/marshal": "^1.6.2",
-    "@endo/nat": "^5.0.13",
-    "@endo/pass-style": "^1.4.7",
-    "@endo/patterns": "^1.4.7",
-    "@endo/promise-kit": "^1.1.8",
+    "@agoric/base-zone": "0.1.1-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/ertp": "0.16.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/internal": "0.3.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/notifier": "0.6.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/store": "0.9.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/swingset-liveslots": "0.10.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/swingset-vat": "0.32.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/time": "0.3.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/vat-data": "0.5.3-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/vow": "0.1.1-upgrade-20-dev-086463b.0+086463b",
+    "@agoric/zone": "0.2.3-upgrade-20-dev-086463b.0+086463b",
+    "@endo/bundle-source": "^4.0.0",
+    "@endo/captp": "^4.4.5",
+    "@endo/common": "^1.2.10",
+    "@endo/errors": "^1.2.10",
+    "@endo/eventual-send": "^1.3.1",
+    "@endo/exo": "^1.5.9",
+    "@endo/far": "^1.1.11",
+    "@endo/import-bundle": "^1.4.0",
+    "@endo/marshal": "^1.6.4",
+    "@endo/nat": "^5.1.0",
+    "@endo/pass-style": "^1.5.0",
+    "@endo/patterns": "^1.5.0",
+    "@endo/promise-kit": "^1.1.10",
     "yargs-parser": "^21.1.1"
   },
   "devDependencies": {
-    "@agoric/kmarshal": "0.1.1-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@endo/init": "^1.1.7",
+    "@agoric/kmarshal": "0.1.1-upgrade-20-dev-086463b.0+086463b",
+    "@endo/init": "^1.1.9",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
-    "import-meta-resolve": "^2.2.1",
+    "import-meta-resolve": "^4.1.0",
     "tsd": "^0.31.1"
   },
   "files": [
@@ -98,7 +98,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 85.06
+    "atLeast": 85.15
   },
-  "gitHead": "4ee05088e5ada989a866a11ff65838d395505ce6"
+  "gitHead": "086463b1a157a30d0382d7dadc56e751f4479028"
 }

package/src/cleanProposal.d.ts

@@ -6,4 +6,6 @@ export function cleanKeywords(uncleanKeywordRecord: {
 export function coerceAmountPatternKeywordRecord(allegedAmountKeywordRecord: any, getAssetKindByBrand: any): Record<string | number | symbol, any>;
 export function coerceAmountKeywordRecord(allegedAmountKeywordRecord: unknown, getAssetKindByBrand: any): AmountKeywordRecord;
 export function cleanProposal(proposal: Proposal, getAssetKindByBrand: GetAssetKindByBrand): ProposalRecord;
+import type { Proposal } from '@agoric/zoe';
+import type { ProposalRecord } from '@agoric/zoe';
 //# sourceMappingURL=cleanProposal.d.ts.map

package/src/cleanProposal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cleanProposal.d.ts","sourceRoot":"","sources":["cleanProposal.js"],"names":[],"mappings":"AAWA,iCAAkC,GAAG,CAAC;AAa/B,sDAYN;AAMM,oDAHI;IAAC,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,GACnB,MAAM,EAAE,CAcpB;AAEM,mJAsBN;AAQM,sEAJI,OAAO,uBACP,GAAC,GACC,mBAAmB,CAa/B;AA4CM,wCAJI,QAAQ,uBACR,mBAAmB,GACjB,cAAc,CA6B1B"}
+{"version":3,"file":"cleanProposal.d.ts","sourceRoot":"","sources":["cleanProposal.js"],"names":[],"mappings":"AASA,iCAAkC,GAAG,CAAC;AAiB/B,sDAYN;AAMM,oDAHI;IAAC,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,GACnB,MAAM,EAAE,CAcpB;AAEM,mJAsBN;AAQM,sEAJI,OAAO,uBACP,GAAC,GACC,mBAAmB,CAa/B;AA4CM,wCAJI,QAAQ,uBACR,mBAAmB,GACjB,cAAc,CA6B1B;8BA9JoD,aAAa;oCAAb,aAAa"}

package/src/cleanProposal.js

@@ -5,12 +5,14 @@ import { assertRecord } from '@endo/marshal';
 import { assertKey, assertPattern, mustMatch, isKey } from '@agoric/store';
 import { FullProposalShape } from './typeGuards.js';
 
-import './internal-types.js';
-
 const { ownKeys } = Reflect;
 
 export const MAX_KEYWORD_LENGTH = 100;
 
+/**
+ * @import {ExitRule, Proposal, ProposalRecord} from '@agoric/zoe';
+ */
+
 const firstCapASCII = /^[A-Z][a-zA-Z0-9_$]*$/;
 
 // We adopt simple requirements on keywords so that they do not accidentally

package/src/contractFacet/exit.d.ts

@@ -1,2 +1,2 @@
-export function makeMakeExiter(baggage: any): (proposal: ProposalRecord, zcfSeat: ZCFSeat) => ExitObj;
+export function makeMakeExiter(baggage: any): (proposal: globalThis.ProposalRecord, zcfSeat: globalThis.ZCFSeat) => ExitObj;
 //# sourceMappingURL=exit.d.ts.map

package/src/contractFacet/exit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exit.d.ts","sourceRoot":"","sources":["exit.js"],"names":[],"mappings":"AAwBO,sGAwGN"}
+{"version":3,"file":"exit.d.ts","sourceRoot":"","sources":["exit.js"],"names":[],"mappings":"AAwBO,4HAwGN"}

package/src/contractFacet/offerHandlerStorage.d.ts

@@ -1,5 +1,5 @@
 export function makeOfferHandlerStorage(zcfBaggage: any): {
-    storeOfferHandler: (offerHandler: any) => Handle<"Invitation">;
+    storeOfferHandler: (offerHandler: any) => globalThis.Handle<"Invitation">;
     takeOfferHandler: (invitationHandle: InvitationHandle, details?: Details) => OfferHandler;
 };
 /**

package/src/contractFacet/offerHandlerStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"offerHandlerStorage.d.ts","sourceRoot":"","sources":["offerHandlerStorage.js"],"names":[],"mappings":"AA6BO;;yCAgCwB,gBAAgB,YAAY,OAAO,KAAK,YAAY;EAsBlF;;;;sBAlEY,MAAM,GAAG,EAAE;mCASX,2BAAiB,eAAe,GAAG,YAAY;oCAL3B,qBAAqB;qCACpB,kBAAkB"}
+{"version":3,"file":"offerHandlerStorage.d.ts","sourceRoot":"","sources":["offerHandlerStorage.js"],"names":[],"mappings":"AAkCO;;yCAgCwB,gBAAgB,YAAY,OAAO,KAAK,YAAY;EAsBlF;;;;sBAlEY,MAAM,GAAG,EAAE;mCASX,2BAAiB,eAAe,GAAG,YAAY;oCAL3B,qBAAqB;qCACpB,kBAAkB"}

package/src/contractFacet/offerHandlerStorage.js

@@ -6,6 +6,11 @@ import { canBeDurable, provideDurableWeakMapStore } from '@agoric/vat-data';
 
 import { defineDurableHandle } from '../makeHandle.js';
 
+/**
+ * @import {LegacyWeakMap, WeakMapStore} from '@agoric/store';
+ * @import {MapStore} from '@agoric/swingset-liveslots';
+ */
+
 /**
  * The following should work. But for some reason, @endo/errors does
  * not export the type `Details`.

package/src/contractFacet/reallocate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reallocate.d.ts","sourceRoot":"","sources":["reallocate.js"],"names":[],"mappings":"AAgBO,6CAHI,KAAK,CAAC,YAAY,CAAC,GACjB,CAAC,OAAO,EAAE,mBAAmB,CAAC,EAAE,CA8E5C;8BAtFa,KAAK,CAAC,mBAAmB,CAAC"}
+{"version":3,"file":"reallocate.d.ts","sourceRoot":"","sources":["reallocate.js"],"names":[],"mappings":"AAoBO,6CAHI,KAAK,CAAC,YAAY,CAAC,GACjB,CAAC,OAAO,EAAE,mBAAmB,CAAC,EAAE,CA8E5C;8BAtFa,KAAK,CAAC,mBAAmB,CAAC"}

package/src/contractFacet/reallocate.js

@@ -4,6 +4,10 @@ import { makeScalarMapStore } from '@agoric/vat-data';
 import { assertRightsConserved } from './rightsConservation.js';
 import { addToAllocation, subtractFromAllocation } from './allocationMath.js';
 
+/**
+ * @import {MapStore} from '@agoric/swingset-liveslots';
+ */
+
 /** @typedef {Array<AmountKeywordRecord>} TransactionList */
 
 /**

package/src/contractFacet/rightsConservation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rightsConservation.d.ts","sourceRoot":"","sources":["rightsConservation.js"],"names":[],"mappings":"AAqFA;;;;;;;;;GASG;AACH,uDANW,MAAM,EAAE,cAER,MAAM,EAAE,GAEN,IAAI,CAMhB"}
+{"version":3,"file":"rightsConservation.d.ts","sourceRoot":"","sources":["rightsConservation.js"],"names":[],"mappings":"AAoFA;;;;;;;;;GASG;AACH,uDANW,MAAM,EAAE,cAER,MAAM,EAAE,GAEN,IAAI,CAMhB"}

package/src/contractFacet/rightsConservation.js

@@ -2,7 +2,6 @@ import { assert, Fail } from '@endo/errors';
 import { makeScalarMapStore } from '@agoric/store';
 import { AmountMath } from '@agoric/ertp';
 
-import '../internal-types.js';
 /**
  * @import {MapStore} from '@agoric/store';
  */

package/src/contractFacet/types.d.ts

@@ -0,0 +1,184 @@
+import type { AdditionalDisplayInfo, Amount, AnyAmount, AssetKind, Brand, DisplayInfo, Issuer, Payment } from '@agoric/ertp';
+import type { Subscriber } from '@agoric/notifier';
+import type { ERef } from '@endo/far';
+import type { Passable } from '@endo/pass-style';
+import type { Key, Pattern } from '@endo/patterns';
+import type { AmountKeywordRecord, ExitRule, FeeMintAccess, Instance, InvitationDetails, Keyword, ProposalRecord, StandardTerms, UserSeat, ZoeService } from '../types-index.js';
+import type { ContractStartFunction } from '../zoeService/utils.js';
+/**
+ * Any passable non-thenable. Often an explanatory string.
+ */
+export type Completion = Passable;
+export type ZCFMakeEmptySeatKit = (exit?: ExitRule | undefined) => ZcfSeatKit;
+export type InvitationAmount = Amount<'set', InvitationDetails>;
+export type ZoeIssuerRecord<K extends AssetKind = AssetKind, M extends Key = Key> = {
+    brand: Brand<K>;
+    issuer: Issuer<K, M>;
+    assetKind: K;
+    displayInfo?: DisplayInfo<K>;
+};
+export type Allocation = Record<Keyword, AnyAmount>;
+/**
+ * Zoe Contract Facet
+ *
+ * The Zoe interface specific to a contract instance. The Zoe Contract
+ * Facet is an API object used by running contract instances to access
+ * the Zoe state for that instance. The Zoe Contract Facet is accessed
+ * synchronously from within the contract, and usually is referred to
+ * in code as zcf.
+ */
+export type ZCF<CT = Record<string, unknown>> = {
+    /**
+     * - atomically reallocate amounts among seats.
+     */
+    atomicRearrange: (transfers: TransferPart[]) => void;
+    /**
+     * - check
+     * whether a keyword is valid and unique and could be added in
+     * `saveIssuer`
+     */
+    assertUniqueKeyword: (keyword: Keyword) => void;
+    /**
+     * Informs Zoe about an issuer and returns a promise for acknowledging
+     * when the issuer is added and ready.
+     *
+     * @returns the AmountMath and brand synchronously accessible after
+     * saving
+     */
+    saveIssuer: <I extends Issuer>(issuerP: ERef<I>, keyword: Keyword) => Promise<I extends Issuer<infer K, infer M> ? ZoeIssuerRecord<K, M> : never>;
+    /**
+     * Make a credible Zoe invitation for a particular smart contract
+     * indicated by the `instance` in the details of the invitation. Zoe
+     * also puts the `installation` and a unique `handle` in the details
+     * of the invitation. The contract must provide a `description` for
+     * the invitation and should include whatever information is necessary
+     * for a potential buyer of the invitation to know what they are
+     * getting in the `customDetails`. `customDetails` will be
+     * placed in the details of the invitation.
+     */
+    makeInvitation: <R, A = undefined>(offerHandler: OfferHandler<ERef<R>, A>, description: string, customDetails?: object, proposalShape?: Pattern) => Promise<Invitation<R, A>>;
+    shutdown: (completion: Completion) => void;
+    shutdownWithFailure: import('@agoric/swingset-vat').ShutdownWithFailure;
+    getZoeService: () => ERef<ZoeService>;
+    getInvitationIssuer: () => Issuer<'set'>;
+    getTerms: () => StandardTerms & CT;
+    getBrandForIssuer: <K extends AssetKind>(issuer: Issuer<K>) => Brand<K>;
+    getIssuerForBrand: <K_1 extends AssetKind>(brand: Brand<K_1>) => Issuer<K_1>;
+    getAssetKind: (brand: Brand) => AssetKind;
+    makeZCFMint: <K_2 extends AssetKind = 'nat'>(keyword: Keyword, assetKind?: K_2 | undefined, displayInfo?: AdditionalDisplayInfo, options?: import('@agoric/ertp').IssuerOptionsRecord) => Promise<ZCFMint<K_2>>;
+    registerFeeMint: ZCFRegisterFeeMint;
+    makeEmptySeatKit: ZCFMakeEmptySeatKit;
+    setTestJig: SetTestJig;
+    stopAcceptingOffers: () => Promise<void>;
+    setOfferFilter: (strings: Array<string>) => Promise<void>;
+    getOfferFilter: () => Promise<Array<string>>;
+    getInstance: () => Instance;
+};
+export type TransferPart = [
+    fromSeat?: ZCFSeat,
+    toSeat?: ZCFSeat,
+    fromAmounts?: AmountKeywordRecord,
+    toAmounts?: AmountKeywordRecord
+];
+export type ZCFRegisterFeeMint = (keyword: Keyword, allegedFeeMintAccess: FeeMintAccess) => Promise<ZCFMint<'nat'>>;
+/**
+ * Provide a jig object for testing purposes only.
+ *
+ * The contract code provides a callback whose return result will
+ * be made available to the test that started this contract. The
+ * supplied callback will only be called in a testing context,
+ * never in production; i.e., it is only called if `testJigSetter`
+ * was supplied.
+ *
+ * If no `testFn` is supplied, then an empty jig will be used.
+ * An additional `zcf` property set to the current ContractFacet
+ * will be appended to the returned jig object (overriding any
+ * provided by the `testFn`).
+ */
+export type SetTestJig = (testFn?: () => Record<string, unknown>) => void;
+export type ZCFMint<K extends AssetKind = AssetKind> = {
+    getIssuerRecord: () => ZoeIssuerRecord<K>;
+    /**
+     * All the amounts in gains must be of this ZCFMint's brand.
+     * The gains' keywords are in the namespace of that seat.
+     * Add the gains to that seat's allocation.
+     * The resulting state must be offer safe. (Currently, increasing assets can
+     * never violate offer safety anyway.)
+     *
+     * Mint that amount of assets into the pooled purse.
+     * If a seat is provided, it is returned. Otherwise a new seat is
+     * returned.
+     */
+    mintGains: (gains: AmountKeywordRecord, zcfSeat?: ZCFSeat) => ZCFSeat;
+    /**
+     * All the amounts in losses must be of this ZCFMint's brand.
+     * The losses' keywords are in the namespace of that seat.
+     * Subtract losses from that seat's allocation.
+     * The resulting state must be offer safe.
+     *
+     * Burn that amount of assets from the pooled purse.
+     */
+    burnLosses: (losses: AmountKeywordRecord, zcfSeat: ZCFSeat) => void;
+};
+/**
+ * fail called with the reason for this failure, where reason is
+ * normally an instanceof Error.
+ */
+export type ZCFSeatFail = (reason: unknown) => Error;
+export type ZCFSeat = import('@endo/pass-style').RemotableObject & {
+    exit: (completion?: Completion) => void;
+    fail: ZCFSeatFail;
+    getSubscriber: () => Promise<Subscriber<Allocation>>;
+    hasExited: () => boolean;
+    getProposal: () => ProposalRecord;
+    /**
+     * @param brand used for filling in an empty amount if the `keyword`
+     * is not present in the allocation
+     */
+    getAmountAllocated: <B extends Brand<any>>(keyword: Keyword, brand?: B) => B extends Brand<infer K> ? Amount<K> : Amount;
+    getCurrentAllocation: () => Allocation;
+    isOfferSafe: (newAllocation: Allocation) => boolean;
+};
+export type ZcfSeatKit = {
+    zcfSeat: ZCFSeat;
+    userSeat: Promise<UserSeat>;
+};
+export type HandleOffer<OR, OA> = (seat: ZCFSeat, offerArgs: OA) => OR;
+export type OfferHandler<OR = unknown, OA = never> = HandleOffer<OR, OA> | {
+    handle: HandleOffer<OR, OA>;
+};
+export type ContractMeta<SF extends ContractStartFunction = ContractStartFunction> = {
+    customTermsShape?: Record<Parameters<SF>[0] extends ZCF<infer CT> ? keyof CT : never, Pattern>;
+    privateArgsShape?: {
+        [K in keyof Parameters<SF>[1]]: Pattern;
+    };
+    /**
+     * - `none` means that the contract is not upgradable.
+     * - `canUpgrade` means this code can perform an upgrade
+     * - `canBeUpgraded` means that the contract stores kinds durably such that the next version can upgrade
+     */
+    upgradability?: 'none' | 'canBeUpgraded' | 'canUpgrade' | undefined;
+};
+/**
+ * API for a contract start function.
+ *
+ * CAVEAT: assumes synchronous
+ */
+export type ContractStartFn<PF = any, CF = any, CT = any, PA = any> = (zcf: ZCF<CT>, privateArgs: PA, baggage: import('@agoric/vat-data').Baggage) => ContractStartFnResult<PF, CF>;
+export type ContractStartFnResult<PF, CF> = {
+    publicFacet?: PF;
+    creatorFacet?: CF;
+    creatorInvitation?: Promise<Invitation<any, any>> | undefined;
+};
+/**
+ * @deprecated use the parameterized version
+ */
+export type AdminFacet = import('../zoeService/utils.js').AdminFacet<any>;
+declare const OfferReturn: unique symbol;
+declare const OfferArgs: unique symbol;
+export type Invitation<R = unknown, A = undefined> = Payment<'set', InvitationDetails> & {
+    [OfferReturn]?: R;
+    [OfferArgs]?: A;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/src/contractFacet/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,MAAM,EACN,SAAS,EACT,SAAS,EACT,KAAK,EACL,WAAW,EACX,MAAM,EACN,OAAO,EACR,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EACV,mBAAmB,EACnB,QAAQ,EACR,aAAa,EACb,QAAQ,EACR,iBAAiB,EACjB,OAAO,EACP,cAAc,EACd,aAAa,EACb,QAAQ,EACR,UAAU,EACX,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;AAClC,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,KAAK,UAAU,CAAC;AAE9E,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;AAEhE,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB;IACF,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrB,SAAS,EAAE,CAAC,CAAC;IACb,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC9B,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AAEpD;;;;;;;;GAQG;AACH,MAAM,MAAM,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAC9C;;OAEG;IACH,eAAe,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,KAAK,IAAI,CAAC;IACrD;;;;OAIG;IACH,mBAAmB,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IAChD;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,CAAC,SAAS,MAAM,EAC3B,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAChB,OAAO,EAAE,OAAO,KACb,OAAO,CACV,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CACnE,CAAC;IAEF;;;;;;;;;OASG;IACH,cAAc,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,EAC/B,YAAY,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EACtC,WAAW,EAAE,MAAM,EACnB,aAAa,CAAC,EAAE,MAAM,EACtB,aAAa,CAAC,EAAE,OAAO,KACpB,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/B,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAC3C,mBAAmB,EAAE,OAAO,sBAAsB,EAAE,mBAAmB,CAAC;IACxE,aAAa,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,mBAAmB,EAAE,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,QAAQ,EAAE,MAAM,aAAa,GAAG,EAAE,CAAC;IACnC,iBAAiB,EAAE,CAAC,CAAC,SAAS,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,iBAAiB,EAAE,CAAC,GAAG,SAAS,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7E,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,SAAS,CAAC;IAC1C,WAAW,EAAE,CAAC,GAAG,SAAS,SAAS,GAAG,KAAK,EACzC,OAAO,EAAE,OAAO,EAChB,SAAS,CAAC,EAAE,GAAG,GAAG,SAAS,EAC3B,WAAW,CAAC,EAAE,qBAAqB,EACnC,OAAO,CAAC,EAAE,OAAO,cAAc,EAAE,mBAAmB,KACjD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,eAAe,EAAE,kBAAkB,CAAC;IACpC,gBAAgB,EAAE,mBAAmB,CAAC;IACtC,UAAU,EAAE,UAAU,CAAC;IACvB,mBAAmB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,cAAc,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,cAAc,EAAE,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,WAAW,EAAE,MAAM,QAAQ,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,OAAO;IAClB,MAAM,CAAC,EAAE,OAAO;IAChB,WAAW,CAAC,EAAE,mBAAmB;IACjC,SAAS,CAAC,EAAE,mBAAmB;CAChC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAC/B,OAAO,EAAE,OAAO,EAChB,oBAAoB,EAAE,aAAa,KAChC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7B;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;AAC1E,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IACrD,eAAe,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,CAAC;IAC1C;;;;;;;;;;OAUG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC;IACtE;;;;;;;OAOG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;CACrE,CAAC;AACF;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,OAAO,KAAK,KAAK,CAAC;AACrD,MAAM,MAAM,OAAO,GAAG,OAAO,kBAAkB,EAAE,eAAe,GAAG;IACjE,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACxC,IAAI,EAAE,WAAW,CAAC;IAClB,aAAa,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;IACrD,SAAS,EAAE,MAAM,OAAO,CAAC;IACzB,WAAW,EAAE,MAAM,cAAc,CAAC;IAClC;;;OAGG;IACH,kBAAkB,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EACvC,OAAO,EAAE,OAAO,EAChB,KAAK,CAAC,EAAE,CAAC,KACN,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IACnD,oBAAoB,EAAE,MAAM,UAAU,CAAC;IACvC,WAAW,EAAE,CAAC,aAAa,EAAE,UAAU,KAAK,OAAO,CAAC;CACrD,CAAC;AACF,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC7B,CAAC;AACF,MAAM,MAAM,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC;AACvE,MAAM,MAAM,YAAY,CAAC,EAAE,GAAG,OAAO,EAAE,EAAE,GAAG,KAAK,IAC7C,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,GACnB;IACE,MAAM,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;CAC7B,CAAC;AACN,MAAM,MAAM,YAAY,CACtB,EAAE,SACA,qBAAqB,GAAG,qBAAqB,IAC7C;IACF,gBAAgB,CAAC,EAAE,MAAM,CACvB,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,KAAK,EAC1D,OAAO,CACR,CAAC;IACF,gBAAgB,CAAC,EAAE;SAAG,CAAC,IAAI,MAAM,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO;KAAE,CAAC;IAC/D;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,eAAe,GAAG,YAAY,GAAG,SAAS,CAAC;CACrE,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,EAAE,GAAG,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,GAAG,GAAG,IAAI,CACpE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EACZ,WAAW,EAAE,EAAE,EACf,OAAO,EAAE,OAAO,kBAAkB,EAAE,OAAO,KACxC,qBAAqB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;AACnC,MAAM,MAAM,qBAAqB,CAAC,EAAE,EAAE,EAAE,IAAI;IAC1C,WAAW,CAAC,EAAE,EAAE,CAAC;IACjB,YAAY,CAAC,EAAE,EAAE,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC;CAC/D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,wBAAwB,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;AAE1E,OAAO,CAAC,MAAM,WAAW,EAAE,OAAO,MAAM,CAAC;AACzC,OAAO,CAAC,MAAM,SAAS,EAAE,OAAO,MAAM,CAAC;AACvC,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,SAAS,IAAI,OAAO,CAC1D,KAAK,EACL,iBAAiB,CAClB,GAAG;IAEF,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;CACjB,CAAC"}

package/src/contractFacet/{types-ambient.d.ts → types.ts}

@@ -1,14 +1,49 @@
-/// <reference types="@agoric/ertp/exported" />
-/// <reference types="@endo/pass-style" />
-/// <reference path="../zoeService/utils.d.ts" />
+import type {
+  AdditionalDisplayInfo,
+  Amount,
+  AnyAmount,
+  AssetKind,
+  Brand,
+  DisplayInfo,
+  Issuer,
+  Payment,
+} from '@agoric/ertp';
+import type { Subscriber } from '@agoric/notifier';
+import type { ERef } from '@endo/far';
+import type { Passable } from '@endo/pass-style';
+import type { Key, Pattern } from '@endo/patterns';
+import type {
+  AmountKeywordRecord,
+  ExitRule,
+  FeeMintAccess,
+  Instance,
+  InvitationDetails,
+  Keyword,
+  ProposalRecord,
+  StandardTerms,
+  UserSeat,
+  ZoeService,
+} from '../types-index.js';
+import type { ContractStartFunction } from '../zoeService/utils.js';
 
 /**
  * Any passable non-thenable. Often an explanatory string.
  */
-type Completion = import('@endo/pass-style').Passable;
-type ZCFMakeEmptySeatKit = (exit?: ExitRule | undefined) => ZcfSeatKit;
+export type Completion = Passable;
+export type ZCFMakeEmptySeatKit = (exit?: ExitRule | undefined) => ZcfSeatKit;
 
-type InvitationAmount = Amount<'set', InvitationDetails>;
+export type InvitationAmount = Amount<'set', InvitationDetails>;
+
+export type ZoeIssuerRecord<
+  K extends AssetKind = AssetKind,
+  M extends Key = Key,
+> = {
+  brand: Brand<K>;
+  issuer: Issuer<K, M>;
+  assetKind: K;
+  displayInfo?: DisplayInfo<K>;
+};
+export type Allocation = Record<Keyword, AnyAmount>;
 
 /**
  * Zoe Contract Facet
@@ -19,16 +54,11 @@ type InvitationAmount = Amount<'set', InvitationDetails>;
  * synchronously from within the contract, and usually is referred to
  * in code as zcf.
  */
-type ZCF<CT extends unknown = Record<string, unknown>> = {
+export type ZCF<CT = Record<string, unknown>> = {
   /**
    * - atomically reallocate amounts among seats.
    */
   atomicRearrange: (transfers: TransferPart[]) => void;
-  /**
-   * - reallocate amounts among seats.
-   * @deprecated Use atomicRearrange instead.
-   */
-  reallocate: Reallocate;
   /**
    * - check
    * whether a keyword is valid and unique and could be added in
@@ -45,7 +75,9 @@ type ZCF<CT extends unknown = Record<string, unknown>> = {
   saveIssuer: <I extends Issuer>(
     issuerP: ERef<I>,
     keyword: Keyword,
-  ) => Promise<I extends Issuer<infer K, infer M> ? IssuerRecord<K, M> : never>;
+  ) => Promise<
+    I extends Issuer<infer K, infer M> ? ZoeIssuerRecord<K, M> : never
+  >;
 
   /**
    * Make a credible Zoe invitation for a particular smart contract
@@ -70,7 +102,7 @@ type ZCF<CT extends unknown = Record<string, unknown>> = {
   getTerms: () => StandardTerms & CT;
   getBrandForIssuer: <K extends AssetKind>(issuer: Issuer<K>) => Brand<K>;
   getIssuerForBrand: <K_1 extends AssetKind>(brand: Brand<K_1>) => Issuer<K_1>;
-  getAssetKind: GetAssetKindByBrand;
+  getAssetKind: (brand: Brand) => AssetKind;
   makeZCFMint: <K_2 extends AssetKind = 'nat'>(
     keyword: Keyword,
     assetKind?: K_2 | undefined,
@@ -86,42 +118,14 @@ type ZCF<CT extends unknown = Record<string, unknown>> = {
   getInstance: () => Instance;
 };
 
-/**
- * @deprecated Use atomicRearrange instead
- *
- * The contract can reallocate over seats, which commits the staged
- * allocation for each seat. On commit, the staged allocation becomes
- * the current allocation and the staged allocation is deleted.
- *
- * The reallocation will only succeed if the reallocation 1) conserves
- * rights (the amounts specified have the same total value as the
- * current total amount), and 2) is 'offer-safe' for all parties
- * involved. All seats that have staged allocations must be included
- * as arguments to `reallocate`, or an error is thrown. Additionally,
- * an error is thrown if any seats included in `reallocate` do not
- * have a staged allocation.
- *
- * The reallocation is partial, meaning that it applies only to the
- * seats passed in as arguments. By induction, if rights conservation
- * and offer safety hold before, they will hold after a safe
- * reallocation, even though we only re-validate for the seats whose
- * allocations will change. Since rights are conserved for the change,
- * overall rights will be unchanged, and a reallocation can only
- * effect offer safety for seats whose allocations change.
- */
-type Reallocate = (
-  seat1: ZCFSeat,
-  seat2: ZCFSeat,
-  ...seatRest: Array<ZCFSeat>
-) => void;
-type TransferPart = [
+export type TransferPart = [
   fromSeat?: ZCFSeat,
   toSeat?: ZCFSeat,
   fromAmounts?: AmountKeywordRecord,
   toAmounts?: AmountKeywordRecord,
 ];
 
-type ZCFRegisterFeeMint = (
+export type ZCFRegisterFeeMint = (
   keyword: Keyword,
   allegedFeeMintAccess: FeeMintAccess,
 ) => Promise<ZCFMint<'nat'>>;
@@ -139,9 +143,9 @@ type ZCFRegisterFeeMint = (
  * will be appended to the returned jig object (overriding any
  * provided by the `testFn`).
  */
-type SetTestJig = (testFn?: () => Record<string, unknown>) => void;
-type ZCFMint<K extends AssetKind = AssetKind> = {
-  getIssuerRecord: () => IssuerRecord<K>;
+export type SetTestJig = (testFn?: () => Record<string, unknown>) => void;
+export type ZCFMint<K extends AssetKind = AssetKind> = {
+  getIssuerRecord: () => ZoeIssuerRecord<K>;
   /**
    * All the amounts in gains must be of this ZCFMint's brand.
    * The gains' keywords are in the namespace of that seat.
@@ -168,8 +172,8 @@ type ZCFMint<K extends AssetKind = AssetKind> = {
  * fail called with the reason for this failure, where reason is
  * normally an instanceof Error.
  */
-type ZCFSeatFail = (reason: unknown) => Error;
-type ZCFSeat = import('@endo/pass-style').RemotableObject & {
+export type ZCFSeatFail = (reason: unknown) => Error;
+export type ZCFSeat = import('@endo/pass-style').RemotableObject & {
   exit: (completion?: Completion) => void;
   fail: ZCFSeatFail;
   getSubscriber: () => Promise<Subscriber<Allocation>>;
@@ -179,50 +183,26 @@ type ZCFSeat = import('@endo/pass-style').RemotableObject & {
    * @param brand used for filling in an empty amount if the `keyword`
    * is not present in the allocation
    */
-  getAmountAllocated: <B extends Brand>(
+  getAmountAllocated: <B extends Brand<any>>(
     keyword: Keyword,
     brand?: B,
   ) => B extends Brand<infer K> ? Amount<K> : Amount;
   getCurrentAllocation: () => Allocation;
-  /**
-   * @deprecated Use atomicRearrange instead
-   */
-  getStagedAllocation: () => Allocation;
-  /**
-   * @deprecated Use atomicRearrange instead
-   */
-  hasStagedAllocation: () => boolean;
   isOfferSafe: (newAllocation: Allocation) => boolean;
-  /**
-   * @deprecated Use atomicRearrange instead
-   */
-  incrementBy: (
-    amountKeywordRecord: AmountKeywordRecord,
-  ) => AmountKeywordRecord;
-  /**
-   * @deprecated Use atomicRearrange instead
-   */
-  decrementBy: (
-    amountKeywordRecord: AmountKeywordRecord,
-  ) => AmountKeywordRecord;
-  /**
-   * @deprecated Use atomicRearrange instead
-   */
-  clear: () => void;
 };
-type ZcfSeatKit = {
+export type ZcfSeatKit = {
   zcfSeat: ZCFSeat;
   userSeat: Promise<UserSeat>;
 };
-type HandleOffer<OR extends unknown, OA> = (seat: ZCFSeat, offerArgs: OA) => OR;
-type OfferHandler<OR extends unknown = unknown, OA = never> =
+export type HandleOffer<OR, OA> = (seat: ZCFSeat, offerArgs: OA) => OR;
+export type OfferHandler<OR = unknown, OA = never> =
   | HandleOffer<OR, OA>
   | {
       handle: HandleOffer<OR, OA>;
     };
-type ContractMeta<
+export type ContractMeta<
   SF extends // import inline to maintain ambient mode
-    import('../zoeService/utils').ContractStartFunction = import('../zoeService/utils').ContractStartFunction,
+    ContractStartFunction = ContractStartFunction,
 > = {
   customTermsShape?: Record<
     Parameters<SF>[0] extends ZCF<infer CT> ? keyof CT : never,
@@ -241,30 +221,25 @@ type ContractMeta<
  *
  * CAVEAT: assumes synchronous
  */
-type ContractStartFn<
-  PF extends unknown = any,
-  CF extends unknown = any,
-  CT extends unknown = any,
-  PA extends unknown = any,
-> = (
+export type ContractStartFn<PF = any, CF = any, CT = any, PA = any> = (
   zcf: ZCF<CT>,
   privateArgs: PA,
   baggage: import('@agoric/vat-data').Baggage,
 ) => ContractStartFnResult<PF, CF>;
-type ContractStartFnResult<PF, CF> = {
+export type ContractStartFnResult<PF, CF> = {
   publicFacet?: PF;
   creatorFacet?: CF;
   creatorInvitation?: Promise<Invitation<any, any>> | undefined;
 };
 
-// XXX redef, losing documentation
-type ContractOf<S extends (...args: any) => any> =
-  import('../zoeService/utils').ContractOf<S>;
-type AdminFacet = import('../zoeService/utils').AdminFacet<any>;
+/**
+ * @deprecated use the parameterized version
+ */
+export type AdminFacet = import('../zoeService/utils.js').AdminFacet<any>;
 
 declare const OfferReturn: unique symbol;
 declare const OfferArgs: unique symbol;
-type Invitation<R = unknown, A = undefined> = Payment<
+export type Invitation<R = unknown, A = undefined> = Payment<
   'set',
   InvitationDetails
 > & {