@agoric/deploy-script-support 0.10.4-other-dev-3eb1a1d.0 → 0.10.4-other-dev-fbe72e7.0.fbe72e7

package/README.md

@@ -70,9 +70,11 @@ 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:
+The manifest object returned from a "getManifestCall" invocation may also
+include "installations" (they'll be registered with `agoricNames` and in the
+bootstrap promise space) and/or "options" (they'll be provided as the "options"
+property of the second argument for each call of the manifest's functions):
+
 ```js
 /** @type {import('@agoric/vats/src/core/lib-boot').BootstrapManifest} */
 const gameManifest = harden({
@@ -87,9 +89,12 @@ const gameManifest = harden({
 export const getManifestForGame1 = ({ restoreRef }, { game1Ref }) => {
   return harden({
     manifest: gameManifest,
+    // a reference to the game1 bundle will be published in agoricNames as "game1"
     installations: {
       game1: restoreRef(game1Ref),
     },
+    // the second argument of `startGameContract` will be `{ options: ["foo"] }`
+    options: ["foo"],
   });
 };
 ```

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@agoric/deploy-script-support",
-  "version": "0.10.4-other-dev-3eb1a1d.0+3eb1a1d",
+  "version": "0.10.4-other-dev-fbe72e7.0.fbe72e7",
   "description": "Helpers and other support for writing deploy scripts",
   "type": "module",
   "main": "src/helpers.js",
   "engines": {
-    "node": "^18.12 || ^20.9"
+    "node": "^20.9 || ^22.11"
   },
   "scripts": {
     "build": "exit 0",
     "test": "ava",
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
-    "lint:eslint": "eslint .",
-    "lint:types": "tsc",
-    "lint": "run-s --continue-on-error lint:*"
+    "lint:eslint": "yarn run -T eslint .",
+    "lint:types": "yarn run -T tsc",
+    "lint": "yarn run -T run-s --continue-on-error 'lint:*'"
   },
   "repository": {
     "type": "git",
@@ -34,27 +34,28 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/ertp": "0.16.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/import-manager": "0.3.12-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/internal": "0.3.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/notifier": "0.6.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/store": "0.9.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/time": "0.3.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/zoe": "0.26.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@endo/base64": "^1.0.9",
-    "@endo/bundle-source": "^3.5.0",
-    "@endo/errors": "^1.2.8",
-    "@endo/far": "^1.1.9",
-    "@endo/marshal": "^1.6.2",
-    "@endo/nat": "^5.0.13",
-    "@endo/promise-kit": "^1.1.8",
-    "@endo/zip": "^1.0.9"
+    "@agoric/ertp": "0.16.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/import-manager": "0.3.12-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/internal": "0.3.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/notifier": "0.6.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/pola-io": "0.1.1-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/store": "0.9.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/time": "0.3.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/zoe": "0.26.3-other-dev-fbe72e7.0.fbe72e7",
+    "@endo/base64": "^1.0.12",
+    "@endo/bundle-source": "^4.1.2",
+    "@endo/errors": "^1.2.13",
+    "@endo/far": "^1.1.14",
+    "@endo/marshal": "^1.8.0",
+    "@endo/nat": "^5.1.3",
+    "@endo/promise-kit": "^1.1.13",
+    "@endo/zip": "^1.0.11"
   },
   "devDependencies": {
-    "@agoric/vats": "0.15.2-other-dev-3eb1a1d.0+3eb1a1d",
-    "@endo/init": "^1.1.7",
+    "@agoric/vats": "0.15.2-other-dev-fbe72e7.0.fbe72e7",
+    "@endo/init": "^1.1.12",
     "ava": "^5.3.0",
-    "import-meta-resolve": "^2.2.1"
+    "import-meta-resolve": "^4.1.0"
   },
   "files": [
     "src",
@@ -72,7 +73,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 83.71
+    "atLeast": 83.26
   },
-  "gitHead": "3eb1a1d2d75b2b4a94807cd3bf759bc9fc531f05"
+  "gitHead": "fbe72e72107f9997f788674e668c660d92ec4492"
 }

package/src/assertOfferResult.js

@@ -2,6 +2,10 @@
 import { Fail } from '@endo/errors';
 import { E } from '@endo/far';
 
+/**
+ * @import {InvitationDetails, PaymentPKeywordRecord, Proposal, UserSeat} from '@agoric/zoe';
+ */
+
 /**
  * @param {ERef<UserSeat>} seat
  * @param {string} expectedOfferResult

package/src/depositInvitation.js

@@ -1,6 +1,11 @@
 // @ts-check
 import { E } from '@endo/far';
 
+/**
+ * @import {Amount, Brand, Issuer, Payment, Purse} from '@agoric/ertp';
+ * @import {InvitationDetails} from '@agoric/zoe';
+ */
+
 /**
  * @param {ERef<Purse>} zoeInvitationPurse
  */

package/src/helpers.js

@@ -20,6 +20,7 @@ import { installInPieces } from './installInPieces.js';
 import { makeWriteCoreEval } from './writeCoreEvalParts.js';
 
 export * from '@agoric/internal/src/node/createBundles.js';
+export { parseScriptArgs } from './parseCoreEvalArgs.js';
 
 // These are also hard-coded in lib-wallet.js.
 // TODO: Add methods to the wallet to access these without hard-coding

package/src/offer.js

@@ -4,7 +4,11 @@ import { E } from '@endo/far';
 // Avoid pulling in too many dependencies like notifiers
 import { AmountMath } from '@agoric/ertp/src/amountMath.js';
 
-/** @import {Petname} from '@agoric/deploy-script-support/src/externalTypes.js' */
+/**
+ * @import {Petname} from '@agoric/deploy-script-support/src/externalTypes.js';
+ * @import {Amount, Brand, Issuer, Payment, Purse} from '@agoric/ertp';
+ * @import {InvitationDetails, Keyword, Proposal} from '@agoric/zoe';
+ */
 
 /**
  * @typedef {object} OfferHelperConfig

package/src/parseCoreEvalArgs.js

@@ -0,0 +1,36 @@
+/**
+ * To customize proposals for multiple environments, we pass the "variant"
+ * identifier in scriptArgs. The variant must match a knownVariant.
+ *
+ * @param {import('./externalTypes.js').DeployScriptEndownments} endowments
+ * @param {string} name a name to use in error messages or Usage suggestions.
+ * @param {string[]} knownVariants
+ */
+export const parseScriptArgs = async (endowments, name, knownVariants) => {
+  const { scriptArgs } = endowments;
+  // const variantOrConfig = scriptArgs?.[0];
+  const variantOrConfig =
+    scriptArgs && scriptArgs.length > 0 ? scriptArgs : undefined;
+
+  console.log(`${name}`, variantOrConfig);
+
+  const Usage = `agoric run ${name}.js ${[...knownVariants, '<json-config>'].join(' | ')}`;
+  const opts = {};
+
+  if (typeof variantOrConfig === 'string') {
+    if (variantOrConfig[0] === '{') {
+      try {
+        opts.config = JSON.parse(variantOrConfig);
+      } catch (err) {
+        throw Error(`Failed to parse config argument ${variantOrConfig}`);
+      }
+    } else {
+      opts.variant = variantOrConfig;
+    }
+  } else {
+    console.error(Usage);
+    throw Error(Usage);
+  }
+
+  return opts;
+};

package/src/permissioned-deployment.js

@@ -0,0 +1,168 @@
+/**
+ * @file support for Contract Deployment Process
+ *
+ * 1. `agoric run XYZ.build.js` produces:
+ *    - `b1-123.json` bundle x 2: contract, aux
+ *    - `XYZ-permit.json`, `XYZ.js` script
+ * 2. Install bundles
+ *    - permissionless with per-byte fee in IST
+ * 3. Submit CoreEval proposal to BLD stakers
+ *    - `XYZ-permit.json`, `XYZ.js`
+ *
+ * @see {runBuilder}
+ * @see {installBundles}
+ * @see {submitCoreEval}
+ */
+import { toCLIOptions } from '@agoric/internal/src/cli-utils.js';
+
+/**
+ * @import {CmdRunner} from '@agoric/pola-io';
+ * @import {FileRd} from '@agoric/pola-io';
+ */
+
+/**
+ *
+ * TODO: builder should be a FileRd
+ * TODO: parameterize dest dir
+ *
+ * @example
+ * to use npx to find `agoric` in node_modules/.bin:
+ *   const execP = promisify(childProcess.execFile)
+ *   const agoric = makeCmdRunner('npx', { execFile: execP }).subCommand('agoric');
+ *
+ * XXX use a different name from execFile since the meaning is different
+ *
+ * @param {CmdRunner} agoric
+ * @param {FileRd} builder
+ * @param {string[]} [builderOpts]
+ * @param {{cwd?: FileRd}} [io]
+ *
+ * @returns {Promise<Plan>}
+ *
+ * @typedef {{
+ *   name: string,
+ *   script: string,
+ *   permit: string,
+ *   bundles: { entrypoint:string, bundleID:string, fileName:string}[];
+ * }} Plan
+ */
+export const runBuilder = async (
+  agoric,
+  builder,
+  builderOpts = [],
+  { cwd = builder.join('../../') } = {},
+) => {
+  const cmd = agoric.withFlags(...builderOpts);
+  const { stdout } = await cmd.exec(['run', String(builder)]);
+  const match = stdout?.match(/ (?<name>[-\w]+)-permit.json/);
+  if (!(match && match.groups)) {
+    throw Error('no permit found');
+  }
+  /** @type {Plan} */
+  const plan = await cwd.join(`${match.groups.name}-plan.json`).readJSON();
+  return plan;
+};
+
+export const txFlags = ({
+  node,
+  from,
+  chainId,
+  keyringBackend = 'test',
+  broadcastMode = 'block',
+}) => ({
+  node,
+  from,
+  'chain-id': chainId,
+  'keyring-backend': keyringBackend,
+  'broadcast-mode': broadcastMode,
+  // TODO: parameterize these?
+  gas: 'auto',
+  'gas-adjustment': '1.4',
+});
+
+/**
+ * @param {CmdRunner} agd
+ * @param {number} n
+ */
+export const waitForBlock = async (agd, n = 1) => {
+  const getHeight = async () => {
+    const { stdout } = await agd.exec(['status']);
+    const status = JSON.parse(stdout);
+    const { latest_block_height: height } = status.sync_info || status.SyncInfo;
+    return height;
+  };
+  const initialHeight = await getHeight();
+  const SEC = 1000;
+  let currentHeight;
+  do {
+    await new Promise(resolve => setTimeout(resolve, 1 * SEC)); // XXX ambient
+    currentHeight = await getHeight();
+  } while (currentHeight - initialHeight < n);
+  console.log('block height:', initialHeight, currentHeight);
+};
+
+/**
+ * @param {CmdRunner} agd - agd with --from etc.
+ * @param {string[]} txArgs
+ */
+export const runTx = async (agd, txArgs) => {
+  const { stdout } = await agd.withFlags('-o', 'json').exec(['tx', ...txArgs]);
+  const result = JSON.parse(stdout);
+  if (result.code !== 0) {
+    throw Object.assign(Error(result.raw_log), result);
+  }
+  return result;
+};
+
+/**
+ * @param {CmdRunner} agd
+ * @param {FileRd} bundle
+ */
+export const installBundle = async (agd, bundle) =>
+  runTx(agd, ['swingset', 'install-bundle', `@${bundle}`]);
+
+export const txAbbr = tx => {
+  const { txhash, code, height, gas_used: g } = tx;
+
+  return { txhash, code, height, gas_used: g };
+};
+
+/**
+ * @param {CmdRunner} agd
+ * @param {Plan['bundles']} bundles
+ * @param {FileRd} files
+ */
+export const installBundles = (agd, bundles, files) => {
+  const ps = bundles.map(b =>
+    installBundle(agd, files.join(files.relative(b.fileName))),
+  );
+  return Promise.all(ps);
+};
+
+/**
+ * @param {CmdRunner} agd
+ * @param {Pick<Plan, 'permit' | 'script'>[]} evals
+ * @param {object} [opts]
+ * @param {string} [opts.title]
+ * @param {string} [opts.description]
+ * @param {object} [opts.depositOpts]
+ * @param {string} [opts.depositOpts.denom]
+ * @param {number} [opts.depositOpts.unit]
+ * @param {number} [opts.depositOpts.qty]
+ * @param {string} [opts.deposit]
+ */
+export const submitCoreEval = async (
+  agd,
+  evals,
+  {
+    title = evals[0].script,
+    description = title,
+    depositOpts: { denom = 'ubld', unit = 1_000_000, qty = 10 } = {},
+    deposit = `${qty * unit}${denom}`,
+  } = {},
+) =>
+  runTx(agd, [
+    ...'gov submit-proposal swingset-core-eval'.split(' '),
+    ...evals.map(e => [e.permit, e.script]).flat(),
+    ...toCLIOptions({ title, description, deposit }),
+  ]);

package/src/saveIssuer.js

@@ -1,7 +1,10 @@
 // @ts-check
 import { E } from '@endo/far';
 
-/** @import {Petname} from '@agoric/deploy-script-support/src/externalTypes.js' */
+/**
+ * @import {Petname} from '@agoric/deploy-script-support/src/externalTypes.js';
+ * @import {Amount, Brand, Issuer, Payment} from '@agoric/ertp';
+ */
 
 /**
  * @param {ERef<any>} walletAdmin - an internal type of the

package/src/startInstance.js

@@ -2,7 +2,11 @@
 import { assert } from '@endo/errors';
 import { E, passStyleOf } from '@endo/far';
 
-/** @import {Petname} from '@agoric/deploy-script-support/src/externalTypes.js' */
+/**
+ * @import {Petname} from '@agoric/deploy-script-support/src/externalTypes.js';
+ * @import {Amount, Brand, Issuer, Payment, Purse} from '@agoric/ertp';
+ * @import {IssuerKeywordRecord, Keyword} from '@agoric/zoe';
+ */
 
 /**
  * @template T