Deposits

Key On‑Chain State

Step 1: Transfer your ERC‑20 into THLP, bridge it into a cloned OrderHelper, and place a Core limit‑sell order.

function depositCollateral(
  address token,
  address sys,
  uint32 index,
  uint256 amountNtl,
  uint8 coreDec,
  uint64 tokenId,
  uint16 slippageBps
) external nonReentrant;

• Reverts if amountNtl == 0 or < MIN_DEPOSIT, or if you already have a pending deposit.
• Reads ERC‑20 decimals ⇒ evmDec; computes amtEvmWei = amountNtl × 10^evmDec (your on‑chain token units).
• Computes amtCoreWei = amountNtl × 10^coreDec (Core’s token units), then transferFrom → THLP → Core sys address.
• Clones a fresh OrderHelper, pre‑funds it via sendSpotSend(coreTokenId, amtCoreWei) and then calls placeOrder().
• Your `slippageBps` is the maximum deviation from mid‑price you’ll accept: limitPx = midPx × (10 000 – slippageBps) / 10 000.
• Typically your UI will fetch the current best bid/ask, compute a small slippage tolerance (e.g. 5–50 bps), and pass it in automatically.
• Stores Dep({ amt: 0, collateral: amtCoreWei, …, helper, st: BRIDGED }) and emits DepositStarted.

Step 2: Once Core fills your order, sweep back USDC, deduct any deposit fee, and enqueue into the current epoch bucket in the HyperLiquid vault.

function depositConfirmAndDeposit() external nonReentrant;

• Requires dep[msg.sender].st == BRIDGED.
• OrderHelper.sweepFilled() ⇒ filledUsdc; split out fee with _splitFee; send fee to owner if enabled.
• Set dep[msg.sender].amt = net, totalDeposits += net.
• Call _activeBucket() to clone or reuse a bucket helper, sendSpotSend(USDC_ID, net), then vaultDeposit(vault, net ÷ 1e6).
• Mark dep[msg.sender].st = FINALIZED and emit VaultDepositEnqueued.

Step 3: Once the HyperLiquid vault equity has updated, mint your tHLP shares pro‑rata and clear your pending state.

function depositFinalize() external;

• Requires dep[msg.sender].st == FINALIZED.
• Optionally verify vaultEquity > preEq to guard against failed deposits.
• Compute shares = _convertToShares(dep[msg.sender].amt, totalSupply()).
• Mint those shares, delete dep[msg.sender], and emit DepositFinalized.

Cancel your in‑flight deposit if your Core limit order never fills (or you change your mind).

function refundCollateral() external nonReentrant;

• Requires dep[msg.sender].st == BRIDGED.
• Calls OrderHelper.sweepBackBase(tokenId) to retrieve any unsold base tokens from Core.
• Forwards that amount back to you via sendSpotSend, then deletes dep[msg.sender].
• You’ll get 100 % of your original collateral back—no fees are taken on refunds.