@agoric/vat-data 0.5.3-dev-4733782.0 → 0.5.3-dev-c774209.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/vat-data",
-  "version": "0.5.3-dev-4733782.0+4733782",
+  "version": "0.5.3-dev-c774209.0+c774209",
   "description": "Safe access to VatData global",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -19,12 +19,14 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-4733782.0+4733782",
-    "@agoric/base-zone": "0.1.1-dev-4733782.0+4733782",
-    "@agoric/internal": "0.3.3-dev-4733782.0+4733782",
-    "@agoric/store": "0.9.3-dev-4733782.0+4733782",
-    "@agoric/swingset-liveslots": "0.10.3-dev-4733782.0+4733782",
-    "@agoric/vow": "0.1.1-dev-4733782.0+4733782"
+    "@agoric/assert": "0.6.1-dev-c774209.0+c774209",
+    "@agoric/base-zone": "0.1.1-dev-c774209.0+c774209",
+    "@agoric/internal": "0.3.3-dev-c774209.0+c774209",
+    "@agoric/store": "0.9.3-dev-c774209.0+c774209",
+    "@agoric/swingset-liveslots": "0.10.3-dev-c774209.0+c774209",
+    "@agoric/vow": "0.1.1-dev-c774209.0+c774209",
+    "@endo/exo": "^1.3.0",
+    "@endo/patterns": "^1.3.0"
   },
   "devDependencies": {
     "@endo/far": "^1.1.0",
@@ -50,5 +52,5 @@
   "typeCoverage": {
     "atLeast": 98.79
   },
-  "gitHead": "47337826034f90078930b0135aa0a81f3a1d773e"
+  "gitHead": "c7742091b64886f933314ec3981c939504552d29"
 }

package/test/test-amplify-virtual-class-kits.js

@@ -0,0 +1,90 @@
+// modeled on test-amplify-heap-class-kits.js
+import { test } from './prepare-test-env-ava.js';
+
+// eslint-disable-next-line import/order
+import { M } from '@endo/patterns';
+import {
+  defineVirtualExoClass,
+  defineVirtualExoClassKit,
+} from '../src/exo-utils.js';
+
+const UpCounterI = M.interface('UpCounter', {
+  incr: M.call().optional(M.gte(0)).returns(M.number()),
+});
+
+const DownCounterI = M.interface('DownCounter', {
+  decr: M.call().optional(M.gte(0)).returns(M.number()),
+});
+
+test('test amplify defineVirtualExoClass fails', t => {
+  t.throws(
+    () =>
+      defineVirtualExoClass(
+        'UpCounter',
+        UpCounterI,
+        /** @param {number} [x] */
+        (x = 0) => ({ x }),
+        {
+          incr(y = 1) {
+            const { state } = this;
+            state.x += y;
+            return state.x;
+          },
+        },
+        {
+          receiveAmplifier(_) {},
+        },
+      ),
+    {
+      message:
+        'Only facets of an exo class kit can be amplified, not "UpCounter"',
+    },
+  );
+});
+
+test('test amplify defineVirtualExoClassKit', t => {
+  /** @type {import('@endo/exo/src/exo-makers.js').Amplify} */
+  let amp;
+  const makeCounterKit = defineVirtualExoClassKit(
+    'Counter',
+    { up: UpCounterI, down: DownCounterI },
+    /** @param {number} [x] */
+    (x = 0) => ({ x }),
+    {
+      up: {
+        incr(y = 1) {
+          const { state } = this;
+          state.x += y;
+          return state.x;
+        },
+      },
+      down: {
+        decr(y = 1) {
+          const { state } = this;
+          state.x -= y;
+          return state.x;
+        },
+      },
+    },
+    {
+      receiveAmplifier(a) {
+        amp = a;
+      },
+    },
+  );
+  // @ts-expect-error TS thinks it is used before assigned, which is a hazard
+  // TS is correct to bring to our attention, since there is not enough static
+  // into to infer otherwise.
+  assert(amp !== undefined);
+
+  const counterKit = makeCounterKit(3);
+  const { up: upCounter, down: downCounter } = counterKit;
+  t.is(upCounter.incr(5), 8);
+  t.is(downCounter.decr(), 7);
+
+  t.throws(() => amp(harden({})), {
+    message: 'Must be a facet of "Counter": {}',
+  });
+  t.deepEqual(amp(upCounter), counterKit);
+  t.deepEqual(amp(downCounter), counterKit);
+});

package/test/test-is-instance-virtual-class-kits.js

@@ -0,0 +1,115 @@
+// modeled on test-is-instance-heap-class-kits.js
+
+// eslint-disable-next-line import/order
+import { test } from './prepare-test-env-ava.js';
+
+// eslint-disable-next-line import/order
+import { M } from '@endo/patterns';
+import {
+  defineVirtualExoClass,
+  defineVirtualExoClassKit,
+} from '../src/exo-utils.js';
+
+const UpCounterI = M.interface('UpCounter', {
+  incr: M.call().optional(M.gte(0)).returns(M.number()),
+});
+
+const DownCounterI = M.interface('DownCounter', {
+  decr: M.call().optional(M.gte(0)).returns(M.number()),
+});
+
+test('test isInstance defineVirtualExoClass', t => {
+  // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
+  // @ts-ignore IsInstance merged after last sync with endo
+  /** @type {import('@endo/exo/src/exo-makers.js').IsInstance} */
+  let isInstance;
+  const makeUpCounter = defineVirtualExoClass(
+    'UpCounter',
+    UpCounterI,
+    /** @param {number} x */
+    (x = 0) => ({ x }),
+    {
+      incr(y = 1) {
+        const { state } = this;
+        state.x += y;
+        return state.x;
+      },
+    },
+    {
+      receiveInstanceTester(i) {
+        isInstance = i;
+      },
+    },
+  );
+  // @ts-expect-error TS thinks it is used before assigned, which is a hazard
+  // TS is correct to bring to our attention, since there is not enough static
+  // into to infer otherwise.
+  assert(isInstance !== undefined);
+
+  t.is(isInstance(harden({})), false);
+  t.throws(() => isInstance(harden({}), 'up'), {
+    message:
+      'facetName can only be used with an exo class kit: "UpCounter" has no facet "up"',
+  });
+
+  const upCounter = makeUpCounter(3);
+
+  t.is(isInstance(upCounter), true);
+  t.throws(() => isInstance(upCounter, 'up'), {
+    message:
+      'facetName can only be used with an exo class kit: "UpCounter" has no facet "up"',
+  });
+});
+
+test('test isInstance defineVirtualExoClassKit', t => {
+  // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
+  // @ts-ignore IsInstance merged after last sync with endo
+  /** @type {import('@endo/exo/src/exo-makers.js').IsInstance} */
+  let isInstance;
+  const makeCounterKit = defineVirtualExoClassKit(
+    'Counter',
+    { up: UpCounterI, down: DownCounterI },
+    /** @param {number} x */
+    (x = 0) => ({ x }),
+    {
+      up: {
+        incr(y = 1) {
+          const { state } = this;
+          state.x += y;
+          return state.x;
+        },
+      },
+      down: {
+        decr(y = 1) {
+          const { state } = this;
+          state.x -= y;
+          return state.x;
+        },
+      },
+    },
+    {
+      receiveInstanceTester(i) {
+        isInstance = i;
+      },
+    },
+  );
+  // @ts-expect-error TS thinks it is used before assigned, which is a hazard
+  // TS is correct to bring to our attention, since there is not enough static
+  // into to infer otherwise.
+  assert(isInstance !== undefined);
+
+  t.is(isInstance(harden({})), false);
+  t.is(isInstance(harden({}), 'up'), false);
+  t.throws(() => isInstance(harden({}), 'foo'), {
+    message: 'exo class kit "Counter" has no facet named "foo"',
+  });
+
+  const { up: upCounter } = makeCounterKit(3);
+
+  t.is(isInstance(upCounter), true);
+  t.is(isInstance(upCounter, 'up'), true);
+  t.is(isInstance(upCounter, 'down'), false);
+  t.throws(() => isInstance(upCounter, 'foo'), {
+    message: 'exo class kit "Counter" has no facet named "foo"',
+  });
+});