Skip to content

chore: refresh the cMPT devbox Custody spec #60

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
pdp2121 merged 1 commit into from
Nov 5, 2026
Merged

chore: refresh the cMPT devbox Custody spec #60

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
4 changes: 4 additions & 0 deletions docs/custody-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ call them by method and path with `api.request`.
| `GET /v1/domains/{domainId}/accounts/{accountId}/manifests` | `getManifests` | 1.15+ | cmpt |
| `GET /v1/domains/{domainId}/accounts/{accountId}/manifests/{manifestId}` | `getManifest` | 1.15+ | cmpt |
| `GET /v1/domains/{domainId}/accounts/{accountId}/parameters-compute/{computeId}` | `getParametersComputeStatus` | — | cmpt |
| `GET /v1/domains/{domainId}/accounts/{accountId}/sponsorship-movements` | `getAccountSponsorshipMovements` | — | cmpt |
| `GET /v1/domains/{domainId}/accounts/{accountId}/sponsorships` | `getAccountSponsorships` | — | cmpt |
| `GET /v1/domains/{domainId}/channels` | `getAllChannels` | 1.19+ | cmpt |
| `GET /v1/domains/{domainId}/channels/{channelId}` | `getChannel` | 1.19+ | cmpt |
| `GET /v1/domains/{domainId}/channels/{channelId}/events` | `getAllChannelEvents` | 1.19+ | cmpt |
Expand Down Expand Up @@ -203,6 +205,8 @@ call them by method and path with `api.request`.
| `MPTokenIssuanceSet` | 1.32+ | cmpt |
| `OfferCreate` | 1.15–1.22, 1.32+ | cmpt |
| `Payment` | 1.15–1.22, 1.32+ | cmpt |
| `SponsorshipSetAsSponsee` | — | cmpt |
| `SponsorshipSetAsSponsor` | — | cmpt |
| `TicketCreate` | — | cmpt |
| `TrustSet` | 1.15–1.22, 1.32+ | cmpt |

Expand Down
127 changes: 127 additions & 0 deletions openapi/custody/devbox/cmpt/internal.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,6 +1055,9 @@
"sequencing": {
"$ref": "#/components/schemas/Internal_ParticipantSequencing"
},
"sponsorship": {
"$ref": "#/components/schemas/Internal_XrplSponsorshipParams"
},
"type": {
"enum": [
"ParticipantOperation"
Expand All @@ -1078,6 +1081,9 @@
"sequencing": {
"$ref": "#/components/schemas/Internal_Sequencing"
},
"sponsorship": {
"$ref": "#/components/schemas/Internal_XrplSponsorshipParams"
},
"type": {
"enum": [
"SubmitterOperation"
Expand Down Expand Up @@ -1564,6 +1570,12 @@
"minimum": 0,
"type": "integer"
},
"flags": {
"items": {
"$ref": "#/components/schemas/Internal_Xrpl_PaymentFlag"
},
"type": "array"
},
"type": {
"enum": [
"Payment"
Expand Down Expand Up @@ -9847,6 +9859,9 @@
"minimum": 0,
"type": "integer"
},
"sponsorship": {
"$ref": "#/components/schemas/Internal_XrplSponsorshipParams"
},
"type": {
"enum": [
"XRPL"
Expand Down Expand Up @@ -12273,6 +12288,8 @@
"MPTokenIssuanceSet": "#/components/schemas/Internal_XrplOperation_MPTokenIssuanceSet",
"OfferCreate": "#/components/schemas/Internal_XrplOperation_OfferCreate",
"Payment": "#/components/schemas/Internal_XrplOperation_Payment",
"SponsorshipSetAsSponsee": "#/components/schemas/Internal_XrplOperation_SponsorshipSetAsSponsee",
"SponsorshipSetAsSponsor": "#/components/schemas/Internal_XrplOperation_SponsorshipSetAsSponsor",
"TicketCreate": "#/components/schemas/Internal_XrplOperation_TicketCreate",
"TrustSet": "#/components/schemas/Internal_XrplOperation_TrustSet"
},
Expand Down Expand Up @@ -12327,6 +12344,12 @@
{
"$ref": "#/components/schemas/Internal_XrplOperation_Payment"
},
{
"$ref": "#/components/schemas/Internal_XrplOperation_SponsorshipSetAsSponsee"
},
{
"$ref": "#/components/schemas/Internal_XrplOperation_SponsorshipSetAsSponsor"
},
{
"$ref": "#/components/schemas/Internal_XrplOperation_TicketCreate"
},
Expand Down Expand Up @@ -12802,6 +12825,12 @@
"minimum": 0,
"type": "integer"
},
"flags": {
"items": {
"$ref": "#/components/schemas/Internal_Xrpl_PaymentFlag"
},
"type": "array"
},
"type": {
"enum": [
"Payment"
Expand All @@ -12816,6 +12845,62 @@
],
"type": "object"
},
"Internal_XrplOperation_SponsorshipSetAsSponsee": {
"properties": {
"sponsor": {
"$ref": "#/components/schemas/Internal_TransactionDestination"
},
"type": {
"enum": [
"SponsorshipSetAsSponsee"
],
"type": "string"
}
},
"required": [
"sponsor",
"type"
],
"type": "object"
},
"Internal_XrplOperation_SponsorshipSetAsSponsor": {
"properties": {
"feeAmountDelta": {
"description": "This field is a large integer and represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.",
"type": "string"
},
"flags": {
"items": {
"$ref": "#/components/schemas/Internal_Xrpl_SponsorshipSetFlag"
},
"type": "array"
},
"maxFee": {
"description": "This field is a large integer that can be positive or zero. It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.",
"minimum": 0,
"type": "string"
},
"remainingOwnerCountDelta": {
"format": "int32",
"type": "integer"
},
"sponsee": {
"$ref": "#/components/schemas/Internal_TransactionDestination"
},
"type": {
"enum": [
"SponsorshipSetAsSponsor"
],
"type": "string"
}
},
"required": [
"sponsee",
"flags",
"type"
],
"type": "object"
},
"Internal_XrplOperation_TicketCreate": {
"properties": {
"ticketCount": {
Expand Down Expand Up @@ -12952,6 +13037,24 @@
],
"type": "object"
},
"Internal_XrplSponsorshipParams": {
"properties": {
"flags": {
"items": {
"$ref": "#/components/schemas/Internal_Xrpl_SponsorFlag"
},
"type": "array"
},
"sponsor": {
"$ref": "#/components/schemas/Internal_TransactionDestination"
}
},
"required": [
"sponsor",
"flags"
],
"type": "object"
},
"Internal_XrplTickerProperties": {
"discriminator": {
"mapping": {
Expand Down Expand Up @@ -13207,6 +13310,30 @@
],
"type": "string"
},
"Internal_Xrpl_PaymentFlag": {
"enum": [
"tfSponsorCreatedAccount"
],
"type": "string"
},
"Internal_Xrpl_SponsorFlag": {
"description": "spfSponsorFee sponsors the transaction fee, spfSponsorReserve the owner reserve. spfSponsorReserve is rejected on transaction types for which the ledger does not allow reserve sponsorship (e.g. OfferCreate, TicketCreate, ConfidentialMPT operations)",
"enum": [
"spfSponsorFee",
"spfSponsorReserve"
],
"type": "string"
},
"Internal_Xrpl_SponsorshipSetFlag": {
"enum": [
"tfRequireSignForFee",
"tfClearRequireSignForFee",
"tfRequireSignForReserve",
"tfClearRequireSignForReserve",
"tfDeleteObject"
],
"type": "string"
},
"Internal_Xrpl_TrustSetFlag": {
"enum": [
"tfSetFreeze",
Expand Down
Loading
Loading