agoric 0.21.2-other-dev-8f8782b.0 → 0.21.2-other-dev-3eb1a1d.0

package/src/commands/{ec.js → gov.js}

@@ -1,11 +1,11 @@
-/* eslint-disable @jessie.js/no-nested-await */
 // @ts-check
 /* eslint-disable func-names */
-/* global globalThis, process, setTimeout */
+/* eslint-env node */
+import { makeVstorageKit } from '@agoric/client-utils';
 import { execFileSync as execFileSyncAmbient } from 'child_process';
 import { Command, CommanderError } from 'commander';
 import { normalizeAddressWithOptions, pollBlocks } from '../lib/chain.js';
-import { getNetworkConfig, makeRpcUtils } from '../lib/rpc.js';
+import { getNetworkConfig } from '../lib/network-config.js';
 import {
   findContinuingIds,
   getCurrent,
@@ -14,7 +14,19 @@ import {
   sendAction,
 } from '../lib/wallet.js';
 
-/** @typedef {import('@agoric/smart-wallet/src/offers.js').OfferSpec} OfferSpec */
+/**
+ * @import {OfferSpec} from '@agoric/smart-wallet/src/offers.js'
+ * @import {QuestionDetails} from '@agoric/governance/src/types.js'
+ */
+
+const collectValues = (val, memo) => {
+  memo.push(val);
+  return memo;
+};
+
+const defaultKeyring = process.env.AGORIC_KEYRING_BACKEND || 'test';
+
+const networkConfig = await getNetworkConfig({ env: process.env, fetch });
 
 /**
  * @param {import('anylogger').Logger} _logger
@@ -27,23 +39,33 @@ import {
  *   delay?: (ms: number) => Promise<void>,
  * }} [io]
  */
-export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
+export const makeGovCommand = (_logger, io = {}) => {
   const {
     // Allow caller to provide access explicitly, but
     // default to conventional ambient IO facilities.
-    env = process.env,
     stdout = process.stdout,
     stderr = process.stderr,
-    fetch = globalThis.fetch,
+    fetch = global.fetch,
     execFileSync = execFileSyncAmbient,
     delay = ms => new Promise(resolve => setTimeout(resolve, ms)),
   } = io;
 
-  const ec = new Command('ec').description('Economic Committee commands');
+  const cmd = new Command('gov').description('Electoral governance commands');
+  // backwards compatibility with less general "ec" command. To make this work
+  // the new CLI options default to the values used for Economic Committee
+  cmd.alias('ec');
+  cmd.option(
+    '--keyring-backend <os|file|test>',
+    `keyring's backend (os|file|test) (default "${defaultKeyring}")`,
+    defaultKeyring,
+  );
 
   /** @param {string} literalOrName */
   const normalizeAddress = literalOrName =>
-    normalizeAddressWithOptions(literalOrName, { keyringBackend: 'test' });
+    normalizeAddressWithOptions(literalOrName, {
+      // FIXME does not observe keyring-backend option, which isn't available during arg parsing
+      keyringBackend: defaultKeyring,
+    });
 
   /** @type {(info: unknown, indent?: unknown) => boolean } */
   const show = (info, indent) =>
@@ -53,6 +75,8 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
     const done = found.filter(it => it.instanceName === instanceName);
     if (done.length > 0) {
       console.warn(`invitation to ${instanceName} already accepted`, done);
+      // CommanderError is a class constructor, and so
+      // must be invoked with `new`.
       throw new CommanderError(1, 'EALREADY', `already accepted`);
     }
   };
@@ -62,20 +86,25 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
    * given a sendFrom address; else print it.
    *
    * @param {{
-   *   toOffer: (agoricNames: *, current: import('@agoric/smart-wallet/src/smartWallet').CurrentWalletRecord | undefined) => OfferSpec,
+   *   toOffer: (agoricNames: *, current: import('@agoric/smart-wallet/src/smartWallet.js').CurrentWalletRecord | undefined) => OfferSpec,
    *   sendFrom?: string | undefined,
+   *   keyringBackend: string,
    *   instanceName?: string,
    * }} detail
-   * @param {Awaited<ReturnType<makeRpcUtils>>} [optUtils]
+   * @param {Awaited<ReturnType<makeVstorageKit>>} [optUtils]
    */
-  const processOffer = async function ({ toOffer, sendFrom }, optUtils) {
-    const networkConfig = await getNetworkConfig(env);
-    const utils = await (optUtils || makeRpcUtils({ fetch }));
-    const { agoricNames, readLatestHead } = utils;
+  const processOffer = async function (
+    { toOffer, sendFrom, keyringBackend },
+    optUtils,
+  ) {
+    const utils = await (optUtils || makeVstorageKit({ fetch }, networkConfig));
+    const { agoricNames, readPublished } = utils;
+
+    assert(keyringBackend, 'missing keyring-backend option');
 
     let current;
     if (sendFrom) {
-      current = await getCurrent(sendFrom, { readLatestHead });
+      current = await getCurrent(sendFrom, { readPublished });
     }
 
     const offer = toOffer(agoricNames, current);
@@ -90,7 +119,7 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
     const result = await sendAction(
       { method: 'executeOffer', offer },
       {
-        keyring: { backend: 'test' }, // XXX
+        keyring: { backend: keyringBackend },
         from: sendFrom,
         verbose: false,
         ...networkConfig,
@@ -105,9 +134,9 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
     show({ timestamp, height, offerId: offer.id, txhash });
     const checkInWallet = async blockInfo => {
       const [state, update] = await Promise.all([
-        getCurrent(sendFrom, { readLatestHead }),
-        getLastUpdate(sendFrom, { readLatestHead }),
-        readLatestHead(`published.wallet.${sendFrom}`),
+        getCurrent(sendFrom, { readPublished }),
+        getLastUpdate(sendFrom, { readPublished }),
+        readPublished(`wallet.${sendFrom}`),
       ]);
       if (update.updated === 'offerStatus' && update.status.id === offer.id) {
         return blockInfo;
@@ -127,29 +156,38 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
     show(blockInfo);
   };
 
-  ec.command('committee')
-    .description('accept invitation to join the economic committee')
+  cmd
+    .command('committee')
+    .description('accept invitation to join a committee')
+    .requiredOption(
+      '--name <string>',
+      'Committee instance name',
+      String,
+      'economicCommittee',
+    )
     .option('--voter <number>', 'Voter number', Number, 0)
     .option(
       '--offerId <string>',
       'Offer id',
       String,
-      `ecCommittee-${Date.now()}`,
+      `gov-committee-${Date.now()}`,
     )
     .option(
       '--send-from <name-or-address>',
       'Send from address',
       normalizeAddress,
     )
-    .action(async function (opts) {
+    .action(async function (opts, options) {
+      const { name: instanceName } = opts;
+
       /** @type {Parameters<typeof processOffer>[0]['toOffer']} */
       const toOffer = (agoricNames, current) => {
-        const instance = agoricNames.instance.economicCommittee;
-        assert(instance, `missing economicCommittee`);
+        const instance = agoricNames.instance[instanceName];
+        assert(instance, `missing ${instanceName}`);
 
         if (current) {
           const found = findContinuingIds(current, agoricNames);
-          abortIfSeen('economicCommittee', found);
+          abortIfSeen(instanceName, found);
         }
 
         return {
@@ -165,28 +203,37 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
 
       await processOffer({
         toOffer,
-        instanceName: 'economicCommittee',
-        ...opts,
+        instanceName,
+        sendFrom: opts.sendFrom,
+        keyringBackend: options.optsWithGlobals().keyringBackend,
       });
     });
 
-  ec.command('charter')
+  cmd
+    .command('charter')
     .description('accept the charter invitation')
-    .option('--offerId <string>', 'Offer id', String, `ecCharter-${Date.now()}`)
+    .requiredOption(
+      '--name <string>',
+      'Charter instance name',
+      'economicCommitteeCharter',
+    )
+    .option('--offerId <string>', 'Offer id', String, `charter-${Date.now()}`)
     .option(
       '--send-from <name-or-address>',
       'Send from address',
       normalizeAddress,
     )
-    .action(async function (opts) {
+    .action(async function (opts, options) {
+      const { name: instanceName } = opts;
+
       /** @type {Parameters<typeof processOffer>[0]['toOffer']} */
       const toOffer = (agoricNames, current) => {
-        const instance = agoricNames.instance.econCommitteeCharter;
-        assert(instance, `missing econCommitteeCharter`);
+        const instance = agoricNames.instance[instanceName];
+        assert(instance, `missing ${instanceName}`);
 
         if (current) {
           const found = findContinuingIds(current, agoricNames);
-          abortIfSeen('econCommitteeCharter', found);
+          abortIfSeen(instanceName, found);
         }
 
         return {
@@ -202,12 +249,14 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
 
       await processOffer({
         toOffer,
-        instanceName: 'econCommitteeCharter',
-        ...opts,
+        instanceName,
+        sendFrom: opts.sendFrom,
+        keyringBackend: options.optsWithGlobals().keyringBackend,
       });
     });
 
-  ec.command('find-continuing-id')
+  cmd
+    .command('find-continuing-id')
     .description('print id of specified voting continuing invitation')
     .requiredOption(
       '--from <name-or-address>',
@@ -216,8 +265,11 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
     )
     .requiredOption('--for <string>', 'description of the invitation')
     .action(async opts => {
-      const { agoricNames, readLatestHead } = await makeRpcUtils({ fetch });
-      const current = await getCurrent(opts.from, { readLatestHead });
+      const { agoricNames, readPublished } = await makeVstorageKit(
+        { fetch },
+        networkConfig,
+      );
+      const current = await getCurrent(opts.from, { readPublished });
 
       const known = findContinuingIds(current, agoricNames);
       if (!known) {
@@ -233,7 +285,8 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
       console.log(match.offerId);
     });
 
-  ec.command('find-continuing-ids')
+  cmd
+    .command('find-continuing-ids')
     .description('print records of voting continuing invitations')
     .requiredOption(
       '--from <name-or-address>',
@@ -241,16 +294,34 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
       normalizeAddress,
     )
     .action(async opts => {
-      const { agoricNames, readLatestHead } = await makeRpcUtils({ fetch });
-      const current = await getCurrent(opts.from, { readLatestHead });
+      const { agoricNames, readPublished } = await makeVstorageKit(
+        { fetch },
+        networkConfig,
+      );
+      const current = await getCurrent(opts.from, { readPublished });
 
       const found = findContinuingIds(current, agoricNames);
-      found.forEach(it => show({ ...it, address: opts.from }));
+      for (const it of found) {
+        show({ ...it, address: opts.from });
+      }
     });
 
-  ec.command('vote')
-    .description('vote on a question (hard-coded for now))')
-    .option('--offerId <number>', 'Offer id', String, `ecVote-${Date.now()}`)
+  cmd
+    .command('vote')
+    .description('vote on latest question')
+    .requiredOption(
+      '--instance <string>',
+      'Committee name under agoricNames.instances',
+      String,
+      'economicCommittee',
+    )
+    .requiredOption(
+      '--pathname <string>',
+      'Committee name under published.committees',
+      String,
+      'Economic_Committee',
+    )
+    .option('--offerId <number>', 'Offer id', String, `gov-vote-${Date.now()}`)
     .requiredOption(
       '--forPosition <number>',
       'index of one position to vote for (within the question description.positions); ',
@@ -261,17 +332,17 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
       'Send from address',
       normalizeAddress,
     )
-    .action(async function (opts) {
-      const utils = await makeRpcUtils({ fetch });
-      const { readLatestHead } = utils;
+    .action(async function (opts, options) {
+      const utils = await makeVstorageKit({ fetch }, networkConfig);
+      const { readPublished } = utils;
 
-      const info = await readLatestHead(
-        'published.committees.Economic_Committee.latestQuestion',
+      const questionDesc = await readPublished(
+        `committees.${opts.pathname}.latestQuestion`,
       ).catch(err => {
+        // CommanderError is a class constructor, and so
+        // must be invoked with `new`.
         throw new CommanderError(1, 'VSTORAGE_FAILURE', err.message);
       });
-      // XXX runtime shape-check
-      const questionDesc = /** @type {any} */ (info);
 
       // TODO support multiple position arguments
       const chosenPositions = [questionDesc.positions[opts.forPosition]];
@@ -280,11 +351,11 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
       /** @type {Parameters<typeof processOffer>[0]['toOffer']} */
       const toOffer = (agoricNames, current) => {
         const cont = current ? findContinuingIds(current, agoricNames) : [];
-        const votingRight = cont.find(
-          it => it.instance === agoricNames.instance.economicCommittee,
-        );
+        const votingRight = cont.find(it => it.instanceName === opts.instance);
         if (!votingRight) {
           console.debug('continuing ids', cont, 'for', current);
+          // CommanderError is a class constructor, and so
+          // must be invoked with `new`.
           throw new CommanderError(
             1,
             'NO_INVITATION',
@@ -307,8 +378,89 @@ export const makeEconomicCommiteeCommand = (_logger, io = {}) => {
         };
       };
 
-      await processOffer({ toOffer, sendFrom: opts.sendFrom }, utils);
+      await processOffer(
+        {
+          toOffer,
+          sendFrom: opts.sendFrom,
+          keyringBackend: options.optsWithGlobals().keyringBackend,
+        },
+        utils,
+      );
+    });
+
+  cmd
+    .command('proposePauseOffers')
+    .description('propose a vote to pause offers')
+    .option(
+      '--send-from <name-or-address>',
+      'Send from address',
+      normalizeAddress,
+    )
+    .option(
+      '--offerId <string>',
+      'Offer id',
+      String,
+      `proposePauseOffers-${Date.now()}`,
+    )
+    .requiredOption(
+      '--instance <string>',
+      'name of governed instance in agoricNames',
+    )
+    .requiredOption(
+      '--substring <string>',
+      'an offer string to pause (can be repeated)',
+      collectValues,
+      [],
+    )
+    .option(
+      '--deadline <minutes>',
+      'minutes from now to close the vote',
+      Number,
+      1,
+    )
+    .action(async function (opts, options) {
+      const { instance: instanceName } = opts;
+
+      /** @type {Parameters<typeof processOffer>[0]['toOffer']} */
+      const toOffer = (agoricNames, current) => {
+        const instance = agoricNames.instance[instanceName];
+        assert(instance, `missing ${instanceName}`);
+        assert(current, 'missing current wallet');
+
+        const known = findContinuingIds(current, agoricNames);
+
+        assert(known, 'could not find committee acceptance offer id');
+
+        // TODO magic string
+        const match = known.find(
+          r => r.description === 'charter member invitation',
+        );
+        assert(match, 'no offer found for charter member invitation');
+
+        return {
+          id: opts.offerId,
+          invitationSpec: {
+            source: 'continuing',
+            previousOffer: match.offerId,
+            invitationMakerName: 'VoteOnPauseOffers',
+            // ( instance, strings list, timer deadline seconds )
+            invitationArgs: harden([
+              instance,
+              opts.substring,
+              BigInt(opts.deadline * 60 + Math.round(Date.now() / 1000)),
+            ]),
+          },
+          proposal: {},
+        };
+      };
+
+      await processOffer({
+        toOffer,
+        instanceName,
+        sendFrom: opts.sendFrom,
+        keyringBackend: options.optsWithGlobals().keyringBackend,
+      });
     });
 
-  return ec;
+  return cmd;
 };