Add solana programs helpers

Author: AgusVelez5

deployment/helpers/env.ts

@@ -45,6 +45,24 @@ export function getEnv(env: string): string {
   return v;
 }
 
+export function getChainInfo(chainId: ChainId): ChainInfo {
+  if (ecosystemChains.solana.networks.length > 1) {
+    throw Error("Unexpected number of Solana networks.");
+  }
+
+  const chains = [
+    ...ecosystemChains.evm.networks,
+    ...ecosystemChains.solana.networks,
+  ];
+
+  const chain = chains.find((c) => c.chainId === chainId);
+  if (chain === undefined) {
+    throw Error(`Failed to find chain info for chain id: ${chainId}`);
+  }
+
+  return chain;
+}
+
 export async function getChainConfig<T extends ChainConfig>(filename: string, whChainId: ChainId): Promise<T> {
   const scriptConfig: T[] = await loadJson(filename);
 

deployment/helpers/interfaces.ts

@@ -1,3 +1,4 @@
+import { Commitment } from "@solana/web3.js";
 import { ChainId, Network } from "@wormhole-foundation/sdk-base";
 import { SolanaLedgerSigner } from "@xlabs-xyz/ledger-signer-solana";
 import { BytesLike, ethers } from "ethers";
@@ -19,6 +20,7 @@ export type ChainInfo = {
    */
   externalId?: string;
   network: Network;
+  commitmentLevel?: Commitment;
 };
 
 export type Deployment = {

deployment/helpers/solana.ts

@@ -7,9 +7,12 @@ import {
   Commitment
 } from "@solana/web3.js";
 import { SolanaLedgerSigner } from "@xlabs-xyz/ledger-signer-solana";
-import { ecosystemChains, getEnv } from "./env";
+import { ecosystemChains, env, getContractAddress, getEnv } from "./env";
 import type { SolanaScriptCb } from "./interfaces";
 import { inspect } from "util";
+import { circle, toChainId } from "@wormhole-foundation/sdk-base";
+import { MatchingEngineProgram, ProgramId as MatchingEngineProgramId } from "@wormhole-foundation/example-liquidity-layer-solana/matchingEngine";
+import { TokenRouterProgram, ProgramId as TokenRouterProgramId } from "@wormhole-foundation/example-liquidity-layer-solana/tokenRouter";
 
 export const connectionCommitmentLevel = (process.env.SOLANA_COMMITMENT || "confirmed") as Commitment;
 export const priorityMicrolamports = process.env.PRIORITY_MICROLAMPORTS !== "undefined" ? Number(process.env.PRIORITY_MICROLAMPORTS) : 1;
@@ -89,4 +92,20 @@ export async function ledgerSignAndSend(connection: Connection, instructions: Tr
 async function addLedgerSignature(tx: Transaction, signer: SolanaLedgerSigner, signerPk: PublicKey) {
   const signedByPayer = await signer.signTransaction(tx.compileMessage().serialize());
   tx.addSignature(signerPk, signedByPayer);
-}
+}
+
+export function getMatchingEngineProgram(connection: Connection) {
+  const matchingEngineId = getContractAddress("MatchingEngine", toChainId("Solana")) as MatchingEngineProgramId;
+  const network = env === "mainnet" ? "Mainnet" : "Testnet";
+
+  const usdcMint = new PublicKey(circle.usdcContract(network, "Solana"));
+  return new MatchingEngineProgram(connection, matchingEngineId, usdcMint); 
+};
+
+export function getTokenRouterProgram(connection: Connection) {
+  const tokenRouterId = getContractAddress("TokenRouter", toChainId("Solana")) as TokenRouterProgramId;
+  const network = env === "mainnet" ? "Mainnet" : "Testnet";
+
+  const usdcMint = new PublicKey(circle.usdcContract(network, "Solana"));
+  return new TokenRouterProgram(connection, tokenRouterId, usdcMint); 
+};

deployment/helpers/utils.ts

@@ -1,6 +1,5 @@
 import chalk from 'chalk';
 import { ChainInfo, LoggerFn, ValueDiff } from '.';
-import { UniversalAddress } from '@wormhole-foundation/sdk-definitions';
 
 export const someoneIsDifferent = (values: ValueDiff[]) => values.some((value) => value.onChain.toString() !== value.offChain.toString() && Number(value.onChain) !== Number(value.offChain));
 

deployment/scripts/evm/TokenRouter/cross-registration-token-router.ts

@@ -1,7 +1,9 @@
-import { evm, getContractInstance, getContractAddress, contracts } from "../../../helpers";
+import { evm, getContractInstance, getContractAddress, contracts, getChainInfo } from "../../../helpers";
 import { TokenRouter } from "../../../contract-bindings";
-import { circle, toChain } from "@wormhole-foundation/sdk-base";
+import { circle, toChain, toChainId } from "@wormhole-foundation/sdk-base";
 import { toUniversal } from "@wormhole-foundation/sdk-definitions";
+import { getTokenRouterProgram } from "../../../helpers/solana";
+import { Connection } from "@solana/web3.js";
 
 evm.runOnEvms("cross-registration-token-router", async (chain, _, log) => {
   const tokenRouterAddress = getContractAddress("TokenRouterProxy", chain.chainId);
@@ -10,11 +12,12 @@ evm.runOnEvms("cross-registration-token-router", async (chain, _, log) => {
 
   for (const router of deployedTokenRouters) {
     const circleDomain = circle.toCircleChainId(chain.network, toChain(router.chainId));
-    // TODO: handle Solana registrations correctly in regards to mintRecipient
     const routerChain = toChain(router.chainId);
+    const routerAddress = toUniversal(routerChain, router.address).toString();
+    const mintRecipient = routerChain === "Solana" ? getSolanaMintRecipient() : routerAddress;
     const endpoint = {
-      router: toUniversal(routerChain, router.address).toString(),
-      mintRecipient: toUniversal(routerChain, router.address).toString()
+      router: routerAddress,
+      mintRecipient
     };
 
     if (router.chainId === 0) 
@@ -33,3 +36,13 @@ evm.runOnEvms("cross-registration-token-router", async (chain, _, log) => {
     log(`Router endpoint added for chainId ${router.chainId}`);
   }
 });
+
+
+function getSolanaMintRecipient(): string {
+  const chain = "Solana";
+  const chainInfo = getChainInfo(toChainId(chain));
+  const connection = new Connection(chainInfo.rpc, chainInfo.commitmentLevel || "confirmed");
+  const tokenRouter = getTokenRouterProgram(connection);
+
+  return toUniversal(chain, tokenRouter.custodianAddress().toBytes()).toString();
+}

deployment/scripts/evm/TokenRouter/deploy-token-router.ts

@@ -1,21 +1,17 @@
 import { ethers } from "ethers";
-import { ecosystemChains, evm, LoggerFn, solana, writeDeployedContract } from "../../../helpers";
+import { evm, getChainInfo, LoggerFn, writeDeployedContract } from "../../../helpers";
 import { TokenRouterConfiguration } from "../../../config/config-types";
 import { deployImplementation, getMatchingEngineMintRecipientAddress, getTokenRouterConfiguration } from "./utils";
 import { ERC1967Proxy__factory } from "../../../contract-bindings";
 import { toUniversal } from "@wormhole-foundation/sdk-definitions";
 import { Connection } from "@solana/web3.js";
+import { toChainId } from "@wormhole-foundation/sdk-base";
 
 evm.runOnEvms("deploy-token-router", async (chain, signer, log) => {
   const config = await getTokenRouterConfiguration(chain);
+  const solanaChainInfo = getChainInfo(toChainId("Solana"));
+  const solanaConnection = new Connection(solanaChainInfo.rpc, solanaChainInfo.commitmentLevel || "confirmed");
 
-  // TODO: write a `getChain(chainId: ChainId): ChainInfo` function to replace these lines
-  if (ecosystemChains.solana.networks.length !== 1) {
-    throw Error("Unexpected number of Solana networks.");
-  }
-  const solanaRpc = ecosystemChains.solana.networks[0].rpc;
-
-  const solanaConnection = new Connection(solanaRpc, solana.connectionCommitmentLevel);
   const matchingEngineMintRecipient = toUniversal("Solana", getMatchingEngineMintRecipientAddress(solanaConnection));
   const implementation = await deployImplementation(signer, config, matchingEngineMintRecipient, log);
   await deployProxy(signer, config, implementation, log);

deployment/scripts/evm/TokenRouter/upgrade-token-router.ts

@@ -1,22 +1,18 @@
-import { evm, ChainInfo, getContractInstance, getContractAddress, getDependencyAddress, ecosystemChains, solana } from "../../../helpers";
+import { evm, ChainInfo, getContractInstance, getContractAddress, getDependencyAddress, getChainInfo } from "../../../helpers";
 import { deployImplementation, getMatchingEngineMintRecipientAddress, getTokenRouterConfiguration, matchingEngineChain, matchingEngineDomain } from "./utils";
 import { TokenRouter } from "../../../contract-bindings";
 import { UniversalAddress, toUniversal } from "@wormhole-foundation/sdk-definitions";
 import { Connection } from "@solana/web3.js";
+import { toChainId } from "@wormhole-foundation/sdk-base";
 
 evm.runOnEvms("upgrade-token-router", async (chain, signer, log) => {
   const currentImplementationAddress = getContractAddress("TokenRouterImplementation", chain.chainId);
   const proxyAddress = getContractAddress("TokenRouterProxy", chain.chainId);
   const proxy = (await getContractInstance("TokenRouter", proxyAddress, chain)) as TokenRouter;
   const config = await getTokenRouterConfiguration(chain);
-
-  // TODO: write a `getChain(chainId: ChainId): ChainInfo` function to replace these lines
-  if (ecosystemChains.solana.networks.length !== 1) {
-    throw Error("Unexpected number of Solana networks.");
-  }
-  const solanaRpc = ecosystemChains.solana.networks[0].rpc;
-
-  const solanaConnection = new Connection(solanaRpc, solana.connectionCommitmentLevel);
+  
+  const solanaChainInfo = getChainInfo(toChainId("Solana"));
+  const solanaConnection = new Connection(solanaChainInfo.rpc, solanaChainInfo.commitmentLevel || "confirmed");
   const matchingEngineMintRecipient = toUniversal("Solana", getMatchingEngineMintRecipientAddress(solanaConnection));
 
   log(`Checking immutables for TokenRouter`);

deployment/scripts/evm/TokenRouter/utils.ts

@@ -4,9 +4,8 @@ import { TokenRouter, TokenRouter__factory } from "../../../contract-bindings";
 import { ChainInfo, getChainConfig, LoggerFn, getDependencyAddress, writeDeployedContract, getContractAddress, getContractInstance, logComparison, someoneIsDifferent } from "../../../helpers";
 import { IERC20 } from "../../../contract-bindings";
 import { UniversalAddress, toUniversal } from "@wormhole-foundation/sdk-definitions";
-import { circle, toChain, toChainId } from "@wormhole-foundation/sdk-base";
-import { MatchingEngineProgram, ProgramId } from "@wormhole-foundation/example-liquidity-layer-solana/matchingEngine";
-import { Connection, PublicKey } from "@solana/web3.js";
+import { Connection } from "@solana/web3.js";
+import { getMatchingEngineProgram } from "../../../helpers/solana";
 
 /**
  * Chain ID for the Solana wormhole chain
@@ -19,11 +18,7 @@ export const matchingEngineChain = 1;
 export const matchingEngineDomain = 5;
 
 export function getMatchingEngineMintRecipientAddress(connection: Connection) {
-  const matchingEngineId = getContractAddress("MatchingEngine", toChainId("Solana")) as ProgramId;
-
-  const env = "Mainnet";
-  const usdcMint = new PublicKey(circle.usdcContract(env, "Solana"));
-  const matchingEngine = new MatchingEngineProgram(connection, matchingEngineId, usdcMint);
+  const matchingEngine = getMatchingEngineProgram(connection);
   return matchingEngine.cctpMintRecipientAddress().toBytes();
 };