HIP-3 部署者操作

部署和運營由部署者部署的永續合約 dex 的 API 涉及以下 L1 操作：

// IMPORTANT: All lists of tuples should be lexographically sorted before signing
type PerpDeployAction =
  | {
      type: "perpDeploy";
      registerAsset2: RegisterAsset2;
    }
  | {
      type: "perpDeploy";
      registerAsset: RegisterAsset;
    }
  | {
      type: "perpDeploy";
      setOracle: SetOracle;
    }
  | {
      type: "perpDeploy";
      setFundingMultipliers: SetFundingMultipliers;
    }
  | {
      type: "perpDeploy";
      setFundingInterestRates: SetFundingInterestRates;
    }
  | {
      type: "perpDeploy";
      setFundingClamps: SetFundingClamps;
    }
  | {
      type: "perpDeploy";
      haltTrading: { coin: string; isHalted: boolean };
    }
  | {
      type: "perpDeploy";
      insertMarginTable: InsertMarginTable;
    }
  | {
      type: "perpDeploy";
      setMarginTableIds: SetMarginTableIds;
    }
  | {
      type: "perpDeploy";
      setFeeRecipient: { dex: string; feeRecipient: address };
    }
  | {
      type: "perpDeploy";
      setOpenInterestCaps: SetOpenInterestCaps;
    }
  | {
      type: "perpDeploy";
      setSubDeployers: { dex: string; subDeployers: Array<SubDeployerInput> };
    }
  | {
      type: "perpDeploy";
      setMarginModes: SetMarginModes;
    }
  | {
      type: "perpDeploy";
      setDeployerFees: SetDeployerFees;
    }
  | {
      type: "perpDeploy";
      setPerpAnnotation: SetPerpAnnotation;
    }
  | {
      type: "perpDeploy";
      disableDex: string;
    };

// User-signed action to transfer collateral between the user's DEX account and its backstop liquidator.
// ntl must be positive and a multiple of 1_000_000_000.
type Hip3LiquidatorTransferAction = {
  type: "hip3LiquidatorTransfer";
  dex: string;
  ntl: number; // Integer amount in millionths of a collateral token: 1_000_000_000 = 1,000 tokens
  isDeposit: boolean; // true deposits; false withdraws
};

/**
 * RegisterAsset2 can be called to initialize a new dex and register an asset at the same time.
 * If schema is not provided, then RegisterAsset can be called multiple times to register additional assets
 * for the provided dex.
 * @param maxGas - Max gas in native token wei. If not provided, then uses current deploy auction price.
 * If the max gas is 0, then a reserve deployment will be used.
 * A reserve deployment allows deployment at the current price of the gas auction, even if it has ended.
 * Currently, 7 reserve deployments are allowed.
 * IMPORTANT: A reserve deployment will be used regardless of whether the auction has completed, so deployers should query the auction status first.
 * @param assetRequest - Contains new asset listing parameters. See RegisterAssetRequest2 below for details.
 * @param dex - Name of the perp dex (2-4 lowercase characters)
 * @param schema - Contains new perp dex parameters. See PerpDexSchemaInput below for details.
 */
type RegisterAsset2 = {
  maxGas?: number;
  assetRequest: RegisterAssetRequest2;
  dex: string;
  schema?: PerpDexSchemaInput;
};

// Same as RegisterAsset2 but uses RegisterAssetRequest
type RegisterAsset = {
  maxGas?: number;
  assetRequest: RegisterAssetRequest;
  dex: string;
  schema?: PerpDexSchemaInput;
};

type RegisterAssetRequest2 = {
  coin: string;
  szDecimals: number;
  oraclePx: string;
  marginTableId: number;
  marginMode: "strictIsolated" | "noCross" | "normal"; // strictIsolated does not allow withdrawing of isolated margin from open positions
};

type RegisterAssetRequest = {
  coin: string;
  szDecimals: number;
  oraclePx: string;
  marginTableId: number;
  onlyIsolated: boolean;
};

/**
 * The markPxs outer list can be length 0, 1, or 2. The median of these inputs
 * along with the local mark price (median(best bid, best ask, last trade price))
 * is used as the new mark price update.
 *
 * SetOracle can be called multiple times but there must be at least 2.5 seconds between calls.
 *
 * Stale mark prices will be updated to the local mark price after 10 seconds of no updates.
 * This fallback counts as an update for purposes of the maximal update frequency.
 * This fallback behavior should not be relied upon. Deployers are expected to call setOracle every 3 seconds even with no changes.
 *
 * All prices are clamped to 10x the start of day value.
 * markPx moves are clamped to 1% from previous markPx.
 * markPx cannot be updated such that open interest would be 10x the open interest cap.
 * @param dex - Name of the perp dex
 * @param oraclePxs - A list (sorted by key) of asset and oracle prices.
 * @param markPxs - An outer list of inner lists (inner list sorted by key) of asset and mark prices.
 * @param externalPerpPxs - A list (sorted by key) of asset and external prices which prevent sudden mark price deviations.
 * Ideally externally determined by deployer, but could fall back to an EMA of recent mark prices.
 * Must include all assets.
 */
type SetOracle = {
  dex: string;
  oraclePxs: Array<[string, string]>;
  markPxs: Array<Array<[string, string]>>;
  externalPerpPxs: Array<[string, string]>;
};

/**
 * @param fullName - Full name of the perp dex
 * @param collateralToken - Collateral token index
 * @param oracleUpdater - User to update oracles. If not provided, then deployer is assumed to be oracle updater.
 */
type PerpDexSchemaInput = {
  fullName: string;
  collateralToken: int;
  oracleUpdater?: string;
};

/**
 * A sorted list of asset and funding multiplier.
 * Multipliers must be between 0 and 10 and are used to scale the funding rate.
 */
type SetFundingMultipliers = Array<[string, string]>;

/**
 * A sorted list of asset and 8 hour interest rate.
 * Interest rates must be between -0.01 and 0.01 and are used as the interest rate
 * component in the funding calculation.
 */
type SetFundingInterestRates = Array<[string, string]>;

/**
 * A sorted list of asset and 8 hour funding clamp.
 * Clamps must be between 0 and 0.01 and bound how far the funding rate can move away from the
 * average premium toward the interest rate. Defaults to 0.0003.
 */
type SetFundingClamps = Array<[string, string]>;

/**
 * A sorted of asset and margin table ids.
 * Margin table ids must be non-zero.
 */
type SetMarginTableIds = Array<[string, number]>;

/**
 * Inserts margin table to dex
 */
type InsertMarginTable = {
  dex: string;
  marginTable: RawMarginTable;
};

/**
 * marginTiers must be sorted in order of increasing lower bound and decreasing maxLeverage
 * marginTiers has a maximum length of 3.
 */
type RawMarginTable = {
  description: string;
  marginTiers: Array<RawMarginTier>;
};

/**
 * lowerBound is a position notional value above which the leverage is constrained by maxLeverage
 */
type RawMarginTier = {
  lowerBound: int;
  maxLeverage: MaxLeverage;
};

/**
 * Max leverage is in the range [1, 50]
 */
type MaxLeverage = number;

/**
 * A sorted list of asset and open interest cap notionals.
 * Open interest caps must be at least the maximum of 1_000_000 (1 size unit of collateral asset) or half of the current open interest.
 * null removes the custom cap for an asset.
 */
type SetOpenInterestCaps = Array<[string, number | null]>;

/**
 * A modification to sub-deployer permissions
 */
type SubDeployerInput = {
  variant: string; // corresponds to a variant of PerpDeployAction. For example, "haltTrading" or "setOracle"
  user: String;
  allowed: boolean; // add or remove the subDeployer from the authorized set for the action variant
};

// A sorted list of (coin, marginMode). See RegisterAssetRequest2 for margin mode definitions.
type SetMarginModes = Array<[string, "strictIsolated" | "noCross" | "normal"]>;

// Let the user normal rate be `x`. Let the user rate be `y` after accounting for aligned quote collateral.
// In other words, `x = y` for non-aligned collateral.
// User pays or receives rebate `P + D` where `P` goes to protocol and `D` goes to deployer.
// If `x > 0` and `scale < 1`, `P = y` and `D = scale * x`
// If `x > 0` and `scale > 1`, `P = y * scale` and `D = x * scale`
// If `x < 0` and `scale < 1`, `P = y / (1 + scale)` and `D = y * scale / (1 + scale)`
// If `x < 0` and `scale > 1`, `P = y / 2` and `D = y / 2`
// On Mainnet, rate limited to one change per 30 days.
// Note that there are currently no aligned quote assets on mainnet.
type SetDeployerFees = Array<
  [
    string,
    {
      scale: string; // Decimal string in [0.0, 3.0], or [0.0, 10.0) when growthMode is true
      growthMode: boolean;
    },
  ]
>;

// category <= 15 characters
// description <= 400 characters
// displayName <= 9 characters
// <= 2 keywords, each keyword <= 10 characters
type SetPerpAnnotation = {
  coin: string;
  category: string;
  description: string;
  displayName: string | null;
  keywords: Array<string>;
};

在以下示例中，feeScale 即 SetDeployerFees 中的 scale 欄位。假設正的普通用戶費率爲 1 個單位且爲非對齊抵押品（x = y = 1）。userFeeToProtocol 和 userFeeToDeployer 是向用戶收取的相應費用單位。

如何查詢永續合約部署拍賣的狀態，參見 https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-information-about-the-perp-deploy-auction。

Open interest caps

由部署者部署的永續合約市場受兩類持倉上限（open interest cap）約束：名義上限（持倉絕對規模乘以標記價格之和）和規模上限（持倉絕對規模之和）。

名義持倉上限在 DEX 內所有資產的總持倉上執行，同時也在單資產級別執行。永續合約部署者可以爲每個資產設定自定義持倉上限，詳見 https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/hip-3-deployer-actions。

以規模計的持倉上限僅在單資產級別執行。以規模計的持倉上限目前爲每資產恆定的 1B，因此合理的預設做法是將 szDecimals 設定爲使最小規模增量在初始標記價格下相當於 $1-10。

Backstop liquidator

後備清算者地址爲 0x4000000000000000000000000000000000000000 + {dex_index}。例如，第一個 HIP-3 DEX 的後備清算者地址爲 0x4000000000000000000000000000000000000001。

Node user clearinghouse states

節點標誌 --write-user-clearinghouse-states <dex> 會將指定 HIP-3 DEX 的清算所狀態按小時寫入文件，路徑爲 ~/hl/data/dex_user_clearinghouse_states/hourly/<date>/<hour>，其中 date 爲 YYYYMMDD。每行是一個 JSON 陣列 [time, messages]，其中 time 是區塊時間，messages 要麼是該 DEX 上所有用戶的單個快照，要麼是按用戶區分的差分列表：

["2026-09-24T09:00:00.123", [{ "Snapshot": { "0xUSER_A": <clearinghouseState> } }]]
["2026-09-24T09:00:03.456", [{ "Diff": ["0xUSER_A", <clearinghouseState>] }]]

每個 <clearinghouseState> 的格式與該 DEX 的 clearinghouseState info 請求回應相同，以該交易場所的抵押品代幣計價。它只計入用戶在指定 DEX 上的狀態，因此跨 DEX 共享的抵押品（例如通過用戶抽象）不包含在內，且 liquidationPx 恆爲 null。每個文件的第一行以及節點啓動後寫入的第一行是快照。其餘各行包含清算所狀態發生變化的用戶的差分，且忽略 time：該場所每次預言機更新時會包含每一個這樣的用戶，而在發生成交、清算、資金費用支付或轉入/轉出該場所的劃轉時，只包含涉及的用戶。

HIP-3* (testnet-only)

Star actions

創建 HIP-3 交易場所時，可以通過在 PerpDexSchemaInput 中設定 isStar: true 將其指定爲 HIP-3*。該可選布爾值預設爲 false。HIP-3* 在 HIP-3 規範之上啓用了若干功能，包括許可名單和代理用戶操作。

Operations

type Hip3StarAction = {
  type: "perpDeploy";
  star: { dex: string; operation: Hip3StarOperation };
};

type Hip3StarOperation =
  | { proxy: [address, Hip3StarProxyOperation] }
  | { setOracle: { oraclePxs: Array<[string, string]> } };

// CancelAction and OrderAction are the standard exchange actions.
type Hip3StarProxyOperation =
  | { modifyApproval: boolean }
  | { modifyBackstopLiquidatorApproval: boolean }
  | { setReduceOnly: boolean }
  | { cancel: Omit<CancelAction, "type"> }
  | { cancelAll: { assets?: Array<number> | null } }
  | { order: Omit<OrderAction, "type"> }
  | { sendAsset: { destination: address; amount: string } };

{
  "type": "perpDeploy",
  "star": {
    "dex": "test",
    "operation": { "proxy": ["0xUSER_A", { "modifyApproval": true }] }
  }
}
{
  "type": "perpDeploy",
  "star": {
    "dex": "test",
    "operation": { "proxy": ["0xUSER_B", { "cancelAll": { "assets": [100001, 100002] } }] }
  }
}
{
  "type": "perpDeploy",
  "star": {
    "dex": "test",
    "operation": { "setOracle": { "oraclePxs": [["test:BTC", "100000.0"], ["test:ETH", "4000.0"]] } }
  }
}

• proxy — 由用戶地址和應用於該用戶的一個代理操作組成的二元組。
• setOracle — 更新預言機價格，如下文 Oracle 部分所述。

Proxy operations

• modifyApproval — { "modifyApproval": true } 將用戶加入許可名單，false 則移除該用戶並清除其標誌。移除一個未被批准的用戶是空操作（no-op）。重新批准一個已批准的用戶是空操作並保留該用戶的標誌。被移除後再次獲得批准的用戶將從預設標誌開始。
• modifyBackstopLiquidatorApproval — { "modifyBackstopLiquidatorApproval": true } 允許用戶通過 hip3LiquidatorTransfer 向該場所的後備清算者充值和從中提幣；false 則撤銷此權限。用戶必須已通過 modifyApproval 獲得批准。
• setReduceOnly — { "setReduceOnly": true } 將已批准的用戶限制爲只能在該場所減倉。該用戶只能下只減倉訂單和 TWAP、將訂單改爲只減倉訂單以及撤單。{ "setReduceOnly": false } 恢復完整交易權限。
• cancel — { "cancel": { "cancels": [{ "a": <asset>, "o": <oid> }] } }，即標準的 cancel exchange action 負載。按 oid 撤銷該用戶的掛單。
• cancelAll — { "cancelAll": { "assets": null } } 撤銷該用戶在此場所的所有掛單和 TWAP。{ "cancelAll": { "assets": [<asset>, ...] } } 僅撤銷所列資產的掛單和 TWAP。列表必須包含 1-10 個條目。
• order — { "order": { "orders": [...], "grouping": "na" } }，即標準的 order exchange action 負載。每筆訂單必須是只減倉訂單（"r": true）。
• sendAsset — { "sendAsset": { "destination": "0xUSER_C", "amount": "100.0" } }。將抵押品從被代理用戶在該 DEX 上的帳戶劃轉至 destination 在同一場所的帳戶。

Oracle

HIP-3* 場所通過 setOracle star 操作部署操作更新價格。oraclePxs 是按 key 排序的資產與現貨預言機價格的列表。外部永續合約價格和標記價格根據部署者的現貨預言機價格輸入在鏈上推導得出。

• 外部永續合約價格根據主 dex 中同名的資產推導，計價單位換算爲 USDC。例如，test:BTC 使用 BTC 的外部永續合約價格。
• 標記價格在鏈上按以下價格的中位數計算：

1. 經中間價相對預言機價格的溢價指數移動平均調整後的預言機價格，
2. 外部永續合約價格，以及
3. 本地標記價格（最優買價、最優賣價、最近成交價的中位數）。

如果這三個價格中只有兩個可用，則會加入本地標記價格的指數移動平均作爲第三個輸入。

Permissions

對於 HIP-3*，SubDeployerInput.variant 還接受下表所示的對象。

每項授權僅覆蓋其自身的操作。例如，modifyApproval 授權不允許 modifyBackstopLiquidatorApproval、setReduceOnly 或 sendAsset。同樣，常規的 "setOracle" 授權（包括授予 oracleUpdater 的授權）不允許執行 setOracle star 操作。

User star state

userStarState info 請求返回用戶在其已獲批准的每個 HIP-3* 場所上的批准狀態。對於此後已移除該用戶批准的場所，狀態爲 null。

{ "type": "userStarState", "user": "0xUSER_A" }

{
  "dexToState": {
    "test": {
      "isReduceOnly": false,
      "isBackstopLiquidatorDepositAllowed": true
    },
    "demo": null
  }
}