@agoric/vat-data 0.5.3-dev-9f8a76e.0 → 0.5.3-dev-e68f280.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/vat-data",
-  "version": "0.5.3-dev-9f8a76e.0+9f8a76e",
+  "version": "0.5.3-dev-e68f280.0+e68f280",
   "description": "Safe access to VatData global",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -19,12 +19,13 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-9f8a76e.0+9f8a76e",
-    "@agoric/internal": "0.3.3-dev-9f8a76e.0+9f8a76e",
-    "@agoric/store": "0.9.3-dev-9f8a76e.0+9f8a76e"
+    "@agoric/assert": "0.6.1-dev-e68f280.0+e68f280",
+    "@agoric/internal": "0.3.3-dev-e68f280.0+e68f280",
+    "@agoric/store": "0.9.3-dev-e68f280.0+e68f280",
+    "@agoric/swingset-liveslots": "0.10.3-dev-e68f280.0+e68f280"
   },
   "devDependencies": {
-    "@agoric/swingset-vat": "0.32.3-dev-9f8a76e.0+9f8a76e",
+    "@endo/init": "^0.5.57",
     "ava": "^5.3.0",
     "tsd": "^0.28.1"
   },
@@ -34,5 +35,5 @@
   "engines": {
     "node": ">=14.15.0"
   },
-  "gitHead": "9f8a76ee66bd74f028158b689c4b437921613f63"
+  "gitHead": "e68f2805dde79871d1421e50c60f08e854e1851d"
 }

package/src/exo-utils.js

@@ -6,17 +6,17 @@ import { provide, VatData as globalVatData } from './vat-data-bindings.js';
 
 /** @template L,R @typedef {import('@endo/eventual-send').RemotableBrand<L, R>} RemotableBrand */
 /** @template T @typedef {import('@endo/far').ERef<T>} ERef */
-/** @typedef {import('./types.js').Baggage} Baggage */
-/** @template T @typedef {import('./types.js').DefineKindOptions<T>} DefineKindOptions */
-/** @template T @typedef {import('./types.js').KindFacet<T>} KindFacet */
-/** @template T @typedef {import('./types.js').KindFacets<T>} KindFacets */
-/** @typedef {import('./types.js').DurableKindHandle} DurableKindHandle */
+/** @typedef {import('@agoric/swingset-liveslots').Baggage} Baggage */
+/** @template T @typedef {import('@agoric/swingset-liveslots').DefineKindOptions<T>} DefineKindOptions */
+/** @template T @typedef {import('@agoric/swingset-liveslots').KindFacet<T>} KindFacet */
+/** @template T @typedef {import('@agoric/swingset-liveslots').KindFacets<T>} KindFacets */
+/** @typedef {import('@agoric/swingset-liveslots').DurableKindHandle} DurableKindHandle */
 
 /**
  * Make a version of the argument function that takes a kind context but
  * ignores it.
  *
- * @type {<T extends Function>(fn: T) => import('./types.js').PlusContext<never, T>}
+ * @type {<T extends Function>(fn: T) => import('@agoric/swingset-liveslots').PlusContext<never, T>}
  */
 export const ignoreContext =
   fn =>
@@ -45,7 +45,7 @@ export const makeExoUtils = VatData => {
 
   /**
    * @deprecated Use prepareExoClass instead
-   * @type {import('./types.js').PrepareKind}
+   * @type {import('@agoric/swingset-liveslots').PrepareKind}
    */
   const prepareKind = (
     baggage,
@@ -64,7 +64,7 @@ export const makeExoUtils = VatData => {
 
   /**
    * @deprecated Use prepareExoClassKit instead
-   * @type {import('./types.js').PrepareKindMulti}
+   * @type {import('@agoric/swingset-liveslots').PrepareKindMulti}
    */
   const prepareKindMulti = (
     baggage,

package/src/index.js

@@ -42,9 +42,9 @@ export {
   prepareSingleton,
 } from './exo-utils.js';
 
-/** @typedef {import('./types.js').Baggage} Baggage */
-/** @typedef {import('./types.js').DurableKindHandle} DurableKindHandle */
-/** @template T @typedef {import('./types.js').DefineKindOptions<T>} DefineKindOptions */
+/** @typedef {import('@agoric/swingset-liveslots').Baggage} Baggage */
+/** @typedef {import('@agoric/swingset-liveslots').DurableKindHandle} DurableKindHandle */
+/** @template T @typedef {import('@agoric/swingset-liveslots').DefineKindOptions<T>} DefineKindOptions */
 
 // //////////////////////////// deprecated /////////////////////////////////////
 

package/src/index.test-d.ts

@@ -1,5 +1,11 @@
 /* eslint-disable no-use-before-define */
 import { expectType } from 'tsd';
+import type {
+  KindFacets,
+  DurableKindHandle,
+  KindFacet,
+  FunctionsPlusContext,
+} from '@agoric/swingset-liveslots';
 import {
   defineKind,
   defineKindMulti,
@@ -7,12 +13,6 @@ import {
   defineDurableKind,
   partialAssign,
 } from '.';
-import {
-  KindFacets,
-  DurableKindHandle,
-  KindFacet,
-  FunctionsPlusContext,
-} from './types.js';
 
 /*
 export const makePaymentMaker = (allegedName: string, brand: unknown) => {

package/src/vat-data-bindings.js

@@ -3,7 +3,7 @@
 import { Fail } from '@agoric/assert';
 import { provideLazy } from '@agoric/store';
 
-/** @type {import('./types').VatData} */
+/** @type {import('@agoric/swingset-liveslots').VatData} */
 let VatDataGlobal;
 if ('VatData' in globalThis) {
   globalThis.VatData || Fail`VatData defined in global as null or undefined`;
@@ -62,7 +62,7 @@ export const {
  *
  *     const makeFoo = pickFacet(makeFooBase, 'self');
  *
- * @type {import('./types').PickFacet}
+ * @type {import('@agoric/swingset-liveslots').PickFacet}
  */
 export const pickFacet =
   (maker, facetName) =>
@@ -107,8 +107,8 @@ harden(partialAssign);
  *   intended to eventually be durable has not yet been made durable.  A store
  *   marked as fakeDurable will appear to operate normally but any attempt to
  *   upgrade its containing vat will fail with an error.
- * @property {import('./types').Pattern} [keyShape]
- * @property {import('./types').Pattern} [valueShape]
+ * @property {import('@agoric/swingset-liveslots').Pattern} [keyShape]
+ * @property {import('@agoric/swingset-liveslots').Pattern} [valueShape]
  */
 /**
  * Unlike `provideLazy`, `provide` should be called at most once
@@ -138,12 +138,12 @@ harden(partialAssign);
 
 export const provide =
   // XXX cast because provideLazy is `any` due to broken type import
-  /** @type {<K, V>(baggage: import('./types.js').Baggage, key: K, makeValue: (key: K) => V) => V} */ (
+  /** @type {<K, V>(baggage: import('@agoric/swingset-liveslots').Baggage, key: K, makeValue: (key: K) => V) => V} */ (
     provideLazy
   );
 
 // TODO: Find a good home for this function used by @agoric/vat-data and testing code
-/** @param {import('@agoric/vat-data/src/types').VatData} VatData */
+/** @param {import('@agoric/swingset-liveslots').VatData} VatData */
 export const makeStoreUtils = VatData => {
   const {
     // eslint-disable-next-line no-shadow -- these literally do shadow the globals
@@ -157,7 +157,7 @@ export const makeStoreUtils = VatData => {
   } = VatData;
 
   /**
-   * @param {import('./types').Baggage} baggage
+   * @param {import('@agoric/swingset-liveslots').Baggage} baggage
    * @param {string} name
    * @param {Omit<StoreOptions, 'durable'>} options
    */
@@ -168,7 +168,7 @@ export const makeStoreUtils = VatData => {
   harden(provideDurableMapStore);
 
   /**
-   * @param {import('./types').Baggage} baggage
+   * @param {import('@agoric/swingset-liveslots').Baggage} baggage
    * @param {string} name
    * @param {Omit<StoreOptions, 'durable'>} options
    */
@@ -179,7 +179,7 @@ export const makeStoreUtils = VatData => {
   harden(provideDurableWeakMapStore);
 
   /**
-   * @param {import('./types').Baggage} baggage
+   * @param {import('@agoric/swingset-liveslots').Baggage} baggage
    * @param {string} name
    * @param {Omit<StoreOptions, 'durable'>} options
    */
@@ -190,7 +190,7 @@ export const makeStoreUtils = VatData => {
   harden(provideDurableSetStore);
 
   /**
-   * @param {import('./types').Baggage} baggage
+   * @param {import('@agoric/swingset-liveslots').Baggage} baggage
    * @param {string} name
    * @param {Omit<StoreOptions, 'durable'>} options
    */

package/test/absent.test.js

@@ -1,9 +1,14 @@
-import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';
+import '@endo/init/debug.js';
+import test from 'ava';
+
 /* global globalThis */
+// @ts-expect-error VatData not optional
 delete globalThis.VatData;
 
 /** @see present.test.js */
 test('methods available that throw', async t => {
   const { defineKind } = await import('../src/index.js');
-  t.throws(defineKind, { message: /VatData unavailable/ });
+  t.throws(() => defineKind('someTag', () => {}, {}), {
+    message: /VatData unavailable/,
+  });
 });

package/test/present.test.js

@@ -1,7 +1,13 @@
-import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';
+import '@endo/init/debug.js';
+import test from 'ava';
+
+const mockDefineKind = /** @type {any} */ (harden({}));
+
+/* global globalThis */
+// @ts-expect-error missing fields
+globalThis.VatData ||= { defineKind: mockDefineKind };
 
 test('methods available', async t => {
   const { defineKind } = await import('../src/index.js');
-  defineKind('test', () => {}, {});
-  t.pass();
+  t.is(defineKind, mockDefineKind);
 });

package/test/test-durable-classes.js

@@ -1,6 +1,8 @@
 // Modeled on test-heap-classes.js
 
-import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';
+import '@agoric/swingset-liveslots/tools/prepare-test-env.js';
+
+import test from 'ava';
 import { M } from '@agoric/store';
 import {
   makeKindHandle,

package/test/test-prepare.js

@@ -1,6 +1,8 @@
 // Modeled on test-heap-classes.js
 
-import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';
+import '@agoric/swingset-liveslots/tools/prepare-test-env.js';
+
+import test from 'ava';
 import { M } from '@agoric/store';
 import {
   prepareExoClass,

package/test/test-scalar-only-keys.js

@@ -1,14 +1,14 @@
 // From https://github.com/Agoric/agoric-sdk/pull/6903#discussion_r1098067133
 
-import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';
+import '@agoric/swingset-liveslots/tools/prepare-test-env.js';
 
+import test from 'ava';
 import { M, makeScalarMapStore } from '@agoric/store';
-
 import { makeScalarBigMapStore } from '../src/vat-data-bindings.js';
 
 test('scalar maps should reject non-scalar keys', t => {
   const bigMap = makeScalarMapStore('dummy', { keyShape: M.key() });
-  t.throws(() => bigMap.init(harden({ label: 'not a scalar' })), {
+  t.throws(() => bigMap.init(harden({ label: 'not a scalar' }), 'val'), {
     message:
       /A "copyRecord" cannot be a scalar key: \{"label":"not a scalar"\}/,
   });

package/test/test-virtual-classes.js

@@ -1,6 +1,8 @@
 // Modeled on test-heap-classes.js
 
-import { test } from '@agoric/swingset-vat/tools/prepare-test-env-ava.js';
+import '@agoric/swingset-liveslots/tools/prepare-test-env.js';
+
+import test from 'ava';
 import { M } from '@agoric/store';
 import {
   defineVirtualExoClass,

package/tsconfig.json

@@ -1,8 +1,10 @@
 {
   "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "strict": true,
-    "noImplicitAny": false, // for compat with peer packages using ambient types
+    // XXX to resolve the swingset-liveslots types
+    "maxNodeModuleJsDepth": 1,
+    // "strict": true, // disabled for compat with >0 module depth
+    // "noImplicitAny": false, // for compat with peer packages using ambient types
   },
   "include": [
     "src/**/*.js",

package/src/types.d.ts

@@ -1,203 +0,0 @@
-/**
- * @file Types for vat-data
- *
- * Facet is a single object with methods.
- * Behavior is a description when defining a kind of what facets it will have.
- * For the non-multi defineKind, there is just one facet so it doesn't have a key.
- */
-import type {
-  InterfaceGuard,
-  MapStore,
-  Pattern,
-  SetStore,
-  StoreOptions,
-  WeakMapStore,
-  WeakSetStore,
-} from '@agoric/store';
-
-export type { MapStore, Pattern };
-
-export type Baggage = MapStore<string, unknown>;
-
-type Tail<T extends any[]> = T extends [head: any, ...rest: infer Rest]
-  ? Rest
-  : [];
-
-type MinusContext<
-  F extends (context, ...rest: any[]) => any,
-  P extends any[] = Parameters<F>, // P: are the parameters of F
-  R = ReturnType<F>, // R: the return type of F
-> = (...args: Tail<P>) => R;
-
-export type KindFacet<O> = { [K in keyof O]: MinusContext<O[K]> };
-
-export type KindFacets<B> = {
-  [FacetKey in keyof B]: KindFacet<B[FacetKey]>;
-};
-
-export type KindContext<S, F> = { state: S; self: KindFacet<F> };
-export type MultiKindContext<S, B> = { state: S; facets: KindFacets<B> };
-
-export type PlusContext<C, M> = (c: C, ...args: Parameters<M>) => ReturnType<M>;
-export type FunctionsPlusContext<C, O> = {
-  [K in keyof O]: PlusContext<C, O[K]>;
-};
-
-declare class DurableKindHandleClass {
-  private descriptionTag: string;
-}
-export type DurableKindHandle = DurableKindHandleClass;
-
-/**
- * Grab bag of options that can be provided to `defineDurableKind` and its
- * siblings. Not all options are meaningful in all contexts. See the
- * doc-comments on each option.
- */
-export type DefineKindOptions<C> = {
-  /**
-   * If provided, the `finish` function will be called after the instance is
-   * made and internally registered, but before it is returned. The finish
-   * function is to do any post-intantiation initialization that should be
-   * done before exposing the object to its clients.
-   */
-  finish?: (context: C) => void;
-
-  /**
-   * Meaningful to `makeScalarBigMapStore` and its siblings. These maker
-   * fuctions will make either virtual or durable stores, depending on
-   * this flag. Defaults to off, making virtual but not durable collections.
-   *
-   * Generally, durable collections are provided with `provideDurableMapStore`
-   * and its sibling, which use this flag internally. If you do not make
-   * durable collections by other means, you can consider this as
-   * intended for internal use only.
-   */
-  durable?: boolean;
-
-  /**
-   * If provided, it describes the shape of all state records of instances
-   * of this kind.
-   */
-  stateShape?: { [name: string]: Pattern };
-
-  /**
-   * Intended for internal use only.
-   * Should the raw methods receive their `context` argument as their first
-   * argument or as their `this` binding? For `defineDurableKind` and its
-   * siblings (including `prepareSingleton`), this defaults to off, meaning that
-   * their behavior methods receive `context` as their first argument.
-   * `prepareExoClass` and its siblings (including `prepareExo`) use
-   * this flag internally to indicate that their methods receive `context`
-   * as their `this` binding.
-   */
-  thisfulMethods?: boolean;
-
-  /**
-   * Intended for internal use only.
-   * If an `interfaceGuard` is provided, then the raw methods passed alongside
-   * it are wrapped by a function that first checks that this method's guard
-   * pattern is satisfied before calling the raw method.
-   *
-   * In `defineDurableKind` and its siblings, this defaults to off.
-   * `prepareExoClass` use this internally to protect their raw class methods
-   * using the provided interface.
-   */
-  interfaceGuard?: InterfaceGuard<unknown>;
-};
-
-export type VatData = {
-  // virtual kinds
-  /** @deprecated Use defineVirtualExoClass instead */
-  defineKind: <P, S, F>(
-    tag: string,
-    init: (...args: P) => S,
-    facet: F,
-    options?: DefineKindOptions<KindContext<S, F>>,
-  ) => (...args: P) => KindFacet<F>;
-
-  /** @deprecated Use defineVirtualExoClassKit instead */
-  defineKindMulti: <P, S, B>(
-    tag: string,
-    init: (...args: P) => S,
-    behavior: B,
-    options?: DefineKindOptions<MultiKindContext<S, B>>,
-  ) => (...args: P) => KindFacets<B>;
-
-  // durable kinds
-  makeKindHandle: (descriptionTag: string) => DurableKindHandle;
-
-  /** @deprecated Use defineDurableExoClass instead */
-  defineDurableKind: <P, S, F>(
-    kindHandle: DurableKindHandle,
-    init: (...args: P) => S,
-    facet: F,
-    options?: DefineKindOptions<KindContext<S, F>>,
-  ) => (...args: P) => KindFacet<F>;
-
-  /** @deprecated Use defineDurableExoClassKit instead */
-  defineDurableKindMulti: <P, S, B>(
-    kindHandle: DurableKindHandle,
-    init: (...args: P) => S,
-    behavior: B,
-    options?: DefineKindOptions<MultiKindContext<S, B>>,
-  ) => (...args: P) => KindFacets<B>;
-
-  providePromiseWatcher: unknown;
-  watchPromise: unknown;
-
-  makeScalarBigMapStore: <K, V>(
-    label: string,
-    options?: StoreOptions,
-  ) => MapStore<K, V>;
-  makeScalarBigWeakMapStore: <K, V>(
-    label: string,
-    options?: StoreOptions,
-  ) => WeakMapStore<K, V>;
-
-  makeScalarBigSetStore: <K>(
-    label: string,
-    options?: StoreOptions,
-  ) => SetStore<K>;
-  makeScalarBigWeakSetStore: <K>(
-    label: string,
-    options?: StoreOptions,
-  ) => WeakSetStore<K>;
-  canBeDurable: (specimen: unknown) => boolean;
-};
-
-// The JSDoc is repeated here and at the function definition so it appears
-// in IDEs where it's used, regardless of type resolution.
-export interface PickFacet {
-  /**
-   * When making a multi-facet kind, it's common to pick one facet to
-   * expose. E.g.,
-   *
-   *     const makeFoo = (a, b, c, d) => makeFooBase(a, b, c, d).self;
-   *
-   * This helper reduces the duplication:
-   *
-   *     const makeFoo = pickFacet(makeFooBase, 'self');
-   */
-  <M extends (...args: any[]) => any, F extends keyof ReturnType<M>>(
-    maker: M,
-    facetName: F,
-  ): (...args: Parameters<M>) => ReturnType<M>[F];
-}
-
-/** @deprecated Use prepareExoClass instead */
-export type PrepareKind = <P, S, F>(
-  baggage: Baggage,
-  tag: string,
-  init: (...args: P) => S,
-  facet: F,
-  options?: DefineKindOptions<KindContext<S, F>>,
-) => (...args: P) => KindFacet<F>;
-
-/** @deprecated Use prepareExoClassKit instead */
-export type PrepareKindMulti = <P, S, B>(
-  baggage: Baggage,
-  tag: string,
-  init: (...args: P) => S,
-  behavior: B,
-  options?: DefineKindOptions<MultiKindContext<S, B>>,
-) => (...args: P) => KindFacets<B>;