View Source Hyperliquid.Api.Exchange.Hip3LiquidatorTransfer (hyperliquid v0.4.1)

Move collateral in or out of a HIP-3 DEX's liquidator account.

Notional amounts are integers in USDC units as used by the liquidator account.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/hip-3-deployer-actions

Usage

{:ok, result} = Hip3LiquidatorTransfer.deposit("test", 1_000)
{:ok, result} = Hip3LiquidatorTransfer.withdraw("test", 500)

Summary

Functions

Deposit notional into a HIP-3 DEX's liquidator account.

Move notional in or out of a HIP-3 DEX's liquidator account.

Withdraw notional from a HIP-3 DEX's liquidator account.

Functions

Link to this function

deposit(dex, ntl, opts \\ [])

View Source
@spec deposit(String.t(), non_neg_integer(), keyword()) ::
  {:ok, map()} | {:error, term()}

Deposit notional into a HIP-3 DEX's liquidator account.

Parameters

  • dex: HIP-3 perp DEX name
  • ntl: Notional amount
  • opts: Optional parameters

Returns

  • {:ok, response} / {:error, term()}
Link to this function

request(dex, ntl, is_deposit, opts \\ [])

View Source
@spec request(String.t(), non_neg_integer(), boolean(), keyword()) ::
  {:ok, map()} | {:error, term()}

Move notional in or out of a HIP-3 DEX's liquidator account.

Parameters

  • dex: HIP-3 perp DEX name
  • ntl: Notional amount
  • is_deposit: true to deposit, false to withdraw
  • opts: Optional parameters

Returns

  • {:ok, response} / {:error, term()}
Link to this function

withdraw(dex, ntl, opts \\ [])

View Source
@spec withdraw(String.t(), non_neg_integer(), keyword()) ::
  {:ok, map()} | {:error, term()}

Withdraw notional from a HIP-3 DEX's liquidator account.

Parameters

  • dex: HIP-3 perp DEX name
  • ntl: Notional amount
  • opts: Optional parameters

Returns

  • {:ok, response} / {:error, term()}