feat: altvm file submitter (#7182)

Author: troykessler

.changeset/bright-glasses-drop.md

@@ -0,0 +1,8 @@
+---
+"@hyperlane-xyz/cosmos-sdk": minor
+"@hyperlane-xyz/radix-sdk": minor
+"@hyperlane-xyz/utils": minor
+"@hyperlane-xyz/sdk": minor
+---
+
+chore: add transactionToPrintableJson to altvm interface

.changeset/red-mayflies-do.md

@@ -0,0 +1,5 @@
+---
+"@hyperlane-xyz/cli": major
+---
+
+feat: add altvm file submitter

typescript/cli/src/commands/core.ts

@@ -33,6 +33,7 @@ import {
   chainCommandOption,
   inputFileCommandOption,
   outputFileCommandOption,
+  strategyCommandOption,
 } from './options.js';
 
 /**
@@ -56,6 +57,7 @@ export const coreCommand: CommandModule = {
 export const apply: CommandModuleWithWriteContext<{
   chain: string;
   config: string;
+  strategy?: string;
 }> = {
   command: 'apply',
   describe:
@@ -70,8 +72,14 @@ export const apply: CommandModuleWithWriteContext<{
       true,
       'The path to output a Core Config JSON or YAML file.',
     ),
+    strategy: { ...strategyCommandOption, demandOption: false },
   },
-  handler: async ({ context, chain, config: configFilePath }) => {
+  handler: async ({
+    context,
+    chain,
+    config: configFilePath,
+    strategy: strategyUrl,
+  }) => {
     logCommandHeader(`Hyperlane Core Apply`);
 
     const addresses = (await context.registry.getChainAddresses(
@@ -86,6 +94,7 @@ export const apply: CommandModuleWithWriteContext<{
       chain,
       config,
       deployedCoreAddresses: addresses,
+      strategyUrl,
     });
     process.exit(0);
   },

typescript/cli/src/context/altvm.ts

@@ -16,7 +16,6 @@ import {
   SubmitterFactory,
   SubmitterMetadata,
   TxSubmitterType,
-  isJsonRpcSubmitterConfig,
 } from '@hyperlane-xyz/sdk';
 import {
   AltVM,
@@ -25,7 +24,11 @@ import {
   assert,
 } from '@hyperlane-xyz/utils';
 
-import { ExtendedChainSubmissionStrategy } from '../submitters/types.js';
+import { AltVMFileSubmitter } from '../submitters/AltVMFileSubmitter.js';
+import {
+  CustomTxSubmitterType,
+  ExtendedChainSubmissionStrategy,
+} from '../submitters/types.js';
 
 import { SignerKeyProtocolMap } from './types.js';
 
@@ -164,19 +167,16 @@ export class AltVMSignerFactory
     // was provided for our chain where we can read our private key
     if (strategyConfig[chain]) {
       const rawConfig = strategyConfig[chain]!.submitter;
-      if (!isJsonRpcSubmitterConfig(rawConfig)) {
-        throw new Error(
-          `found unknown submitter in strategy config for chain ${chain}`,
-        );
-      }
 
-      if (!rawConfig.privateKey) {
-        throw new Error(
-          `missing private key in strategy config for chain ${chain}`,
-        );
-      }
+      if (rawConfig.type === TxSubmitterType.JSON_RPC) {
+        if (!rawConfig.privateKey) {
+          throw new Error(
+            `missing private key in strategy config for chain ${chain}`,
+          );
+        }
 
-      return rawConfig.privateKey;
+        return rawConfig.privateKey;
+      }
     }
 
     // 3. Finally, if no key flag or strategy was provided we prompt the user
@@ -237,21 +237,40 @@ export class AltVMSignerFactory
     return new AltVMSignerFactory(metadataManager, signers);
   }
 
-  public submitterFactories(): ProtocolMap<Record<string, SubmitterFactory>> {
+  public submitterFactories(
+    chain: string,
+  ): ProtocolMap<Record<string, SubmitterFactory>> {
+    const protocol = this.metadataManager.getProtocol(chain);
+
     const factories: ProtocolMap<Record<string, SubmitterFactory>> = {};
 
+    if (
+      protocol === ProtocolType.Ethereum ||
+      protocol === ProtocolType.Sealevel
+    ) {
+      return factories;
+    }
+
+    const signer = this.get(chain);
+
     for (const protocol of this.getSupportedProtocols()) {
       factories[protocol] = {
         [TxSubmitterType.JSON_RPC]: (
-          multiProvider: MultiProvider,
+          _multiProvider: MultiProvider,
           metadata: SubmitterMetadata,
         ) => {
           // Used to type narrow metadata
           assert(
             metadata.type === TxSubmitterType.JSON_RPC,
             `Invalid metadata type: ${metadata.type}, expected ${TxSubmitterType.JSON_RPC}`,
           );
-          return new AltVMJsonRpcTxSubmitter(multiProvider, this, metadata);
+          return new AltVMJsonRpcTxSubmitter(signer, metadata);
+        },
+        [CustomTxSubmitterType.FILE]: (
+          _multiProvider: MultiProvider,
+          metadata: any,
+        ) => {
+          return new AltVMFileSubmitter(signer, metadata);
         },
       };
     }

typescript/cli/src/deploy/core.ts

@@ -25,6 +25,7 @@ import {
   runPreflightChecksForChains,
   validateCoreIsmCompatibility,
 } from './utils.js';
+import { getSubmitterByStrategy } from './warp.js';
 
 interface DeployParams {
   context: WriteCommandContext;
@@ -35,6 +36,7 @@ interface DeployParams {
 
 interface ApplyParams extends DeployParams {
   deployedCoreAddresses: DeployedCoreAddresses;
+  strategyUrl?: string;
 }
 
 /**
@@ -163,6 +165,12 @@ export async function runCoreApply(params: ApplyParams) {
     default: {
       const signer = context.altVmSigner.get(chain);
 
+      const { submitter } = await getSubmitterByStrategy({
+        chain,
+        context: params.context,
+        strategyUrl: params.strategyUrl,
+      });
+
       const coreModule = new AltVMCoreModule(multiProvider, signer, {
         chain,
         config,
@@ -174,13 +182,7 @@ export async function runCoreApply(params: ApplyParams) {
       if (transactions.length) {
         logGray('Updating deployed core contracts');
 
-        if (signer.supportsTransactionBatching()) {
-          await signer.sendAndConfirmBatchTransactions(transactions);
-        } else {
-          for (const tx of transactions) {
-            await signer.sendAndConfirmTransaction(tx);
-          }
-        }
+        await submitter.submit(...transactions);
 
         logGreen(`Core config updated on ${chain}.`);
       } else {

typescript/cli/src/deploy/warp.ts

@@ -1014,7 +1014,7 @@ export async function getSubmitterByStrategy<T extends ProtocolType>({
             return new EV5FileSubmitter(metadata);
           },
         },
-        ...altVmSigner.submitterFactories(),
+        ...altVmSigner.submitterFactories(chain),
       },
     }),
     config: submissionStrategy,

typescript/cli/src/submitters/AltVMFileSubmitter.ts

@@ -0,0 +1,69 @@
+import { Logger } from 'pino';
+
+import {
+  ProtocolReceipt,
+  ProtocolTransaction,
+  ProtocolTypedTransaction,
+  TxSubmitterInterface,
+  TxSubmitterType,
+} from '@hyperlane-xyz/sdk';
+import {
+  AltVM,
+  Annotated,
+  ProtocolType,
+  assert,
+  rootLogger,
+} from '@hyperlane-xyz/utils';
+
+import { readYamlOrJson, writeYamlOrJson } from '../utils/files.js';
+
+import { CustomTxSubmitterType, FileTxSubmitterProps } from './types.js';
+
+export class AltVMFileSubmitter<PT extends ProtocolType>
+  implements TxSubmitterInterface<PT>
+{
+  txSubmitterType: TxSubmitterType =
+    CustomTxSubmitterType.FILE as TxSubmitterType;
+
+  protected readonly logger: Logger;
+
+  constructor(
+    public readonly signer: AltVM.ISigner<
+      ProtocolTransaction<PT>,
+      ProtocolReceipt<PT>
+    >,
+    public readonly props: FileTxSubmitterProps,
+  ) {
+    this.logger = rootLogger.child({
+      module: AltVMFileSubmitter.name,
+    });
+  }
+
+  async submit(
+    ...txs: Annotated<ProtocolTypedTransaction<PT>['transaction']>[]
+  ): Promise<[]> {
+    const filepath = this.props.filepath.trim();
+    const allTxs = [];
+
+    // Convert raw transactions to printable ones which can later be signed
+    for (const tx of txs) {
+      allTxs.push(await this.signer.transactionToPrintableJson(tx));
+    }
+
+    // Attempt to append transactions to existing filepath.
+    try {
+      const maybeExistingTxs = readYamlOrJson(filepath); // Can throw if file is empty
+      assert(
+        Array.isArray(maybeExistingTxs),
+        `Target filepath ${filepath} has existing data, but is not an array. Overwriting.`,
+      );
+      allTxs.unshift(...maybeExistingTxs);
+    } catch (e) {
+      this.logger.debug(`Invalid transactions read from ${filepath}: ${e}`);
+    }
+
+    writeYamlOrJson(filepath, allTxs);
+    this.logger.debug(`Transactions written to ${filepath}`);
+    return [];
+  }
+}

typescript/cli/src/submitters/EV5FileSubmitter.ts

@@ -14,7 +14,7 @@ import {
 
 import { readYamlOrJson, writeYamlOrJson } from '../utils/files.js';
 
-import { CustomTxSubmitterType, EV5FileTxSubmitterProps } from './types.js';
+import { CustomTxSubmitterType, FileTxSubmitterProps } from './types.js';
 
 export class EV5FileSubmitter
   implements TxSubmitterInterface<ProtocolType.Ethereum>
@@ -24,7 +24,7 @@ export class EV5FileSubmitter
   protected readonly logger: Logger = rootLogger.child({
     module: 'file-submitter',
   });
-  constructor(public readonly props: EV5FileTxSubmitterProps) {}
+  constructor(public readonly props: FileTxSubmitterProps) {}
 
   async submit(
     ...txs: Annotated<

typescript/cli/src/submitters/types.ts

@@ -14,13 +14,14 @@ export const CustomTxSubmitterType = {
   FILE: 'file',
 } as const;
 
-export const EV5FileTxSubmitterPropsSchema = z.object({
+export const FileTxSubmitterPropsSchema = z.object({
   filepath: z.string(),
+  chain: ZChainName,
 });
 
 const FileSubmitterMetadataSchema = z.object({
   type: z.literal(CustomTxSubmitterType.FILE),
-  ...EV5FileTxSubmitterPropsSchema.shape,
+  ...FileTxSubmitterPropsSchema.shape,
 });
 
 type FileSubmitterMetadata = z.infer<typeof FileSubmitterMetadataSchema>;
@@ -52,6 +53,4 @@ export type ExtendedChainSubmissionStrategy = z.infer<
   typeof ExtendedChainSubmissionStrategySchema
 >;
 
-export type EV5FileTxSubmitterProps = z.infer<
-  typeof EV5FileTxSubmitterPropsSchema
->;
+export type FileTxSubmitterProps = z.infer<typeof FileTxSubmitterPropsSchema>;

typescript/cli/src/utils/balances.ts

@@ -72,7 +72,10 @@ export async function nativeBalancesAreSufficient(
           nativeToken.denom,
           `nativeToken denom is not defined on chain ${chain}`,
         );
-        assert(gasPrice, `gasPrice is not defined on chain ${chain}`);
+
+        if (!gasPrice) {
+          return;
+        }
 
         const ALT_VM_GAS = altVmSigner.getMinGas(protocol);
         requiredMinBalanceNativeDenom = BigNumber.from(