@stableflow/hyperliquid
v3.0.0
Published
Hyperliquid helpers for StableFlow SDK
Readme
@stableflow/hyperliquid
Hyperliquid deposit helpers for the StableFlow SDK: quote via OneClick, transfer on source chain, permit + deposit to Hyperliquid, and status polling.
Installation
pnpm add @stableflow/hyperliquid @stableflow/core @stableflow/bridgesInstall wallet adapters for the source chain (e.g. @stableflow/wallet-evm, @stableflow/wallet-solana) and an EVM wallet on Arbitrum for USDC permit signing.
Main exports
| Export | Description |
|--------|-------------|
| Hyperliquid | Service instance: quote, transfer, deposit, getStatus |
| HyperliquidFromTokens | Supported source tokens |
| HyperliuquidToToken | Destination token (USDC on Arbitrum) — note typo in export name |
| HyperliuquidMinAmount | Minimum amountWei for quotes — note typo in export name |
Types: HyperliquidQuoteParams, HyperliquidTransferParams, HyperliquidDepositParams, HyperliquidGetStatusParams, …
Flow
Hyperliquid.quote({ dry: true, ... })— fast estimate (defaultdry: true)Hyperliquid.quote({ dry: false, ... })— obtain deposit address before transferHyperliquid.transfer({ wallet, quote })— source-chain deposit txHyperliquid.deposit({ evmWallet, evmWalletAddress, quote, txhash })— Arbitrum USDC permit + API depositHyperliquid.getStatus({ depositId })— poll deposit status
See Developer Guide for details.
