Skip to content

Update OpenAPI spec #145

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
Destiner merged 1 commit into from
Aug 19, 2026
Merged

Update OpenAPI spec #145

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
16 changes: 12 additions & 4 deletions orchestrator/alps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3926,6 +3926,10 @@
},
"sponsoredProtocolFeeUsd": {
"type": "number"
},
"plannedGasPrincipalMicroUsd": {
"type": "string",
"format": "uint256"
}
},
"required": [
Expand Down Expand Up @@ -6617,6 +6621,10 @@
},
"sponsoredProtocolFeeUsd": {
"type": "number"
},
"plannedGasPrincipalMicroUsd": {
"type": "string",
"format": "uint256"
}
},
"required": [
Expand Down Expand Up @@ -7750,7 +7758,7 @@
"amount": {
"type": "string",
"format": "uint256",
"description": "The amount of the requested token (in the smallest unit). Omit for max-out.",
"description": "The amount of the requested token (in the smallest unit). Omit for max-out. IMPORTANT: for a self-send with no `destinationExecutions`, any balance of this token already held on the destination chain is CREDITED against the request, so this behaves as a target final balance and an already-satisfied request delivers nothing. The credit only applies when that destination balance is in scope as a source — pinning `sourceAssets` or `sourceChains` away from the destination chain excludes it, and then this amount is delivered in full on top of whatever is already there. Same-chain intents always have the destination balance in scope, so they always credit.",
"example": "1000000"
},
"balance": {
Expand All @@ -7761,7 +7769,7 @@
"tokenAddress"
]
},
"description": "A list of token requested on the target chain"
"description": "A list of tokens requested on the target chain. Note `amount` may be credited against a balance already held on the destination chain — see the field for exactly when."
},
"account": {
"type": "object",
Expand Down Expand Up @@ -8343,7 +8351,7 @@
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "App fee rate in basis points of the input value (0–10000 = 0–100%).",
"description": "App fee rate in basis points (0–10000 = 0–100%). The base is the USD value of the intent, and which value depends on the intent shape: for a fixed-output intent it is the requested destination target(s), summed across `tokenRequests`; for a max-out intent it is the spendable source balance; for a destination-swap intent it is the swap input. Note the fixed-output base is the full requested target, not the delta over any balance already held.",
"example": 25
}
},
Expand All @@ -8358,7 +8366,7 @@
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "Rhinestone protocol fee rate in basis points of the input value (0–10000 = 0–100%). Collected alongside the app fee in one batched transfer and always accrues to Rhinestone; sponsor it via `sponsorSettings.protocolFees` to charge the integrator balance instead of the user.",
"description": "Rhinestone protocol fee rate in basis points (0–10000 = 0–100%), on the same base as `appFees.feeBps` — see that field. Collected alongside the app fee in one batched transfer and always accrues to Rhinestone; sponsor it via `sponsorSettings.protocolFees` to charge the integrator balance instead of the user.",
"example": 35
}
},
Expand Down
8 changes: 4 additions & 4 deletions orchestrator/blanc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9191,7 +9191,7 @@
"amount": {
"type": "string",
"format": "uint256",
"description": "The amount of the requested token (in the smallest unit). Omit for max-out.",
"description": "The amount of the requested token (in the smallest unit). Omit for max-out. IMPORTANT: for a self-send with no `destinationExecutions`, any balance of this token already held on the destination chain is CREDITED against the request, so this behaves as a target final balance and an already-satisfied request delivers nothing. The credit only applies when that destination balance is in scope as a source — pinning `sourceAssets` or `sourceChains` away from the destination chain excludes it, and then this amount is delivered in full on top of whatever is already there. Same-chain intents always have the destination balance in scope, so they always credit.",
"example": "1000000"
},
"balance": {
Expand All @@ -9202,7 +9202,7 @@
"tokenAddress"
]
},
"description": "A list of token requested on the target chain"
"description": "A list of tokens requested on the target chain. Note `amount` may be credited against a balance already held on the destination chain — see the field for exactly when."
},
"account": {
"type": "object",
Expand Down Expand Up @@ -9806,7 +9806,7 @@
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "App fee rate in basis points of the input value (0–10000 = 0–100%).",
"description": "App fee rate in basis points (0–10000 = 0–100%). The base is the USD value of the intent, and which value depends on the intent shape: for a fixed-output intent it is the requested destination target(s), summed across `tokenRequests`; for a max-out intent it is the spendable source balance; for a destination-swap intent it is the swap input. Note the fixed-output base is the full requested target, not the delta over any balance already held.",
"example": 25
}
},
Expand All @@ -9821,7 +9821,7 @@
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "Rhinestone protocol fee rate in basis points of the input value (0–10000 = 0–100%). Collected alongside the app fee in one batched transfer and always accrues to Rhinestone; sponsor it via `sponsorSettings.protocolFees` to charge the integrator balance instead of the user.",
"description": "Rhinestone protocol fee rate in basis points (0–10000 = 0–100%), on the same base as `appFees.feeBps` — see that field. Collected alongside the app fee in one batched transfer and always accrues to Rhinestone; sponsor it via `sponsorSettings.protocolFees` to charge the integrator balance instead of the user.",
"example": 35
}
},
Expand Down
Loading