xrpl 4.4.0-smartescrow.0 → 4.5.0-smartescrow.0

package/build/xrpl-latest.js

@@ -18983,10 +18983,14 @@ const enums_1 = __webpack_require__(/*! ../enums */ "../../node_modules/ripple-b
 const HEX_REGEX = /^[a-fA-F0-9]{1,16}$/;
 const BASE10_REGEX = /^[0-9]{1,20}$/;
 const mask = BigInt(0x00000000ffffffff);
-function useBase10(fieldName) {
-    return (fieldName === 'MaximumAmount' ||
-        fieldName === 'OutstandingAmount' ||
-        fieldName === 'MPTAmount');
+const BASE10_AMOUNT_FIELDS = new Set([
+    'MaximumAmount',
+    'OutstandingAmount',
+    'MPTAmount',
+    'LockedAmount',
+]);
+function isBase10(fieldName) {
+    return BASE10_AMOUNT_FIELDS.has(fieldName);
 }
 /**
  * Derived UInt class for serializing/deserializing 64 bit UInt
@@ -19020,7 +19024,7 @@ class UInt64 extends uint_1.UInt {
             return new UInt64((0, utils_1.concat)(intBuf));
         }
         if (typeof val === 'string') {
-            if (useBase10(fieldName)) {
+            if (isBase10(fieldName)) {
                 if (!BASE10_REGEX.test(val)) {
                     throw new Error(`${fieldName} ${val} is not a valid base 10 string`);
                 }
@@ -19048,7 +19052,7 @@ class UInt64 extends uint_1.UInt {
      */
     toJSON(_definitions = enums_1.DEFAULT_DEFINITIONS, fieldName = '') {
         const hexString = (0, utils_1.bytesToHex)(this.bytes);
-        if (useBase10(fieldName)) {
+        if (isBase10(fieldName)) {
             return BigInt('0x' + hexString).toString(10);
         }
         return hexString;
@@ -21924,6 +21928,7 @@ var AccountRootFlags;
     AccountRootFlags[AccountRootFlags["lsfDisallowIncomingPayChan"] = 268435456] = "lsfDisallowIncomingPayChan";
     AccountRootFlags[AccountRootFlags["lsfDisallowIncomingTrustline"] = 536870912] = "lsfDisallowIncomingTrustline";
     AccountRootFlags[AccountRootFlags["lsfAllowTrustLineClawback"] = 2147483648] = "lsfAllowTrustLineClawback";
+    AccountRootFlags[AccountRootFlags["lsfAllowTrustLineLocking"] = 1073741824] = "lsfAllowTrustLineLocking";
 })(AccountRootFlags || (exports.AccountRootFlags = AccountRootFlags = {}));
 
 
@@ -21988,6 +21993,7 @@ var OfferFlags;
 (function (OfferFlags) {
     OfferFlags[OfferFlags["lsfPassive"] = 65536] = "lsfPassive";
     OfferFlags[OfferFlags["lsfSell"] = 131072] = "lsfSell";
+    OfferFlags[OfferFlags["lsfHybrid"] = 262144] = "lsfHybrid";
 })(OfferFlags || (exports.OfferFlags = OfferFlags = {}));
 
 
@@ -22625,11 +22631,10 @@ function validateMPTokenIssuanceCreate(tx) {
     (0, common_1.validateOptionalField)(tx, 'MPTokenMetadata', common_1.isString);
     (0, common_1.validateOptionalField)(tx, 'TransferFee', common_1.isNumber);
     (0, common_1.validateOptionalField)(tx, 'AssetScale', common_1.isNumber);
-    if (typeof tx.MPTokenMetadata === 'string' && tx.MPTokenMetadata === '') {
-        throw new errors_1.ValidationError('MPTokenIssuanceCreate: MPTokenMetadata must not be empty string');
-    }
-    if (typeof tx.MPTokenMetadata === 'string' && !(0, utils_1.isHex)(tx.MPTokenMetadata)) {
-        throw new errors_1.ValidationError('MPTokenIssuanceCreate: MPTokenMetadata must be in hex format');
+    if (typeof tx.MPTokenMetadata === 'string' &&
+        (!(0, utils_1.isHex)(tx.MPTokenMetadata) ||
+            tx.MPTokenMetadata.length / 2 > common_1.MAX_MPT_META_BYTE_LENGTH)) {
+        throw new errors_1.ValidationError(`MPTokenIssuanceCreate: MPTokenMetadata (hex format) must be non-empty and no more than ${common_1.MAX_MPT_META_BYTE_LENGTH} bytes.`);
     }
     if (typeof tx.MaximumAmount === 'string') {
         if (!utils_1.INTEGER_SANITY_CHECK.exec(tx.MaximumAmount)) {
@@ -22652,6 +22657,16 @@ function validateMPTokenIssuanceCreate(tx) {
             throw new errors_1.ValidationError('MPTokenIssuanceCreate: TransferFee cannot be provided without enabling tfMPTCanTransfer flag');
         }
     }
+    if (tx.MPTokenMetadata != null) {
+        const validationMessages = (0, common_1.validateMPTokenMetadata)(tx.MPTokenMetadata);
+        if (validationMessages.length > 0) {
+            const message = [
+                common_1.MPT_META_WARNING_HEADER,
+                ...validationMessages.map((msg) => `- ${msg}`),
+            ].join('\n');
+            console.warn(message);
+        }
+    }
 }
 exports.validateMPTokenIssuanceCreate = validateMPTokenIssuanceCreate;
 
@@ -23197,6 +23212,7 @@ var AccountSetAsfFlags;
     AccountSetAsfFlags[AccountSetAsfFlags["asfDisallowIncomingPayChan"] = 14] = "asfDisallowIncomingPayChan";
     AccountSetAsfFlags[AccountSetAsfFlags["asfDisallowIncomingTrustline"] = 15] = "asfDisallowIncomingTrustline";
     AccountSetAsfFlags[AccountSetAsfFlags["asfAllowTrustLineClawback"] = 16] = "asfAllowTrustLineClawback";
+    AccountSetAsfFlags[AccountSetAsfFlags["asfAllowTrustLineLocking"] = 17] = "asfAllowTrustLineLocking";
 })(AccountSetAsfFlags || (exports.AccountSetAsfFlags = AccountSetAsfFlags = {}));
 var AccountSetTfFlags;
 (function (AccountSetTfFlags) {
@@ -23469,7 +23485,7 @@ exports.validateClawback = validateClawback;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.containsDuplicates = exports.validateCredentialsList = exports.validateCredentialType = exports.parseAmountValue = exports.validateBaseTransaction = exports.GlobalFlags = exports.validateOptionalField = exports.validateRequiredField = exports.isArray = exports.isXChainBridge = exports.isAmount = exports.isAccount = exports.isClawbackAmount = exports.isMPTAmount = exports.isAuthorizeCredential = exports.isIssuedCurrencyAmount = exports.isIssuedCurrency = exports.isCurrency = exports.isXRPLNumber = exports.isNumber = exports.isString = exports.isRecord = exports.VAULT_DATA_MAX_BYTE_LENGTH = exports.MAX_AUTHORIZED_CREDENTIALS = void 0;
+exports.validateMPTokenMetadata = exports.isDomainID = exports.containsDuplicates = exports.validateCredentialsList = exports.validateCredentialType = exports.parseAmountValue = exports.validateBaseTransaction = exports.GlobalFlags = exports.validateOptionalField = exports.validateRequiredField = exports.isArray = exports.isXChainBridge = exports.isAmount = exports.isAccount = exports.isClawbackAmount = exports.isMPTAmount = exports.isAuthorizeCredential = exports.isIssuedCurrencyAmount = exports.isIssuedCurrency = exports.isCurrency = exports.isXRPLNumber = exports.isNumber = exports.isString = exports.isRecord = exports.MPT_META_WARNING_HEADER = exports.VAULT_DATA_MAX_BYTE_LENGTH = exports.MAX_MPT_META_BYTE_LENGTH = exports.MAX_AUTHORIZED_CREDENTIALS = void 0;
 const utils_1 = __webpack_require__(/*! @xrplf/isomorphic/utils */ "../../node_modules/@xrplf/isomorphic/dist/utils/browser.js");
 const ripple_address_codec_1 = __webpack_require__(/*! ripple-address-codec */ "../../node_modules/ripple-address-codec/dist/index.js");
 const ripple_binary_codec_1 = __webpack_require__(/*! ripple-binary-codec */ "../../node_modules/ripple-binary-codec/dist/index.js");
@@ -23479,7 +23495,38 @@ const MEMO_SIZE = 3;
 exports.MAX_AUTHORIZED_CREDENTIALS = 8;
 const MAX_CREDENTIAL_BYTE_LENGTH = 64;
 const MAX_CREDENTIAL_TYPE_LENGTH = MAX_CREDENTIAL_BYTE_LENGTH * 2;
+exports.MAX_MPT_META_BYTE_LENGTH = 1024;
 exports.VAULT_DATA_MAX_BYTE_LENGTH = 256;
+const TICKER_REGEX = /^[A-Z0-9]{1,6}$/u;
+const MAX_MPT_META_TOP_LEVEL_FIELD_COUNT = 9;
+const MPT_META_URL_FIELD_COUNT = 3;
+const MPT_META_REQUIRED_FIELDS = [
+    'ticker',
+    'name',
+    'icon',
+    'asset_class',
+    'issuer_name',
+];
+const MPT_META_ASSET_CLASSES = [
+    'rwa',
+    'memes',
+    'wrapped',
+    'gaming',
+    'defi',
+    'other',
+];
+const MPT_META_ASSET_SUB_CLASSES = [
+    'stablecoin',
+    'commodity',
+    'real_estate',
+    'private_credit',
+    'equity',
+    'treasury',
+    'other',
+];
+exports.MPT_META_WARNING_HEADER = 'MPTokenMetadata is not properly formatted as JSON as per the XLS-89d standard. ' +
+    "While adherence to this standard is not mandatory, such non-compliant MPToken's might not be discoverable " +
+    'by Explorers and Indexers in the XRPL ecosystem.';
 function isMemo(obj) {
     if (!isRecord(obj)) {
         return false;
@@ -23745,6 +23792,108 @@ function containsDuplicates(objectList) {
     return false;
 }
 exports.containsDuplicates = containsDuplicates;
+const _DOMAIN_ID_LENGTH = 64;
+function isDomainID(domainID) {
+    return (isString(domainID) &&
+        domainID.length === _DOMAIN_ID_LENGTH &&
+        (0, utils_2.isHex)(domainID));
+}
+exports.isDomainID = isDomainID;
+function validateMPTokenMetadata(input) {
+    const validationMessages = [];
+    if (!(0, utils_2.isHex)(input)) {
+        validationMessages.push(`MPTokenMetadata must be in hex format.`);
+        return validationMessages;
+    }
+    if (input.length / 2 > exports.MAX_MPT_META_BYTE_LENGTH) {
+        validationMessages.push(`MPTokenMetadata must be max ${exports.MAX_MPT_META_BYTE_LENGTH} bytes.`);
+        return validationMessages;
+    }
+    let jsonMetaData;
+    try {
+        jsonMetaData = JSON.parse((0, utils_1.hexToString)(input));
+    }
+    catch (err) {
+        validationMessages.push(`MPTokenMetadata is not properly formatted as JSON - ${String(err)}`);
+        return validationMessages;
+    }
+    if (jsonMetaData == null ||
+        typeof jsonMetaData !== 'object' ||
+        Array.isArray(jsonMetaData)) {
+        validationMessages.push('MPTokenMetadata is not properly formatted as per XLS-89d.');
+        return validationMessages;
+    }
+    const obj = jsonMetaData;
+    const fieldCount = Object.keys(obj).length;
+    if (fieldCount > MAX_MPT_META_TOP_LEVEL_FIELD_COUNT) {
+        validationMessages.push(`MPTokenMetadata must not contain more than ${MAX_MPT_META_TOP_LEVEL_FIELD_COUNT} top-level fields (found ${fieldCount}).`);
+        return validationMessages;
+    }
+    const incorrectRequiredFields = MPT_META_REQUIRED_FIELDS.filter((field) => !isString(obj[field]));
+    if (incorrectRequiredFields.length > 0) {
+        incorrectRequiredFields.forEach((field) => validationMessages.push(`${field} is required and must be string.`));
+        return validationMessages;
+    }
+    if (obj.desc != null && !isString(obj.desc)) {
+        validationMessages.push(`desc must be a string.`);
+        return validationMessages;
+    }
+    if (obj.asset_subclass != null && !isString(obj.asset_subclass)) {
+        validationMessages.push(`asset_subclass must be a string.`);
+        return validationMessages;
+    }
+    if (obj.additional_info != null &&
+        !isString(obj.additional_info) &&
+        !isRecord(obj.additional_info)) {
+        validationMessages.push(`additional_info must be a string or JSON object.`);
+        return validationMessages;
+    }
+    if (obj.urls != null) {
+        if (!Array.isArray(obj.urls)) {
+            validationMessages.push('urls must be an array as per XLS-89d.');
+            return validationMessages;
+        }
+        if (!obj.urls.every(isValidMPTokenMetadataUrlStructure)) {
+            validationMessages.push('One or more urls are not structured per XLS-89d.');
+            return validationMessages;
+        }
+    }
+    const mptMPTokenMetadata = obj;
+    if (!TICKER_REGEX.test(mptMPTokenMetadata.ticker)) {
+        validationMessages.push(`ticker should have uppercase letters (A-Z) and digits (0-9) only. Max 6 characters recommended.`);
+    }
+    if (!mptMPTokenMetadata.icon.startsWith('https://')) {
+        validationMessages.push(`icon should be a valid https url.`);
+    }
+    if (!MPT_META_ASSET_CLASSES.includes(mptMPTokenMetadata.asset_class.toLowerCase())) {
+        validationMessages.push(`asset_class should be one of ${MPT_META_ASSET_CLASSES.join(', ')}.`);
+    }
+    if (mptMPTokenMetadata.asset_subclass != null &&
+        !MPT_META_ASSET_SUB_CLASSES.includes(mptMPTokenMetadata.asset_subclass.toLowerCase())) {
+        validationMessages.push(`asset_subclass should be one of ${MPT_META_ASSET_SUB_CLASSES.join(', ')}.`);
+    }
+    if (mptMPTokenMetadata.asset_class.toLowerCase() === 'rwa' &&
+        mptMPTokenMetadata.asset_subclass == null) {
+        validationMessages.push(`asset_subclass is required when asset_class is rwa.`);
+    }
+    if (mptMPTokenMetadata.urls != null &&
+        !mptMPTokenMetadata.urls.every((ele) => ele.url.startsWith('https://'))) {
+        validationMessages.push(`url should be a valid https url.`);
+    }
+    return validationMessages;
+}
+exports.validateMPTokenMetadata = validateMPTokenMetadata;
+function isValidMPTokenMetadataUrlStructure(input) {
+    if (input == null) {
+        return false;
+    }
+    const obj = input;
+    return (typeof obj === 'object' &&
+        isString(obj.url) &&
+        isString(obj.type) &&
+        isString(obj.title) &&
+        Object.keys(obj).length === MPT_META_URL_FIELD_COUNT);
+}
 
 
 /***/ }),
@@ -23930,12 +24079,7 @@ const errors_1 = __webpack_require__(/*! ../../errors */ "./dist/npm/errors.js")
 const common_1 = __webpack_require__(/*! ./common */ "./dist/npm/models/transactions/common.js");
 function validateEscrowCreate(tx) {
     (0, common_1.validateBaseTransaction)(tx);
-    if (tx.Amount === undefined) {
-        throw new errors_1.ValidationError('EscrowCreate: missing field Amount');
-    }
-    if (typeof tx.Amount !== 'string') {
-        throw new errors_1.ValidationError('EscrowCreate: Amount must be a string');
-    }
+    (0, common_1.validateRequiredField)(tx, 'Amount', common_1.isAmount);
     (0, common_1.validateRequiredField)(tx, 'Destination', common_1.isAccount);
     (0, common_1.validateOptionalField)(tx, 'DestinationTag', common_1.isNumber);
     if (tx.CancelAfter === undefined && tx.FinishAfter === undefined) {
@@ -24020,9 +24164,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.XChainModifyBridgeFlags = exports.VaultWithdrawalPolicy = exports.VaultCreateFlags = exports.TrustSetFlags = exports.PaymentChannelClaimFlags = exports.PaymentFlags = exports.OfferCreateFlags = exports.validateNFTokenModify = exports.NFTokenMintFlags = exports.NFTokenCreateOfferFlags = exports.MPTokenIssuanceSetFlags = exports.MPTokenIssuanceCreateFlags = exports.MPTokenAuthorizeFlags = exports.EnableAmendmentFlags = exports.AMMWithdrawFlags = exports.AMMDepositFlags = exports.AMMClawbackFlags = exports.AccountSetTfFlags = exports.AccountSetAsfFlags = exports.validate = exports.isMPTAmount = void 0;
+exports.XChainModifyBridgeFlags = exports.VaultWithdrawalPolicy = exports.VaultCreateFlags = exports.TrustSetFlags = exports.PaymentChannelClaimFlags = exports.PaymentFlags = exports.OfferCreateFlags = exports.validateNFTokenModify = exports.NFTokenMintFlags = exports.NFTokenCreateOfferFlags = exports.MPTokenIssuanceSetFlags = exports.MPTokenIssuanceCreateFlags = exports.MPTokenAuthorizeFlags = exports.EnableAmendmentFlags = exports.AMMWithdrawFlags = exports.AMMDepositFlags = exports.AMMClawbackFlags = exports.AccountSetTfFlags = exports.AccountSetAsfFlags = exports.validate = exports.validateMPTokenMetadata = exports.isMPTAmount = void 0;
 var common_1 = __webpack_require__(/*! ./common */ "./dist/npm/models/transactions/common.js");
 Object.defineProperty(exports, "isMPTAmount", ({ enumerable: true, get: function () { return common_1.isMPTAmount; } }));
+Object.defineProperty(exports, "validateMPTokenMetadata", ({ enumerable: true, get: function () { return common_1.validateMPTokenMetadata; } }));
 var transaction_1 = __webpack_require__(/*! ./transaction */ "./dist/npm/models/transactions/transaction.js");
 Object.defineProperty(exports, "validate", ({ enumerable: true, get: function () { return transaction_1.validate; } }));
 __exportStar(__webpack_require__(/*! ./metadata */ "./dist/npm/models/transactions/metadata.js"), exports);
@@ -24129,6 +24274,7 @@ exports.validateOfferCancel = validateOfferCancel;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.validateOfferCreate = exports.OfferCreateFlags = void 0;
 const errors_1 = __webpack_require__(/*! ../../errors */ "./dist/npm/errors.js");
+const utils_1 = __webpack_require__(/*! ../utils */ "./dist/npm/models/utils/index.js");
 const common_1 = __webpack_require__(/*! ./common */ "./dist/npm/models/transactions/common.js");
 var OfferCreateFlags;
 (function (OfferCreateFlags) {
@@ -24136,6 +24282,7 @@ var OfferCreateFlags;
     OfferCreateFlags[OfferCreateFlags["tfImmediateOrCancel"] = 131072] = "tfImmediateOrCancel";
     OfferCreateFlags[OfferCreateFlags["tfFillOrKill"] = 262144] = "tfFillOrKill";
     OfferCreateFlags[OfferCreateFlags["tfSell"] = 524288] = "tfSell";
+    OfferCreateFlags[OfferCreateFlags["tfHybrid"] = 1048576] = "tfHybrid";
 })(OfferCreateFlags || (exports.OfferCreateFlags = OfferCreateFlags = {}));
 function validateOfferCreate(tx) {
     (0, common_1.validateBaseTransaction)(tx);
@@ -24157,6 +24304,14 @@ function validateOfferCreate(tx) {
     if (tx.OfferSequence !== undefined && typeof tx.OfferSequence !== 'number') {
         throw new errors_1.ValidationError('OfferCreate: invalid OfferSequence');
     }
+    (0, common_1.validateOptionalField)(tx, 'DomainID', common_1.isDomainID, {
+        txType: 'OfferCreate',
+        paramName: 'DomainID',
+    });
+    if (tx.DomainID == null &&
+        (0, utils_1.hasFlag)(tx, OfferCreateFlags.tfHybrid, 'tfHybrid')) {
+        throw new errors_1.ValidationError('OfferCreate: tfHybrid flag cannot be set if DomainID is not present');
+    }
 }
 exports.validateOfferCreate = validateOfferCreate;
 
@@ -24300,6 +24455,10 @@ function validatePayment(tx) {
     if (tx.InvoiceID !== undefined && typeof tx.InvoiceID !== 'string') {
         throw new errors_1.ValidationError('PaymentTransaction: InvoiceID must be a string');
     }
+    (0, common_1.validateOptionalField)(tx, 'DomainID', common_1.isDomainID, {
+        txType: 'PaymentTransaction',
+        paramName: 'DomainID',
+    });
     if (tx.Paths !== undefined && !isPaths(tx.Paths)) {
         throw new errors_1.ValidationError('PaymentTransaction: invalid Paths');
     }
@@ -24307,9 +24466,6 @@ function validatePayment(tx) {
         throw new errors_1.ValidationError('PaymentTransaction: invalid SendMax');
     }
     checkPartialPayment(tx);
-    if (tx.DeliverMax != null) {
-        throw new errors_1.ValidationError('PaymentTransaction: Cannot have DeliverMax in a submitted transaction');
-    }
 }
 exports.validatePayment = validatePayment;
 function checkPartialPayment(tx) {
@@ -25013,7 +25169,6 @@ exports.validateVaultCreate = exports.VaultCreateFlags = exports.VaultWithdrawal
 const errors_1 = __webpack_require__(/*! ../../errors */ "./dist/npm/errors.js");
 const utils_1 = __webpack_require__(/*! ../utils */ "./dist/npm/models/utils/index.js");
 const common_1 = __webpack_require__(/*! ./common */ "./dist/npm/models/transactions/common.js");
-const META_MAX_BYTE_LENGTH = 1024;
 var VaultWithdrawalPolicy;
 (function (VaultWithdrawalPolicy) {
     VaultWithdrawalPolicy[VaultWithdrawalPolicy["vaultStrategyFirstComeFirstServe"] = 1] = "vaultStrategyFirstComeFirstServe";
@@ -25044,17 +25199,27 @@ function validateVaultCreate(tx) {
     if (tx.MPTokenMetadata !== undefined) {
         const metaHex = tx.MPTokenMetadata;
         if (!(0, utils_1.isHex)(metaHex)) {
-            throw new errors_1.ValidationError('VaultCreate: MPTokenMetadata must be a valid hex string');
+            throw new errors_1.ValidationError('VaultCreate: MPTokenMetadata must be a valid non-empty hex string');
         }
         const metaByteLength = metaHex.length / 2;
-        if (metaByteLength > META_MAX_BYTE_LENGTH) {
-            throw new errors_1.ValidationError(`VaultCreate: MPTokenMetadata exceeds ${META_MAX_BYTE_LENGTH} bytes (actual: ${metaByteLength})`);
+        if (metaByteLength > common_1.MAX_MPT_META_BYTE_LENGTH) {
+            throw new errors_1.ValidationError(`VaultCreate: MPTokenMetadata exceeds ${common_1.MAX_MPT_META_BYTE_LENGTH} bytes (actual: ${metaByteLength})`);
         }
     }
     if (tx.DomainID !== undefined &&
         !(0, utils_1.hasFlag)(tx, VaultCreateFlags.tfVaultPrivate, 'tfVaultPrivate')) {
         throw new errors_1.ValidationError('VaultCreate: Cannot set DomainID unless tfVaultPrivate flag is set.');
     }
+    if (tx.MPTokenMetadata != null) {
+        const validationMessages = (0, common_1.validateMPTokenMetadata)(tx.MPTokenMetadata);
+        if (validationMessages.length > 0) {
+            const message = [
+                common_1.MPT_META_WARNING_HEADER,
+                ...validationMessages.map((msg) => `- ${msg}`),
+            ].join('\n');
+            console.warn(message);
+        }
+    }
 }
 exports.validateVaultCreate = validateVaultCreate;