feat/starknet-core-abi-exports

Author: ljankovic-txfusion

.changeset/popular-trains-repair.md

@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/starknet-core': major
+---
+
+feat: Add Starknet contract ABI fetching and contract artifact generation

Dockerfile

@@ -22,6 +22,7 @@ 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/ 
 
 RUN yarn install && yarn cache clean
 

package.json

@@ -40,7 +40,8 @@
   },
   "workspaces": [
     "solidity",
-    "typescript/*"
+    "typescript/*",
+    "starknet"
   ],
   "resolutions": {
     "async": "^2.6.4",

starknet/.gitignore

@@ -0,0 +1,3 @@
+.env
+dist
+release

starknet/README.md

@@ -0,0 +1,96 @@
+# Hyperlane Starknet Core
+
+The Hyperlane Starknet Core package provides TypeScript tooling for interacting with Hyperlane's Cairo contracts on Starknet. It includes TypeScript artifacts autogenerated from Cairo contracts developed in collaboration with Astraly Labs.
+
+## Features
+
+- Pre-compiled Cairo contract ABI artifacts
+- TypeScript bindings for Starknet contracts
+
+## Installation
+
+```bash
+# Install with NPM
+npm install @hyperlane-xyz/starknet-core
+
+# Or with Yarn
+yarn add @hyperlane-xyz/starknet-core
+```
+
+## Requirements
+
+- Node.js 18 or newer
+- For development: `curl`, `jq`, and `unzip` utilities
+
+## Usage
+
+```typescript
+import {
+  ContractType,
+  getCompiledContract,
+} from '@hyperlane-xyz/starknet-core';
+
+// Get the Hyperlane mailbox contract
+const mailboxContract = getCompiledContract('mailbox');
+
+// Get token contracts
+const tokenContract = getCompiledContract('erc20', ContractType.TOKEN);
+
+// Get mock contracts
+const mockContract = getCompiledContract('mock_validator', ContractType.MOCK);
+```
+
+## Contract Categories
+
+Contracts are organized into three categories:
+
+- `contracts`: Core Hyperlane protocol contracts
+- `tokens`: Token implementation contracts
+- `mocks`: Test and mock contracts
+
+## Development
+
+### Setup
+
+1. Clone the repository
+2. Install dependencies: `yarn install`
+
+### Build Process
+
+The build process combines multiple steps in a specific order:
+
+```bash
+yarn build
+```
+
+This command runs:
+
+1. TypeScript compilation (`tsc`)
+2. Fetching contract artifacts from GitHub (`fetch-contracts`)
+3. Generating TypeScript ABI artifacts from Cairo contracts (`generate-artifacts`)
+
+All build output is placed in the `dist` directory.
+
+### Individual Build Steps
+
+You can also run the individual build steps separately:
+
+#### Fetching Contract Artifacts
+
+```bash
+yarn fetch-contracts
+```
+
+This downloads the contract artifacts from the [Hyperlane Starknet repository](https://github.com/hyperlane-xyz/hyperlane_starknet).
+
+#### Generating TypeScript Artifacts
+
+```bash
+yarn generate-artifacts
+```
+
+This creates JavaScript and TypeScript declaration files in the `dist/artifacts` directory.
+
+## License
+
+Apache 2.0

starknet/eslint.config.mjs

@@ -0,0 +1,15 @@
+import MonorepoDefaults from '../eslint.config.mjs';
+
+export default [
+  ...MonorepoDefaults,
+  {
+    files: ['**/*.ts'],
+    rules: {
+      'no-console': 'off',
+      'no-restricted-imports': 'off',
+    },
+  },
+  {
+    ignores: ['scripts/**/*'],
+  },
+];

starknet/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@hyperlane-xyz/starknet-core",
+  "description": "Core cairo contracts for Hyperlane",
+  "version": "1.0.0",
+  "type": "module",
+  "homepage": "https://www.hyperlane.xyz",
+  "license": "Apache-2.0",
+  "scripts": {
+    "fetch-contracts": "./scripts/fetch-contracts-release.sh",
+    "generate-artifacts": "tsx ./scripts/generate-artifacts.ts",
+    "build": "tsc && yarn fetch-contracts && yarn generate-artifacts",
+    "clean": "rm -rf ./dist ./release",
+    "lint": "eslint -c ./eslint.config.mjs .",
+    "prettier": "prettier --write ./src ./package.json"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "Hyperlane",
+    "Cairo",
+    "Starknet"
+  ],
+  "dependencies": {
+    "starknet": "^6.24.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.15.0",
+    "@typescript-eslint/eslint-plugin": "^8.1.6",
+    "@typescript-eslint/parser": "^8.1.6",
+    "eslint": "^9.15.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import": "^2.31.0",
+    "globby": "^14.1.0",
+    "prettier": "^3.5.3",
+    "tsx": "^4.19.1",
+    "typescript": "5.3.3"
+  }
+}