> For the complete documentation index, see [llms.txt](https://hyperliquid.gitbook.io/hyperliquid-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/hip-4-deployer-actions.md). # HIP-4 deployer actions #### Overview To ensure markets are high quality and well-defined, validators vote on outcome templates, which HIP-4 deployers use as the basis for permissionless deployments. Templates fix the structure of the specification's display text, side names, and the set of typed keywords. Deploying has no gas cost. Capacity is instead bounded by per-deployer limits (see Limits). #### Action format The following actions are involved in deployment: ```json { "type": "activateOutcomeDeployer", "activate": { "venueName": } } { "type": "activateOutcomeDeployer", "deactivate": null } { "type": "spotDeploy", "outcome": { "": { ...variant fields... } } } ``` * Outcomes and questions are referenced by the numeric index assigned at creation, e.g. `"outcome": 7`. * **Venue name**: 2–4 lowercase ASCII letters, subject to the same rules as HIP-3 perp DEX names. The name must be unique across the venue names of all deployers — including deactivated ones, whose names stay reserved — and must not match an existing perp DEX name (nor `spot`). Conversely, a registered venue name cannot be claimed by a later perp DEX deployment. * As with HIP-3, all lists of tuples should be lexicographically sorted before signing * `keywordToValue` is a sorted list of tuples mapping each template keyword to its value. For example, `[["expiry","20260801-0600"],["target","100"],["underlying","ABC"]]`. * Name-and-description values are two-element arrays: `["", ""]`. * `sideNames` arrays are `["", ""]`. * Amounts and settlement fractions are decimal strings (`"1"`, `"0.25"`). #### Activation `activateOutcomeDeployer` is an enum with `activate` and `deactivate` variants: ```json { "type": "activateOutcomeDeployer", "activate": { "venueName": "ab" } } { "type": "activateOutcomeDeployer", "deactivate": null } ``` * **Staking requirement**: active deployers must maintain the staking requirement for as long as it remains an outcome deployer. Requirements stack with the deployer's other staking requirements. For example, stake that counts towards HIP-3 deployment does not double-count towards outcome deployment. * Deployers must use Standard account abstraction. Deactivation requires that the minimum deployer staking duration (183 days) has elapsed and that the deployer has no active outcomes. Deactivation is permanent: the account cannot activate again, and its venue name stays reserved. #### Templates Every deployer-created market comes from a template. A template has one of three roles: * **Standalone outcome**: deploys a single YES/NO market; the template fixes the side names. * **Question**: deploys a question (the container). * **Question outcome**: deploys one outcome of a question; each question-outcome template declares its parent question template, and instantiations are only accepted under that parent. A template fixes display name and description text containing `{keyword}` placeholders (e.g., `"{underlying} above {target} at {expiry}"`) together with a typed `hint` per keyword. An instantiation supplies exactly one value per keyword. Keyword value formats by hint type: | Hint | Value format | | ------------- | ------------------------------------------------------------------------------------------- | | `dateTime` | `%Y%m%d-%H%M`, e.g. `"20260712-1830"`; must be within the next year | | `date` | `YYYYMMDD`, e.g. `"20260712"` (end of day); must be within the next year | | `string` | free text | | `shortString` | free text of at most 10 characters | | `hlPerp` | coin name of an existing perp, e.g. `"ABC"` or `"test:ABC"` | | `uInt` | nonnegative integer that fits in a u64, e.g. `"250"` (no sign or leading zeros) | | `uDecimal` | nonnegative decimal, e.g. `"0.5"` or `"250"` (no sign, exponent, or leading/trailing zeros) | Values are at most 100 characters and cannot contain `{`, `}`, or `|` (`:` is allowed, e.g. for HIP-3 coin names). The onchain outcome descriptions are derived from the instantiation: * **Name**: `template:`, e.g. `template:aaa`. The `template:` prefix is reserved. Only template deployments can produce it. * **Description**: the keyword-value pairs sorted by keyword and joined as `keyword:value|keyword:value`, e.g. `expiry:20260801-0600|target:100|underlying:BTC`. * **Side names**: for standalone outcomes, `template:` plus the template's side names (e.g. `template:Over` / `template:Under`); question outcomes use the defaults `Yes` / `No`. * **Question fallback**: named `template fallback` with description `other` and side names `Yes` / `No`. #### Deployer fee scale Template instances (`registerStandaloneOutcomeFromTemplate` and the `questionTemplateInstance` of `registerQuestionFromTemplate`) carry a required `deployerFeeScale`, a decimal string in `[0, 10]` (`Deployer fee scale cannot be negative or greater than 10.`). * Users trading the outcome's markets pay the base outcome trading fee rate times `scale + max(scale, 1)`: the deployer receives the `scale` component and the protocol the rest. With `"0"`, users pay the base rate and the deployer receives nothing. Maker rebates are never paid on outcome markets. * A question's scale applies uniformly to its fallback and every question outcome, including ones associated later; question outcome template instances carry no scale of their own. * Per-outcome scales are returned in the `outcomeMeta` info request. Examples, expressed as multiples of the user's base outcome trading fee rate: | `deployerFeeScale` | Total user fee | Deployer receives | Protocol receives | | ------------------ | -------------- | ----------------- | ----------------- | | `"1"` | 2x | 1x | 1x | | `"3"` | 6x | 3x | 3x | | `"10"` | 20x | 10x | 10x | | `"0.5"` | 1.5x | 0.5x | 1x | | `"0.25"` | 1.25x | 0.25x | 1x | | `"0"` | 1x | 0x | 1x | #### Action reference The `outcome` family of `spotDeploy` has five deployer variants. **`registerStandaloneOutcomeFromTemplate`** Deploys a standalone YES/NO market from a standalone outcome template. ```json { "type": "spotDeploy", "outcome": { "registerStandaloneOutcomeFromTemplate": { "id": "abc", "keywordToValue": [ ["expiry", "20260801-0600"], ["target", "100"], ["underlying", "ABC"] ], "deployerFeeScale": "1" } } } ``` **`registerQuestionFromTemplate`** Deploys a question and its question outcomes in one action. ```json { "type": "spotDeploy", "outcome": { "registerQuestionFromTemplate": { "questionTemplateInstance": { "id": "abc", "keywordToValue": [["expiry", "20260801-1830"]], "deployerFeeScale": "1" }, "namedOutcomeTemplateInstances": [ { "id": "abc-outcome", "keywordToValue": [["choice", "A"]] }, { "id": "abc-outcome", "keywordToValue": [["choice", "B"]] }, { "id": "abc-other", "keywordToValue": [] } ] } } } ``` * Each question outcome template must declare the question template as its parent. The same question outcome template may be instantiated multiple times with different values. * A question with N question outcomes registers N + 1 outcomes (the fallback is created automatically). All count toward the deployer's active-outcome cap. * More question outcomes can be added to the live question with `registerAndAssociateNamedOutcomeFromTemplate`. Bounded to at most 100 question outcomes per question. **`registerAndAssociateNamedOutcomeFromTemplate`** Adds one question outcome to a live question of the deployer. ```json { "type": "spotDeploy", "outcome": { "registerAndAssociateNamedOutcomeFromTemplate": { "question": 3, "namedOutcomeTemplateInstance": { "id": "abc-outcome", "keywordToValue": [["choice", "C"]] } } } } ``` * The question must have been deployed from a template, and the question outcome template must declare the question's template as its parent. * The new outcome inherits the question's `deployerFeeScale` and counts toward the deployer's active-outcome and daily caps. * Holders of the question's fallback YES token receive an equal balance of the new outcome's YES token, so existing "other" positions keep their meaning. **`settleOutcome`** Settles one outcome of the deployer. ```json { "type": "spotDeploy", "outcome": { "settleOutcome": { "outcome": 7, "settleFraction": "1", "details": "", "nameAndDescription": ["template:abc", "expiry:20260801-0600|target:100|underlying:ABC"], "sideNames": ["template:Over", "template:Under"] } } } ``` * `nameAndDescription` and `sideNames` must exactly match the outcome being settled. * `settleFraction` is a decimal in `[0, 1]`. Standalone outcomes may settle to any fraction (e.g. `"0.66"` for scalar payouts); outcomes that belong to a question must settle to exactly `"0"` or `"1"`. * `details` must be empty. * For question outcomes, settlement is sequential: question outcomes may settle to `"0"` in any order. A single outcome settles to `"1"` after it is the last active question outcome, which automatically settles the fallback to 0 and settles the question. **`settleQuestion2`** Settles all remaining question outcomes of a question in one action. Note: The original `settleQuestion` variant is discontinued. ```json { "type": "spotDeploy", "outcome": { "settleQuestion2": { "question": 3, "outcomeSettlements": [ { "outcome": 11, "settleFraction": "1", "details": "", "nameAndDescription": ["template:abc-outcome", "choice:A"], "sideNames": ["Yes", "No"] }, { "outcome": 12, "settleFraction": "0", "details": "", "nameAndDescription": ["template:abc-outcome", "choice:B"], "sideNames": ["Yes", "No"] } ], "nameAndDescription": ["template:abc", "expiry:20260801-1830"] } } } ``` * `outcomeSettlements` must cover exactly the question's remaining active question outcomes, with exactly one settling to `"1"` and all others to `"0"`. The fallback settles to 0 automatically. #### Read API * `{"type": "outcomeMeta"}` info request includes non-null outcome deployers. * `{"type": "outcomeTemplates"}` info request returns all templates. #### Limits * At most `N` active outcomes per deployer (N=10 on testnet). Settling outcomes frees capacity. * A deployer can deploy `M` outcomes per day (M=50 on testnet).