@agoric/deploy-script-support 0.10.4-dev-9b34be9.0 → 0.10.4-dev-45bab17.0

package/README.md

@@ -19,7 +19,10 @@ the proposal.
 
 Here's a simple example:
 
-```
+```js
+import { makeHelpers } from '@agoric/deploy-script-support';
+import { getManifestForGame1 } from '@agoric/smart-wallet/test/start-game1-proposal.js';
+
 /** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
 const game1ProposalBuilder = async ({ publishRef, install }) => {
   return harden({
@@ -45,28 +48,42 @@ export default async (homeP, endowments) => {
 };
 ```
 
-The first element of `getManifestCall` is interpreted as the name of a function
-defining a behavior. The second element of `getManifestCall` produces the
-`options` argument passed to the function (`{ game1Red }` in the example
-above). A common thing to want to pass in `options` is a reference to code to be
-installed on-chain. The example above shows how. `publishRef(install(<path>))`
-is built from sources in agoric-sdk, and passed as a `bundleRef`, which contains
-a `bundleID` suitable for passing to Zoe (for contracts) or `vatAdminService`
-(for non-contract vat code).
-
-The CoreEvalBuilder says the proposal to run is
-'@agoric/smart-wallet/test/start-game1-proposal.js'. It says the manifest can be
-produced by running `getManifestForGame1`, and directs the creation of bundles
-from `@agoric/smart-wallet/test/gameAssetContract.js` which will be made
-available to the proposal as `game1Ref` in `options`.
-
-The manifest gives permissions for accessing objects in promise space, and
-passes installations to the proposalBuilder. Notice that `game1Ref` from the
-proposalBuilder is passed to `getManifestForGame1`, which adds it to
-`installations`, with the name `game1`. The name provided for installations will
-also be used to register the installation in `agoricNames`.
+This CoreEvalBuilder returns an object whose "sourceSpec" indicates that the
+proposal to run is "@agoric/smart-wallet/test/start-game1-proposal.js" and whose
+"getManifestCall" is a [functionName, ...args] array describing an invocation of
+`getManifestForGame1` exported from that file which is expected to return an
+object including a "manifest" as described below (but the actual invocation will
+insert as the first argument a "powers" object that includes functions such as
+`restoreRef`). A common thing to want to pass in `args` is a reference to code
+to be installed on-chain, and the example above shows how.
+`publishRef(install(...))` is built from sources in agoric-sdk, and passed as a
+`bundleRef`, which contains a `bundleID` suitable for passing to Zoe (for
+contracts) or `vatAdminService` (for non-contract vat code).
+
+The manifest from such an invocation is a JSON-serializable object in which each
+key is the name of a function to itself be invoked and the corresponding value
+is a "permit" describing an attenuation of the core-eval promise space to be
+provided as its first argument. A permit is either `true` or a string (_both
+meaning no attenuation of the respective subtree of the promise space, with a
+string serving as a grouping label for convenience and/or diagram generation_),
+or an object whose keys identify child properties and whose corresponding values
+are theirselves (recursive) permits. See `BootstrapManifiest` in
+[lib-boot.js](../vats/src/core/lib-boot.js).
+
+The object returned from a "getManifestCall" invocation may also include
+"installations" to register in `agoricNames`, as is done here with name "game1"
+using the reference passed in via the invocation argument:
+```js
+/** @type {import('@agoric/vats/src/core/lib-boot').BootstrapManifest} */
+const gameManifest = harden({
+  [startGameContract.name]: {
+    consume: {...},
+    brand: {...},
+    issuer: {...},
+    ...
+  },
+});
 
-```
 export const getManifestForGame1 = ({ restoreRef }, { game1Ref }) => {
   return harden({
     manifest: gameManifest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/deploy-script-support",
-  "version": "0.10.4-dev-9b34be9.0+9b34be9",
+  "version": "0.10.4-dev-45bab17.0+45bab17",
   "description": "Helpers and other support for writing deploy scripts",
   "type": "module",
   "main": "src/helpers.js",
@@ -34,13 +34,13 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/ertp": "0.16.3-dev-9b34be9.0+9b34be9",
-    "@agoric/import-manager": "0.3.12-dev-9b34be9.0+9b34be9",
-    "@agoric/internal": "0.3.3-dev-9b34be9.0+9b34be9",
-    "@agoric/notifier": "0.6.3-dev-9b34be9.0+9b34be9",
-    "@agoric/store": "0.9.3-dev-9b34be9.0+9b34be9",
-    "@agoric/time": "0.3.3-dev-9b34be9.0+9b34be9",
-    "@agoric/zoe": "0.26.3-dev-9b34be9.0+9b34be9",
+    "@agoric/ertp": "0.16.3-dev-45bab17.0+45bab17",
+    "@agoric/import-manager": "0.3.12-dev-45bab17.0+45bab17",
+    "@agoric/internal": "0.3.3-dev-45bab17.0+45bab17",
+    "@agoric/notifier": "0.6.3-dev-45bab17.0+45bab17",
+    "@agoric/store": "0.9.3-dev-45bab17.0+45bab17",
+    "@agoric/time": "0.3.3-dev-45bab17.0+45bab17",
+    "@agoric/zoe": "0.26.3-dev-45bab17.0+45bab17",
     "@endo/base64": "^1.0.8",
     "@endo/bundle-source": "^3.4.2",
     "@endo/errors": "^1.2.7",
@@ -51,7 +51,7 @@
     "@endo/zip": "^1.0.8"
   },
   "devDependencies": {
-    "@agoric/vats": "0.15.2-dev-9b34be9.0+9b34be9",
+    "@agoric/vats": "0.15.2-dev-45bab17.0+45bab17",
     "@endo/init": "^1.1.6",
     "ava": "^5.3.0",
     "import-meta-resolve": "^2.2.1"
@@ -74,5 +74,5 @@
   "typeCoverage": {
     "atLeast": 83.71
   },
-  "gitHead": "9b34be9c20249ce02d6d3dbcf8b0557be18d8160"
+  "gitHead": "45bab1715b07dee25fe34d24971b47f1acf79036"
 }