> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usemina.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Mina SDK

> Cross-chain bridge SDK for Hyperliquid - Bridge assets from 40+ chains with automatic deposit to trading accounts

# Mina SDK

The Mina SDK is a TypeScript-first cross-chain bridge SDK that enables seamless bridging of assets from over 40 blockchain networks directly to Hyperliquid. With built-in auto-deposit functionality, bridged USDC is automatically deposited to your trading account on Hyperliquid L1.

## Features

<CardGroup cols={2}>
  <Card title="40+ Supported Chains" icon="link">
    Bridge from Ethereum, Arbitrum, Optimism, Base, Polygon, Avalanche, BSC, and many more chains to HyperEVM.
  </Card>

  <Card title="Auto-Deposit to L1" icon="arrow-right-to-arc">
    Bridged USDC is automatically detected and deposited to your Hyperliquid L1 trading account.
  </Card>

  <Card title="Smart Route Optimization" icon="route">
    Intelligent routing finds the best bridge path based on speed, cost, or a balanced recommendation.
  </Card>

  <Card title="React Integration" icon="react">
    First-class React support with hooks for quotes, balances, and transaction status tracking.
  </Card>
</CardGroup>

## How It Works

The Mina SDK simplifies the complex process of cross-chain bridging and depositing to Hyperliquid into a single, streamlined flow.

<Steps>
  <Step title="Get a Quote">
    Request a bridge quote specifying source chain, destination (HyperEVM), tokens, and amount. The SDK finds optimal routes across integrated bridge protocols.
  </Step>

  <Step title="Approve Tokens">
    If needed, the SDK prompts for token approval. This is a one-time operation per token per chain.
  </Step>

  <Step title="Execute Bridge">
    Sign and submit the bridge transaction. The SDK handles all the complexity of cross-chain messaging.
  </Step>

  <Step title="Detect USDC Arrival">
    The SDK monitors HyperEVM for your USDC arrival, polling the balance until the bridge completes.
  </Step>

  <Step title="Auto-Deposit to L1">
    Once USDC arrives on HyperEVM, the SDK automatically approves and executes the deposit to Hyperliquid L1.
  </Step>

  <Step title="Confirmation">
    The SDK confirms the deposit is reflected in your Hyperliquid L1 trading balance.
  </Step>
</Steps>

## Architecture Overview

```
Your Application
       |
       v
+------------------+
|    Mina SDK      |
+------------------+
       |
       +---> Chain Service (discover chains)
       |
       +---> Token Service (discover tokens)
       |
       +---> Quote Service (get bridge quotes via LiFi)
       |
       +---> Execute Service (submit bridge transactions)
       |
       +---> Deposit Service (auto-deposit to Hyperliquid L1)
       |
       v
+------------------+
|    HyperEVM      |  <-- USDC arrives here
+------------------+
       |
       v
+------------------+
| Hyperliquid L1   |  <-- USDC deposited to trading account
+------------------+
```

## Quick Links

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/installation">
    Install the SDK with npm, yarn, pnpm, or bun
  </Card>

  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Bridge your first transaction in 5 minutes
  </Card>

  <Card title="API Reference" icon="code" href="/api/mina">
    Complete API documentation for all methods
  </Card>

  <Card title="React Hooks" icon="react" href="/react/installation">
    Use the SDK with React hooks and providers
  </Card>
</CardGroup>

## Requirements

<AccordionGroup>
  <Accordion title="Runtime Requirements">
    * Node.js 18+ or modern browser with ES2020 support
    * TypeScript 5.0+ (optional, but recommended)
  </Accordion>

  <Accordion title="Peer Dependencies">
    * `viem` ^2.0.0 - Required for Ethereum interactions
    * `react` ^18.0.0 - Required only for React hooks
  </Accordion>

  <Accordion title="Wallet Requirements">
    * Any EVM-compatible wallet (MetaMask, WalletConnect, Coinbase Wallet, etc.)
    * Sufficient native token balance for gas on the source chain
  </Accordion>
</AccordionGroup>

## Package Information

| Property       | Value                          |
| -------------- | ------------------------------ |
| Package Name   | `@siphoyawe/mina-sdk`          |
| Latest Version | 1.0.0                          |
| Bundle Size    | \~45KB (minified + gzipped)    |
| License        | MIT                            |
| TypeScript     | Full type definitions included |
| Tree-Shakeable | Yes                            |

## Supported Chains

The SDK supports bridging from 40+ chains to HyperEVM (Chain ID: 999). Some of the most popular source chains include:

| Chain                  | Chain ID | Native Token |
| ---------------------- | -------- | ------------ |
| Ethereum               | 1        | ETH          |
| Arbitrum               | 42161    | ETH          |
| Optimism               | 10       | ETH          |
| Base                   | 8453     | ETH          |
| Polygon                | 137      | MATIC        |
| Avalanche              | 43114    | AVAX         |
| BSC                    | 56       | BNB          |
| HyperEVM (destination) | 999      | ETH          |

<Tip>
  Use `mina.getChains()` to fetch the complete list of supported chains at runtime.
</Tip>

## Next Steps

Ready to get started? Install the SDK and bridge your first transaction.

<CardGroup cols={2}>
  <Card title="Install the SDK" icon="terminal" href="/installation">
    Get the SDK installed in your project
  </Card>

  <Card title="Quick Start Guide" icon="play" href="/quickstart">
    Follow our 5-minute quick start guide
  </Card>
</CardGroup>
