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

package/src/lib/bundles.js

@@ -0,0 +1,102 @@
+// @ts-check
+/* eslint-env node */
+
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import { join } from 'node:path';
+
+import { ZipReader } from '@endo/zip';
+
+/** @import {Bundle} from '@agoric/swingset-vat'; */
+/** @import {CoreEvalPlan} from '@agoric/deploy-script-support/src/writeCoreEvalParts.js' */
+
+// exported for testing
+export const PACKAGE_NAME_RE = /^(?:@[^/]+\/)?[^/]+/;
+
+/**
+ * @typedef {{ name: string, label: string, location: string, modules: Record<string, {compartment: string, module: string}>}} Compartment
+ */
+
+/**
+ * @typedef CompartmentMap
+ * @property {string[]} tags
+ * @property {{compartment: string, module: string}} entry
+ * @property {Record<string, Compartment>} compartments
+ */
+
+/** @param {Bundle} bundleObj*/
+export const extractBundleInfo = async bundleObj => {
+  if (bundleObj.moduleFormat !== 'endoZipBase64') {
+    throw Error('only endoZipBase64 is supported');
+  }
+
+  const contents = Buffer.from(bundleObj.endoZipBase64, 'base64');
+
+  const zipReader = new ZipReader(contents);
+  const { files } = zipReader;
+
+  const cmapEntry = files.get('compartment-map.json');
+  /** @type {CompartmentMap} */
+  const compartmentMap = JSON.parse(Buffer.from(cmapEntry.content).toString());
+
+  // XXX mapIter better but requires SES
+  const fileSizes = Object.fromEntries(
+    Array.from(files.values()).map(f => [
+      f.name,
+      // bundle contents are not compressed
+      f.content.length,
+    ]),
+  );
+
+  return { compartmentMap, fileSizes };
+};
+
+// UNTIL https://github.com/endojs/endo/issues/1656
+/** @param {string} bundleFilename */
+export const statBundle = async bundleFilename => {
+  const bundle = fs.readFileSync(bundleFilename, 'utf8');
+  /** @type {Bundle} */
+  const bundleObj = JSON.parse(bundle);
+  console.log('\nBUNDLE', bundleObj.moduleFormat, bundleFilename);
+
+  const info = await extractBundleInfo(bundleObj);
+  assert(info, 'no bundle info');
+
+  /** @type {Record<string, number>} */
+  const byPackage = {};
+  let totalSize = 0;
+  for (const [filename, size] of Object.entries(info.fileSizes)) {
+    totalSize += size;
+    if (filename === 'compartment-map.json') {
+      continue;
+    }
+    const packageName = filename.match(PACKAGE_NAME_RE)?.[0];
+    assert(packageName, `invalid filename ${filename}`);
+    byPackage[packageName] ||= 0;
+    byPackage[packageName] += size;
+  }
+
+  console.log('Sum of file sizes in each package:');
+  console.table(byPackage);
+
+  console.log('total size:', totalSize);
+  console.log('\nTo explore the contents:\n');
+  console.log(
+    `  DIR=$(mktemp -d); cat ${bundleFilename} | jq -r .endoZipBase64 | base64 -d | tar xC $DIR; open $DIR`,
+  );
+};
+
+/** @param {string} path */
+export const statPlans = async path => {
+  const files = await fs.promises.readdir(path);
+  const planfiles = files.filter(f => f.endsWith('plan.json'));
+
+  for (const planfile of planfiles) {
+    /** @type {CoreEvalPlan} */
+    const plan = JSON.parse(fs.readFileSync(join(path, planfile), 'utf8'));
+    console.log('\n**\nPLAN', plan.name);
+    for (const bundle of plan.bundles) {
+      await statBundle(bundle.fileName);
+    }
+  }
+};

package/src/lib/chain.js

@@ -1,8 +1,12 @@
 // @ts-check
-/* global process */
+/* eslint-env node */
 import { normalizeBech32 } from '@cosmjs/encoding';
 import { execFileSync as execFileSyncAmbient } from 'child_process';
 
+/**
+ * @import {MinimalNetworkConfig} from '@agoric/client-utils';
+ */
+
 const agdBinary = 'agd';
 
 /**
@@ -34,10 +38,42 @@ export const normalizeAddressWithOptions = (
 };
 harden(normalizeAddressWithOptions);
 
+/** @typedef {number | 'auto' | ['auto', adjustment?: number | undefined]} GasLimit */
+
+/**
+ * @param {GasLimit} limit
+ * @returns {string[]}
+ */
+const makeGasOpts = limit => {
+  if (Number.isFinite(limit) || limit === 'auto') {
+    return [`--gas=${limit}`];
+  }
+  if (Array.isArray(limit) && limit.length >= 1 && limit[0] === 'auto') {
+    const gasOpts = ['--gas=auto'];
+    if (limit.length > 1) {
+      const [adjustment, ...rest] = limit.slice(1);
+      const adjustmentIsValid =
+        adjustment === undefined ||
+        (Number.isFinite(adjustment) && Number(adjustment) > 0);
+      if (rest.length !== 0 || !adjustmentIsValid) {
+        throw Error('invalid gas input');
+      }
+      if (adjustment !== undefined) {
+        gasOpts.push(`--gas-adjustment=${adjustment}`);
+      }
+    }
+    return gasOpts;
+  }
+
+  throw Error('invalid gas input');
+};
+
 /**
  * @param {ReadonlyArray<string>} swingsetArgs
- * @param {import('./rpc').MinimalNetworkConfig & {
+ * @param {MinimalNetworkConfig & {
  *   from: string,
+ *   fees?: string,
+ *   gas?: GasLimit,
  *   dryRun?: boolean,
  *   verbose?: boolean,
  *   keyring?: {home?: string, backend: string}
@@ -48,6 +84,8 @@ harden(normalizeAddressWithOptions);
 export const execSwingsetTransaction = (swingsetArgs, opts) => {
   const {
     from,
+    fees,
+    gas = ['auto', 1.2],
     dryRun = false,
     verbose = true,
     keyring = undefined,
@@ -60,9 +98,12 @@ export const execSwingsetTransaction = (swingsetArgs, opts) => {
   const backendOpt = keyring?.backend
     ? [`--keyring-backend=${keyring.backend}`]
     : [];
+  const feeOpt = fees ? ['--fees', fees] : [];
   const cmd = [`--node=${rpcAddrs[0]}`, `--chain-id=${chainName}`].concat(
     homeOpt,
     backendOpt,
+    feeOpt,
+    makeGasOpts(gas),
     [`--from=${from}`, 'tx', 'swingset'],
     swingsetArgs,
   );
@@ -74,15 +115,27 @@ export const execSwingsetTransaction = (swingsetArgs, opts) => {
     stdout.write('\n');
   } else {
     const yesCmd = cmd.concat(['--yes']);
-    if (verbose) console.log('Executing ', yesCmd);
-    return execFileSync(agdBinary, yesCmd, { encoding: 'utf-8' });
+    if (verbose) console.log('Executing ', agdBinary, yesCmd);
+    const out = execFileSync(agdBinary, yesCmd, { encoding: 'utf-8' });
+
+    // agd puts this diagnostic on stdout rather than stderr :-/
+    // "Default sign-mode 'direct' not supported by Ledger, using sign-mode 'amino-json'.
+    if (out.startsWith('Default sign-mode')) {
+      const stripDiagnostic = out.replace(/^Default[^\n]+\n/, '');
+      return stripDiagnostic;
+    }
+    return out;
   }
 };
 harden(execSwingsetTransaction);
 
-// xxx rpc should be able to query this by HTTP without shelling out
+/**
+ *
+ * @param {MinimalNetworkConfig} net
+ */
+// TODO fetch by HTTP instead of shelling out https://github.com/Agoric/agoric-sdk/issues/9200
 export const fetchSwingsetParams = net => {
-  const { chainName, rpcAddrs, execFileSync = execFileSyncAmbient } = net;
+  const { chainName, rpcAddrs } = net;
   const cmd = [
     `--node=${rpcAddrs[0]}`,
     `--chain-id=${chainName}`,
@@ -90,15 +143,15 @@ export const fetchSwingsetParams = net => {
     'swingset',
     'params',
     '--output',
-    '--json',
+    'json',
   ];
-  const buffer = execFileSync(agdBinary, cmd);
+  const buffer = execFileSyncAmbient(agdBinary, cmd);
   return JSON.parse(buffer.toString());
 };
 harden(fetchSwingsetParams);
 
 /**
- * @param {import('./rpc').MinimalNetworkConfig & {
+ * @param {MinimalNetworkConfig & {
  *   execFileSync: typeof import('child_process').execFileSync,
  *   delay: (ms: number) => Promise<void>,
  *   period?: number,
@@ -122,7 +175,6 @@ export const pollBlocks = opts => async lookup => {
     } = status;
     try {
       // see await null above
-      // eslint-disable-next-line @jessie.js/no-nested-await, no-await-in-loop
       const result = await lookup({ time, height });
       return result;
     } catch (_err) {
@@ -132,7 +184,6 @@ export const pollBlocks = opts => async lookup => {
         height,
         'retrying...',
       );
-      // eslint-disable-next-line @jessie.js/no-nested-await, no-await-in-loop
       await delay(period);
     }
   }
@@ -140,7 +191,7 @@ export const pollBlocks = opts => async lookup => {
 
 /**
  * @param {string} txhash
- * @param {import('./rpc').MinimalNetworkConfig & {
+ * @param {MinimalNetworkConfig & {
  *   execFileSync: typeof import('child_process').execFileSync,
  *   delay: (ms: number) => Promise<void>,
  *   period?: number,

package/src/lib/format.js

@@ -1,25 +1,21 @@
-// @ts-check
+import { Fail, q } from '@endo/errors';
 import { makeBoardRemote } from '@agoric/vats/tools/board-utils.js';
-// eslint-disable-next-line no-unused-vars -- typeof below
-import { makeAgoricNames } from './rpc.js';
 
-// ambient types
-import '@agoric/ertp/src/types-ambient.js';
-
-/** @typedef {import('@agoric/vats/tools/board-utils.js').BoardRemote} BoardRemote */
+/**
+ * @import {Amount, Brand} from '@agoric/ertp'
+ * @import {AgoricNamesRemotes, BoardRemote, VBankAssetDetail} from '@agoric/vats/tools/board-utils.js';
+ */
 
+// TODO Move to packages/internal.
 /**
- * Like @endo/nat but coerces
+ * Parses the input and returns either a finite number or NaN.
  *
- * @param {string} str
- * @returns {bigint}
+ * @param {string} input
+ * @returns {number}
  */
-export const Natural = str => {
-  const b = BigInt(str);
-  if (b < 0) {
-    throw RangeError(`${b} is negative`);
-  }
-  return b;
+export const parseFiniteNumber = input => {
+  const result = /[0-9]/.test(input || '') ? Number(input) : NaN;
+  return Number.isFinite(result) ? result : NaN;
 };
 
 /**
@@ -30,21 +26,18 @@ export const Natural = str => {
  */
 export const bigintReplacer = (k, v) => (typeof v === 'bigint' ? `${v}` : v);
 
-/** @type {import('@agoric/vats/tools/board-utils.js').VBankAssetDetail} */
+/** @type {Partial<VBankAssetDetail>} */
 // eslint-disable-next-line no-unused-vars
 const exampleAsset = {
-  // @ts-expect-error cast
   brand: makeBoardRemote({ boardId: 'board0425', iface: 'Alleged: BLD brand' }),
   displayInfo: { assetKind: 'nat', decimalPlaces: 6 },
-  // @ts-expect-error cast
   issuer: makeBoardRemote({ boardId: null, iface: undefined }),
-  petname: 'Agoric staking token',
+  proposedName: 'Agoric staking token',
 };
-/** @typedef {import('@agoric/vats/tools/board-utils.js').VBankAssetDetail } AssetDescriptor */
 
 /**
- * @param {AssetDescriptor[]} assets
- * @returns {(a: Amount & { brand: BoardRemote }) => [string, number | any[]]}
+ * @param {VBankAssetDetail[]} assets
+ * @returns {(a: Amount & { brand: BoardRemote }) => [string | null, number | any[]]}
  */
 export const makeAmountFormatter = assets => amt => {
   const { brand, value } = amt;
@@ -60,7 +53,9 @@ export const makeAmountFormatter = assets => amt => {
       return [issuerName, Number(value) / 10 ** decimalPlaces];
     case 'set':
       assert(Array.isArray(value));
+      // @ts-expect-error narrowed
       if (value[0]?.handle?.iface?.includes('InvitationHandle')) {
+        // @ts-expect-error narrowed
         return [issuerName, value.map(v => v.description)];
       }
       return [issuerName, value];
@@ -75,8 +70,6 @@ export const asPercent = ratio => {
   return (100 * Number(numerator.value)) / Number(denominator.value);
 };
 
-const { Fail, quote: q } = assert;
-
 const isObject = x => typeof x === 'object' && x !== null;
 
 /**
@@ -94,8 +87,8 @@ export const asBoardRemote = x => {
 /**
  * Summarize the balances array as user-facing informative tuples
  *
- * @param {import('@agoric/smart-wallet/src/smartWallet').CurrentWalletRecord['purses']} purses
- * @param {AssetDescriptor[]} assets
+ * @param {import('@agoric/smart-wallet/src/smartWallet.js').CurrentWalletRecord['purses']} purses
+ * @param {VBankAssetDetail[]} assets
  */
 export const purseBalanceTuples = (purses, assets) => {
   const fmt = makeAmountFormatter(assets);
@@ -107,14 +100,15 @@ export const purseBalanceTuples = (purses, assets) => {
  */
 export const fmtRecordOfLines = record => {
   const { stringify } = JSON;
+  /** @type {Array<[string, string[]]>} */
   const groups = Object.entries(record).map(([key, items]) => [
     key,
     items.map(item => `    ${stringify(item)}`),
   ]);
-  const lineEntries = groups.map(
-    // @ts-expect-error ???
-    ([key, lines]) => `  ${stringify(key)}: [\n${lines.join(',\n')}\n  ]`,
-  );
+  const lineEntries = groups.map(([key, lines]) => {
+    const linesStr = lines.length === 0 ? `[]` : `[\n${lines.join(',\n')}\n  ]`;
+    return `  ${stringify(key)}: ${linesStr}`;
+  });
   return `{\n${lineEntries.join(',\n')}\n}`;
 };
 
@@ -122,7 +116,7 @@ export const fmtRecordOfLines = record => {
  * Summarize the offerStatuses of the state as user-facing informative tuples
  *
  * @param {import('@agoric/smart-wallet/src/utils.js').CoalescedWalletState} state
- * @param {Awaited<ReturnType<typeof makeAgoricNames>>} agoricNames
+ * @param {AgoricNamesRemotes} agoricNames
  */
 export const offerStatusTuples = (state, agoricNames) => {
   const { offerStatuses } = state;
@@ -177,9 +171,9 @@ export const offerStatusTuples = (state, agoricNames) => {
 };
 
 /**
- * @param {import('@agoric/smart-wallet/src/smartWallet').CurrentWalletRecord} current
+ * @param {import('@agoric/smart-wallet/src/smartWallet.js').CurrentWalletRecord} current
  * @param {ReturnType<import('@agoric/smart-wallet/src/utils.js').makeWalletStateCoalescer>['state']} coalesced
- * @param {Awaited<ReturnType<typeof makeAgoricNames>>} agoricNames
+ * @param {AgoricNamesRemotes} agoricNames
  */
 export const summarize = (current, coalesced, agoricNames) => {
   return {

package/src/lib/network-config.js

@@ -0,0 +1,41 @@
+import { NonNullish } from '@agoric/internal';
+
+/**
+ * @import {MinimalNetworkConfig} from '@agoric/client-utils';
+ */
+
+export const networkConfigUrl = agoricNetSubdomain =>
+  `https://${agoricNetSubdomain}.agoric.net/network-config`;
+export const rpcUrl = agoricNetSubdomain =>
+  `https://${agoricNetSubdomain}.rpc.agoric.net:443`;
+
+/**
+ * @param {string} str
+ * @param {{ fetch: typeof fetch }} io
+ * @returns {Promise<MinimalNetworkConfig>}
+ */
+const fromAgoricNet = (str, { fetch }) => {
+  const [netName, chainName] = str.split(',');
+  if (chainName) {
+    return Promise.resolve({ chainName, rpcAddrs: [rpcUrl(netName)] });
+  }
+  return fetch(networkConfigUrl(netName)).then(res => res.json());
+};
+
+/**
+ * @param {{ env: typeof process.env, fetch: typeof fetch }} io
+ * @returns {Promise<MinimalNetworkConfig>}
+ */
+export const getNetworkConfig = async ({ env, fetch }) => {
+  if (!('AGORIC_NET' in env) || env.AGORIC_NET === 'local') {
+    return { rpcAddrs: ['http://0.0.0.0:26657'], chainName: 'agoriclocal' };
+  }
+
+  return fromAgoricNet(NonNullish(env.AGORIC_NET), { fetch }).catch(err => {
+    throw Error(
+      `cannot get network config (${env.AGORIC_NET || 'local'}): ${
+        err.message
+      }`,
+    );
+  });
+};