ripple-binary-codec 2.1.0 → 4.0.0-mpt-beta

package/dist/enums/definitions.json

@@ -18,7 +18,7 @@
         "PathSet": 18,
         "Vector256": 19,
         "UInt96": 20,
-        "UInt192": 21,
+        "Hash192": 21,
         "UInt384": 22,
         "UInt512": 23,
         "Issue": 24,
@@ -53,6 +53,8 @@
         "AMM": 121,
         "DID": 73,
         "Oracle": 128,
+        "MPTokenIssuance": 126,
+        "MPToken": 127,
         "Any": -3,
         "Child": -2,
         "Nickname": 110,
@@ -260,6 +262,16 @@
                 "type": "UInt8"
             }
         ],
+        [
+            "AssetScale",
+            {
+                "nth": 20,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt8"
+            }
+        ],
         [
             "LedgerEntryType",
             {
@@ -1070,6 +1082,46 @@
                 "type": "UInt64"
             }
         ],
+        [
+            "MaximumAmount",
+            {
+                "nth": 24,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
+        [
+            "OutstandingAmount",
+            {
+                "nth": 25,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
+        [
+            "LockedAmount",
+            {
+                "nth": 26,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
+        [
+            "MPTAmount",
+            {
+                "nth": 27,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
         [
             "EmailHash",
             {
@@ -1120,6 +1172,16 @@
                 "type": "Hash160"
             }
         ],
+        [
+            "MPTokenIssuanceID",
+            {
+                "nth": 1,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "Hash192"
+            }
+        ],
         [
             "LedgerHash",
             {
@@ -1980,6 +2042,16 @@
                 "type": "Blob"
             }
         ],
+        [
+            "MPTokenMetadata",
+            {
+                "nth": 30,
+                "isVLEncoded": true,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "Blob"
+            }
+        ],
         [
             "Account",
             {
@@ -2070,6 +2142,16 @@
                 "type": "AccountID"
             }
         ],
+        [
+            "MPTokenHolder",
+            {
+                "nth": 11,
+                "isVLEncoded": true,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "AccountID"
+            }
+        ],
         [
             "HookAccount",
             {
@@ -2797,16 +2879,17 @@
         "temUNKNOWN": -264,
         "temSEQ_AND_TICKET": -263,
         "temBAD_NFTOKEN_TRANSFER_FEE": -262,
-        "temBAD_AMM_TOKENS": -261,
-        "temXCHAIN_EQUAL_DOOR_ACCOUNTS": -260,
-        "temXCHAIN_BAD_PROOF": -259,
-        "temXCHAIN_BRIDGE_BAD_ISSUES": -258,
-        "temXCHAIN_BRIDGE_NONDOOR_OWNER": -257,
-        "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -256,
-        "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
-        "temEMPTY_DID": -254,
-        "temARRAY_EMPTY": -253,
-        "temARRAY_TOO_LARGE": -252,
+        "temBAD_MPTOKEN_TRANSFER_FEE": -261,
+        "temBAD_AMM_TOKENS": -260,
+        "temXCHAIN_EQUAL_DOOR_ACCOUNTS": -259,
+        "temXCHAIN_BAD_PROOF": -258,
+        "temXCHAIN_BRIDGE_BAD_ISSUES": -257,
+        "temXCHAIN_BRIDGE_NONDOOR_OWNER": -256,
+        "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -255,
+        "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -254,
+        "temEMPTY_DID": -253,
+        "temARRAY_EMPTY": -252,
+        "temARRAY_TOO_LARGE": -251,
         "tefFAILURE": -199,
         "tefALREADY": -198,
         "tefBAD_ADD_AUTH": -197,
@@ -2918,7 +3001,11 @@
         "tecINVALID_UPDATE_TIME": 188,
         "tecTOKEN_PAIR_NOT_FOUND": 189,
         "tecARRAY_EMPTY": 190,
-        "tecARRAY_TOO_LARGE": 191
+        "tecARRAY_TOO_LARGE": 191,
+        "tecMPTOKEN_EXISTS": 192,
+        "tecMPT_MAX_AMOUNT_EXCEEDED": 193,
+        "tecMPT_LOCKED": 194,
+        "tecMPT_NOT_SUPPORTED": 195
     },
     "TRANSACTION_TYPES": {
         "Invalid": -1,
@@ -2969,6 +3056,10 @@
         "DIDDelete": 50,
         "OracleSet": 51,
         "OracleDelete": 52,
+        "MPTokenIssuanceCreate": 53,
+        "MPTokenIssuanceDestroy": 54,
+        "MPTokenAuthorize": 55,
+        "MPTokenIssuanceSet": 56,
         "EnableAmendment": 100,
         "SetFee": 101,
         "UNLModify": 102

package/dist/enums/src/enums/definitions.json

@@ -18,7 +18,7 @@
     "PathSet": 18,
     "Vector256": 19,
     "UInt96": 20,
-    "UInt192": 21,
+    "Hash192": 21,
     "UInt384": 22,
     "UInt512": 23,
     "Issue": 24,
@@ -53,6 +53,8 @@
     "AMM": 121,
     "DID": 73,
     "Oracle": 128,
+    "MPTokenIssuance": 126,
+    "MPToken": 127,
     "Any": -3,
     "Child": -2,
     "Nickname": 110,
@@ -260,6 +262,16 @@
         "type": "UInt8"
       }
     ],
+    [
+      "AssetScale",
+      {
+        "nth": 20,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt8"
+      }
+    ],
     [
       "LedgerEntryType",
       {
@@ -1070,6 +1082,46 @@
         "type": "UInt64"
       }
     ],
+    [
+      "MaximumAmount",
+      {
+        "nth": 24,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt64"
+      }
+    ],
+    [
+      "OutstandingAmount",
+      {
+        "nth": 25,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt64"
+      }
+    ],
+    [
+      "LockedAmount",
+      {
+        "nth": 26,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt64"
+      }
+    ],
+    [
+      "MPTAmount",
+      {
+        "nth": 27,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "UInt64"
+      }
+    ],
     [
       "EmailHash",
       {
@@ -1120,6 +1172,16 @@
         "type": "Hash160"
       }
     ],
+    [
+      "MPTokenIssuanceID",
+      {
+        "nth": 1,
+        "isVLEncoded": false,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Hash192"
+      }
+    ],
     [
       "LedgerHash",
       {
@@ -1980,6 +2042,16 @@
         "type": "Blob"
       }
     ],
+    [
+      "MPTokenMetadata",
+      {
+        "nth": 30,
+        "isVLEncoded": true,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "Blob"
+      }
+    ],
     [
       "Account",
       {
@@ -2070,6 +2142,16 @@
         "type": "AccountID"
       }
     ],
+    [
+      "MPTokenHolder",
+      {
+        "nth": 11,
+        "isVLEncoded": true,
+        "isSerialized": true,
+        "isSigningField": true,
+        "type": "AccountID"
+      }
+    ],
     [
       "HookAccount",
       {
@@ -2798,16 +2880,17 @@
     "temUNKNOWN": -264,
     "temSEQ_AND_TICKET": -263,
     "temBAD_NFTOKEN_TRANSFER_FEE": -262,
-    "temBAD_AMM_TOKENS": -261,
-    "temXCHAIN_EQUAL_DOOR_ACCOUNTS": -260,
-    "temXCHAIN_BAD_PROOF": -259,
-    "temXCHAIN_BRIDGE_BAD_ISSUES": -258,
-    "temXCHAIN_BRIDGE_NONDOOR_OWNER": -257,
-    "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -256,
-    "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
-    "temEMPTY_DID": -254,
-    "temARRAY_EMPTY": -253,
-    "temARRAY_TOO_LARGE": -252,
+    "temBAD_MPTOKEN_TRANSFER_FEE": -261,
+    "temBAD_AMM_TOKENS": -260,
+    "temXCHAIN_EQUAL_DOOR_ACCOUNTS": -259,
+    "temXCHAIN_BAD_PROOF": -258,
+    "temXCHAIN_BRIDGE_BAD_ISSUES": -257,
+    "temXCHAIN_BRIDGE_NONDOOR_OWNER": -256,
+    "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -255,
+    "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -254,
+    "temEMPTY_DID": -253,
+    "temARRAY_EMPTY": -252,
+    "temARRAY_TOO_LARGE": -251,
 
     "tefFAILURE": -199,
     "tefALREADY": -198,
@@ -2923,7 +3006,11 @@
     "tecINVALID_UPDATE_TIME": 188,
     "tecTOKEN_PAIR_NOT_FOUND": 189,
     "tecARRAY_EMPTY": 190,
-    "tecARRAY_TOO_LARGE": 191
+    "tecARRAY_TOO_LARGE": 191,
+    "tecMPTOKEN_EXISTS": 192,
+    "tecMPT_MAX_AMOUNT_EXCEEDED": 193,
+    "tecMPT_LOCKED": 194,
+    "tecMPT_NOT_SUPPORTED": 195
   },
   "TRANSACTION_TYPES": {
     "Invalid": -1,
@@ -2974,6 +3061,10 @@
     "DIDDelete": 50,
     "OracleSet": 51,
     "OracleDelete": 52,
+    "MPTokenIssuanceCreate": 53,
+    "MPTokenIssuanceDestroy": 54,
+    "MPTokenAuthorize": 55,
+    "MPTokenIssuanceSet": 56,
     "EnableAmendment": 100,
     "SetFee": 101,
     "UNLModify": 102

package/dist/src/enums/definitions.json

@@ -18,7 +18,7 @@
         "PathSet": 18,
         "Vector256": 19,
         "UInt96": 20,
-        "UInt192": 21,
+        "Hash192": 21,
         "UInt384": 22,
         "UInt512": 23,
         "Issue": 24,
@@ -53,6 +53,8 @@
         "AMM": 121,
         "DID": 73,
         "Oracle": 128,
+        "MPTokenIssuance": 126,
+        "MPToken": 127,
         "Any": -3,
         "Child": -2,
         "Nickname": 110,
@@ -260,6 +262,16 @@
                 "type": "UInt8"
             }
         ],
+        [
+            "AssetScale",
+            {
+                "nth": 20,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt8"
+            }
+        ],
         [
             "LedgerEntryType",
             {
@@ -1070,6 +1082,46 @@
                 "type": "UInt64"
             }
         ],
+        [
+            "MaximumAmount",
+            {
+                "nth": 24,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
+        [
+            "OutstandingAmount",
+            {
+                "nth": 25,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
+        [
+            "LockedAmount",
+            {
+                "nth": 26,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
+        [
+            "MPTAmount",
+            {
+                "nth": 27,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "UInt64"
+            }
+        ],
         [
             "EmailHash",
             {
@@ -1120,6 +1172,16 @@
                 "type": "Hash160"
             }
         ],
+        [
+            "MPTokenIssuanceID",
+            {
+                "nth": 1,
+                "isVLEncoded": false,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "Hash192"
+            }
+        ],
         [
             "LedgerHash",
             {
@@ -1980,6 +2042,16 @@
                 "type": "Blob"
             }
         ],
+        [
+            "MPTokenMetadata",
+            {
+                "nth": 30,
+                "isVLEncoded": true,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "Blob"
+            }
+        ],
         [
             "Account",
             {
@@ -2070,6 +2142,16 @@
                 "type": "AccountID"
             }
         ],
+        [
+            "MPTokenHolder",
+            {
+                "nth": 11,
+                "isVLEncoded": true,
+                "isSerialized": true,
+                "isSigningField": true,
+                "type": "AccountID"
+            }
+        ],
         [
             "HookAccount",
             {
@@ -2797,16 +2879,17 @@
         "temUNKNOWN": -264,
         "temSEQ_AND_TICKET": -263,
         "temBAD_NFTOKEN_TRANSFER_FEE": -262,
-        "temBAD_AMM_TOKENS": -261,
-        "temXCHAIN_EQUAL_DOOR_ACCOUNTS": -260,
-        "temXCHAIN_BAD_PROOF": -259,
-        "temXCHAIN_BRIDGE_BAD_ISSUES": -258,
-        "temXCHAIN_BRIDGE_NONDOOR_OWNER": -257,
-        "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -256,
-        "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
-        "temEMPTY_DID": -254,
-        "temARRAY_EMPTY": -253,
-        "temARRAY_TOO_LARGE": -252,
+        "temBAD_MPTOKEN_TRANSFER_FEE": -261,
+        "temBAD_AMM_TOKENS": -260,
+        "temXCHAIN_EQUAL_DOOR_ACCOUNTS": -259,
+        "temXCHAIN_BAD_PROOF": -258,
+        "temXCHAIN_BRIDGE_BAD_ISSUES": -257,
+        "temXCHAIN_BRIDGE_NONDOOR_OWNER": -256,
+        "temXCHAIN_BRIDGE_BAD_MIN_ACCOUNT_CREATE_AMOUNT": -255,
+        "temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -254,
+        "temEMPTY_DID": -253,
+        "temARRAY_EMPTY": -252,
+        "temARRAY_TOO_LARGE": -251,
         "tefFAILURE": -199,
         "tefALREADY": -198,
         "tefBAD_ADD_AUTH": -197,
@@ -2918,7 +3001,11 @@
         "tecINVALID_UPDATE_TIME": 188,
         "tecTOKEN_PAIR_NOT_FOUND": 189,
         "tecARRAY_EMPTY": 190,
-        "tecARRAY_TOO_LARGE": 191
+        "tecARRAY_TOO_LARGE": 191,
+        "tecMPTOKEN_EXISTS": 192,
+        "tecMPT_MAX_AMOUNT_EXCEEDED": 193,
+        "tecMPT_LOCKED": 194,
+        "tecMPT_NOT_SUPPORTED": 195
     },
     "TRANSACTION_TYPES": {
         "Invalid": -1,
@@ -2969,6 +3056,10 @@
         "DIDDelete": 50,
         "OracleSet": 51,
         "OracleDelete": 52,
+        "MPTokenIssuanceCreate": 53,
+        "MPTokenIssuanceDestroy": 54,
+        "MPTokenAuthorize": 55,
+        "MPTokenIssuanceSet": 56,
         "EnableAmendment": 100,
         "SetFee": 101,
         "UNLModify": 102

package/dist/src/types/amount.d.ts

@@ -1,13 +1,18 @@
 import { BinaryParser } from '../serdes/binary-parser';
 import { JsonObject, SerializedType } from './serialized-type';
-/**
- * Interface for JSON objects that represent amounts
- */
-interface AmountObject extends JsonObject {
+interface AmountObjectIOU extends JsonObject {
     value: string;
     currency: string;
     issuer: string;
 }
+interface AmountObjectMPT extends JsonObject {
+    value: string;
+    mpt_issuance_id: string;
+}
+/**
+ * Interface for JSON objects that represent amounts
+ */
+type AmountObject = AmountObjectIOU | AmountObjectMPT;
 /**
  * Class for serializing/Deserializing Amounts
  */
@@ -15,7 +20,7 @@ declare class Amount extends SerializedType {
     static defaultAmount: Amount;
     constructor(bytes: Uint8Array);
     /**
-     * Construct an amount from an IOU or string amount
+     * Construct an amount from an IOU, MPT or string amount
      *
      * @param value An Amount, object representing an IOU, or a string
      *     representing an integer amount
@@ -49,6 +54,13 @@ declare class Amount extends SerializedType {
      * @returns void, but will throw if invalid amount
      */
     private static assertIouIsValid;
+    /**
+     * Validate MPT.value amount
+     *
+     * @param decimal BigNumber object representing MPT.value
+     * @returns void, but will throw if invalid amount
+     */
+    private static assertMptIsValid;
     /**
      * Ensure that the value after being multiplied by the exponent does not
      * contain a decimal.
@@ -63,5 +75,17 @@ declare class Amount extends SerializedType {
      * @returns true if Native (XRP)
      */
     private isNative;
+    /**
+     * Test if this amount is in units of MPT
+     *
+     * @returns true if MPT
+     */
+    private isMPT;
+    /**
+     * Test if this amount is in units of IOU
+     *
+     * @returns true if IOU
+     */
+    private isIOU;
 }
 export { Amount, AmountObject };