@agoric/zone 0.1.1-dev-4874362.0 → 0.1.1-dev-a1c0b7a.0

package/README.md

@@ -0,0 +1,41 @@
+# Zones
+
+Each Zone provides an API that allows the allocation of [Exo objects](https://github.com/endojs/endo/tree/master/packages/exo#readme) and [Stores
+(object collections)](../store/README.md) which use the same underlying persistence mechanism.  This
+allows library code to be agnostic to whether its objects are backed purely by
+the JS heap (ephemeral), pageable out to disk (virtual) or can be revived after
+a vat upgrade (durable).
+
+See [SwingSet vat upgrade documentation](../SwingSet/docs/vat-upgrade.md) for more example use of the zone API.
+
+An example of making a Zone-aware vat might look something like this:
+
+```js
+import { makeDurableZone } from '@agoric/zone/durable.js';
+import { zoneFrobulator } from 'frob-package';
+import { zoneWidget } from 'widget-package';
+
+export const buildRootObject = (vatPowers, _args, baggage) => {
+  const zone = makeDurableZone(baggage);
+
+  // Ensure that Widgets cannot interfere with Frobs.
+  const makeWidget = zoneWidget(zone.subZone('Widgets'));
+
+  // Create a collection of frobulators.
+  const frobZone = zone.subZone('Frobs');
+  const makeFrobulator = zoneFrobulator(frobZone);
+  const widgetToFrob = frobZone.mapStore('widgetToFrob');
+
+  return Far('WidgetFrobulator', {
+    makeWidget,
+    registerWidget(w) {
+      const frobulator = makeFrobulator();
+      widgetToFrob.init(w, frobulator);
+    },
+    frobWidget(w) {
+      const frobulator = widgetToFrob.get(w);
+      return frobulator.frob(w);
+    },
+  });
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/zone",
-  "version": "0.1.1-dev-4874362.0+4874362",
+  "version": "0.1.1-dev-a1c0b7a.0+a1c0b7a",
   "description": "Allocation zone abstraction for objects on the heap, persistent stores, etc.",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -25,8 +25,8 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/store": "0.8.4-dev-4874362.0+4874362",
-    "@agoric/vat-data": "0.4.4-dev-4874362.0+4874362",
+    "@agoric/store": "0.8.4-dev-a1c0b7a.0+a1c0b7a",
+    "@agoric/vat-data": "0.4.4-dev-a1c0b7a.0+a1c0b7a",
     "@endo/far": "^0.2.14"
   },
   "publishConfig": {
@@ -42,5 +42,5 @@
     "timeout": "20m",
     "workerThreads": false
   },
-  "gitHead": "4874362b8f9aa4f7c9f67ef7761bd78df126f267"
+  "gitHead": "a1c0b7a8f05d3f359d07935d0b782adeffb9af4c"
 }