@agoric/deploy-script-support 0.10.4-dev-cc2bf0b.0 → 0.10.4-dev-0270908.0

package/README.md

@@ -4,14 +4,35 @@ To install code on chain or in the a3p-integration environment, you'll have to
 generate a proposal, and write a script to build the core proposal. The
 proposals have limited access to bootstrap powers, described by their manifests.
 
+There are collections of proposals in .../vats/src/proposals,
+smart-wallet/src/proposals, orchestration/src/proposals, pegasus/src/proposals.
+
+The overall format is a proposalBuilder script (There are several in
+.../builders/scripts/vats/) which has a default export that passes resources to
+the proposal. The resources include bundled source code and string-value
+parameters. The ProposalBuilder specifies (as an import string) the proposal
+it uses, identifies the "manifest", (which associates permissions to access
+powers in the bootstrap space with functions to be called), and builds bundles
+of source code needed by the proposal.
+
+`.../builders/scripts/vats/upgradeVaults.js` is a canonical example. It says the
+proposal to run is '@agoric/inter-protocol/src/proposals/upgrade-vaults.js',
+lists the manifest there as `'getManifestForUpgradeVaults'`, and directs the
+creation of a bundle from
+'@agoric/inter-protocol/src/vaultFactory/vaultFactory.js', which will be made
+available to the proposal as `vaultsRef` in options.
+
+`upgrade-vaults.js` defines `getManifestForUpgradeVaults()`, which returns a
+`manifest` that says `upgradeVaults()` should be executed, and specifies what
+powers it should have access to.
 
 ### Proposal
 
 The proposal is called with `(powers, options)` available. The manifest
 detailing the powers that will be used is usually in the same file, and
 conventionally provided by a function named `getManifestForFoo`. The manifest
-needs to have a unique name, since it will be referenced by name from the script.
-The usual format is
+needs to have a unique name, since it will be referenced by name from the
+script. The usual format is
 ```js
 export const foo = async (
   {
@@ -24,6 +45,7 @@ export const foo = async (
   },
  options,
 ) => {
+  const { fooRef } = options;
   // do the things using powers and options
 };
 
@@ -44,14 +66,13 @@ export const getManifestForFoo = (powers, options) => {
 `options` allows the proposal to be provided with arbitray other powerful
 objects.
 
-### Script
+### proposalBuilder Script
 
 The script describes how to build the core proposal. For
 `agoric-3-proposals` and uploading to the chain, the script must be named in the
 `CoreProposalSteps` section in
 [`app.go`](https://github.com/Agoric/agoric-sdk/blob/b13743a2cccf0cb63a412b54384435596d4e81ea/golang/cosmos/app/app.go#L881),
-and its `defaultProposalBuilder` will be invoked
-directly.
+and its `defaultProposalBuilder` will be invoked directly.
 
 Script files should export `defaultProposalBuilder` and a `default` function
 that invokes `writeCoreProposal` one or more times to generate sets of files
@@ -79,8 +100,8 @@ export default async (homeP, endowments) => {
 
 The first element of `getManifestCall` is interpreted as the name of a proposal.
 The second element of `getManifestCall` produces the `options` argument passed
-to the proposal. (`foo` in the example above). A common thing to want to pass in
-options is a reference to code to be installed on-chain. The `fooRef` example
+to the proposal. (`fooRef` in the example above). A common thing to want to pass
+in options is a reference to code to be installed on-chain. The `fooRef` example
 above shows how. `publishRef(install(<path>))` is built from sources in the
 sdk, and passed as a `bundleRef`, which contains a `bundleID` suitable for
 passing to Zoe (for contracts) or `vatAdminService` (for non-contract vat code).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/deploy-script-support",
-  "version": "0.10.4-dev-cc2bf0b.0+cc2bf0b",
+  "version": "0.10.4-dev-0270908.0+0270908",
   "description": "Helpers and other support for writing deploy scripts",
   "type": "module",
   "main": "src/helpers.js",
@@ -34,14 +34,14 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-cc2bf0b.0+cc2bf0b",
-    "@agoric/ertp": "0.16.3-dev-cc2bf0b.0+cc2bf0b",
-    "@agoric/import-manager": "0.3.12-dev-cc2bf0b.0+cc2bf0b",
-    "@agoric/internal": "0.3.3-dev-cc2bf0b.0+cc2bf0b",
-    "@agoric/notifier": "0.6.3-dev-cc2bf0b.0+cc2bf0b",
-    "@agoric/store": "0.9.3-dev-cc2bf0b.0+cc2bf0b",
-    "@agoric/time": "0.3.3-dev-cc2bf0b.0+cc2bf0b",
-    "@agoric/zoe": "0.26.3-dev-cc2bf0b.0+cc2bf0b",
+    "@agoric/assert": "0.6.1-dev-0270908.0+0270908",
+    "@agoric/ertp": "0.16.3-dev-0270908.0+0270908",
+    "@agoric/import-manager": "0.3.12-dev-0270908.0+0270908",
+    "@agoric/internal": "0.3.3-dev-0270908.0+0270908",
+    "@agoric/notifier": "0.6.3-dev-0270908.0+0270908",
+    "@agoric/store": "0.9.3-dev-0270908.0+0270908",
+    "@agoric/time": "0.3.3-dev-0270908.0+0270908",
+    "@agoric/zoe": "0.26.3-dev-0270908.0+0270908",
     "@endo/base64": "^1.0.5",
     "@endo/bundle-source": "^3.2.3",
     "@endo/far": "^1.1.2",
@@ -51,7 +51,7 @@
     "@endo/zip": "^1.0.5"
   },
   "devDependencies": {
-    "@agoric/vats": "0.15.2-dev-cc2bf0b.0+cc2bf0b",
+    "@agoric/vats": "0.15.2-dev-0270908.0+0270908",
     "@endo/init": "^1.1.2",
     "ava": "^5.3.0",
     "import-meta-resolve": "^2.2.1"
@@ -75,5 +75,5 @@
   "typeCoverage": {
     "atLeast": 81.63
   },
-  "gitHead": "cc2bf0bb431aa64c601628f53cf191fcc84c5750"
+  "gitHead": "0270908690b17f67dc4a390c650353841df9f1e0"
 }