feat: safe api key support (#7090)

Author: paulbalaji

.changeset/weak-trainers-join.md

@@ -0,0 +1,5 @@
+---
+"@hyperlane-xyz/sdk": minor
+---
+
+Update all @safe-global dependencies to latest, to support usage of Safe API Keys. Add gnosisSafeApiKey to chain metadata schema.

typescript/infra/package.json

@@ -20,9 +20,9 @@
     "@hyperlane-xyz/utils": "19.4.0",
     "@inquirer/prompts": "3.3.2",
     "@nomiclabs/hardhat-etherscan": "^3.0.3",
-    "@safe-global/api-kit": "1.3.0",
-    "@safe-global/protocol-kit": "1.3.0",
-    "@safe-global/safe-core-sdk-types": "2.3.0",
+    "@safe-global/api-kit": "4.0.0",
+    "@safe-global/protocol-kit": "6.1.1",
+    "@safe-global/safe-core-sdk-types": "5.1.0",
     "@solana/web3.js": "^1.98.4",
     "@turnkey/api-key-stamper": "^0.5.0",
     "@turnkey/sdk-server": "^4.10.4",

typescript/infra/scripts/safe-delegate.ts

@@ -1,9 +1,5 @@
-import {
-  EthersAdapter,
-  SafeAccountConfig,
-  SafeFactory,
-} from '@safe-global/protocol-kit';
-import { ethers } from 'ethers';
+import Safe, { SafeAccountConfig } from '@safe-global/protocol-kit';
+import { BigNumber } from 'ethers';
 
 import { rootLogger } from '@hyperlane-xyz/utils';
 
@@ -33,62 +29,33 @@ async function main() {
     [chain],
   );
 
-  const signer = multiProvider.getSigner(chain);
-  const ethAdapter = new EthersAdapter({
-    ethers,
-    signerOrProvider: signer,
-  });
-
-  let safeFactory;
-  try {
-    safeFactory = await SafeFactory.create({
-      ethAdapter,
-    });
-  } catch (e) {
-    rootLogger.error(`Error initializing SafeFactory: ${e}`);
-    process.exit(1);
-  }
-
   const { signers, threshold: defaultThreshold } =
     getGovernanceSigners(governanceType);
   const safeAccountConfig: SafeAccountConfig = {
     owners: signers,
     threshold: threshold ?? defaultThreshold,
   };
 
-  let safe;
-  try {
-    safe = await safeFactory.deploySafe({ safeAccountConfig });
-  } catch (e) {
-    rootLogger.error(`Error deploying Safe: ${e}`);
-    process.exit(1);
-  }
+  // @ts-ignore
+  const safe = await Safe.init({
+    provider: multiProvider.getChainMetadata(chain).rpcUrls[0].http,
+    predictedSafe: {
+      safeAccountConfig,
+    },
+  });
+
+  const { to, data, value } = await safe.createSafeDeploymentTransaction();
+  await multiProvider.sendTransaction(chain, {
+    to,
+    data,
+    value: BigNumber.from(value),
+  });
 
   const safeAddress = await safe.getAddress();
 
   rootLogger.info(`Safe address: ${safeAddress}`);
   rootLogger.info(`Safe url: ${safeHomeUrl}/home?safe=${chain}:${safeAddress}`);
-  rootLogger.info('url may not be correct, please check by following the link');
-
-  try {
-    // TODO: check https://app.safe.global for officially supported chains, filter by chain id
-    const chainsUrl = `${safeHomeUrl.replace(
-      'https://',
-      'https://gateway.',
-    )}/v1/chains`;
-    rootLogger.info(`Fetching chain data from ${chainsUrl}`);
-    const response = await fetch(chainsUrl);
-
-    const resultsJson = await response.json();
-
-    const transactionService = resultsJson.results[0].transactionService;
-    rootLogger.info(`Chains: ${JSON.stringify(transactionService)}`);
-    rootLogger.info(
-      `Add the transaction service url ${transactionService} as gnosisSafeTransactionServiceUrl to the metadata.yml in the registry`,
-    );
-  } catch (e) {
-    rootLogger.error(`Could not fetch safe tx service url: ${e}`);
-  }
+  rootLogger.info('Please confirm the safe is created by following the link');
 }
 
 main()

typescript/infra/scripts/safes/create-safe.ts

@@ -7,6 +7,7 @@ import {
   ChainName,
   HyperlaneSmartProvider,
   ProviderRetryOptions,
+  safeApiKeyRequired,
 } from '@hyperlane-xyz/sdk';
 import {
   Address,
@@ -18,6 +19,7 @@ import {
 
 import { getChain, getRegistryWithOverrides } from '../../config/registry.js';
 import { getSecretRpcEndpoints } from '../agents/index.js';
+import { getSafeApiKey } from '../utils/safe.js';
 
 import { DeployEnvironment } from './environment.js';
 
@@ -171,6 +173,9 @@ export async function getSecretMetadataOverrides(
 ): Promise<ChainMap<Partial<ChainMetadata>>> {
   const chainMetadataOverrides: ChainMap<Partial<ChainMetadata>> = {};
 
+  // Fetch Safe API key once
+  const safeApiKey = await getSafeApiKey();
+
   const secretRpcUrls = await Promise.all(
     chains.map(async (chain) => {
       const rpcUrls = await getSecretRpcEndpoints(deployEnv, chain);
@@ -192,6 +197,13 @@ export async function getSecretMetadataOverrides(
     chainMetadataOverrides[chain] = {
       rpcUrls: metadataRpcUrls,
     };
+
+    // Add Safe API key if required
+    const chainMetadata = getChain(chain);
+    const txServiceUrl = chainMetadata.gnosisSafeTransactionServiceUrl;
+    if (txServiceUrl && safeApiKeyRequired(txServiceUrl)) {
+      chainMetadataOverrides[chain].gnosisSafeApiKey = safeApiKey;
+    }
   }
 
   return chainMetadataOverrides;

typescript/infra/src/config/chain.ts

@@ -1,5 +1,4 @@
 import { Result } from '@ethersproject/abi';
-import { decodeMultiSendData } from '@safe-global/protocol-kit/dist/src/utils/index.js';
 import {
   MetaTransactionData,
   OperationType,
@@ -71,7 +70,7 @@ import {
   Owner,
   determineGovernanceType,
 } from '../governance.js';
-import { getSafeTx, parseSafeTx } from '../utils/safe.js';
+import { decodeMultiSendData, getSafeTx, parseSafeTx } from '../utils/safe.js';
 
 export interface GovernTransaction extends Record<string, any> {
   chain: ChainName;