@gardenfi/hyperliquid-swaps
v1.0.4
Published
Bridge tokens between Hyperliquid and EVM chains
Readme
@gardenfi/hyperliquid-swaps
A TypeScript SDK for bridging tokens to and from Hyperliquid trading accounts to Arbitrum or HyperEVM, leveraging Hyperliquid APIs.
Overview
This package provides seamless integration between EVM chains and Hyperliquid's trading infrastructure:
- Spot Trading: Connect any EVM token to Hyperliquid's spot account via hyperEVM
- Perpetual Trading: Bridge USDC from Arbitrum to Hyperliquid's perpetual trading account
Key Features
Spot Account (HyperEVM ↔ HyperCore)
- Multi-Token Support: Seamlessly bridge any supported EVM token from HyperEVM to Hyperliquid's spot account
- Real-time Balances: Monitor account balances across all supported tokens
Perpetual Account (Arbitrum ↔ Hyperliquid)
- USDC Bridge: Dedicated pathway for USDC transfers between Arbitrum and Hyperliquid's perp's account
- Balance Management: Real-time USDC balance tracking in your perpetual account
Quick Start
import {
createHyperliquid,
HyperliquidSpot,
HyperliquidPerp,
} from "@gardenfi/hyperliquid-swaps";
import { createWalletClient } from "viem";
// Option 1: Create separate account classes
const spotAccount = new HyperliquidSpot(walletClient, Network.MAINNET);
const perpAccount = new HyperliquidPerp(walletClient, Network.MAINNET);
// Option 2: Create both accounts together
const { spot, perp } = createHyperliquid({
network: Network.MAINNET,
wallet: walletClient,
});
// Get available tokens
const tokens = await spot.getTokens();
// Spot: Deposit any token to hyperEVM
await spot.deposit("USDC", "1000000000"); // 1000 USDC (6 decimals)
// Spot: Withdraw any token from hyperEVM
await spot.withdraw("HYPE", "0.001"); // 0.001 HYPE
// Perp: Deposit USDC from Arbitrum
await perp.deposit("1000000000"); // 1000 USDC (6 decimals)
// Perp: Withdraw USDC to Arbitrum
await perp.withdraw("1000"); // 1000 USDC
// Spot: Transfer USDC to perp account
await spot.transfer("5"); // 5 USDC
// Perp: Transfer USDC to spot account
await perp.transfer("5"); // 5 USDCNetwork Architecture
Arbitrum <──> Hyperliquid Perp (USDC Only)
hyperEVM <──> Hyperliquid Spot (Any Token)Installation
npm install @gardenfi/hyperliquid-swaps