@agoric/base-zone 0.1.1-dev-24f7f32.0 → 0.1.1-dev-459998d.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/base-zone",
-  "version": "0.1.1-dev-24f7f32.0+24f7f32",
+  "version": "0.1.1-dev-459998d.0+459998d",
   "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-24f7f32.0+24f7f32",
+    "@agoric/store": "0.9.3-dev-459998d.0+459998d",
     "@endo/common": "^1.2.1",
     "@endo/exo": "^1.4.0",
     "@endo/far": "^1.1.1",
@@ -58,5 +58,5 @@
   "typeCoverage": {
     "atLeast": 88.55
   },
-  "gitHead": "24f7f32495a6eda13fd75d18620ab9f7989b5d2e"
+  "gitHead": "459998d3944d5ad9d495de146a6322aedcdd06d0"
 }

package/src/heap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"heap.d.ts","sourceRoot":"","sources":["heap.js"],"names":[],"mappings":"AAkCO,8DAFM,OAAO,YAAY,EAAE,IAAI,CA2BrC"}
+{"version":3,"file":"heap.d.ts","sourceRoot":"","sources":["heap.js"],"names":[],"mappings":"AAmCO,8DAFM,OAAO,YAAY,EAAE,IAAI,CA4BrC"}

package/src/heap.js

@@ -12,6 +12,7 @@ import {
 
 import { makeOnceKit } from './make-once.js';
 import { agoricVatDataKeys as keys } from './keys.js';
+import { watchPromise } from './watch-promise.js';
 
 /**
  * @type {import('./types.js').Stores}
@@ -49,6 +50,7 @@ export const makeHeapZone = (baseLabel = 'heapZone') => {
     subZone: wrapProvider(makeSubZone),
 
     makeOnce,
+    watchPromise,
     detached: detachedHeapStores.detached,
     isStorable: detachedHeapStores.isStorable,
 

package/src/index.d.ts

@@ -2,4 +2,5 @@ export * from "./exports.js";
 export * from "./make-once.js";
 export * from "./keys.js";
 export * from "./is-passable.js";
+export * from "./watch-promise.js";
 //# sourceMappingURL=index.d.ts.map

package/src/index.js

@@ -10,3 +10,4 @@ export * from './exports.js';
 export * from './make-once.js';
 export * from './keys.js';
 export * from './is-passable.js';
+export * from './watch-promise.js';

package/src/types.d.ts

@@ -26,6 +26,10 @@ export type ExoZone = {
      * create a new Zone that can be passed to untrusted consumers without exposing the storage of the parent zone
      */
     subZone: (label: string, options?: StoreOptions) => Zone;
+    /**
+     * register a promise watcher created by this zone
+     */
+    watchPromise: typeof watchPromise;
 };
 export type Stores = {
     /**
@@ -56,4 +60,5 @@ export type Stores = {
 import { makeExo } from '@endo/exo';
 import { defineExoClass } from '@endo/exo';
 import { defineExoClassKit } from '@endo/exo';
+import { watchPromise } from './watch-promise.js';
 //# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"4BAMc,UAAU,GAAG,aAAa,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM;wBACrD,MAAM,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;;;;;mBAGnD,OAAO,GAAG,MAAM;;;;;SAMf,OAAO,OAAO;;;;cACd,OAAO,cAAc;;;;iBACrB,OAAO,iBAAiB;;;;cACxB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC;;;;aAChD,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,IAAI;;;;;;cAK/C,MAAM,MAAM;;;;gBACZ,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO;;;;cAC9B,CAAC,CAAC,EAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;;;;cAC9D,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC;;;;kBACzD,CAAC,CAAC,EAAC,CAAC,EACjB,KAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;;;;kBAEnD,CAAC,CAAC,EACf,KAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,YAAY,CAAC,CAAC,CAAC;;wBAhCH,WAAW;+BAAX,WAAW;kCAAX,WAAW"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":"4BAQc,UAAU,GAAG,aAAa,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM;wBACrD,MAAM,CAAC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC;;;;;mBAGnD,OAAO,GAAG,MAAM;;;;;SAMf,OAAO,OAAO;;;;cACd,OAAO,cAAc;;;;iBACrB,OAAO,iBAAiB;;;;cACxB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC;;;;aAChD,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,IAAI;;;;kBAC/C,OAAO,YAAY;;;;;;cAKnB,MAAM,MAAM;;;;gBACZ,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO;;;;cAC9B,CAAC,CAAC,EAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;;;;cAC9D,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC;;;;kBACzD,CAAC,CAAC,EAAC,CAAC,EACjB,KAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;;;;kBAEnD,CAAC,CAAC,EACf,KAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,YAAY,CAAC,CAAC,CAAC;;wBAnCH,WAAW;+BAAX,WAAW;kCAAX,WAAW;6BAEzC,oBAAoB"}

package/src/types.js

@@ -1,5 +1,7 @@
 // eslint-disable-next-line no-unused-vars
 import { makeExo, defineExoClass, defineExoClassKit } from '@endo/exo';
+// eslint-disable-next-line no-unused-vars
+import { watchPromise } from './watch-promise.js';
 
 // Ensure this is a module.
 export {};
@@ -19,6 +21,7 @@ export {};
  * @property {typeof defineExoClassKit} exoClassKit create a "kit" maker function that can be used to create a record of exo-objects sharing the same state
  * @property {<T>(key: string, maker: (key: string) => T) => T} makeOnce create or retrieve a singleton object bound to this zone
  * @property {(label: string, options?: StoreOptions) => Zone} subZone create a new Zone that can be passed to untrusted consumers without exposing the storage of the parent zone
+ * @property {typeof watchPromise} watchPromise register a promise watcher created by this zone
  */
 
 /**

package/src/watch-promise.d.ts

@@ -0,0 +1,29 @@
+/**
+ * A PromiseWatcher method guard callable with or more arguments, returning void.
+ */
+export const PromiseWatcherHandler: import("@endo/patterns").MethodGuard;
+/**
+ * A PromiseWatcher interface that has both onFulfilled and onRejected handlers.
+ */
+export const PromiseWatcherI: import("@endo/patterns").InterfaceGuard<{
+    onFulfilled: import("@endo/patterns").MethodGuard;
+    onRejected: import("@endo/patterns").MethodGuard;
+}>;
+/**
+ * A PromiseWatcher interface that has only an onFulfilled handler.
+ */
+export const PromiseWatcherFulfilledI: import("@endo/patterns").InterfaceGuard<{
+    onFulfilled: import("@endo/patterns").MethodGuard;
+}>;
+/**
+ * A PromiseWatcher interface that has only an onRejected handler.
+ */
+export const PromiseWatcherRejectedI: import("@endo/patterns").InterfaceGuard<{
+    onRejected: import("@endo/patterns").MethodGuard;
+}>;
+export function watchPromise(p: Promise<any>, watcher: PromiseWatcher, ...watcherArgs: unknown[]): void;
+export type PromiseWatcher = {
+    onFulfilled?: ((fulfilment: unknown, ...args: unknown[]) => void) | undefined;
+    onRejected?: ((reason: unknown, ...args: unknown[]) => void) | undefined;
+};
+//# sourceMappingURL=watch-promise.d.ts.map

package/src/watch-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watch-promise.d.ts","sourceRoot":"","sources":["watch-promise.js"],"names":[],"mappings":"AAQA;;GAEG;AACH,yEAA6E;AAE7E;;GAEG;AACH;;;GAGG;AAEH;;GAEG;AACH;;GAEG;AAEH;;GAEG;AACH;;GAEG;AAuCI,gCALI,OAAO,CAAC,GAAG,CAAC,WACZ,cAAc,kBACX,OAAO,KACR,IAAI,CAUhB;;gCA3C0B,OAAO,WAAW,OAAO,EAAE,KAAK,IAAI;2BACxC,OAAO,WAAW,OAAO,EAAE,KAAK,IAAI"}

package/src/watch-promise.js

@@ -0,0 +1,82 @@
+// @ts-check
+import { M } from '@endo/patterns';
+import { E } from '@endo/far';
+
+const { Fail } = assert;
+
+const { apply } = Reflect;
+
+/**
+ * A PromiseWatcher method guard callable with or more arguments, returning void.
+ */
+export const PromiseWatcherHandler = M.call(M.any()).rest(M.any()).returns();
+
+/**
+ * A PromiseWatcher interface that has both onFulfilled and onRejected handlers.
+ */
+export const PromiseWatcherI = M.interface('PromiseWatcher', {
+  onFulfilled: PromiseWatcherHandler,
+  onRejected: PromiseWatcherHandler,
+});
+
+/**
+ * A PromiseWatcher interface that has only an onFulfilled handler.
+ */
+export const PromiseWatcherFulfilledI = M.interface('PromiseWatcherFulfilled', {
+  onFulfilled: PromiseWatcherHandler,
+});
+
+/**
+ * A PromiseWatcher interface that has only an onRejected handler.
+ */
+export const PromiseWatcherRejectedI = M.interface('PromiseWatcherRejected', {
+  onRejected: PromiseWatcherHandler,
+});
+
+/**
+ * @typedef {object} PromiseWatcher
+ * @property {(fulfilment: unknown, ...args: unknown[]) => void} [onFulfilled]
+ * @property {(reason: unknown, ...args: unknown[]) => void} [onRejected]
+ */
+
+/**
+ * Adapt a promise watcher method to E.when.
+ * @param {Record<PropertyKey, (...args: unknown[]) => unknown>} that
+ * @param {PropertyKey} prop
+ * @param {unknown[]} postArgs
+ */
+const callMeMaybe = (that, prop, postArgs) => {
+  const fn = that[prop];
+  if (!fn) {
+    return undefined;
+  }
+  assert.typeof(fn, 'function');
+  /**
+   * @param {unknown} arg value or reason
+   */
+  const wrapped = arg => {
+    // Don't return a value, to prevent E.when from subscribing to a resulting
+    // promise.
+    apply(fn, that, [arg, ...postArgs]);
+  };
+  return wrapped;
+};
+
+/**
+ * Shim the promise watcher behaviour when VatData.watchPromise is not available.
+ *
+ * @param {Promise<any>} p
+ * @param {PromiseWatcher} watcher
+ * @param {...unknown} watcherArgs
+ * @returns {void}
+ */
+export const watchPromise = (p, watcher, ...watcherArgs) => {
+  Promise.resolve(p) === p || Fail`watchPromise only watches promises`;
+  const onFulfilled = callMeMaybe(watcher, 'onFulfilled', watcherArgs);
+  const onRejected = callMeMaybe(watcher, 'onRejected', watcherArgs);
+  onFulfilled ||
+    onRejected ||
+    Fail`promise watcher must implement at least one handler method`;
+  void E.when(p, onFulfilled, onRejected);
+};
+harden(watchPromise);