Skip to content

feat(exchange/spotDeploy): add outcome deployer actions #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nktkas merged 1 commit into from
Aug 1, 2026
Merged

feat(exchange/spotDeploy): add outcome deployer actions #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions src/api/exchange/_methods/spotDeploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,85 @@ export const SpotDeployRequest = /* @__PURE__ */ (() => {
evmExtraWeiDecimals: v.pipe(Integer, v.minValue(-2), v.maxValue(18)),
}),
}),
v.object({
/** Type of action. */
type: v.literal("spotDeploy"),
/**
* Outcome deployer parameters.
* @see https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/hip-4-deployer-actions
*/
outcome: v.union([
v.object({
/** Deploy a standalone Yes/No market from a standalone outcome template. */
registerStandaloneOutcomeFromTemplate: v.object({
/** Template identifier. */
id: v.string(),
/** A list (sorted by key) of template keyword and value. */
keywordToValue: v.array(v.tuple([v.string(), v.string()])),
}),
}),
v.object({
/** Deploy a question and its named outcomes. */
registerQuestionFromTemplate: v.object({
/** Instantiation of the question template. */
questionTemplateInstance: v.object({
/** Template identifier. */
id: v.string(),
/** A list (sorted by key) of template keyword and value. */
keywordToValue: v.array(v.tuple([v.string(), v.string()])),
}),
/** Instantiations of the named outcome templates (at most 100). */
namedOutcomeTemplateInstances: v.array(
v.object({
/** Template identifier. */
id: v.string(),
/** A list (sorted by key) of template keyword and value. */
keywordToValue: v.array(v.tuple([v.string(), v.string()])),
}),
),
}),
}),
v.object({
/** Settle one outcome of the deployer. */
settleOutcome: v.object({
/** Outcome identifier. */
outcome: UnsignedInteger,
/** Payout fraction of the Yes side (between 0 and 1). */
settleFraction: UnsignedDecimal,
/** Settlement details. Must be empty. */
details: v.string(),
/** Name and description of the outcome being settled. */
nameAndDescription: v.tuple([v.string(), v.string()]),
/** Names of the Yes and No sides of the outcome being settled. */
sideNames: v.tuple([v.string(), v.string()]),
}),
}),
v.object({
/** Settle all remaining named outcomes of a question. */
settleQuestion2: v.object({
/** Question identifier. */
question: UnsignedInteger,
/** Settlement of each remaining active named outcome. */
outcomeSettlements: v.array(
v.object({
/** Outcome identifier. */
outcome: UnsignedInteger,
/** Payout fraction of the Yes side (between 0 and 1). */
settleFraction: UnsignedDecimal,
/** Settlement details. Must be empty. */
details: v.string(),
/** Name and description of the outcome being settled. */
nameAndDescription: v.tuple([v.string(), v.string()]),
/** Names of the Yes and No sides of the outcome being settled. */
sideNames: v.tuple([v.string(), v.string()]),
}),
),
/** Name and description of the question being settled. */
nameAndDescription: v.tuple([v.string(), v.string()]),
}),
}),
]),
}),
]),
/** Nonce (timestamp in ms) used to prevent replay attacks. */
nonce: UnsignedInteger,
Expand Down
52 changes: 52 additions & 0 deletions tests/api/exchange/spotDeploy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,58 @@ runTest({
evmExtraWeiDecimals: 0,
},
},
{
outcome: {
registerStandaloneOutcomeFromTemplate: {
id: "binaryPrice",
keywordToValue: [["perp", "BTC"], ["threshold", "1000000"], ["time", "20260901-0600"]],
},
},
},
{
outcome: {
registerQuestionFromTemplate: {
questionTemplateInstance: {
id: "binaryPrice",
keywordToValue: [["perp", "BTC"], ["threshold", "1000000"], ["time", "20260901-0600"]],
},
namedOutcomeTemplateInstances: [
{
id: "binaryPrice",
keywordToValue: [["perp", "BTC"], ["threshold", "1000000"], ["time", "20260901-0600"]],
},
],
},
},
},
{
outcome: {
settleOutcome: {
outcome: 0,
settleFraction: "1",
details: "",
nameAndDescription: ["template:binaryPrice", "perp:BTC"],
sideNames: ["Yes", "No"],
},
},
},
{
outcome: {
settleQuestion2: {
question: 0,
outcomeSettlements: [
{
outcome: 0,
settleFraction: "1",
details: "",
nameAndDescription: ["template:binaryPrice", "perp:BTC"],
sideNames: ["Yes", "No"],
},
],
nameAndDescription: ["template:binaryPrice", "perp:BTC"],
},
},
},
];

await Promise.all(params.map((p) =>
Expand Down