chore: altvm interface additions (#7300)

Author: troykessler

.changeset/pink-beds-act.md

@@ -0,0 +1,9 @@
+---
+"@hyperlane-xyz/cosmos-sdk": minor
+"@hyperlane-xyz/radix-sdk": minor
+"@hyperlane-xyz/utils": minor
+"@hyperlane-xyz/cli": minor
+"@hyperlane-xyz/sdk": minor
+---
+
+add new methods for altvm interface

typescript/cli/src/context/altvm.ts

@@ -203,20 +203,10 @@ export class AltVMSignerFactory
     for (const chain of chains) {
       const metadata = metadataManager.getChainMetadata(chain);
 
-      if (metadata.protocol === ProtocolType.Ethereum) {
-        continue;
-      }
-
-      if (metadata.protocol === ProtocolType.Sealevel) {
-        continue;
-      }
-
       const protocol = ALT_VM_SUPPORTED_PROTOCOLS[metadata.protocol];
 
       if (!protocol) {
-        throw new Error(
-          `Chain ${chain} with protocol type ${metadata.protocol} not supported in AltVM`,
-        );
+        continue;
       }
 
       const privateKey = await AltVMSignerFactory.loadPrivateKey(
@@ -245,10 +235,7 @@ export class AltVMSignerFactory
 
     const factories: ProtocolMap<Record<string, SubmitterFactory>> = {};
 
-    if (
-      protocol === ProtocolType.Ethereum ||
-      protocol === ProtocolType.Sealevel
-    ) {
+    if (!ALT_VM_SUPPORTED_PROTOCOLS[protocol]) {
       return factories;
     }
 

typescript/cosmos-sdk/src/clients/provider.ts

@@ -36,6 +36,7 @@ import {
 import {
   MsgCreateIgpEncodeObject,
   MsgCreateMerkleTreeHookEncodeObject,
+  MsgCreateNoopHookEncodeObject,
   MsgSetDestinationGasConfigEncodeObject,
   MsgSetIgpOwnerEncodeObject,
 } from '../hyperlane/post_dispatch/messages.js';
@@ -65,6 +66,9 @@ export class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
   private readonly cometClient: CometClient;
   private readonly rpcUrls: string[];
 
+  private static NULL_ADDRESS =
+    '0x0000000000000000000000000000000000000000000000000000000000000000';
+
   static async connect(
     rpcUrls: string[],
     _chainId: string | number,
@@ -113,11 +117,15 @@ export class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
   }
 
   async getBalance(req: AltVM.ReqGetBalance): Promise<bigint> {
+    assert(req.denom, `denom required by ${CosmosNativeProvider.name}`);
+
     const coin = await this.query.bank.balance(req.address, req.denom);
     return BigInt(coin.amount);
   }
 
   async getTotalSupply(req: AltVM.ReqGetTotalSupply): Promise<bigint> {
+    assert(req.denom, `denom required by ${CosmosNativeProvider.name}`);
+
     const coin = await this.query.bank.supplyOf(req.denom);
     return BigInt(coin.amount);
   }
@@ -174,6 +182,10 @@ export class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
     });
     assert(mailbox, `found no mailbox for id ${req.mailboxAddress}`);
 
+    if (mailbox.default_ism === CosmosNativeProvider.NULL_ADDRESS) {
+      mailbox.default_ism = '';
+    }
+
     return {
       address: mailbox.id,
       owner: mailbox.owner,
@@ -353,6 +365,17 @@ export class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
     };
   }
 
+  async getNoopHook(req: AltVM.ReqGetNoopHook): Promise<AltVM.ResGetNoopHook> {
+    const { noop_hook } = await this.query.postDispatch.NoopHook({
+      id: req.hookAddress,
+    });
+    assert(noop_hook, `found no noop hook for id ${req.hookAddress}`);
+
+    return {
+      address: noop_hook.id,
+    };
+  }
+
   // ### QUERY WARP ###
 
   async getToken(req: AltVM.ReqGetToken): Promise<AltVM.ResGetToken> {
@@ -447,7 +470,6 @@ export class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
       typeUrl: R.MsgCreateMailbox.proto.type,
       value: R.MsgCreateMailbox.proto.converter.create({
         local_domain: req.domainId,
-        default_ism: req.defaultIsmAddress,
         owner: req.signer,
       }),
     };
@@ -660,16 +682,41 @@ export class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
     };
   }
 
+  async getRemoveDestinationGasConfigTransaction(
+    _req: AltVM.ReqRemoveDestinationGasConfig,
+  ): Promise<EncodeObject> {
+    throw new Error(
+      `RemoveDestinationGasConfig is currently not supported on Cosmos Native`,
+    );
+  }
+
+  async getCreateNoopHookTransaction(
+    req: AltVM.ReqCreateNoopHook,
+  ): Promise<MsgCreateNoopHookEncodeObject> {
+    return {
+      typeUrl: R.MsgCreateNoopHook.proto.type,
+      value: R.MsgCreateNoopHook.proto.converter.create({
+        owner: req.signer,
+      }),
+    };
+  }
+
   async getCreateValidatorAnnounceTransaction(
     _req: AltVM.ReqCreateValidatorAnnounce,
-  ): Promise<any> {
+  ): Promise<EncodeObject> {
     throw new Error(
       'Cosmos Native does not support populateCreateValidatorAnnounce',
     );
   }
 
   // ### GET WARP TXS ###
 
+  async getCreateNativeTokenTransaction(
+    _req: AltVM.ReqCreateNativeToken,
+  ): Promise<EncodeObject> {
+    throw new Error(`Native Token is not supported on Cosmos Native`);
+  }
+
   async getCreateCollateralTokenTransaction(
     req: AltVM.ReqCreateCollateralToken,
   ): Promise<MsgCreateCollateralTokenEncodeObject> {
@@ -755,6 +802,8 @@ export class CosmosNativeProvider implements AltVM.IProvider<EncodeObject> {
   async getTransferTransaction(
     req: AltVM.ReqTransfer,
   ): Promise<MsgSendEncodeObject> {
+    assert(req.denom, `denom required by ${CosmosNativeProvider.name}`);
+
     return {
       typeUrl: '/cosmos.bank.v1beta1.MsgSend',
       value: {

typescript/cosmos-sdk/src/clients/signer.ts

@@ -385,6 +385,8 @@ export class CosmosNativeSigner
   async createInterchainGasPaymasterHook(
     req: Omit<AltVM.ReqCreateInterchainGasPaymasterHook, 'signer'>,
   ): Promise<AltVM.ResCreateInterchainGasPaymasterHook> {
+    assert(req.denom, `denom required by ${CosmosNativeSigner.name}`);
+
     const msg = await this.getCreateInterchainGasPaymasterHookTransaction({
       ...req,
       signer: this.account.address,
@@ -424,6 +426,28 @@ export class CosmosNativeSigner
     };
   }
 
+  async removeDestinationGasConfig(
+    _req: Omit<AltVM.ReqRemoveDestinationGasConfig, 'signer'>,
+  ): Promise<AltVM.ResRemoveDestinationGasConfig> {
+    throw new Error(
+      `RemoveDestinationGasConfig is currently not supported on Cosmos Native`,
+    );
+  }
+
+  async createNoopHook(
+    req: Omit<AltVM.ReqCreateNoopHook, 'signer'>,
+  ): Promise<AltVM.ResCreateNoopHook> {
+    const msg = await this.getCreateNoopHookTransaction({
+      ...req,
+      signer: this.account.address,
+    });
+
+    const result = await this.submitTx(msg);
+    return {
+      hookAddress: result.id,
+    };
+  }
+
   async createValidatorAnnounce(
     _req: Omit<AltVM.ReqCreateValidatorAnnounce, 'signer'>,
   ): Promise<AltVM.ResCreateValidatorAnnounce> {
@@ -433,6 +457,12 @@ export class CosmosNativeSigner
 
   // ### TX WARP ###
 
+  async createNativeToken(
+    _req: Omit<AltVM.ReqCreateNativeToken, 'signer'>,
+  ): Promise<AltVM.ResCreateNativeToken> {
+    throw new Error(`Native Token is not supported on Cosmos Native`);
+  }
+
   async createCollateralToken(
     req: Omit<AltVM.ReqCreateCollateralToken, 'signer'>,
   ): Promise<AltVM.ResCreateCollateralToken> {
@@ -520,6 +550,8 @@ export class CosmosNativeSigner
   async transfer(
     req: Omit<AltVM.ReqTransfer, 'signer'>,
   ): Promise<AltVM.ResTransfer> {
+    assert(req.denom, `denom required by ${CosmosNativeSigner.name}`);
+
     const msg = await this.getTransferTransaction({
       ...req,
       signer: this.account.address,

typescript/cosmos-sdk/src/tests/2_core.e2e-test.ts

@@ -22,14 +22,11 @@ describe('2. cosmos sdk core e2e tests', async function () {
 
   step('create new mailbox', async () => {
     // ARRANGE
-    const { ismAddress } = await signer.createNoopIsm({});
-
     const domainId = 1234;
 
     // ACT
     const txResponse = await signer.createMailbox({
       domainId: domainId,
-      defaultIsmAddress: ismAddress,
     });
 
     // ASSERT
@@ -45,20 +42,17 @@ describe('2. cosmos sdk core e2e tests', async function () {
     expect(mailbox.address).to.equal(txResponse.mailboxAddress);
     expect(mailbox.owner).to.equal(signer.getSignerAddress());
     expect(mailbox.localDomain).to.equal(domainId);
-    expect(mailbox.defaultIsm).to.equal(ismAddress);
+    expect(mailbox.defaultIsm).to.be.empty;
     expect(mailbox.defaultHook).to.be.empty;
     expect(mailbox.requiredHook).to.be.empty;
   });
 
   step('set mailbox owner', async () => {
     // ARRANGE
-    const { ismAddress } = await signer.createNoopIsm({});
-
     const domainId = 1234;
 
     const { mailboxAddress } = await signer.createMailbox({
       domainId: domainId,
-      defaultIsmAddress: ismAddress,
     });
 
     let mailbox = await signer.getMailbox({ mailboxAddress });
@@ -77,15 +71,36 @@ describe('2. cosmos sdk core e2e tests', async function () {
     expect(mailbox.owner).to.equal(bobSigner.getSignerAddress());
   });
 
-  step('set mailbox default hook', async () => {
+  step('set mailbox default ism', async () => {
     // ARRANGE
     const { ismAddress } = await signer.createNoopIsm({});
 
     const domainId = 1234;
 
     const { mailboxAddress } = await signer.createMailbox({
       domainId: domainId,
-      defaultIsmAddress: ismAddress,
+    });
+
+    let mailbox = await signer.getMailbox({ mailboxAddress });
+    expect(mailbox.defaultIsm).to.be.empty;
+
+    // ACT
+    await signer.setDefaultIsm({
+      mailboxAddress,
+      ismAddress,
+    });
+
+    // ASSERT
+    mailbox = await signer.getMailbox({ mailboxAddress });
+    expect(mailbox.defaultIsm).to.equal(ismAddress);
+  });
+
+  step('set mailbox default hook', async () => {
+    // ARRANGE
+    const domainId = 1234;
+
+    const { mailboxAddress } = await signer.createMailbox({
+      domainId: domainId,
     });
 
     const { hookAddress } = await signer.createMerkleTreeHook({
@@ -108,13 +123,10 @@ describe('2. cosmos sdk core e2e tests', async function () {
 
   step('set mailbox required hook', async () => {
     // ARRANGE
-    const { ismAddress } = await signer.createNoopIsm({});
-
     const domainId = 1234;
 
     const { mailboxAddress } = await signer.createMailbox({
       domainId: domainId,
-      defaultIsmAddress: ismAddress,
     });
 
     const { hookAddress } = await signer.createMerkleTreeHook({

typescript/cosmos-sdk/src/tests/3_post_dispatch.e2e-test.ts

@@ -44,13 +44,10 @@ describe('3. cosmos sdk post dispatch e2e tests', async function () {
 
   step('create new Merkle Tree hook', async () => {
     // ARRANGE
-    const { ismAddress } = await signer.createNoopIsm({});
-
     const domainId = 1234;
 
     const { mailboxAddress } = await signer.createMailbox({
       domainId: domainId,
-      defaultIsmAddress: ismAddress,
     });
 
     // ACT