@agoric/inter-protocol 0.16.2-dev-da94029.0 → 0.16.2-dev-43b4090.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.16.2-dev-da94029.0+da94029",
+  "version": "0.16.2-dev-43b4090.0+43b4090",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
@@ -31,6 +31,7 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
+    "@agoric/base-zone": "workspace:*",
     "@agoric/ertp": "workspace:*",
     "@agoric/governance": "workspace:*",
     "@agoric/internal": "workspace:*",
@@ -84,5 +85,5 @@
   "typeCoverage": {
     "atLeast": 95.72
   },
-  "gitHead": "da940299e592bd6866ddb29e4ceebdbe17c79ce0"
+  "gitHead": "43b409040628dd3706a1279098534d3cf1d18ab7"
 }

package/src/reserve/assetReserve.d.ts

@@ -16,6 +16,11 @@ export function start(zcf: ZCF<GovernanceTerms<{}> & {
             increaseLiquidationShortfall(shortfall: Amount<"nat">): void;
             reduceLiquidationShortfall(reduction: Amount<"nat">): void;
         }>, undefined>>;
+        makeSingleWithdrawalInvitation(): Promise<globalThis.Invitation<any, undefined>>;
+        makeRepeatableWithdrawalInvitation(): Promise<globalThis.Invitation<{
+            invitationMakers: Partial<any>;
+        }, undefined>>;
+        revokeOutstandingWithdrawalInvitations(): void;
     }>>;
     /** @type {GovernedPublicFacet<typeof assetReserveKit.public>} */
     publicFacet: GovernedPublicFacet<import("@endo/exo").Guarded<{
@@ -43,9 +48,11 @@ export type AssetReservePublicFacet = EReturn<typeof start>["publicFacet"];
  * the creator facet for the governor
  */
 export type AssetReserveCreatorFacet = EReturn<typeof start>["creatorFacet"];
+export type ReserveContract = ContractOf<typeof start>;
 import type { ContractMeta } from '@agoric/zoe';
 import type { FeeMintAccess } from '@agoric/zoe';
 import type { Baggage } from '@agoric/vat-data';
 import type { Allocation } from '@agoric/zoe';
 import type { EReturn } from '@endo/far';
+import type { ContractOf } from '@agoric/zoe/src/zoeService/utils.js';
 //# sourceMappingURL=assetReserve.d.ts.map

package/src/reserve/assetReserve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assetReserve.d.ts","sourceRoot":"","sources":["assetReserve.js"],"names":[],"mappings":"AAiBA,yCAAyC;AACzC,mBADW,aAAa,OAAO,KAAK,CAAC,CAGnC;AAgCK,2BAbI,GAAG,CACT,eAAe,CAAC,EAAE,CAAC,GAAG;IACpB,YAAY,EAAE,CAAC,2BAA2B,CAAC,CAAC;CAC7C,CACF,eACO;IACN,aAAa,EAAE,aAAa,CAAC;IAC7B,sBAAsB,EAAE,UAAU,CAAC;IACnC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;CAChC,WACO,OAAO;IAoDd,mEAAmE;kBAAxD,oBAAoB;;;;;;;OAAgC;IAE/D,iEAAiE;iBAAtD,mBAAmB;;;;;OAA+B;GAKhE;sCArFY;IACR,4BAA4B,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,0BAA0B,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CACzD;;kCAuFU,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI;gCAC3B,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI;;;eAK3B,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI;oBACrC,MAAM,UAAU;sCAChB,MAAM,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;;sCAG5C,QAAQ,OAAO,KAAK,CAAb,CAAe,aAAa,CAAC;;;;uCAErC,QAAQ,OAAO,KAAK,CAAb,CAAe,cAAc,CAAC;kCAnHsB,aAAa;mCAAb,aAAa;6BAkB1D,kBAAkB;gCAlB2B,aAAa;6BAD3D,WAAW"}
+{"version":3,"file":"assetReserve.d.ts","sourceRoot":"","sources":["assetReserve.js"],"names":[],"mappings":"AAkBA,yCAAyC;AACzC,mBADW,aAAa,OAAO,KAAK,CAAC,CAGnC;AAgCK,2BAbI,GAAG,CACT,eAAe,CAAC,EAAE,CAAC,GAAG;IACpB,YAAY,EAAE,CAAC,2BAA2B,CAAC,CAAC;CAC7C,CACF,eACO;IACN,aAAa,EAAE,aAAa,CAAC;IAC7B,sBAAsB,EAAE,UAAU,CAAC;IACnC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;CAChC,WACO,OAAO;IAoDd,mEAAmE;kBAAxD,oBAAoB;;;;;;;;;;;;OAAgC;IAE/D,iEAAiE;iBAAtD,mBAAmB;;;;;OAA+B;GAKhE;sCArFY;IACR,4BAA4B,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,0BAA0B,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CACzD;;kCAuFU,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI;gCAC3B,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI;;;eAK3B,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI;oBACrC,MAAM,UAAU;sCAChB,MAAM,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;;sCAG5C,QAAQ,OAAO,KAAK,CAAb,CAAe,aAAa,CAAC;;;;uCAErC,QAAQ,OAAO,KAAK,CAAb,CAAe,cAAc,CAAC;8BAIpC,WAAW,OAAO,KAAK,CAAC;kCAvHkC,aAAa;mCAAb,aAAa;6BAkB1D,kBAAkB;gCAlB2B,aAAa;6BAF3D,WAAW;gCACR,qCAAqC"}

package/src/reserve/assetReserve.js

@@ -10,6 +10,7 @@ import { prepareAssetReserveKit } from './assetReserveKit.js';
 
 /**
  * @import {EReturn} from '@endo/far';
+ * @import {ContractOf} from '@agoric/zoe/src/zoeService/utils.js';
  * @import {Allocation, ContractMeta, FeeMintAccess, Installation} from '@agoric/zoe';
  */
 
@@ -128,3 +129,5 @@ harden(start);
  * @typedef {EReturn<typeof start>['creatorFacet']} AssetReserveCreatorFacet
  *   the creator facet for the governor
  */
+
+/** @typedef {ContractOf<typeof start>} ReserveContract */

package/src/reserve/assetReserveKit.d.ts

@@ -21,6 +21,20 @@ export function prepareAssetReserveKit(baggage: import("@agoric/vat-data").Bagga
          */
         burnFeesToReduceShortfall(reduction: Amount<"nat">): void;
     };
+    withdrawalHandler: {
+        handle(seat: any): Promise<string>;
+    };
+    withdrawalFacet: {
+        Withdraw(): Promise<globalThis.Invitation<any, undefined>>;
+    };
+    repeatableWithdrawalHandler: {
+        /**
+         * @param {ZCFSeat} seat
+         */
+        handle(seat: ZCFSeat): {
+            invitationMakers: Partial<any>;
+        };
+    };
     machine: {
         /**
          * @param {Issuer} issuer
@@ -35,6 +49,11 @@ export function prepareAssetReserveKit(baggage: import("@agoric/vat-data").Bagga
             /** @param {Amount<'nat'>} reduction */
             reduceLiquidationShortfall(reduction: Amount<"nat">): void;
         }>, undefined>>;
+        makeSingleWithdrawalInvitation(): Promise<globalThis.Invitation<any, undefined>>;
+        makeRepeatableWithdrawalInvitation(): Promise<globalThis.Invitation<{
+            invitationMakers: Partial<any>;
+        }, undefined>>;
+        revokeOutstandingWithdrawalInvitations(): void;
     };
     /**
      * XXX missing governance public methods
@@ -72,5 +91,13 @@ export type MetricsNotification = {
 };
 export type AssetReserveKit = EReturn<EReturn<typeof prepareAssetReserveKit>>;
 import type { ZCFMint } from '@agoric/zoe';
+import type { StorageNode } from '@agoric/internal/src/lib-chainStorage.js';
+import type { ZCF } from '@agoric/zoe';
+import type { Brand } from '@agoric/ertp';
+import type { Keyword } from '@agoric/zoe';
+import type { Amount } from '@agoric/ertp';
+import type { ZCFSeat } from '@agoric/zoe';
+import type { Issuer } from '@agoric/ertp';
+import type { AmountKeywordRecord } from '@agoric/zoe/src/zoeService/types.js';
 import type { EReturn } from '@endo/far';
 //# sourceMappingURL=assetReserveKit.d.ts.map

package/src/reserve/assetReserveKit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assetReserveKit.d.ts","sourceRoot":"","sources":["assetReserveKit.js"],"names":[],"mappings":"AAwCO,gDARI,OAAO,kBAAkB,EAAE,OAAO,kDAClC;IACN,OAAO,EAAE,QAAQ,KAAK,CAAC,CAAC;IACxB,eAAe,EAAE,OAAO,6CAA6C,EAAE,eAAe,CAAC;IACvF,WAAW,EAAE,WAAW,CAAC;IACzB,GAAG,EAAE,GAAG,CAAC;CACV;;QAoEI,2BAA2B;kCAAf,KAAK;QAUjB;;;WAGG;gCAFQ,KAAK,WACL,OAAO;;;;QAqBlB;;;WAGG;6CAFQ,MAAM,CAAC,KAAK,CAAC,GACX,IAAI;;;QA6BjB;;;WAGG;0BAFQ,MAAM,WACN,MAAM;QAmBjB,8DAA8D;;;YA2D9D,uCAAuC;oDAA3B,MAAM,CAAC,KAAK,CAAC;YAWzB,uCAAuC;kDAA3B,MAAM,CAAC,KAAK,CAAC;;;IArD3B;;;OAGG;;QAED,mDAAmD;;;;;;;QAqCnD,uCAAuC;gDAA3B,MAAM,CAAC,KAAK,CAAC;QAWzB,uCAAuC;8CAA3B,MAAM,CAAC,KAAK,CAAC;;KA8BhC;;iBA3Qa,mBAAmB;;;;;sBACnB,MAAM,CAAC,KAAK,CAAC;;;;oBAEb,MAAM,CAAC,KAAK,CAAC;;;;oBACb,MAAM,CAAC,KAAK,CAAC;;8BAyQb,QAAQ,QAAQ,OAAO,sBAAsB,CAAC,CAAC;6BAlRO,aAAa;6BAHvD,WAAW"}
+{"version":3,"file":"assetReserveKit.d.ts","sourceRoot":"","sources":["assetReserveKit.js"],"names":[],"mappings":"AAiDO,gDARI,OAAO,kBAAkB,EAAE,OAAO,kDAClC;IACN,OAAO,EAAE,QAAQ,KAAK,CAAC,CAAC;IACxB,eAAe,EAAE,OAAO,6CAA6C,EAAE,eAAe,CAAC;IACvF,WAAW,EAAE,WAAW,CAAC;IACzB,GAAG,EAAE,GAAG,CAAC;CACV;;QA8GI,2BAA2B;kCAAf,KAAK;QAUjB;;;WAGG;gCAFQ,KAAK,WACL,OAAO;;;;QAqBlB;;;WAGG;6CAFQ,OAAO,KAAK,CAAC,GACX,IAAI;;;;;;;;;QAsDjB;;WAEG;qBADQ,OAAO;;;;;QAYlB;;;WAGG;0BAFQ,MAAM,WACN,MAAM;QAmBjB,8DAA8D;;;YA2E9D,uCAAuC;oDAA3B,OAAO,KAAK,CAAC;YAWzB,uCAAuC;kDAA3B,OAAO,KAAK,CAAC;;;;;;;;IArD3B;;;OAGG;;QAED,mDAAmD;;;;;;;QAqCnD,uCAAuC;gDAA3B,OAAO,KAAK,CAAC;QAWzB,uCAAuC;8CAA3B,OAAO,KAAK,CAAC;;KA8BhC;;iBA3Wa,mBAAmB;;;;;sBACnB,OAAO,KAAK,CAAC;;;;oBAEb,OAAO,KAAK,CAAC;;;;oBACb,OAAO,KAAK,CAAC;;8BAyWb,QAAQ,QAAQ,OAAO,sBAAsB,CAAC,CAAC;6BAlXE,aAAa;iCAJ9C,0CAA0C;yBAIT,aAAa;2BAHpC,cAAc;6BAGS,aAAa;4BAHpC,cAAc;6BAGS,aAAa;4BAHpC,cAAc;yCAEhB,qCAAqC;6BALjD,WAAW"}

package/src/reserve/assetReserveKit.js

@@ -1,3 +1,4 @@
+// @ts-check
 import { Fail, q } from '@endo/errors';
 import { AmountMath, AmountShape, IssuerShape } from '@agoric/ertp';
 import { makeTracer } from '@agoric/internal';
@@ -7,17 +8,25 @@ import {
   makeRecorderTopic,
   TopicsRecordShape,
 } from '@agoric/zoe/src/contractSupport/topics.js';
-import { AmountKeywordRecordShape } from '@agoric/zoe/src/typeGuards.js';
+import {
+  AmountKeywordRecordShape,
+  OfferHandlerI,
+} from '@agoric/zoe/src/typeGuards.js';
 import { E } from '@endo/eventual-send';
 import { UnguardedHelperI } from '@agoric/internal/src/typeGuards.js';
+import { prepareRevocableMakerKit } from '@agoric/base-zone/zone-helpers.js';
+import { makeDurableZone } from '@agoric/zone/durable.js';
 
 const trace = makeTracer('ReserveKit', true);
 
 /**
  * @import {EReturn} from '@endo/far';
  * @import {TypedPattern} from '@agoric/internal';
- * @import {MapStore} from '@agoric/store';
- * @import {AdminFacet, ContractOf, InvitationAmount, ZCFMint} from '@agoric/zoe';
+ * @import {StorageNode} from '@agoric/internal/src/lib-chainStorage.js';
+ * @import {Amount, Brand, Issuer} from '@agoric/ertp';
+ * @import {MapStore, SetStore} from '@agoric/store';
+ * @import {AmountKeywordRecord} from '@agoric/zoe/src/zoeService/types.js';
+ * @import {ZCF, OfferHandler, Keyword, ZCFMint, ZCFSeat} from '@agoric/zoe';
  */
 
 /**
@@ -46,6 +55,40 @@ export const prepareAssetReserveKit = async (
   const feeKit = feeMint.getIssuerRecord();
   const emptyAmount = AmountMath.makeEmpty(feeKit.brand);
 
+  const zone = makeDurableZone(baggage);
+
+  // Durable revocation bookkeeping for the revocable single and repeatable
+  // invitations.
+  /** @type {SetStore<{ revoke: () => boolean }>} */
+  const outstandingRevokers = zone.setStore('outstandingRevokers');
+
+  const { makeRevocableKit: makeRevocableWithdrawalFacet } =
+    prepareRevocableMakerKit(zone, 'WithdrawalFacet', ['Withdraw']);
+
+  const { makeRevocableKit: makeRevocableWithdrawalHandler } =
+    prepareRevocableMakerKit(zone, 'WithdrawalHandler', ['handle'], {
+      extraMethods: {
+        /**
+         * Add some additional cleanup to avoid proliferation of revokers for
+         * spent invitations.
+         *
+         * @param {ZCFSeat} seat
+         * @param {never} offerArgs
+         */
+        handle(seat, offerArgs) {
+          const { revoker } = this.facets;
+          // We remove our outstanding revoker because we are consumed by Zoe
+          // and cannot be used again.
+          if (this.state.underlying === undefined) {
+            Fail`${q('WithdrawalHandler_caretaker')} revoked`;
+          }
+
+          outstandingRevokers.delete(revoker);
+          return this.state.underlying.handle(seat, offerArgs);
+        },
+      },
+    });
+
   const makeAssetReserveKitInternal = prepareExoClassKit(
     baggage,
     'AssetReserveKit',
@@ -54,10 +97,18 @@ export const prepareAssetReserveKit = async (
       governedApis: M.interface('AssetReserve governedApis', {
         burnFeesToReduceShortfall: M.call(AmountShape).returns(),
       }),
+      withdrawalFacet: M.interface('AssetReserve withdrawalFacet', {
+        Withdraw: M.call().returns(M.promise()),
+      }),
+      withdrawalHandler: OfferHandlerI,
+      repeatableWithdrawalHandler: OfferHandlerI,
       machine: M.interface('AssetReserve machine', {
         addIssuer: M.call(IssuerShape, M.string()).returns(M.promise()),
         getAllocations: M.call().returns(AmountKeywordRecordShape),
         makeShortfallReportingInvitation: M.call().returns(M.promise()),
+        makeSingleWithdrawalInvitation: M.call().returns(M.promise()),
+        makeRepeatableWithdrawalInvitation: M.call().returns(M.promise()),
+        revokeOutstandingWithdrawalInvitations: M.call().returns(),
       }),
       public: M.interface('AssetReserve public', {
         makeAddCollateralInvitation: M.call().returns(M.promise()),
@@ -166,6 +217,44 @@ export const prepareAssetReserveKit = async (
           facets.helper.writeMetrics();
         },
       },
+      withdrawalHandler: {
+        async handle(seat) {
+          const { collateralSeat } = this.state;
+          const { helper } = this.facets;
+          const { want } = seat.getProposal();
+
+          // COMMIT POINT
+          // UNTIL #10684: ability to terminate an incarnation w/o terminating the contract
+          zcf.atomicRearrange(harden([[collateralSeat, seat, want]]));
+
+          helper.writeMetrics();
+          seat.exit();
+
+          trace('withdrew collateral', want);
+          return 'withdrew Collateral from the Reserve';
+        },
+      },
+      withdrawalFacet: {
+        Withdraw() {
+          const { revoker, revocable: handler } =
+            makeRevocableWithdrawalHandler(this.facets.withdrawalHandler);
+          outstandingRevokers.add(revoker);
+          // @ts-expect-error Argument of type Guarded<
+          return zcf.makeInvitation(handler, 'Withdraw Collateral');
+        },
+      },
+      repeatableWithdrawalHandler: {
+        /**
+         * @param {ZCFSeat} seat
+         */
+        handle(seat) {
+          seat.exit();
+          const { revoker, revocable: invitationMakers } =
+            makeRevocableWithdrawalFacet(this.facets.withdrawalFacet);
+          outstandingRevokers.add(revoker);
+          return harden({ invitationMakers });
+        },
+      },
       machine: {
         // add makeRedeemLiquidityTokensInvitation later. For now just store them
         /**
@@ -205,6 +294,22 @@ export const prepareAssetReserveKit = async (
             'getFacetForReportingShortfalls',
           );
         },
+
+        makeSingleWithdrawalInvitation() {
+          return this.facets.withdrawalFacet.Withdraw();
+        },
+
+        makeRepeatableWithdrawalInvitation() {
+          const handler = this.facets.repeatableWithdrawalHandler;
+          return zcf.makeInvitation(handler, 'Repeatable Withdraw Collateral');
+        },
+
+        revokeOutstandingWithdrawalInvitations() {
+          for (const revoker of outstandingRevokers.keys()) {
+            revoker.revoke();
+          }
+          outstandingRevokers.clear();
+        },
       },
       /**
        * XXX missing governance public methods