@agoric/builders 0.1.1-upgrade-18-dev-6ddbef0.0 → 0.1.1-upgrade-19-dev-2a71f04.0

package/scripts/orchestration/init-basic-flows.js

@@ -1,8 +1,22 @@
 import { makeHelpers } from '@agoric/deploy-script-support';
 import { startBasicFlows } from '@agoric/orchestration/src/proposals/start-basic-flows.js';
+import { parseArgs } from 'node:util';
+
+/**
+ * @import {ParseArgsConfig} from 'node:util'
+ */
+
+/** @type {ParseArgsConfig['options']} */
+const parserOpts = {
+  chainInfo: { type: 'string' },
+  assetInfo: { type: 'string' },
+};
 
 /** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
-export const defaultProposalBuilder = async ({ publishRef, install }) => {
+export const defaultProposalBuilder = async (
+  { publishRef, install },
+  options,
+) => {
   return harden({
     sourceSpec: '@agoric/orchestration/src/proposals/start-basic-flows.js',
     getManifestCall: [
@@ -15,6 +29,7 @@ export const defaultProposalBuilder = async ({ publishRef, install }) => {
             ),
           ),
         },
+        options,
       },
     ],
   });
@@ -22,6 +37,31 @@ export const defaultProposalBuilder = async ({ publishRef, install }) => {
 
 /** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
 export default async (homeP, endowments) => {
+  const { scriptArgs } = endowments;
+
+  const {
+    values: { chainInfo, assetInfo },
+  } = parseArgs({
+    args: scriptArgs,
+    options: parserOpts,
+  });
+
+  const parseChainInfo = () => {
+    if (typeof chainInfo !== 'string') return undefined;
+    return JSON.parse(chainInfo);
+  };
+  const parseAssetInfo = () => {
+    if (typeof assetInfo !== 'string') return undefined;
+    return JSON.parse(assetInfo);
+  };
+  const opts = harden({
+    chainInfo: parseChainInfo(),
+    assetInfo: parseAssetInfo(),
+  });
+
   const { writeCoreEval } = await makeHelpers(homeP, endowments);
-  await writeCoreEval(startBasicFlows.name, defaultProposalBuilder);
+
+  await writeCoreEval(startBasicFlows.name, utils =>
+    defaultProposalBuilder(utils, opts),
+  );
 };

package/scripts/testing/add-USD-LEMONS.js

@@ -0,0 +1,19 @@
+import { makeHelpers } from '@agoric/deploy-script-support';
+import { psmProposalBuilder } from '../inter-protocol/add-collateral-core.js';
+
+const addUsdLemonsProposalBuilder = async powers => {
+  return psmProposalBuilder(powers, {
+    anchorOptions: {
+      denom: 'ibc/000C0AAAEECAFE000',
+      keyword: 'USD_LEMONS',
+      decimalPlaces: 6,
+      proposedName: 'USD_LEMONS',
+    },
+  });
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+  await writeCoreEval('add-LEMONS-PSM', addUsdLemonsProposalBuilder);
+};

package/scripts/testing/add-USD-OLIVES.js

@@ -0,0 +1,19 @@
+import { makeHelpers } from '@agoric/deploy-script-support';
+import { psmProposalBuilder } from '../inter-protocol/add-collateral-core.js';
+
+const addUsdOlivesProposalBuilder = async powers => {
+  return psmProposalBuilder(powers, {
+    anchorOptions: {
+      denom: 'ibc/000C0AAAEECAFE111',
+      keyword: 'USD_OLIVES',
+      decimalPlaces: 6,
+      proposedName: 'USD_OLIVES',
+    },
+  });
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+  await writeCoreEval('add-OLIVES-PSM', addUsdOlivesProposalBuilder);
+};

package/scripts/testing/init-auto-stake-it.js

@@ -0,0 +1,73 @@
+/**
+ * @file A proposal to start the auto-stake-it contract.
+ *
+ *   AutoStakeIt allows users to to create an auto-forwarding address that
+ *   transfers and stakes tokens on a remote chain when received.
+ */
+import { makeHelpers } from '@agoric/deploy-script-support';
+import { startAutoStakeIt } from '@agoric/orchestration/src/proposals/start-auto-stake-it.js';
+import { parseArgs } from 'node:util';
+
+/**
+ * @import {ParseArgsConfig} from 'node:util'
+ */
+
+/** @type {ParseArgsConfig['options']} */
+const parserOpts = {
+  chainInfo: { type: 'string' },
+  assetInfo: { type: 'string' },
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder = async (
+  { publishRef, install },
+  options,
+) => {
+  return harden({
+    sourceSpec: '@agoric/orchestration/src/proposals/start-auto-stake-it.js',
+    getManifestCall: [
+      'getManifest',
+      {
+        installKeys: {
+          autoAutoStakeIt: publishRef(
+            install(
+              '@agoric/orchestration/src/examples/auto-stake-it.contract.js',
+            ),
+          ),
+        },
+        options,
+      },
+    ],
+  });
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  const { scriptArgs } = endowments;
+
+  const {
+    values: { chainInfo, assetInfo },
+  } = parseArgs({
+    args: scriptArgs,
+    options: parserOpts,
+  });
+
+  const parseChainInfo = () => {
+    if (typeof chainInfo !== 'string') return undefined;
+    return JSON.parse(chainInfo);
+  };
+  const parseAssetInfo = () => {
+    if (typeof assetInfo !== 'string') return undefined;
+    return JSON.parse(assetInfo);
+  };
+  const opts = harden({
+    chainInfo: parseChainInfo(),
+    assetInfo: parseAssetInfo(),
+  });
+
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+
+  await writeCoreEval(startAutoStakeIt.name, utils =>
+    defaultProposalBuilder(utils, opts),
+  );
+};

package/scripts/testing/init-send-anywhere.js

@@ -0,0 +1,67 @@
+import { makeHelpers } from '@agoric/deploy-script-support';
+import {
+  getManifest,
+  startSendAnywhere,
+} from '@agoric/orchestration/src/proposals/start-send-anywhere.js';
+import { parseArgs } from 'node:util';
+
+/**
+ * @import {ParseArgsConfig} from 'node:util'
+ */
+
+/** @type {ParseArgsConfig['options']} */
+const parserOpts = {
+  chainInfo: { type: 'string' },
+  assetInfo: { type: 'string' },
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder = async (
+  { publishRef, install },
+  options,
+) =>
+  harden({
+    sourceSpec: '@agoric/orchestration/src/proposals/start-send-anywhere.js',
+    getManifestCall: [
+      getManifest.name,
+      {
+        installationRef: publishRef(
+          install(
+            '@agoric/orchestration/src/examples/send-anywhere.contract.js',
+          ),
+        ),
+        options,
+      },
+    ],
+  });
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  const { scriptArgs } = endowments;
+
+  const {
+    values: { chainInfo, assetInfo },
+  } = parseArgs({
+    args: scriptArgs,
+    options: parserOpts,
+  });
+
+  const parseChainInfo = () => {
+    if (typeof chainInfo !== 'string') return undefined;
+    return JSON.parse(chainInfo);
+  };
+  const parseAssetInfo = () => {
+    if (typeof assetInfo !== 'string') return undefined;
+    return JSON.parse(assetInfo);
+  };
+  const opts = harden({
+    chainInfo: parseChainInfo(),
+    assetInfo: parseAssetInfo(),
+  });
+
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+
+  await writeCoreEval(startSendAnywhere.name, utils =>
+    defaultProposalBuilder(utils, opts),
+  );
+};

package/scripts/testing/provokeBOYD.js

@@ -0,0 +1,54 @@
+/**
+ * @file call getTimerBrand() 300 times in hopes of provoking BOYD. This is
+ * intended for tests on mainFork for upgrade-18. If there's a similar need in
+ * other tests, it can be included there as well. There would be no value in
+ * including it in an upgrade of MainNet; it just spins cycles to provoke
+ * garbage collection.
+ */
+
+import { makeTracer } from '@agoric/internal';
+import { E } from '@endo/far';
+
+/// <reference types="@agoric/vats/src/core/types-ambient"/>
+/** @import {Instance} from '@agoric/zoe/src/zoeService/utils.js'; */
+
+const trace = makeTracer('provokeBOYD', true);
+
+/**
+ * @param {BootstrapPowers} powers
+ */
+export const provokeBOYD = async ({ consume: { chainTimerService } }) => {
+  trace(provokeBOYD.name);
+  await null;
+
+  for (let i = 0; i < 300; i += 1) {
+    await E(chainTimerService).getTimerBrand();
+  }
+  trace('done');
+};
+harden(provokeBOYD);
+
+export const getManifestForProvokeBOYD = () => {
+  return {
+    manifest: {
+      [provokeBOYD.name]: {
+        consume: { chainTimerService: true },
+      },
+    },
+  };
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder = async () =>
+  harden({
+    sourceSpec: '@agoric/builders/scripts/testing/provokeBOYD.js',
+    getManifestCall: ['getManifestForProvokeBOYD'],
+  });
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  const dspModule = await import('@agoric/deploy-script-support');
+  const { makeHelpers } = dspModule;
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+  await writeCoreEval(provokeBOYD.name, defaultProposalBuilder);
+};

package/scripts/testing/publish-test-info.js

@@ -0,0 +1,79 @@
+import { makeTracer } from '@agoric/internal';
+import { E, Far } from '@endo/far';
+import { makeMarshal } from '@endo/marshal';
+
+const trace = makeTracer('PublishTestInfo');
+const { Fail } = assert;
+
+/**
+ * @param {BootstrapPowers} powers
+ */
+export const publishTestInfo = async powers => {
+  const {
+    consume: { agoricNamesAdmin, chainStorage: chainStorageP },
+  } = powers;
+
+  const chainStorage = await chainStorageP;
+  if (!chainStorage) {
+    trace('no chain storage, not registering chain info');
+    return;
+  }
+
+  trace('publishing testInfo');
+  const agoricNamesNode = E(chainStorage).makeChildNode('agoricNames');
+  const testInfoNode = E(agoricNamesNode).makeChildNode('testInfo');
+  const { nameAdmin } = await E(agoricNamesAdmin).provideChild('testInfo');
+
+  trace('registering onUpdate...');
+  await E(nameAdmin).onUpdate(
+    Far('chain info writer', {
+      write(entries) {
+        const marshalData = makeMarshal(_val => Fail`data only`);
+        const value = JSON.stringify(marshalData.toCapData(entries));
+        void E(testInfoNode)
+          .setValue(value)
+          .catch(() =>
+            console.log('cannot update vstorage after write to testInfo'),
+          );
+      },
+    }),
+  );
+
+  trace('writing to testInfo...');
+  await E(nameAdmin).update('agoric', {
+    isAwesome: 'yes',
+    tech: ['HardenedJs', 'Orchestration', 'Async_Execution'],
+  });
+
+  trace('Done.');
+};
+
+export const getManifestForPublishTestInfo = () => {
+  return {
+    manifest: {
+      [publishTestInfo.name]: {
+        consume: {
+          agoricNamesAdmin: true,
+          chainStorage: true,
+        },
+      },
+    },
+  };
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder = async () =>
+  harden({
+    // Somewhat unorthodox, source the exports from this builder module
+    sourceSpec: '@agoric/builders/scripts/testing/publish-test-info.js',
+    getManifestCall: ['getManifestForPublishTestInfo'],
+  });
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  // import dynamically so the module can work in CoreEval environment
+  const dspModule = await import('@agoric/deploy-script-support');
+  const { makeHelpers } = dspModule;
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+  await writeCoreEval('publish-test-info', defaultProposalBuilder);
+};

package/scripts/testing/recorded-retired-instances.js

@@ -0,0 +1,81 @@
+import { makeTracer } from '@agoric/internal';
+import { E } from '@endo/far';
+
+const trace = makeTracer('RecordedRetired', true);
+
+/**
+ * @param {BootstrapPowers &
+ *   PromiseSpaceOf<{ retiredContractInstances: MapStore<string, Instance>;
+ *   }>
+ * } powers
+ */
+export const testRecordedRetiredInstances = async ({
+  consume: {
+    contractKits,
+    governedContractKits,
+    retiredContractInstances: retiredContractInstancesP,
+  },
+}) => {
+  trace('Start');
+  const retiredContractInstances = await retiredContractInstancesP;
+
+  const auctionIDs = Array.from(retiredContractInstances.keys()).filter(k =>
+    k.startsWith('auction'),
+  );
+  assert(auctionIDs);
+  assert(auctionIDs.length === 1);
+  const auctionInstance = retiredContractInstances.get(auctionIDs[0]);
+  trace({ auctionInstance });
+  assert(await E(governedContractKits).get(auctionInstance));
+
+  const committeeIDs = Array.from(retiredContractInstances.keys()).filter(k =>
+    k.startsWith('economicCommittee'),
+  );
+  assert(committeeIDs);
+  assert(committeeIDs.length === 1);
+  trace('found committeeIDs', committeeIDs);
+
+  const committeeInstance = retiredContractInstances.get(committeeIDs[0]);
+  assert(await E(contractKits).get(committeeInstance));
+
+  const charterIDs = [...retiredContractInstances.keys()].filter(k =>
+    k.startsWith('econCommitteeCharter'),
+  );
+  assert(charterIDs);
+  assert(charterIDs.length === 1);
+  trace('found charterID', charterIDs);
+
+  trace('done');
+};
+harden(testRecordedRetiredInstances);
+
+export const getManifestForRecordedRetiredInstances = () => {
+  return {
+    manifest: {
+      [testRecordedRetiredInstances.name]: {
+        consume: {
+          contractKits: true,
+          governedContractKits: true,
+          retiredContractInstances: true,
+        },
+      },
+    },
+  };
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder = async () =>
+  harden({
+    sourceSpec:
+      '@agoric/builders/scripts/testing/recorded-retired-instances.js',
+    getManifestCall: ['getManifestForRecordedRetiredInstances', {}],
+  });
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  // import dynamically so the module can work in CoreEval environment
+  const dspModule = await import('@agoric/deploy-script-support');
+  const { makeHelpers } = dspModule;
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+  await writeCoreEval('recorded-retired', defaultProposalBuilder);
+};

package/scripts/testing/register-interchain-bank-assets.js

@@ -0,0 +1,199 @@
+/**
+ * @file register-interchain-bank-assets.js Core Eval
+ *
+ * Used to populate vbank in testing environments.
+ */
+import { AssetKind } from '@agoric/ertp';
+import { makeTracer } from '@agoric/internal';
+import { E } from '@endo/far';
+import { makeMarshal } from '@endo/marshal';
+
+const { Fail } = assert;
+
+const trace = makeTracer('RegisterInterchainBankAssets', true);
+
+/** @import {Board} from '@agoric/vats'; */
+
+/**
+ * @typedef {object} InterchainAssetOptions
+ * @property {string} denom
+ * @property {number} decimalPlaces
+ * @property {string} issuerName
+ * @property {string} keyword - defaults to `issuerName` if not provided
+ * @property {string} [proposedName] - defaults to `issuerName` if not provided
+ */
+
+// vstorage paths under published.*
+const BOARD_AUX = 'boardAux';
+
+const marshalData = makeMarshal(_val => Fail`data only`);
+
+/**
+ * Make a storage node for auxiliary data for a value on the board.
+ *
+ * @param {ERef<StorageNode>} chainStorage
+ * @param {string} boardId
+ */
+const makeBoardAuxNode = async (chainStorage, boardId) => {
+  const boardAux = E(chainStorage).makeChildNode(BOARD_AUX);
+  return E(boardAux).makeChildNode(boardId);
+};
+
+/**
+ * see `publishAgoricBrandsDisplayInfo` {@link @agoric/smart-wallet/proposals/upgrade-walletFactory-proposal.js}
+ *
+ * @param {ERef<StorageNode>} chainStorage
+ * @param {ERef<Board>} board
+ * @param {Brand<'nat'>} brand
+ */
+const publishBrandInfo = async (chainStorage, board, brand) => {
+  const [boardId, displayInfo, allegedName] = await Promise.all([
+    E(board).getId(brand),
+    E(brand).getDisplayInfo(),
+    E(brand).getAllegedName(),
+  ]);
+  const node = makeBoardAuxNode(chainStorage, boardId);
+  const aux = marshalData.toCapData(harden({ allegedName, displayInfo }));
+  await E(node).setValue(JSON.stringify(aux));
+};
+
+/**
+ * @param {BootstrapPowers} powers
+ * @param {object} config
+ * @param {object} config.options
+ * @param {InterchainAssetOptions[]} config.options.assets
+ */
+export const publishInterchainAssets = async (
+  {
+    consume: {
+      agoricNamesAdmin,
+      bankManager,
+      board,
+      chainStorage,
+      startUpgradable,
+    },
+    brand: { produce: produceBrands },
+    issuer: { produce: produceIssuers },
+    installation: {
+      consume: { mintHolder },
+    },
+  },
+  { options: { assets } },
+) => {
+  trace(`${publishInterchainAssets.name} starting...`);
+  trace(assets);
+  await null;
+  for (const interchainAssetOptions of assets) {
+    const {
+      denom,
+      decimalPlaces,
+      issuerName,
+      keyword = issuerName,
+      proposedName = issuerName,
+    } = interchainAssetOptions;
+
+    trace('interchainAssetOptions', {
+      denom,
+      decimalPlaces,
+      issuerName,
+      keyword,
+      proposedName,
+    });
+
+    assert.typeof(denom, 'string');
+    assert.typeof(decimalPlaces, 'number');
+    assert.typeof(keyword, 'string');
+    assert.typeof(issuerName, 'string');
+    assert.typeof(proposedName, 'string');
+
+    const terms = {
+      keyword: issuerName, // "keyword" is a misnomer in mintHolder terms
+      assetKind: AssetKind.NAT,
+      displayInfo: {
+        decimalPlaces,
+        assetKind: AssetKind.NAT,
+      },
+    };
+    const { creatorFacet: mint, publicFacet: issuer } = await E(
+      startUpgradable,
+    )({
+      installation: mintHolder,
+      label: issuerName,
+      privateArgs: undefined,
+      terms,
+    });
+
+    const brand = await E(issuer).getBrand();
+    const kit = /** @type {IssuerKit<'nat'>} */ ({ mint, issuer, brand });
+
+    /**
+     * `addAssetToVault.js` will register the issuer with the `reserveKit`,
+     * but we don't need to do that here.
+     */
+
+    await Promise.all([
+      E(E(agoricNamesAdmin).lookupAdmin('issuer')).update(issuerName, issuer),
+      E(E(agoricNamesAdmin).lookupAdmin('brand')).update(issuerName, brand),
+      // triggers benign UnhandledPromiseRejection 'Error: keyword "ATOM" must
+      // be unique' in provisionPool in testing environments
+      E(bankManager).addAsset(denom, issuerName, proposedName, kit),
+    ]);
+
+    // publish brands and issuers to Bootstrap space for use in proposals
+    produceBrands[keyword].reset();
+    produceIssuers[keyword].reset();
+    produceBrands[keyword].resolve(brand);
+    produceIssuers[keyword].resolve(issuer);
+
+    // publish brand info / boardAux for offer legibility
+    await publishBrandInfo(
+      // @ts-expect-error 'Promise<StorageNode | null>' is not assignable to
+      // parameter of type 'ERef<StorageNode>'
+      chainStorage,
+      board,
+      brand,
+    );
+  }
+  trace(`${publishInterchainAssets.name} complete`);
+};
+
+/**
+ * @param {unknown} _powers
+ * @param {{ assets: InterchainAssetOptions[] }} options
+ */
+export const getManifestCall = (_powers, options) => {
+  /** @type {Record<string, true>} */
+  const IssuerKws = options.assets.reduce(
+    /**
+     * @param {Record<string, true>} acc
+     * @param {InterchainAssetOptions} assetOptions
+     */
+    (acc, { issuerName }) => Object.assign(acc, { [issuerName]: true }),
+    {},
+  );
+  harden(IssuerKws);
+
+  return {
+    manifest: {
+      [publishInterchainAssets.name]: {
+        consume: {
+          agoricNamesAdmin: true,
+          bankManager: true,
+          board: true,
+          chainStorage: true,
+          startUpgradable: true,
+        },
+        brand: {
+          produce: IssuerKws,
+        },
+        issuer: {
+          produce: IssuerKws,
+        },
+        installation: {
+          consume: { mintHolder: true },
+        },
+      },
+    },
+    options,
+  };
+};

package/scripts/testing/replace-feeDistributor-short.js

@@ -0,0 +1,33 @@
+import { makeHelpers } from '@agoric/deploy-script-support';
+import { getManifestForReplaceFeeDistributor } from '@agoric/inter-protocol/src/proposals/replace-fee-distributor.js';
+
+/**
+ * @file
+ * a Variant of ../inter-protocol/replace-feeDistributor.js that shortens the
+ * collectionInterval for testing
+ */
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').CoreEvalBuilder} */
+export const defaultProposalBuilder = async (_, opts) => {
+  console.log('feeDist  OPTS', opts);
+  return harden({
+    sourceSpec:
+      '@agoric/inter-protocol/src/proposals/replace-fee-distributor.js',
+    getManifestCall: [getManifestForReplaceFeeDistributor.name, { ...opts }],
+  });
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').DeployScriptFunction} */
+export default async (homeP, endowments) => {
+  const { writeCoreEval } = await makeHelpers(homeP, endowments);
+
+  await writeCoreEval('replace-feeDistributor-testing', utils =>
+    defaultProposalBuilder(utils, {
+      collectionInterval: 30n,
+      keywordShares: {
+        RewardDistributor: 0n,
+        Reserve: 1n,
+      },
+    }),
+  );
+};