Merge pull request #119 from Agoric/ta/cosmic-proto

adopt cosmic-proto types

Author: turadg

packages/synthetic-chain/package.json

@@ -2,9 +2,7 @@
   "name": "@agoric/synthetic-chain",
   "version": "0.1.0",
   "description": "Utilities to build a chain and test proposals atop it",
-  "bin": {
-    "synthetic-chain": "dist/cli/cli.js"
-  },
+  "bin": "dist/cli/cli.js",
   "main": "./dist/lib/index.js",
   "type": "module",
   "module": "./dist/lib/index.js",
@@ -25,9 +23,11 @@
     "@endo/zip": "^1.0.1",
     "better-sqlite3": "^9.4.0",
     "chalk": "^5.3.0",
+    "cosmjs-types": "^0.9.0",
     "execa": "^8.0.1"
   },
   "devDependencies": {
+    "@agoric/cosmic-proto": "^0.4.1-dev-c5284e4.0",
     "@types/better-sqlite3": "^7.6.9",
     "@types/node": "^18.19.14",
     "ava": "^5.3.1",

packages/synthetic-chain/src/cli/dockerfileGen.ts

@@ -1,14 +1,14 @@
 import fs from 'node:fs';
+import { Platform } from './build.js';
 import {
-  type CoreEvalProposal,
-  type ProposalInfo,
-  type SoftwareUpgradeProposal,
   encodeUpgradeInfo,
   imageNameForProposal,
   isPassed,
-  ParameterChangeProposal,
+  type CoreEvalPackage,
+  type ParameterChangePackage,
+  type ProposalInfo,
+  type SoftwareUpgradePackage,
 } from './proposals.js';
-import { Platform } from './build.js';
 
 /**
  * Templates for Dockerfile stages
@@ -58,7 +58,7 @@ FROM ghcr.io/agoric/agoric-3-proposals:${fromTag} as use-${fromTag}
       proposalName,
       upgradeInfo,
       releaseNotes,
-    }: SoftwareUpgradeProposal,
+    }: SoftwareUpgradePackage,
     lastProposal: ProposalInfo,
   ) {
     const skipProposalValidation = !releaseNotes;
@@ -89,7 +89,7 @@ RUN ./run_prepare.sh ${path}
     planName,
     proposalName,
     sdkImageTag,
-  }: SoftwareUpgradeProposal) {
+  }: SoftwareUpgradePackage) {
     return `
 # EXECUTE ${proposalName}
 FROM ghcr.io/agoric/agoric-sdk:${sdkImageTag} as execute-${proposalName}
@@ -112,7 +112,7 @@ RUN ./run_execute.sh ${planName}
    * - Run the core-eval scripts from the proposal. They are only guaranteed to have started, not completed.
    */
   EVAL(
-    { path, proposalName }: CoreEvalProposal | ParameterChangeProposal,
+    { path, proposalName }: CoreEvalPackage | ParameterChangePackage,
     lastProposal: ProposalInfo,
   ) {
     return `

packages/synthetic-chain/src/cli/proposals.ts

@@ -10,7 +10,7 @@ type ProposalCommon = {
   proposalIdentifier: string;
 };
 
-export type SoftwareUpgradeProposal = ProposalCommon & {
+export type SoftwareUpgradePackage = ProposalCommon & {
   sdkImageTag: string;
   planName: string;
   upgradeInfo?: unknown;
@@ -22,7 +22,7 @@ export type SoftwareUpgradeProposal = ProposalCommon & {
   type: 'Software Upgrade Proposal';
 };
 
-export type CoreEvalProposal = ProposalCommon & {
+export type CoreEvalPackage = ProposalCommon & {
   type: '/agoric.swingset.CoreEvalProposal';
 } & (
     | { source: 'build'; buildScript: string }
@@ -32,14 +32,14 @@ export type CoreEvalProposal = ProposalCommon & {
       }
   );
 
-export type ParameterChangeProposal = ProposalCommon & {
+export type ParameterChangePackage = ProposalCommon & {
   type: '/cosmos.params.v1beta1.ParameterChangeProposal';
 };
 
 export type ProposalInfo =
-  | SoftwareUpgradeProposal
-  | CoreEvalProposal
-  | ParameterChangeProposal;
+  | SoftwareUpgradePackage
+  | CoreEvalPackage
+  | ParameterChangePackage;
 
 function readInfo(proposalPath: string): ProposalInfo {
   assert(

packages/synthetic-chain/src/lib/cliHelper.js renamed to packages/synthetic-chain/src/lib/cliHelper.ts

@@ -1,7 +1,11 @@
 import { $, execaCommand } from 'execa';
 import { BINARY } from './constants.js';
 
-export const executeCommand = async (command, params, options = {}) => {
+export const executeCommand = async (
+  command: string,
+  params: string[],
+  options = {},
+) => {
   const { stdout } = await execaCommand(
     `${command} ${params.join(' ')}`,
     options,
@@ -10,12 +14,12 @@ export const executeCommand = async (command, params, options = {}) => {
 };
 
 export const agd = {
-  query: async (...params) => {
+  query: async (...params: string[]) => {
     const newParams = ['query', ...params, '-o json'];
     const data = await executeCommand(BINARY, newParams);
     return JSON.parse(data);
   },
-  tx: async (...params) => {
+  tx: async (...params: string[]) => {
     const newParams = [
       'tx',
       '-bblock',
@@ -27,7 +31,7 @@ export const agd = {
     const data = await executeCommand(BINARY, newParams, { shell: true });
     return JSON.parse(data);
   },
-  keys: async (...params) => {
+  keys: async (...params: string[]) => {
     let newParams = ['keys', ...params];
     let shouldParse = true;
 
@@ -48,15 +52,15 @@ export const agd = {
 
     return JSON.parse(data);
   },
-  export: async (...params) => {
+  export: async (...params: string[]) => {
     const newParams = ['export', ...params];
     const data = await executeCommand(BINARY, newParams);
     return JSON.parse(data);
   },
 };
 
 export const agoric = {
-  follow: async (...params) => {
+  follow: async (...params: string[]) => {
     let newParams = ['follow', ...params];
     let parseJson = false;
 
@@ -72,11 +76,11 @@ export const agoric = {
 
     return data;
   },
-  wallet: async (...params) => {
+  wallet: async (...params: string[]) => {
     const newParams = ['wallet', ...params];
     return executeCommand('agoric', newParams);
   },
-  run: async (...params) => {
+  run: async (...params: string[]) => {
     const newParams = ['run', ...params];
     return executeCommand('agoric', newParams);
   },
@@ -88,7 +92,7 @@ export const { stdout: agopsLocation } = await $({
 })`yarn bin agops`;
 
 export const agops = {
-  vaults: async (...params) => {
+  vaults: async (...params: string[]) => {
     const newParams = ['vaults', ...params];
 
     const result = await executeCommand(agopsLocation, newParams);
@@ -101,19 +105,19 @@ export const agops = {
 
     return result;
   },
-  ec: async (...params) => {
+  ec: async (...params: string[]) => {
     const newParams = ['ec', ...params];
     return executeCommand(agopsLocation, newParams);
   },
-  oracle: async (...params) => {
+  oracle: async (...params: string[]) => {
     const newParams = ['oracle', ...params];
     return executeCommand(agopsLocation, newParams);
   },
-  perf: async (...params) => {
+  perf: async (...params: string[]) => {
     const newParams = ['perf', ...params];
     return executeCommand(agopsLocation, newParams);
   },
-  auctioneer: async (...params) => {
+  auctioneer: async (...params: string[]) => {
     const newParams = ['auctioneer', ...params];
     return executeCommand(agopsLocation, newParams);
   },
@@ -125,23 +129,23 @@ export const { stdout: bundleSourceLocation } = await $({
 })`yarn bin bundle-source`;
 
 /**
- * @param {string} filePath
- * @param {string} bundleName
- * @returns {Promise<string>} Returns the filepath of the bundle
+ * @returns Returns the filepath of the bundle
  */
-export const bundleSource = async (filePath, bundleName) => {
+export const bundleSource = async (filePath: string, bundleName: string) => {
   const output =
     await $`${bundleSourceLocation} --cache-json /tmp ${filePath} ${bundleName}`;
   console.log(output.stderr);
   return `/tmp/bundle-${bundleName}.json`;
 };
 
 export const wellKnownIdentities = async (io = {}) => {
+  // @ts-expect-error
   const { agoric: { follow = agoric.follow } = {} } = io;
-  const zip = (xs, ys) => xs.map((x, i) => [x, ys[i]]);
-  const fromSmallCapsEntries = txt => {
+  const zip = (xs: unknown[], ys: unknown[]) => xs.map((x, i) => [x, ys[i]]);
+  const fromSmallCapsEntries = (txt: string) => {
     const { body, slots } = JSON.parse(txt);
     const theEntries = zip(JSON.parse(body.slice(1)), slots).map(
+      // @ts-expect-error
       ([[name, ref], boardID]) => {
         const iface = ref.replace(/^\$\d+\./, '');
         return [name, { iface, boardID }];
@@ -166,11 +170,11 @@ export const wellKnownIdentities = async (io = {}) => {
 };
 
 export const smallCapsContext = () => {
-  const slots = []; // XXX global mutable state
+  const slots = [] as string[]; // XXX global mutable state
   const smallCaps = {
-    Nat: n => `+${n}`,
+    Nat: (n: number | bigint) => `+${n}`,
     // XXX mutates obj
-    ref: obj => {
+    ref: (obj: any) => {
       if (obj.ix) return obj.ix;
       const ix = slots.length;
       slots.push(obj.boardID);
@@ -179,7 +183,7 @@ export const smallCapsContext = () => {
     },
   };
 
-  const toCapData = body => {
+  const toCapData = (body: unknown) => {
     const capData = { body: `#${JSON.stringify(body)}`, slots };
     return JSON.stringify(capData);
   };