@agoric/vat-data 0.5.3-u16.1 → 0.5.3-u17.1

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.5.3-u16.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/vat-data@0.5.3-u16.0...@agoric/vat-data@0.5.3-u16.1) (2024-07-10)
+### [0.5.3-u17.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/vat-data@0.5.3-u17.0...@agoric/vat-data@0.5.3-u17.1) (2024-09-19)
 
 **Note:** Version bump only for package @agoric/vat-data
 
@@ -11,7 +11,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 
 
-### [0.5.3-u16.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/vat-data@0.5.2...@agoric/vat-data@0.5.3-u16.0) (2024-07-02)
+### [0.5.3-u17.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/vat-data@0.5.2...@agoric/vat-data@0.5.3-u17.0) (2024-09-17)
 
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/vat-data",
-  "version": "0.5.3-u16.1",
+  "version": "0.5.3-u17.1",
   "description": "Safe access to VatData global",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -19,20 +19,19 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/assert": "^0.6.1-u16.0",
-    "@agoric/base-zone": "^0.1.1-u16.0",
-    "@agoric/store": "^0.9.3-u16.0",
-    "@agoric/swingset-liveslots": "^0.10.3-u16.1",
-    "@agoric/vow": "^0.2.0-u16.1",
-    "@endo/exo": "^1.5.0",
-    "@endo/patterns": "^1.4.0"
+    "@agoric/base-zone": "^0.1.1-u17.1",
+    "@agoric/store": "^0.9.3-u17.1",
+    "@agoric/swingset-liveslots": "^0.10.3-u17.1",
+    "@endo/errors": "^1.2.5",
+    "@endo/exo": "^1.5.3",
+    "@endo/patterns": "^1.4.3"
   },
   "devDependencies": {
-    "@endo/far": "^1.1.2",
-    "@endo/init": "^1.1.2",
-    "@endo/ses-ava": "^1.2.2",
+    "@endo/far": "^1.1.5",
+    "@endo/init": "^1.1.4",
+    "@endo/ses-ava": "^1.2.5",
     "ava": "^5.3.0",
-    "tsd": "^0.30.7"
+    "tsd": "^0.31.1"
   },
   "ava": {
     "require": [
@@ -51,5 +50,5 @@
   "typeCoverage": {
     "atLeast": 99.33
   },
-  "gitHead": "2eaeab90b4015e355faea534c1c933351d25b1b9"
+  "gitHead": "5259430561693bfcf58516c3ea54123895859708"
 }

package/src/exo-utils.js

@@ -20,10 +20,12 @@ import { provide, VatData as globalVatData } from './vat-data-bindings.js';
  */
 
 /**
- * Make a version of the argument function that takes a kind context but
- * ignores it.
+ * Make a version of the argument function that takes a kind context but ignores
+ * it.
  *
- * @type {<T extends (...args: any) => any>(fn: T) => import('@agoric/swingset-liveslots').PlusContext<never, T>}
+ * @type {<T extends (...args: any) => any>(
+ *   fn: T,
+ * ) => import('@agoric/swingset-liveslots').PlusContext<never, T>}
  */
 export const ignoreContext =
   fn =>
@@ -96,13 +98,14 @@ export const makeExoUtils = VatData => {
    * @param {string} tag
    * @param {InterfaceGuard | undefined} interfaceGuard
    * @param {I} init
-   * @param {T & ThisType<{
-   *   self: T,
-   *   state: StateResult<I>
-   * }>} methods
+   * @param {T &
+   *   ThisType<{
+   *     self: T;
+   *     state: StateResult<I>;
+   *   }>} methods
    * @param {DefineKindOptions<{
-   *   self: T,
-   *   state: StateResult<I>
+   *   self: T;
+   *   state: StateResult<I>;
    * }>} [options]
    * @returns {(...args: Parameters<I>) => import('@endo/exo').Guarded<T>}
    */
@@ -121,13 +124,14 @@ export const makeExoUtils = VatData => {
    * @param {string} tag
    * @param {InterfaceGuardKit | undefined} interfaceGuardKit
    * @param {I} init
-   * @param {T & ThisType<{
-   *   facets: import('@endo/exo').GuardedKit<T>,
-   *   state: StateResult<I>
-   * }> } facets
+   * @param {T &
+   *   ThisType<{
+   *     facets: import('@endo/exo').GuardedKit<T>;
+   *     state: StateResult<I>;
+   *   }>} facets
    * @param {DefineKindOptions<{
-   *   facets: T,
-   *   state: StateResult<I>
+   *   facets: T;
+   *   state: StateResult<I>;
    * }>} [options]
    * @returns {(...args: Parameters<I>) => import('@endo/exo').GuardedKit<T>}
    */
@@ -152,13 +156,14 @@ export const makeExoUtils = VatData => {
    * @param {DurableKindHandle} kindHandle
    * @param {InterfaceGuard | undefined} interfaceGuard
    * @param {I} init
-   * @param {T & ThisType<{
-   *   self: T,
-   *   state: StateResult<I>
-   * }>} methods
+   * @param {T &
+   *   ThisType<{
+   *     self: T;
+   *     state: StateResult<I>;
+   *   }>} methods
    * @param {DefineKindOptions<{
-   *   self: T,
-   *   state: StateResult<I>
+   *   self: T;
+   *   state: StateResult<I>;
    * }>} [options]
    * @returns {(...args: Parameters<I>) => import('@endo/exo').Guarded<T>}
    */
@@ -183,13 +188,14 @@ export const makeExoUtils = VatData => {
    * @param {DurableKindHandle} kindHandle
    * @param {InterfaceGuardKit | undefined} interfaceGuardKit
    * @param {I} init
-   * @param {T & ThisType<{
-   *   facets: import('@endo/exo').GuardedKit<T>,
-   *   state: StateResult<I>
-   * }> } facets
+   * @param {T &
+   *   ThisType<{
+   *     facets: import('@endo/exo').GuardedKit<T>;
+   *     state: StateResult<I>;
+   *   }>} facets
    * @param {DefineKindOptions<{
-   *   facets: T,
-   *   state: StateResult<I>
+   *   facets: T;
+   *   state: StateResult<I>;
    * }>} [options]
    * @returns {(...args: Parameters<I>) => import('@endo/exo').GuardedKit<T>}
    */
@@ -215,13 +221,14 @@ export const makeExoUtils = VatData => {
    * @param {string} kindName
    * @param {InterfaceGuard | undefined} interfaceGuard
    * @param {I} init
-   * @param {T & ThisType<{
-   *   self: RemotableObject & T,
-   *   state: StateResult<I>
-   * }>} methods
+   * @param {T &
+   *   ThisType<{
+   *     self: RemotableObject & T;
+   *     state: StateResult<I>;
+   *   }>} methods
    * @param {DefineKindOptions<{
-   *   self: T,
-   *   state: StateResult<I>
+   *   self: T;
+   *   state: StateResult<I>;
    * }>} [options]
    * @returns {(...args: Parameters<I>) => import('@endo/exo').Guarded<T>}
    */
@@ -249,13 +256,14 @@ export const makeExoUtils = VatData => {
    * @param {string} kindName
    * @param {InterfaceGuardKit | undefined} interfaceGuardKit
    * @param {I} init
-   * @param {T & ThisType<{
-   *   facets: import('@endo/exo').GuardedKit<T>,
-   *   state: StateResult<I>
-   * }> } facets
+   * @param {T &
+   *   ThisType<{
+   *     facets: import('@endo/exo').GuardedKit<T>;
+   *     state: StateResult<I>;
+   *   }>} facets
    * @param {DefineKindOptions<{
-   *   facets: T,
-   *   state: StateResult<I>
+   *   facets: T;
+   *   state: StateResult<I>;
    * }>} [options]
    * @returns {(...args: Parameters<I>) => import('@endo/exo').GuardedKit<T>}
    */
@@ -306,8 +314,8 @@ export const makeExoUtils = VatData => {
   harden(prepareExo);
 
   /**
-   * @template {Record<PropertyKey, CallableFunction>} M methods
    * @deprecated Use prepareExo instead.
+   * @template {Record<PropertyKey, CallableFunction>} M methods
    * @param {Baggage} baggage
    * @param {string} kindName
    * @param {M} methods

package/src/index.js

@@ -43,7 +43,11 @@ export {
 } from './exo-utils.js';
 
 // TODO re-export these
-/** @template T @typedef {import('@agoric/swingset-liveslots').DefineKindOptions<T>} DefineKindOptions */
+/**
+ * @template T @typedef
+ *   {import('@agoric/swingset-liveslots').DefineKindOptions<T>}
+ *   DefineKindOptions
+ */
 // Copy this type because aliasing it by `import('@agoric/swingset-liveslots').Baggage`
 // causes this error in typedoc: Expected a symbol for node with kind Identifier
 /** @typedef {MapStore<string, any>} Baggage */

package/src/vat-data-bindings.js

@@ -1,6 +1,6 @@
 /* global globalThis */
 
-import { Fail } from '@agoric/assert';
+import { Fail } from '@endo/errors';
 import { provideLazy } from '@agoric/store';
 
 /** @import {Baggage, PickFacet, VatData} from '@agoric/swingset-liveslots' */
@@ -57,7 +57,8 @@ export const {
 } = VatDataGlobal;
 
 /**
- * When making a multi-facet kind, it's common to pick one facet to expose. E.g.,
+ * 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;
  *
@@ -89,36 +90,39 @@ harden(partialAssign);
 /** @import {StoreOptions} from '@agoric/store' */
 
 /**
- * Unlike `provideLazy`, `provide` should be called at most once
- * within any vat incarnation with a given `baggage`,`key` pair.
+ * Unlike `provideLazy`, `provide` should be called at most once within any vat
+ * incarnation with a given `baggage`,`key` pair.
  *
- * `provide` should only to be used to populate baggage,
- * where the total number of calls to `provide` must be
- * low cardinality, since we keep the bookkeeping to detect collisions
- * in normal language-heap memory. All the other baggage-oriented
- * `provide*` and `prepare*` functions call `provide`,
- * and so impose the same constraints. This is consistent with
- * our expected durability patterns: What we store in baggage are
- *    * kindHandles, which are per kind, which must be low cardinality
- *    * data "variables" for reestablishing the lexical scope, especially
- *      of singletons
- *    * named non-baggage collections at the leaves of the baggage tree.
+ * `provide` should only be used to populate baggage, where the total number of
+ * calls to `provide` must be low cardinality, since we keep the bookkeeping to
+ * detect collisions in normal language-heap memory. All the other
+ * baggage-oriented `provide*` and `prepare*` functions call `provide`, and so
+ * impose the same constraints. This is consistent with our expected durability
+ * patterns: What we store in baggage are
  *
- * What is expected to be high cardinality are the instances of the kinds,
- * and the members of the non-bagggage collections.
+ * - kindHandles, which are per kind, which must be low cardinality
+ * - data "variables" for reestablishing the lexical scope, especially of
+ *   singletons
+ * - named non-baggage collections at the leaves of the baggage tree.
  *
- * TODO https://github.com/Agoric/agoric-sdk/pull/5875 :
- * Implement development-time instrumentation to detect when
- * `provide` violates the above prescription, and is called more
- * than once in the same vat incarnation with the same
- * baggage,key pair.
+ * What is expected to be high cardinality are the instances of the kinds, and
+ * the members of the non-bagggage collections.
+ *
+ * TODO https://github.com/Agoric/agoric-sdk/pull/5875 : Implement
+ * development-time instrumentation to detect when `provide` violates the above
+ * prescription, and is called more than once in the same vat incarnation with
+ * the same baggage,key pair.
  */
 
 export const provide =
   // XXX cast because provideLazy is `any` due to broken type import
-  /** @type {<K, V>(baggage: Baggage, key: K, makeValue: (key: K) => V) => V} */ (
-    provideLazy
-  );
+  /**
+   * @type {<K, V>(
+   *   baggage: 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 {VatData} VatData */