add mpt-issuance-destroy

ripple · Jan 31, 2025 · 6170e84 · 6170e84
1 parent 47c23a6
commit 6170e84
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/shared/requests/submit.yaml b/shared/requests/submit.yaml
@@ -94,6 +94,7 @@ components:
               TicketCreate: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
               MPTokenAuthorize: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
               MPTokenIssuanceCreate: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+              MPTokenIssuanceDestroy: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV1'
             - $ref: '../transactions/oracle_set.yaml#/components/schemas/OracleSetTransaction'
@@ -121,6 +122,7 @@ components:
             - $ref: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
             - $ref: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
             - $ref: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+            - $ref: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
             # TODO: Add other transaction types here
 
           description: 'Transaction definition in JSON format, optionally omitting any auto-fillable fields.'
@@ -163,6 +165,7 @@ components:
               TicketCreate: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
               MPTokenAuthorize: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
               MPTokenIssuanceCreate: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+              MPTokenIssuanceDestroy: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV2'
             - $ref: '../transactions/oracle_set.yaml#/components/schemas/OracleSetTransaction'
@@ -190,6 +193,7 @@ components:
             - $ref: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
             - $ref: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
             - $ref: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+            - $ref: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
             # TODO: Add other transaction types here
           description: 'Transaction definition in JSON format, optionally omitting any auto-fillable fields.'
       required:
@@ -291,6 +295,7 @@ components:
               TicketCreate: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
               MPTokenAuthorize: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
               MPTokenIssuanceCreate: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+              MPTokenIssuanceDestroy: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
               # TODO: Add other transaction types here
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV1'
@@ -319,6 +324,7 @@ components:
             - $ref: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
             - $ref: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
             - $ref: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+            - $ref: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
             # TODO: Add other transaction types here
 
     SubmitSuccessResponseV2:
@@ -356,6 +362,7 @@ components:
               TicketCreate: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
               MPTokenAuthorize: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
               MPTokenIssuanceCreate: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+              MPTokenIssuanceDestroy: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
               # TODO: Add other transaction types here
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV2'
@@ -384,6 +391,7 @@ components:
             - $ref: '../transactions/ticket_create.yaml#/components/schemas/TicketCreateTransaction'
             - $ref: '../transactions/mptoken_authorize.yaml#/components/schemas/MPTokenAuthorizeTransaction'
             - $ref: '../transactions/mptoken_issuance_create.yaml#/components/schemas/MPTokenIssuanceCreateTransaction'
+            - $ref: '../transactions/mptoken_issuance_destroy.yaml#/components/schemas/MPTokenIssuanceDestroyTransaction'
             # TODO: Add other transaction types here
 
     SubmitErrorResponse:

diff --git a/shared/transactions/mptoken_issuance_destroy.yaml b/shared/transactions/mptoken_issuance_destroy.yaml
@@ -0,0 +1,21 @@
+components:
+  schemas:
+    MPTokenIssuanceDestroyTransaction:
+      $id: MPTokenIssuanceDestroyTransaction
+      allOf:
+        - $ref: '../base.yaml#/components/schemas/BaseTransaction'
+      type: object
+      description: |
+        The MPTokenIssuanceDestroy transaction is used to remove an MPTokenIssuance object from the directory
+        node in which it is being held, effectively removing the token from the ledger ("destroying" it).
+
+        If this operation succeeds, the corresponding MPTokenIssuance is removed and the owner’s reserve
+        requirement is reduced by one. This operation must fail if there are any holders of the MPT in question.
+      required:
+        - MPTokenIssuanceID
+      properties:
+        MPTokenIssuanceID:
+          type: string
+          format: uint192
+          description: |
+            Identifies the MPTokenIssuance object to be removed by the transaction.