fix(vow): export vat-compatible tools by default

Agoric · Aug 20, 2024 · eedd1c8 · eedd1c8
1 parent 9986152
commit eedd1c8
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 9 deletions.
diff --git a/packages/vow/src/index.js b/packages/vow/src/index.js
@@ -1,8 +1,15 @@
 // @ts-check
-export * from './tools.js';
+
+// We default to the vat-compatible version of this package, which is easy to
+// reconfigure if not running under SwingSet.
+export * from '../vat.js';
 export { default as makeE } from './E.js';
 export { VowShape, toPassableCap } from './vow-utils.js';
 
+/**
+ * @typedef {import('./tools.js').VowTools} VowTools
+ */
+
 // eslint-disable-next-line import/export
 export * from './types.js';
 

diff --git a/packages/vow/src/tools.js b/packages/vow/src/tools.js
@@ -18,7 +18,7 @@ import { makeWhen } from './when.js';
  * @param {object} [powers]
  * @param {IsRetryableReason} [powers.isRetryableReason]
  */
-export const prepareVowTools = (zone, powers = {}) => {
+export const prepareVowToolsForTesting = (zone, powers = {}) => {
   const { isRetryableReason = /** @type {IsRetryableReason} */ (() => false) } =
     powers;
   const makeVowKit = prepareVowKit(zone);
@@ -72,6 +72,6 @@ export const prepareVowTools = (zone, powers = {}) => {
     retriable,
   });
 };
-harden(prepareVowTools);
+harden(prepareVowToolsForTesting);
 
-/** @typedef {ReturnType<typeof prepareVowTools>} VowTools */
+/** @typedef {ReturnType<typeof prepareVowToolsForTesting>} VowTools */
diff --git a/packages/vow/vat.js b/packages/vow/vat.js
@@ -7,7 +7,9 @@
 // @ts-check
 import { isUpgradeDisconnection } from '@agoric/internal/src/upgrade-api.js';
 import { makeHeapZone } from '@agoric/base-zone/heap.js';
-import { makeE, prepareVowTools as rawPrepareVowTools } from './src/index.js';
+
+import { prepareVowToolsForTesting } from './src/tools.js';
+import makeE from './src/E.js';
 
 /** @type {import('./src/types.js').IsRetryableReason} */
 const isRetryableReason = (reason, priorRetryValue) => {
@@ -28,13 +30,17 @@ export const defaultPowers = harden({
 /**
  * Produce SwingSet-compatible vowTools, with an arbitrary Zone type
  *
- * @type {typeof rawPrepareVowTools}
+ * @type {typeof prepareVowToolsForTesting}
  */
 export const prepareSwingsetVowTools = (zone, powers = {}) =>
-  rawPrepareVowTools(zone, { ...defaultPowers, ...powers });
+  prepareVowToolsForTesting(zone, { ...defaultPowers, ...powers });
+harden(prepareSwingsetVowTools);
 
-/** @deprecated */
-export const prepareVowTools = prepareSwingsetVowTools;
+/**
+ * Reexport as prepareVowTools, since that's the thing that people find easiest
+ * to reach.
+ */
+export { prepareSwingsetVowTools as prepareVowTools };
 
 /**
  * `vowTools` that are not durable, but are useful in non-durable clients that