@agoric/base-zone 0.1.1-dev-860d051.0 → 0.1.1-dev-5cdf6e3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/base-zone",
-  "version": "0.1.1-dev-860d051.0+860d051",
+  "version": "0.1.1-dev-5cdf6e3.0+5cdf6e3",
   "description": "Allocation zone abstraction library and heap implementation",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -27,7 +27,7 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/store": "0.9.3-dev-860d051.0+860d051",
+    "@agoric/store": "0.9.3-dev-5cdf6e3.0+5cdf6e3",
     "@endo/common": "^1.2.0",
     "@endo/exo": "^1.3.0",
     "@endo/far": "^1.1.0",
@@ -58,5 +58,5 @@
   "typeCoverage": {
     "atLeast": 89.25
   },
-  "gitHead": "860d051e8c26975d244c211b061a8189f1718cab"
+  "gitHead": "5cdf6e3a8b4fbb5cb8e276e6efeec65d9c3d6623"
 }

package/src/prepare-revocable.d.ts

@@ -1,9 +1,16 @@
-export function prepareRevocableKit<U extends unknown = any>(zone: import('@agoric/base-zone').Zone, uKindName: string, uMethodNames: (string | symbol)[], options?: RevocableKitOptions<any> | undefined): (underlying: U) => RevocableKit<U>;
-export type Revoker = {
+export function prepareRevocableMakerKit<U = any>(zone: import('@agoric/base-zone').Zone, uKindName: string, uMethodNames: (string | symbol)[], options?: RevocableKitOptions<any> | undefined): RevocableMakerKit<U>;
+export type RevocableMakerKit<U = any> = {
+    revoke: (revocable: U) => boolean;
+    /**
+     *   Forwards to the underlying exo object, until revoked
+     */
+    makeRevocable: (underlying: U) => U;
+};
+export type RevokerFacet = {
     revoke: () => boolean;
 };
-export type RevocableKit<U extends unknown = any> = {
-    revoker: Revoker;
+export type RevocableKit<U = any> = {
+    revoker: RevokerFacet;
     /**
      *   Forwards to the underlying exo object, until revoked
      */
@@ -15,7 +22,7 @@ export type RevocableKitThis<U = any> = {
         underlying: U;
     };
 };
-export type RevocableKitOptions<U extends unknown = any> = {
+export type RevocableKitOptions<U = any> = {
     /**
      * The `interfaceName` of the underlying interface guard.
      * Defaults to the `uKindName`.

package/src/prepare-revocable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prepare-revocable.d.ts","sourceRoot":"","sources":["prepare-revocable.js"],"names":[],"mappings":"AA6DO,mEATI,OAAO,mBAAmB,EAAE,IAAI,aAChC,MAAM,gBAEN,CAAC,MAAM,GAAC,MAAM,CAAC,EAAE,sFAgF3B;;YAhIa,MAAM,OAAO;;;aAMb,OAAO;;;;eACP,CAAC;;;YAOD,aAAa,CAAC,CAAC;WACf;QAAE,UAAU,EAAE,CAAC,CAAA;KAAE;;;;;;;;;;;;;;;;;;kDAkBnB,iBAAiB,CAAC,CAAC,WAAW,GAAG,EAAE,KAAK,GAAG"}
+{"version":3,"file":"prepare-revocable.d.ts","sourceRoot":"","sources":["prepare-revocable.js"],"names":[],"mappings":"AAoEO,wDATI,OAAO,mBAAmB,EAAE,IAAI,aAChC,MAAM,gBAEN,CAAC,MAAM,GAAC,MAAM,CAAC,EAAE,wEA4G3B;;YAlKa,CAAC,SAAS,EAAE,CAAC,KAAK,OAAO;;;;mBACzB,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC;;;YAMpB,MAAM,OAAO;;;aAMb,YAAY;;;;eACZ,CAAC;;;YAOD,aAAa,CAAC,CAAC;WACf;QAAE,UAAU,EAAE,CAAC,CAAA;KAAE;;;;;;;;;;;;;;;;;;kDAkBnB,iBAAiB,CAAC,CAAC,WAAW,GAAG,EAAE,KAAK,GAAG"}

package/src/prepare-revocable.js

@@ -4,14 +4,22 @@ import { fromUniqueEntries } from '@endo/common/from-unique-entries.js';
 const { Fail, quote: q } = assert;
 
 /**
- * @typedef {object} Revoker
+ * @template [U=any]
+ * @typedef {object} RevocableMakerKit
+ * @property {(revocable: U) => boolean} revoke
+ * @property {(underlying: U) => U} makeRevocable
+ *   Forwards to the underlying exo object, until revoked
+ */
+
+/**
+ * @typedef {object} RevokerFacet
  * @property {() => boolean} revoke
  */
 
 /**
- * @template {any} [U=any]
+ * @template [U=any]
  * @typedef {object} RevocableKit
- * @property {Revoker} revoker
+ * @property {RevokerFacet} revoker
  * @property {U} revocable
  *   Forwards to the underlying exo object, until revoked
  */
@@ -24,7 +32,7 @@ const { Fail, quote: q } = assert;
  */
 
 /**
- * @template {any} [U=any]
+ * @template [U=any]
  * @typedef {object} RevocableKitOptions
  * @property {string} [uInterfaceName]
  *   The `interfaceName` of the underlying interface guard.
@@ -48,8 +56,7 @@ const { Fail, quote: q } = assert;
  * Make an exo class kit for wrapping an underlying exo class,
  * where the wrapper is a revocable forwarder.
  *
- * @deprecated Change to `prepareRevocableMakerKit` once #8977 happens
- * @template {any} [U=any]
+ * @template [U=any]
  * @param {import('@agoric/base-zone').Zone} zone
  * @param {string} uKindName
  *   The `kindName` of the underlying exo class
@@ -57,9 +64,9 @@ const { Fail, quote: q } = assert;
  *   The method names of the underlying exo class that should be represented
  *   by transparently-forwarding methods of the revocable caretaker.
  * @param {RevocableKitOptions} [options]
- * @returns {(underlying: U) => RevocableKit<U>}
+ * @returns {RevocableMakerKit<U>}
  */
-export const prepareRevocableKit = (
+export const prepareRevocableMakerKit = (
   zone,
   uKindName,
   uMethodNames,
@@ -87,6 +94,8 @@ export const prepareRevocableKit = (
 
   const revocableKindName = `${uKindName}_caretaker`;
 
+  let amplifier;
+
   const makeRevocableKit = zone.exoClassKit(
     revocableKindName,
     RevocableIKit,
@@ -128,10 +137,36 @@ export const prepareRevocableKit = (
       stateShape: {
         underlying: M.opt(M.remotable('underlying')),
       },
+      receiveAmplifier: amp => {
+        amplifier = amp;
+      },
     },
   );
 
-  // @ts-expect-error parameter confusion
-  return makeRevocableKit;
+  /**
+   * @param {U} underlying
+   * @returns {U}
+   */
+  const makeRevocable = underlying =>
+    // @ts-expect-error some confusion about UU vs Guarded<U> I think
+    makeRevocableKit(underlying).revocable;
+
+  /**
+   * @param {U} revocable
+   * @returns {boolean}
+   */
+  const revoke = revocable => {
+    /** @type {RevocableKit<U>} */
+    const facets = amplifier(revocable);
+    if (facets === undefined) {
+      return false;
+    }
+    return facets.revoker.revoke();
+  };
+
+  return harden({
+    revoke,
+    makeRevocable,
+  });
 };
-harden(prepareRevocableKit);
+harden(prepareRevocableMakerKit);

package/test/test-prepare-revocable.js

@@ -5,7 +5,7 @@ import { test } from './prepare-test-env-ava.js';
 // eslint-disable-next-line import/order
 import { M } from '@endo/patterns';
 import { makeHeapZone } from '../src/heap.js';
-import { prepareRevocableKit } from '../src/prepare-revocable.js';
+import { prepareRevocableMakerKit } from '../src/prepare-revocable.js';
 
 const UpCounterI = M.interface('UpCounter', {
   incr: M.call()
@@ -38,16 +38,17 @@ test('test revoke defineVirtualExoClass', t => {
     },
   );
 
-  const makeRevocableUpCounterKit = prepareRevocableKit(zone, 'UpCounter', [
-    'incr',
-  ]);
+  const { revoke, makeRevocable } = prepareRevocableMakerKit(
+    zone,
+    'UpCounter',
+    ['incr'],
+  );
 
-  const makeUpCounterKit = x =>
-    makeRevocableUpCounterKit(makeUnderlyingUpCounter(x));
+  const makeUpCounter = x => makeRevocable(makeUnderlyingUpCounter(x));
 
-  const { revoker, revocable: upCounter } = makeUpCounterKit(3);
+  const upCounter = makeUpCounter(3);
   t.is(upCounter.incr(5), 8);
-  t.is(revoker.revoke(), true);
+  t.is(revoke(upCounter), true);
   t.throws(() => upCounter.incr(1), {
     message: '"UpCounter_caretaker" revoked',
   });
@@ -79,7 +80,7 @@ test('test revoke defineVirtualExoClassKit', t => {
     },
   );
 
-  const makeRevocableUpCounterKit = prepareRevocableKit(
+  const { revoke, makeRevocable } = prepareRevocableMakerKit(
     zone,
     'UpCounter',
     ['incr'],
@@ -89,8 +90,12 @@ test('test revoke defineVirtualExoClassKit', t => {
       },
       extraMethods: {
         selfRevoke() {
-          const { revoker } = this.facets;
-          return revoker.revoke();
+          // Could directly use the revoker facet instead, but this
+          // should now be considered more of an internal detail that
+          // we should deemphasize. This tests the code pattern we wish
+          // to encourage.
+          const { revocable } = this.facets;
+          return revoke(revocable);
         },
       },
     },
@@ -98,8 +103,7 @@ test('test revoke defineVirtualExoClassKit', t => {
 
   const makeCounterKit = x => {
     const { up: upCounter, down: downCounter } = makeUnderlyingCounterKit(x);
-    const { revocable: revocableUpCounter } =
-      makeRevocableUpCounterKit(upCounter);
+    const revocableUpCounter = makeRevocable(upCounter);
     return harden({
       up: revocableUpCounter,
       down: downCounter,