add mpt-issuance-set

ripple · Jan 31, 2025 · 721d87d · 721d87d
1 parent 6170e84
commit 721d87d
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/shared/requests/submit.yaml b/shared/requests/submit.yaml
@@ -95,6 +95,7 @@ components:
               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'
+              MPTokenIssuanceSet: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV1'
             - $ref: '../transactions/oracle_set.yaml#/components/schemas/OracleSetTransaction'
@@ -123,6 +124,7 @@ components:
             - $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'
+            - $ref: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
             # TODO: Add other transaction types here
 
           description: 'Transaction definition in JSON format, optionally omitting any auto-fillable fields.'
@@ -166,6 +168,7 @@ components:
               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'
+              MPTokenIssuanceSet: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV2'
             - $ref: '../transactions/oracle_set.yaml#/components/schemas/OracleSetTransaction'
@@ -194,6 +197,7 @@ components:
             - $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'
+            - $ref: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
             # TODO: Add other transaction types here
           description: 'Transaction definition in JSON format, optionally omitting any auto-fillable fields.'
       required:
@@ -296,6 +300,7 @@ components:
               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'
+              MPTokenIssuanceSet: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
               # TODO: Add other transaction types here
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV1'
@@ -325,6 +330,7 @@ components:
             - $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'
+            - $ref: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
             # TODO: Add other transaction types here
 
     SubmitSuccessResponseV2:
@@ -363,6 +369,7 @@ components:
               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'
+              MPTokenIssuanceSet: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
               # TODO: Add other transaction types here
           oneOf:
             - $ref: '../transactions/payment.yaml#/components/schemas/PaymentTransactionV2'
@@ -392,6 +399,7 @@ components:
             - $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'
+            - $ref: '../transactions/mptoken_issuance_set.yaml#/components/schemas/MPTokenIssuanceSetTransaction'
             # TODO: Add other transaction types here
 
     SubmitErrorResponse:

diff --git a/shared/transactions/mptoken_issuance_set.yaml b/shared/transactions/mptoken_issuance_set.yaml
@@ -0,0 +1,36 @@
+components:
+  schemas:
+    MPTokenIssuanceSetTransaction:
+      $id: MPTokenIssuanceSetTransaction
+      allOf:
+        - $ref: '../base.yaml#/components/schemas/BaseTransaction'
+      type: object
+      description: |
+        Use this transaction to update a mutable property for a Multi-purpose Token.
+      required:
+        - MPTokenIssuanceID
+      properties:
+        MPTokenIssuanceID:
+          type: string
+          format: uint192
+          description: |
+            The MPTokenIssuance identifier.
+        Holder:
+          type: string
+          description: |
+            (Optional) XRPL Address of an individual token holder balance to lock/unlock. If omitted, this
+            transaction applies to all any accounts holding MPTs.
+      x-custom-validation:
+        flagConflict:
+          - flag1: tfMPTLock
+            flag2: tfMPTUnlock
+    MPTokenIssuanceSetFlag:
+      $id: MPTokenIssuanceSetFlag
+      type: string
+      enum:
+        - tfMPTLock: 0x00000001
+        - tfMPTUnlock: 0x00000002
+      description: Enum representing flags for MPTokenIssuanceSet transactions.
+      x-enum-descriptions:
+        tfMPTLock: If set, indicates that all MPT balances for this asset should be locked.
+        tfMPTUnlock: If set, indicates that all MPT balances for this asset should be unlocked.