Finish migrating warp UI utils + adapters to SDK (#2711)

### Description - Build on #2684, migrates the EvmAdapter and missing utils from the warp UI - Remove the token App as it's unused and redundant with adapters - Add IGP serialization code for #2546 - Simplify multi-protocol adapters in SDK - Make token adapters extend base adapters - Move token serialization code to token package ### Drive-by changes - Update Sepolia RPC which was causing errors ### Related issues #2652 ### Backward compatibility Yes ### Testing Tested these in warp UI --------- Co-authored-by: Yorke Rhodes <[email protected]>
hyperlane-xyz · Sep 13, 2023 · 7a5dce2 · 7a5dce2
1 parent 35fdc74
commit 7a5dce2
Show file tree

Hide file tree

Showing 40 changed files with 1,108 additions and 674 deletions.
diff --git a/typescript/helloworld/src/multiProtocolApp/evmAdapter.ts b/typescript/helloworld/src/multiProtocolApp/evmAdapter.ts
@@ -2,8 +2,8 @@ import {
   ChainName,
   EthersV5Transaction,
   EvmRouterAdapter,
+  MultiProtocolProvider,
   ProviderType,
-  RouterAddress,
 } from '@hyperlane-xyz/sdk';
 import { Address } from '@hyperlane-xyz/utils';
 
@@ -13,19 +13,27 @@ import { HelloWorld, HelloWorld__factory } from '../types';
 import { IHelloWorldAdapter } from './types';
 
 export class EvmHelloWorldAdapter
-  extends EvmRouterAdapter<RouterAddress & { mailbox: Address }>
+  extends EvmRouterAdapter
   implements IHelloWorldAdapter
 {
+  constructor(
+    public readonly chainName: ChainName,
+    public readonly multiProvider: MultiProtocolProvider,
+    public readonly addresses: { router: Address; mailbox: Address },
+  ) {
+    super(chainName, multiProvider, addresses);
+  }
+
   async populateSendHelloTx(
-    origin: ChainName,
     destination: ChainName,
     message: string,
     value: string,
   ): Promise<EthersV5Transaction> {
-    const contract = this.getConnectedContract(origin);
+    const contract = this.getConnectedContract();
     const toDomain = this.multiProvider.getDomainId(destination);
-    const { transactionOverrides } =
-      this.multiProvider.getChainMetadata(origin);
+    const { transactionOverrides } = this.multiProvider.getChainMetadata(
+      this.chainName,
+    );
 
     // apply gas buffer due to https://github.com/hyperlane-xyz/hyperlane-monorepo/issues/634
     const estimated = await contract.estimateGas.sendHelloWorld(
@@ -48,23 +56,27 @@ export class EvmHelloWorldAdapter
   }
 
   async channelStats(
-    origin: ChainName,
     destination: ChainName,
+    destinationMailbox: Address,
   ): Promise<StatCounts> {
-    const originDomain = this.multiProvider.getDomainId(origin);
+    const originDomain = this.multiProvider.getDomainId(this.chainName);
     const destinationDomain = this.multiProvider.getDomainId(destination);
-    const sent = await this.getConnectedContract(origin).sentTo(
-      destinationDomain,
-    );
-    const received = await this.getConnectedContract(destination).sentTo(
-      originDomain,
+    const originContract = this.getConnectedContract();
+    const sent = await originContract.sentTo(destinationDomain);
+    const destinationProvider =
+      this.multiProvider.getEthersV5Provider(destination);
+    const destinationContract = HelloWorld__factory.connect(
+      destinationMailbox,
+      destinationProvider,
     );
+    const received = await destinationContract.sentTo(originDomain);
     return { sent: sent.toNumber(), received: received.toNumber() };
   }
 
-  override getConnectedContract(chain: ChainName): HelloWorld {
-    const address = this.multiProvider.getChainMetadata(chain).router;
-    const provider = this.multiProvider.getEthersV5Provider(chain);
-    return HelloWorld__factory.connect(address, provider);
+  override getConnectedContract(): HelloWorld {
+    return HelloWorld__factory.connect(
+      this.addresses.router,
+      this.getProvider(),
+    );
   }
 }
diff --git a/typescript/helloworld/src/multiProtocolApp/multiProtocolApp.ts b/typescript/helloworld/src/multiProtocolApp/multiProtocolApp.ts
@@ -14,8 +14,8 @@ import { SealevelHelloWorldAdapter } from './sealevelAdapter';
 import { IHelloWorldAdapter } from './types';
 
 export class HelloMultiProtocolApp extends MultiProtocolRouterApp<
-  RouterAddress & { mailbox: Address },
-  IHelloWorldAdapter
+  IHelloWorldAdapter,
+  RouterAddress & { mailbox: Address }
 > {
   override protocolToAdapter(protocol: ProtocolType) {
     if (protocol === ProtocolType.Ethereum) return EvmHelloWorldAdapter;
@@ -31,7 +31,6 @@ export class HelloMultiProtocolApp extends MultiProtocolRouterApp<
     sender: Address,
   ): Promise<TypedTransaction> {
     return this.adapter(origin).populateSendHelloTx(
-      origin,
       destination,
       message,
       value,
@@ -40,7 +39,10 @@ export class HelloMultiProtocolApp extends MultiProtocolRouterApp<
   }
 
   channelStats(origin: ChainName, destination: ChainName): Promise<StatCounts> {
-    return this.adapter(origin).channelStats(origin, destination);
+    return this.adapter(origin).channelStats(
+      destination,
+      this.addresses[destination].mailbox,
+    );
   }
 
   async stats(): Promise<ChainMap<ChainMap<StatCounts>>> {

diff --git a/typescript/helloworld/src/multiProtocolApp/sealevelAdapter.ts b/typescript/helloworld/src/multiProtocolApp/sealevelAdapter.ts
@@ -9,14 +9,15 @@ import {
 import { deserializeUnchecked, serialize } from 'borsh';
 
 import {
-  BaseSealevelAdapter,
   ChainName,
+  MultiProtocolProvider,
   ProviderType,
-  RouterAddress,
   SEALEVEL_SPL_NOOP_ADDRESS,
   SealevelAccountDataWrapper,
   SealevelCoreAdapter,
   SealevelInstructionWrapper,
+  SealevelInterchainGasPaymasterConfig,
+  SealevelInterchainGasPaymasterConfigSchema,
   SealevelRouterAdapter,
   SolanaWeb3Transaction,
   getSealevelAccountDataSchema,
@@ -28,26 +29,32 @@ import { StatCounts } from '../app/types';
 import { IHelloWorldAdapter } from './types';
 
 export class SealevelHelloWorldAdapter
-  extends SealevelRouterAdapter<RouterAddress & { mailbox: Address }>
+  extends SealevelRouterAdapter
   implements IHelloWorldAdapter
 {
+  constructor(
+    public readonly chainName: ChainName,
+    public readonly multiProvider: MultiProtocolProvider,
+    public readonly addresses: { router: Address; mailbox: Address },
+  ) {
+    super(chainName, multiProvider, addresses);
+  }
+
   async populateSendHelloTx(
-    origin: ChainName,
     destination: ChainName,
     message: string,
     value: string,
     sender: Address,
   ): Promise<SolanaWeb3Transaction> {
     this.logger(
       'Creating sendHelloWorld tx for sealevel',
-      origin,
+      this.chainName,
       destination,
       message,
       value,
     );
 
-    const { mailbox, router: programId } =
-      this.multiProvider.getChainMetadata(origin);
+    const { mailbox, router: programId } = this.addresses;
     const mailboxPubKey = new PublicKey(mailbox);
     const senderPubKey = new PublicKey(sender);
     const programPubKey = new PublicKey(programId);
@@ -75,7 +82,7 @@ export class SealevelHelloWorldAdapter
       data: Buffer.from(serializedData),
     });
 
-    const connection = this.multiProvider.getSolanaWeb3Provider(origin);
+    const connection = this.getProvider();
     const recentBlockhash = (await connection.getLatestBlockhash('finalized'))
       .blockhash;
     // @ts-ignore Workaround for bug in the web3 lib, sometimes uses recentBlockhash and sometimes uses blockhash
@@ -151,23 +158,20 @@ export class SealevelHelloWorldAdapter
 
   // Should match https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/dd7ff727b0d3d393a159afa5f0a364775bde3a58/rust/sealevel/programs/helloworld/src/processor.rs#L44
   deriveProgramStoragePDA(programId: string | PublicKey): PublicKey {
-    return BaseSealevelAdapter.derivePda(
+    return this.derivePda(
       ['hello_world', '-', 'handle', '-', 'storage'],
       programId,
     );
   }
 
-  async channelStats(
-    origin: ChainName,
-    _destination: ChainName,
-  ): Promise<StatCounts> {
-    const data = await this.getAccountInfo(origin);
+  async channelStats(_destination: ChainName): Promise<StatCounts> {
+    const data = await this.getAccountInfo();
     return { sent: data.sent, received: data.received };
   }
 
-  async getAccountInfo(chain: ChainName): Promise<HelloWorldData> {
-    const address = this.multiProvider.getChainMetadata(chain).router;
-    const connection = this.multiProvider.getSolanaWeb3Provider(chain);
+  async getAccountInfo(): Promise<HelloWorldData> {
+    const address = this.addresses.router;
+    const connection = this.getProvider();
 
     const msgRecipientPda = this.deriveMessageRecipientPda(address);
     const accountInfo = await connection.getAccountInfo(msgRecipientPda);
@@ -290,14 +294,7 @@ export const HelloWorldDataSchema = new Map<any, any>([
           'igp',
           {
             kind: 'option',
-            type: {
-              kind: 'struct',
-              fields: [
-                ['program_id', [32]],
-                ['type', 'u8'],
-                ['igp_account', [32]],
-              ],
-            },
+            type: SealevelInterchainGasPaymasterConfig,
           },
         ],
         ['owner', { kind: 'option', type: [32] }],
@@ -309,4 +306,8 @@ export const HelloWorldDataSchema = new Map<any, any>([
       ],
     },
   ],
+  [
+    SealevelInterchainGasPaymasterConfig,
+    SealevelInterchainGasPaymasterConfigSchema,
+  ],
 ]);
diff --git a/typescript/helloworld/src/multiProtocolApp/types.ts b/typescript/helloworld/src/multiProtocolApp/types.ts
@@ -1,25 +1,24 @@
 import {
   ChainName,
   IRouterAdapter,
-  RouterAddress,
   TypedTransaction,
 } from '@hyperlane-xyz/sdk';
 import { Address } from '@hyperlane-xyz/utils';
 
 import { StatCounts } from '../app/types';
 
-export interface IHelloWorldAdapter
-  extends IRouterAdapter<RouterAddress & { mailbox: Address }> {
+export interface IHelloWorldAdapter extends IRouterAdapter {
   populateSendHelloTx: (
-    origin: ChainName,
     destination: ChainName,
     message: string,
     value: string,
     sender: Address,
   ) => Promise<TypedTransaction>;
 
+  // TODO break apart into separate origin + destination methods to
+  // handle case where origin/dest protocols differ
   channelStats: (
-    origin: ChainName,
     destination: ChainName,
+    destinationMailbox: Address,
   ) => Promise<StatCounts>;
 }
diff --git a/typescript/infra/scripts/helloworld/utils.ts b/typescript/infra/scripts/helloworld/utils.ts
@@ -17,7 +17,7 @@ import {
   igpFactories,
 } from '@hyperlane-xyz/sdk';
 import { hyperlaneEnvironmentsWithSealevel } from '@hyperlane-xyz/sdk/src';
-import { ProtocolType } from '@hyperlane-xyz/utils';
+import { ProtocolType, objMerge } from '@hyperlane-xyz/utils';
 
 import { Contexts } from '../../config/contexts';
 import { EnvironmentConfig } from '../../src/config';
@@ -74,20 +74,20 @@ export async function getHelloWorldMultiProtocolApp(
   if (!multiProtocolProvider.getKnownChainNames().includes('solanadevnet')) {
     multiProtocolProvider.addChain(chainMetadata.solanadevnet);
   }
-  // Add the helloWorld contract addresses to the metadata
-  const mpWithHelloWorld = multiProtocolProvider.extendChainMetadata(
-    helloworldConfig.addresses,
-  );
 
   const core = MultiProtocolCore.fromAddressesMap(
     hyperlaneEnvironmentsWithSealevel[sdkEnvName],
     multiProtocolProvider,
   );
 
-  // Extend the MP with mailbox addresses because the sealevel
-  // adapter needs that to function
-  const mpWithMailbox = mpWithHelloWorld.extendChainMetadata(core.chainMap);
-  const app = new HelloMultiProtocolApp(mpWithMailbox);
+  const routersAndMailboxes = objMerge(
+    core.chainMap,
+    helloworldConfig.addresses,
+  );
+  const app = new HelloMultiProtocolApp(
+    multiProtocolProvider,
+    routersAndMailboxes,
+  );
 
   // TODO we need a MultiProtocolIgp
   // Using an standard IGP for just evm chains for now

diff --git a/typescript/infra/scripts/warp-routes/monitor-warp-routes-balances.ts b/typescript/infra/scripts/warp-routes/monitor-warp-routes-balances.ts
@@ -1,4 +1,4 @@
-import { Connection } from '@solana/web3.js';
+import { SystemProgram } from '@solana/web3.js';
 import { ethers } from 'ethers';
 import { Gauge, Registry } from 'prom-client';
 import yargs from 'yargs';
@@ -8,7 +8,12 @@ import {
   SealevelHypCollateralAdapter,
   TokenType,
 } from '@hyperlane-xyz/hyperlane-token';
-import { ChainMap, ChainName, MultiProvider } from '@hyperlane-xyz/sdk';
+import {
+  ChainMap,
+  ChainName,
+  MultiProtocolProvider,
+  MultiProvider,
+} from '@hyperlane-xyz/sdk';
 import {
   ProtocolType,
   debug,
@@ -92,11 +97,15 @@ async function checkBalance(
             ethers.utils.formatUnits(collateralBalance, token.decimals),
           );
         } else {
-          const connection = new Connection(multiprovider.getRpcUrl(chain));
           const adapter = new SealevelHypCollateralAdapter(
-            connection,
-            token.hypCollateralAddress,
-            token.address,
+            chain,
+            MultiProtocolProvider.fromMultiProvider(multiprovider),
+            {
+              token: token.address,
+              warpRouter: token.hypCollateralAddress,
+              // Mailbox only required for transfers, using system as placeholder
+              mailbox: SystemProgram.programId.toBase58(),
+            },
             token.isSpl2022,
           );
           const collateralBalance = ethers.BigNumber.from(

diff --git a/typescript/sdk/src/app/MultiProtocolApp.test.ts b/typescript/sdk/src/app/MultiProtocolApp.test.ts
@@ -6,12 +6,13 @@ import { Chains } from '../consts/chains';
 import { MultiProtocolProvider } from '../providers/MultiProtocolProvider';
 
 import {
+  BaseAppAdapter,
   BaseEvmAdapter,
   BaseSealevelAdapter,
   MultiProtocolApp,
 } from './MultiProtocolApp';
 
-class TestMultiProtocolApp extends MultiProtocolApp {
+class TestMultiProtocolApp extends MultiProtocolApp<BaseAppAdapter> {
   override protocolToAdapter(protocol: ProtocolType) {
     if (protocol === ProtocolType.Ethereum) return BaseEvmAdapter;
     if (protocol === ProtocolType.Sealevel) return BaseSealevelAdapter;
@@ -23,9 +24,11 @@ describe('MultiProtocolApp', () => {
   describe('constructs', () => {
     const multiProvider = new MultiProtocolProvider();
     it('creates an app class and gleans types from generic', async () => {
-      const app = new TestMultiProtocolApp(multiProvider);
+      const app = new TestMultiProtocolApp(multiProvider, {});
       expect(app).to.be.instanceOf(MultiProtocolApp);
-      expect(app.adapter(Chains.ethereum).protocol).to.eql(Chains.ethereum);
+      expect(app.adapter(Chains.ethereum).protocol).to.eql(
+        ProtocolType.Ethereum,
+      );
     });
   });
 });