feat: starknet core integration -> main [STRK-01]

.changeset/hip-papayas-kiss.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/sdk': minor
+---
+
+feat: Starknet SDK logic integration

.changeset/metal-coats-remain.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/utils': minor
+---
+
+Add Starknet address and tx utils

Dockerfile

@@ -2,7 +2,7 @@ FROM node:20-alpine
 
 WORKDIR /hyperlane-monorepo
 
-RUN apk add --update --no-cache git g++ make py3-pip jq
+RUN apk add --update --no-cache git g++ make py3-pip jq bash curl
 
 RUN yarn set version 4.5.1
 
@@ -22,14 +22,15 @@ COPY typescript/github-proxy/package.json ./typescript/github-proxy/
 COPY typescript/cosmos-types/package.json ./typescript/cosmos-types/
 COPY typescript/cosmos-sdk/package.json ./typescript/cosmos-sdk/
 COPY solidity/package.json ./solidity/
-COPY starknet/package.json ./starknet/ 
+COPY starknet/package.json ./starknet/
 
 RUN yarn install && yarn cache clean
 
 # Copy everything else
 COPY tsconfig.json ./
 COPY typescript ./typescript
 COPY solidity ./solidity
+COPY starknet ./starknet
 
 RUN yarn build
 

rust/sealevel/environments/mainnet3/gas-oracle-configs.json

@@ -56,6 +56,14 @@
       },
       "overhead": 600000
     },
+    "abstract": {
+      "oracleConfig": {
+        "tokenExchangeRate": "187056373229658428214",
+        "gasPrice": "193418836",
+        "tokenDecimals": 18
+      },
+      "overhead": 333774
+    },
     "artela": {
       "oracleConfig": {
         "tokenExchangeRate": "152446195501249",
@@ -194,6 +202,22 @@
     }
   },
   "eclipsemainnet": {
+    "sonicsvm": {
+      "oracleConfig": {
+        "tokenExchangeRate": "120284594486260",
+        "gasPrice": "35603",
+        "tokenDecimals": 9
+      },
+      "overhead": 600000
+    },
+    "soon": {
+      "oracleConfig": {
+        "tokenExchangeRate": "1500000000000000",
+        "gasPrice": "2855",
+        "tokenDecimals": 9
+      },
+      "overhead": 600000
+    },
     "ethereum": {
       "oracleConfig": {
         "tokenExchangeRate": "15000000000000000000",
@@ -243,9 +267,25 @@
         "tokenDecimals": 18
       },
       "overhead": 159736
+    },
+    "eclipsemainnet": {
+      "oracleConfig": {
+        "tokenExchangeRate": "1500000000000000",
+        "gasPrice": "2855",
+        "tokenDecimals": 9
+      },
+      "overhead": 600000
     }
   },
   "sonicsvm": {
+    "eclipsemainnet": {
+      "oracleConfig": {
+        "tokenExchangeRate": "18705637322965842",
+        "gasPrice": "2855",
+        "tokenDecimals": 9
+      },
+      "overhead": 600000
+    },
     "solanamainnet": {
       "oracleConfig": {
         "tokenExchangeRate": "1500000000000000",

rust/sealevel/environments/mainnet3/warp-routes/tUSD-eclipsemainnet-ethereum/program-ids.json

@@ -0,0 +1,10 @@
+{
+  "eclipsemainnet": {
+    "hex": "0x3c141cbabe775eb1cb82d357bed3724e39e4fd2de256aee2a69de336d360d97a",
+    "base58": "53XFTNcTRTzrNyD3QodXbRBZ249G8v3iSHh8FzYeHZoX"
+  },
+  "ethereum": {
+    "hex": "0x00000000000000000000000069b1a59e98d94e1b9647c08cb295fc52597d20f0",
+    "base58": "1111111111112UQUH3pY5HJ7m8iy1sgSB5Gs9dvX"
+  }
+}

rust/sealevel/environments/mainnet3/warp-routes/tUSD-eclipsemainnet-ethereum/token-config.json

@@ -0,0 +1,17 @@
+{
+  "eclipsemainnet": {
+    "type": "synthetic",
+    "decimals": 6,
+    "remoteDecimals": 6,
+    "name": "Turbo USD",
+    "symbol": "tUSD",
+    "uri": "https://raw.githubusercontent.com/hyperlane-xyz/hyperlane-registry/71b97e47ffe47348b2ea9cb1bde344ca78daea50/deployments/warp_routes/tUSD/metadata.json",
+    "interchainGasPaymaster": "3Wp4qKkgf4tjXz1soGyTSndCgBPLZFSrZkiDZ8Qp9EEj"
+  },
+  "ethereum": {
+    "type": "collateral",
+    "decimals": 6,
+    "token": "0x722a851B6798D65b80526562Fc3a36E19b1F883b",
+    "foreignDeployment": "0x69B1A59e98D94E1B9647C08Cb295Fc52597D20f0"
+  }
+}

typescript/infra/scripts/sealevel-helpers/print-gas-oracles.ts

@@ -108,8 +108,11 @@ function getChainConnections(
       ['svmbnb', 'solanamainnet'],
       ['svmbnb', 'bsc'],
       ['svmbnb', 'soon'],
+      ['sonicsvm', 'eclipsemainnet'],
       ['soon', 'solanamainnet'],
       ['soon', 'bsc'],
+      ['soon', 'eclipsemainnet'],
+      ['abstract', 'solanamainnet'],
       // All warp routes
       ...Object.values(WarpRouteIds).map(getWarpChains),
     ];

typescript/sdk/CHANGELOG.md

@@ -12,7 +12,7 @@
 - d182d7d: Adds the sortArraysInObject function to properly sort arrays in an object recursively given an optional sort function
 - 248d2e1: Enables the CLI to warp check routes that include non EVM routes
 - e2a4727: Deploy to new chains: ontology, miraclechain, kyve.
-- b360802: Add the isCosmosIbcDenomAddress function and improve the config expasion logic to correctly format the destination gas
+- b360802: Add the isCosmosIbcDenomAddress function and improve the config expansion logic to correctly format the destination gas
 - 31ee1c6: Adds fiatCollateral token on chain config derivation logic as it was incorrectly inferred as collateral
 - a36d5c1: add cosmos native hook module & reader
 

typescript/sdk/package.json

@@ -10,6 +10,7 @@
     "@cosmjs/stargate": "^0.32.4",
     "@hyperlane-xyz/core": "7.1.5",
     "@hyperlane-xyz/cosmos-sdk": "12.6.0",
+    "@hyperlane-xyz/starknet-core": "1.0.0",
     "@hyperlane-xyz/utils": "12.6.0",
     "@safe-global/api-kit": "1.3.0",
     "@safe-global/protocol-kit": "1.3.0",

typescript/sdk/src/app/MultiProtocolApp.ts

@@ -17,6 +17,7 @@ import {
   CosmJsWasmProvider,
   EthersV5Provider,
   SolanaWeb3Provider,
+  StarknetJsProvider,
   TypedProvider,
 } from '../providers/ProviderType.js';
 import { ChainMap, ChainName } from '../types.js';
@@ -104,6 +105,14 @@ export class BaseSealevelAdapter extends BaseAppAdapter {
   }
 }
 
+export class BaseStarknetAdapter extends BaseAppAdapter {
+  public readonly protocol: ProtocolType = ProtocolType.Starknet;
+
+  public getProvider(): StarknetJsProvider['provider'] {
+    return this.multiProvider.getStarknetProvider(this.chainName);
+  }
+}
+
 /**
  * A version of HyperlaneApp that can support different
  * provider types across different protocol types.

typescript/sdk/src/consts/testChains.ts

@@ -143,13 +143,32 @@ export const testSealevelChain: ChainMetadata = {
   rpcUrls: [{ http: 'http://127.0.0.1:8899' }],
 };
 
+export const testStarknetChain: ChainMetadata = {
+  chainId: '0x534e5f5345504f4c4941',
+  domainId: 5854809,
+  name: 'starknetdevnet',
+  nativeToken: {
+    decimals: 18,
+    denom: '0x49D36570D4E46F48E99674BD3FCC84644DDD6B96F7C741B1562B82F9E004DC7',
+    name: 'Ether',
+    symbol: 'ETH',
+  },
+  protocol: ProtocolType.Starknet,
+  rpcUrls: [
+    {
+      http: 'http://127.0.0.1:5050',
+    },
+  ],
+};
+
 export const multiProtocolTestChainMetadata: ChainMap<ChainMetadata> = {
   ...testChainMetadata,
   testcosmos: testCosmosChain,
   testsealevel: testSealevelChain,
   testxerc20: testXERC20,
   testvsxerc20: testVSXERC20,
   testxerc20lockbox: testXERC20Lockbox,
+  starknetdevnet: testStarknetChain,
 };
 
 export const multiProtocolTestChains: Array<ChainName> = Object.keys(

typescript/sdk/src/core/MultiProtocolCore.ts

@@ -9,6 +9,7 @@ import { CosmNativeCoreAdapter } from './adapters/CosmNativeCoreAdapter.js';
 import { CosmWasmCoreAdapter } from './adapters/CosmWasmCoreAdapter.js';
 import { EvmCoreAdapter } from './adapters/EvmCoreAdapter.js';
 import { SealevelCoreAdapter } from './adapters/SealevelCoreAdapter.js';
+import { StarknetCoreAdapter } from './adapters/StarknetCoreAdapter.js';
 import { ICoreAdapter } from './adapters/types.js';
 import { CoreAddresses } from './contracts.js';
 
@@ -41,6 +42,7 @@ export class MultiProtocolCore extends MultiProtocolApp<
     if (protocol === ProtocolType.Sealevel) return SealevelCoreAdapter;
     if (protocol === ProtocolType.Cosmos) return CosmWasmCoreAdapter;
     if (protocol === ProtocolType.CosmosNative) return CosmNativeCoreAdapter;
+    if (protocol === ProtocolType.Starknet) return StarknetCoreAdapter;
     throw new Error(`No adapter for protocol ${protocol}`);
   }
 

typescript/sdk/src/core/adapters/StarknetCoreAdapter.ts

@@ -0,0 +1,127 @@
+import {
+  CallData,
+  InvokeTransactionReceiptResponse,
+  ParsedEvents,
+  events as eventsUtils,
+} from 'starknet';
+
+import { getCompiledContract } from '@hyperlane-xyz/starknet-core';
+import { Address, HexString, pollAsync } from '@hyperlane-xyz/utils';
+
+import { BaseStarknetAdapter } from '../../app/MultiProtocolApp.js';
+import { MultiProtocolProvider } from '../../providers/MultiProtocolProvider.js';
+import {
+  ProviderType,
+  StarknetJsTransactionReceipt,
+} from '../../providers/ProviderType.js';
+import { ChainName } from '../../types.js';
+import {
+  getStarknetMailboxContract,
+  parseStarknetDispatchEvents,
+} from '../../utils/starknet.js';
+
+import { ICoreAdapter } from './types.js';
+
+export class StarknetCoreAdapter
+  extends BaseStarknetAdapter
+  implements ICoreAdapter
+{
+  constructor(
+    public readonly chainName: ChainName,
+    public readonly multiProvider: MultiProtocolProvider,
+    public readonly addresses: { mailbox: Address },
+  ) {
+    super(chainName, multiProvider, addresses);
+  }
+
+  extractMessageIds(
+    sourceTx: StarknetJsTransactionReceipt,
+  ): Array<{ messageId: string; destination: ChainName }> {
+    if (sourceTx.type !== ProviderType.Starknet) {
+      throw new Error(
+        `Unsupported provider type for StarknetCoreAdapter ${sourceTx.type}`,
+      );
+    }
+
+    let parsedEvents: ParsedEvents = [];
+    sourceTx.receipt.match({
+      success: (txR) => {
+        const emittedEvents =
+          (txR as InvokeTransactionReceiptResponse).events?.map((event) => {
+            return {
+              block_hash: (txR as any).block_hash,
+              block_number: (txR as any).block_number,
+              transaction_hash: (txR as any).transaction_hash,
+              ...event,
+            };
+          }) || [];
+
+        if (emittedEvents.length === 0) return;
+        const mailboxAbi = getCompiledContract('mailbox').abi;
+        parsedEvents = eventsUtils.parseEvents(
+          emittedEvents,
+          eventsUtils.getAbiEvents(mailboxAbi),
+          CallData.getAbiStruct(mailboxAbi),
+          CallData.getAbiEnum(mailboxAbi),
+        );
+      },
+      _: () => {
+        throw Error('This transaction was not successful.');
+      },
+    });
+
+    if (!parsedEvents || parsedEvents.length === 0) return [];
+
+    const messages = parseStarknetDispatchEvents(
+      parsedEvents,
+      (domain) => this.multiProvider.tryGetChainName(domain) ?? undefined,
+    );
+
+    return messages.map(({ id, parsed }) => ({
+      messageId: id,
+      destination: this.multiProvider.getChainName(parsed.destination),
+    }));
+  }
+
+  async waitForMessageProcessed(
+    messageId: HexString,
+    destination: ChainName,
+    delayMs = 5000,
+    maxAttempts = 60,
+  ): Promise<boolean> {
+    const destAdapter = new StarknetCoreAdapter(
+      destination,
+      this.multiProvider,
+      { mailbox: this.addresses.mailbox },
+    );
+
+    const mailboxContract = getStarknetMailboxContract(
+      destAdapter.addresses.mailbox,
+      destAdapter.getProvider(),
+    );
+
+    await pollAsync(
+      async () => {
+        const isDelivered = await mailboxContract.call('delivered', [
+          messageId,
+        ]);
+
+        if (!isDelivered) {
+          throw new Error(
+            `Message ${messageId} not yet delivered on ${destination}`,
+          );
+        }
+
+        this.logger.debug(
+          `Message ${messageId} confirmed delivered on ${destination}`,
+        );
+
+        return isDelivered;
+      },
+      delayMs,
+      maxAttempts,
+    );
+
+    return true;
+  }
+}

typescript/sdk/src/index.ts

@@ -60,6 +60,7 @@ export {
 export { CosmWasmCoreAdapter } from './core/adapters/CosmWasmCoreAdapter.js';
 export { EvmCoreAdapter } from './core/adapters/EvmCoreAdapter.js';
 export { SealevelCoreAdapter } from './core/adapters/SealevelCoreAdapter.js';
+export { StarknetCoreAdapter } from './core/adapters/StarknetCoreAdapter.js';
 export { ICoreAdapter } from './core/adapters/types.js';
 export {
   CoreAddresses,
@@ -366,6 +367,10 @@ export {
   SolanaWeb3Provider,
   SolanaWeb3Transaction,
   SolanaWeb3TransactionReceipt,
+  StarknetJsContract,
+  StarknetJsProvider,
+  StarknetJsTransaction,
+  StarknetJsTransactionReceipt,
   TypedContract,
   TypedProvider,
   TypedTransaction,
@@ -712,3 +717,12 @@ export {
   CCIPContractCache,
 } from './ccip/utils.js';
 export { HyperlaneCCIPDeployer } from './ccip/HyperlaneCCIPDeployer.js';
+
+export {
+  StarknetContractName,
+  getStarknetContract,
+  getStarknetHypERC20Contract,
+  getStarknetHypERC20CollateralContract,
+  getStarknetMailboxContract,
+  getStarknetEtherContract,
+} from './utils/starknet.js';