fix: restore starknet-sdk package lost during main merge

Author: yorhodes

typescript/starknet-sdk/.gitignore

@@ -0,0 +1,2 @@
+dist
+cache

typescript/starknet-sdk/.mocharc-e2e.json

@@ -0,0 +1,5 @@
+{
+  "import": ["tsx"],
+  "file": ["src/tests/e2e-test.setup.ts"],
+  "exit": true
+}

typescript/starknet-sdk/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "import": ["tsx"],
+  "spec": ["./src/**/*.test.ts"],
+  "exit": true
+}

typescript/starknet-sdk/CHANGELOG.md

@@ -0,0 +1,31 @@
+# @hyperlane-xyz/starknet-sdk
+
+## 27.2.2
+
+### Patch Changes
+
+- @hyperlane-xyz/starknet-core@29.1.0
+- @hyperlane-xyz/utils@29.1.0
+- @hyperlane-xyz/provider-sdk@4.2.2
+
+## 27.2.1
+
+### Patch Changes
+
+- @hyperlane-xyz/starknet-core@29.0.1
+- @hyperlane-xyz/utils@29.0.1
+- @hyperlane-xyz/provider-sdk@4.2.1
+
+## 27.2.0
+
+### Minor Changes
+
+- 09d6760: Added Starknet artifact API support across the TypeScript AltVM toolchain. The new `@hyperlane-xyz/starknet-sdk` package provides Starknet protocol, signer, provider, ISM, hook, mailbox, validator announce, and end-to-end test coverage. Deploy SDK protocol loading and the CLI context/signer flows were updated so Starknet chains can be resolved and used through the shared AltVM paths.
+
+### Patch Changes
+
+- Updated dependencies [3c6b1ad]
+- Updated dependencies [084c6b6]
+  - @hyperlane-xyz/utils@29.0.0
+  - @hyperlane-xyz/provider-sdk@4.2.0
+  - @hyperlane-xyz/starknet-core@29.0.0

typescript/starknet-sdk/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@hyperlane-xyz/starknet-sdk",
+  "version": "27.2.2",
+  "description": "Hyperlane TypeScript SDK for Starknet artifact API support",
+  "keywords": [
+    "blockchain",
+    "hyperlane",
+    "sdk",
+    "starknet"
+  ],
+  "homepage": "https://www.hyperlane.xyz",
+  "license": "Apache-2.0",
+  "repository": "https://github.com/hyperlane-xyz/hyperlane-monorepo",
+  "files": [
+    "/dist"
+  ],
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "default": "./dist/testing/index.js"
+    }
+  },
+  "scripts": {
+    "build": "rm -rf ./dist && tsc",
+    "format": "oxfmt --write ./src",
+    "lint": "oxlint -c ../../oxlint.json",
+    "clean": "rm -rf ./dist ./cache",
+    "dev": "tsc --watch",
+    "test": "mocha --config .mocharc.json",
+    "test:e2e": "./scripts/run-e2e-test.sh",
+    "test:ci": "pnpm test"
+  },
+  "dependencies": {
+    "@hyperlane-xyz/provider-sdk": "workspace:*",
+    "@hyperlane-xyz/starknet-core": "workspace:*",
+    "@hyperlane-xyz/utils": "workspace:*",
+    "starknet": "catalog:"
+  },
+  "devDependencies": {
+    "@hyperlane-xyz/tsconfig": "workspace:^",
+    "@types/chai": "catalog:",
+    "@types/mocha": "catalog:",
+    "@types/node": "catalog:",
+    "chai": "catalog:",
+    "mocha": "catalog:",
+    "testcontainers": "catalog:",
+    "tsx": "catalog:",
+    "typescript": "catalog:"
+  }
+}

typescript/starknet-sdk/scripts/run-e2e-test.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+case "${STARKNET_SDK_E2E_TEST:-}" in
+  "")
+    spec="src/tests/*.e2e-test.ts"
+    echo "Running all Starknet SDK E2E tests"
+    ;;
+  ism|mailbox|hook|validator_announce|warp_core|warp_transfer|read-warp-token)
+    spec="src/tests/${STARKNET_SDK_E2E_TEST}.e2e-test.ts"
+    ;;
+  *)
+    echo "Error: unknown STARKNET_SDK_E2E_TEST value '${STARKNET_SDK_E2E_TEST}'" >&2
+    echo "Expected one of: ism, mailbox, hook, validator_announce, warp_core, warp_transfer, read-warp-token" >&2
+    exit 1
+    ;;
+esac
+
+if [ -n "${STARKNET_SDK_E2E_TEST:-}" ]; then
+  echo "Running Starknet SDK E2E shard: ${STARKNET_SDK_E2E_TEST}"
+fi
+
+pnpm mocha --config .mocharc-e2e.json "${spec}"

typescript/starknet-sdk/src/clients/protocol.test.ts

@@ -0,0 +1,44 @@
+import { expect } from 'chai';
+
+import { ProtocolType } from '@hyperlane-xyz/provider-sdk';
+
+import { StarknetWarpArtifactManager } from '../warp/warp-artifact-manager.js';
+
+import { StarknetProtocolProvider } from './protocol.js';
+
+const METADATA = {
+  name: 'starknetsepolia',
+  protocol: ProtocolType.Starknet,
+  chainId: 'SN_SEPOLIA',
+  domainId: 1234,
+  rpcUrls: [{ http: 'http://localhost:9545' }],
+};
+
+describe('StarknetProtocolProvider', () => {
+  it('returns a Starknet warp artifact manager', () => {
+    const provider = new StarknetProtocolProvider();
+
+    const manager = provider.createWarpArtifactManager(METADATA);
+
+    expect(manager).to.be.instanceOf(StarknetWarpArtifactManager);
+    expect(manager.supportsHookUpdates()).to.equal(true);
+  });
+
+  it('does not implement a protocol-level submitter', async () => {
+    const provider = new StarknetProtocolProvider();
+
+    let error: unknown;
+    try {
+      await provider.createSubmitter(METADATA, {
+        type: 'jsonRpc',
+        chain: 'starknetsepolia',
+        privateKey: '0xkey',
+        accountAddress: '0x123',
+      });
+    } catch (caughtError) {
+      error = caughtError;
+    }
+
+    expect(String(error)).to.match(/Not implemented/);
+  });
+});

typescript/starknet-sdk/src/clients/protocol.ts

@@ -0,0 +1,102 @@
+import {
+  AltVM,
+  ChainMetadataForAltVM,
+  ITransactionSubmitter,
+  MinimumRequiredGasByAction,
+  ProtocolProvider,
+  SignerConfig,
+  TransactionSubmitterConfig,
+} from '@hyperlane-xyz/provider-sdk';
+import { IProvider } from '@hyperlane-xyz/provider-sdk/altvm';
+import { IRawHookArtifactManager } from '@hyperlane-xyz/provider-sdk/hook';
+import { IRawIsmArtifactManager } from '@hyperlane-xyz/provider-sdk/ism';
+import { IRawMailboxArtifactManager } from '@hyperlane-xyz/provider-sdk/mailbox';
+import { AnnotatedTx, TxReceipt } from '@hyperlane-xyz/provider-sdk/module';
+import { IRawValidatorAnnounceArtifactManager } from '@hyperlane-xyz/provider-sdk/validator-announce';
+import { IRawWarpArtifactManager } from '@hyperlane-xyz/provider-sdk/warp';
+import { assert } from '@hyperlane-xyz/utils';
+
+import { StarknetHookArtifactManager } from '../hook/hook-artifact-manager.js';
+import { StarknetIsmArtifactManager } from '../ism/ism-artifact-manager.js';
+import { StarknetMailboxArtifactManager } from '../mailbox/mailbox-artifact-manager.js';
+import { StarknetValidatorAnnounceArtifactManager } from '../validator-announce/validator-announce-artifact-manager.js';
+import { StarknetWarpArtifactManager } from '../warp/warp-artifact-manager.js';
+
+import { StarknetProvider } from './provider.js';
+import { StarknetSigner } from './signer.js';
+
+export class StarknetProtocolProvider implements ProtocolProvider {
+  async createProvider(
+    chainMetadata: ChainMetadataForAltVM,
+  ): Promise<IProvider> {
+    const rpcUrls = (chainMetadata.rpcUrls ?? []).map(({ http }) => http);
+    assert(rpcUrls.length > 0, 'rpc urls undefined for Starknet');
+    return StarknetProvider.connect(rpcUrls, chainMetadata.chainId, {
+      metadata: chainMetadata,
+    });
+  }
+
+  async createSigner(
+    chainMetadata: ChainMetadataForAltVM,
+    config: SignerConfig,
+  ): Promise<AltVM.ISigner<AnnotatedTx, TxReceipt>> {
+    const rpcUrls = (chainMetadata.rpcUrls ?? []).map(({ http }) => http);
+    assert(rpcUrls.length > 0, 'rpc urls undefined for Starknet');
+    assert(config.privateKey, 'privateKey missing for Starknet signer');
+    assert(config.accountAddress, 'accountAddress missing for Starknet signer');
+
+    return StarknetSigner.connectWithSigner(rpcUrls, config.privateKey, {
+      metadata: chainMetadata,
+      accountAddress: config.accountAddress,
+    });
+  }
+
+  async createSubmitter<TConfig extends TransactionSubmitterConfig>(
+    _chainMetadata: ChainMetadataForAltVM,
+    _config: TConfig,
+  ): Promise<ITransactionSubmitter> {
+    throw Error('Not implemented');
+  }
+
+  createIsmArtifactManager(
+    chainMetadata: ChainMetadataForAltVM,
+  ): IRawIsmArtifactManager {
+    return new StarknetIsmArtifactManager(chainMetadata);
+  }
+
+  createHookArtifactManager(
+    chainMetadata: ChainMetadataForAltVM,
+    context?: { mailbox?: string },
+  ): IRawHookArtifactManager {
+    return new StarknetHookArtifactManager(chainMetadata, context);
+  }
+
+  createWarpArtifactManager(
+    chainMetadata: ChainMetadataForAltVM,
+    _context?: { mailbox?: string },
+  ): IRawWarpArtifactManager {
+    return new StarknetWarpArtifactManager(chainMetadata);
+  }
+
+  createMailboxArtifactManager(
+    chainMetadata: ChainMetadataForAltVM,
+  ): IRawMailboxArtifactManager {
+    return new StarknetMailboxArtifactManager(chainMetadata);
+  }
+
+  createValidatorAnnounceArtifactManager(
+    chainMetadata: ChainMetadataForAltVM,
+  ): IRawValidatorAnnounceArtifactManager | null {
+    return new StarknetValidatorAnnounceArtifactManager(chainMetadata);
+  }
+
+  getMinGas(): MinimumRequiredGasByAction {
+    return {
+      CORE_DEPLOY_GAS: BigInt(1e9),
+      WARP_DEPLOY_GAS: BigInt(3e8),
+      TEST_SEND_GAS: BigInt(3e7),
+      AVS_GAS: BigInt(3e8),
+      ISM_DEPLOY_GAS: BigInt(5e7),
+    };
+  }
+}