xrpjson 0.1.0

package/dist/fp/factories/trust-set.js

@@ -0,0 +1,111 @@
+import { isAccount, isNumber } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// UInt32 bounds — per xrpl-dev-portal `trustset.md` field table.
+const UINT32_MIN = 0;
+const UINT32_MAX = 0xffffffff;
+// ISO 4217 standard currency codes are 3 ASCII chars; non-standard codes
+// are 160-bit hex = 40 chars (per xrpl-dev-portal `currency-formats.md`).
+const CURRENCY_CODE_STD_LENGTH = 3;
+const CURRENCY_CODE_NONSTD_LENGTH = 40;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Per xrpl-dev-portal `currency-formats.md` "String Numbers" section,
+ * a valid XRPL string-number is decimal (`123`, `1.5`, `0.5`) or
+ * scientific (`1.23e11`, `1.5E-3`), and may not contain leading `+` or
+ * whitespace. Negative values are disallowed in TrustSet contexts.
+ */
+const STRING_NUMBER_REGEX = /^(?:0|[1-9][0-9]*)(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$/u;
+/**
+ * Validate the structural shape of an `IssuedCurrencyAmount` and the
+ * contents of each field against the TrustSet spec:
+ *   - `currency` is either a 3-char ISO 4217 code or a 40-char hex code.
+ *     The literal `"XRP"` is explicitly forbidden.
+ *   - `issuer` is a valid XRPL account address.
+ *   - `value` is a non-negative XRPL string-number.
+ *
+ * Returns null on success, or a human-readable error message describing
+ * the first failure encountered.
+ */
+function checkTrustLimit(amount) {
+    if (amount === undefined || amount === null) {
+        return 'missing field LimitAmount';
+    }
+    if (typeof amount !== 'object' || Array.isArray(amount)) {
+        return 'LimitAmount must be an IssuedCurrencyAmount object';
+    }
+    const a = amount;
+    if (a.mpt_issuance_id !== undefined) {
+        return 'LimitAmount must be an IssuedCurrencyAmount, not an MPTAmount';
+    }
+    if (typeof a.currency !== 'string') {
+        return 'LimitAmount.currency must be a string';
+    }
+    if (a.currency === 'XRP') {
+        return 'LimitAmount.currency must not be "XRP"';
+    }
+    if (a.currency.length !== CURRENCY_CODE_STD_LENGTH &&
+        a.currency.length !== CURRENCY_CODE_NONSTD_LENGTH) {
+        return `LimitAmount.currency must be a ${CURRENCY_CODE_STD_LENGTH}-character ISO 4217 code or ${CURRENCY_CODE_NONSTD_LENGTH}-character hex string`;
+    }
+    if (typeof a.issuer !== 'string' || !isAccount(a.issuer)) {
+        return 'LimitAmount.issuer must be a valid XRPL account address';
+    }
+    if (typeof a.value !== 'string') {
+        return 'LimitAmount.value must be a string';
+    }
+    if (!STRING_NUMBER_REGEX.test(a.value)) {
+        return 'LimitAmount.value must be a non-negative XRPL string-number (decimal or scientific)';
+    }
+    return null;
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function trustSet(props) {
+    // ── Account ── required, must be a valid XRPL classic/X-address.
+    require(props.Account, 'TrustSet: missing or invalid Account', isAccount);
+    // ── LimitAmount ── required, must be a spec-conformant
+    //    IssuedCurrencyAmount (no XRP, no MPT, non-negative value).
+    const limitError = checkTrustLimit(props.LimitAmount);
+    if (limitError !== null) {
+        throw new ValidationError(`TrustSet: ${limitError}`);
+    }
+    // ── QualityIn ── optional UInt32.
+    if (props.QualityIn !== undefined) {
+        if (!isNumber(props.QualityIn) ||
+            !Number.isInteger(props.QualityIn) ||
+            props.QualityIn < UINT32_MIN ||
+            props.QualityIn > UINT32_MAX) {
+            throw new ValidationError(`TrustSet: QualityIn must be a UInt32 in [${UINT32_MIN}, ${UINT32_MAX}]`);
+        }
+    }
+    // ── QualityOut ── optional UInt32.
+    if (props.QualityOut !== undefined) {
+        if (!isNumber(props.QualityOut) ||
+            !Number.isInteger(props.QualityOut) ||
+            props.QualityOut < UINT32_MIN ||
+            props.QualityOut > UINT32_MAX) {
+            throw new ValidationError(`TrustSet: QualityOut must be a UInt32 in [${UINT32_MIN}, ${UINT32_MAX}]`);
+        }
+    }
+    return buildFrozenTx('TrustSet', props, {
+        validate() {
+            // Validated at construction.
+        },
+        toJSON() {
+            const json = {};
+            for (const k of Object.keys(this)) {
+                if (k === 'validate' || k === 'toJSON' || k === 'with')
+                    continue;
+                const v = this[k];
+                if (v !== undefined)
+                    json[k] = v;
+            }
+            return json;
+        },
+        with(overrides) {
+            return trustSet(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=trust-set.js.map

package/dist/fp/factories/trust-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trust-set.js","sourceRoot":"","sources":["../../../src/fp/factories/trust-set.ts"],"names":[],"mappings":"AA8EA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,iEAAiE;AACjE,MAAM,UAAU,GAAG,CAAC,CAAC;AACrB,MAAM,UAAU,GAAG,UAAU,CAAC;AAC9B,yEAAyE;AACzE,0EAA0E;AAC1E,MAAM,wBAAwB,GAAG,CAAC,CAAC;AACnC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AA0BvC,wEAAwE;AAExE;;;;;GAKG;AACH,MAAM,mBAAmB,GACvB,uDAAuD,CAAC;AAU1D;;;;;;;;;;GAUG;AACH,SAAS,eAAe,CAAC,MAAe;IACtC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,2BAA2B,CAAC;IACrC,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,OAAO,oDAAoD,CAAC;IAC9D,CAAC;IACD,MAAM,CAAC,GAAG,MAAkB,CAAC;IAC7B,IAAI,CAAC,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,+DAA+D,CAAC;IACzE,CAAC;IACD,IAAI,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,uCAAuC,CAAC;IACjD,CAAC;IACD,IAAI,CAAC,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QACzB,OAAO,wCAAwC,CAAC;IAClD,CAAC;IACD,IACE,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,wBAAwB;QAC9C,CAAC,CAAC,QAAQ,CAAC,MAAM,KAAK,2BAA2B,EACjD,CAAC;QACD,OAAO,kCAAkC,wBAAwB,+BAA+B,2BAA2B,uBAAuB,CAAC;IACrJ,CAAC;IACD,IAAI,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACzD,OAAO,yDAAyD,CAAC;IACnE,CAAC;IACD,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,oCAAoC,CAAC;IAC9C,CAAC;IACD,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,OAAO,qFAAqF,CAAC;IAC/F,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,QAAQ,CAAC,KAAoB;IAC3C,kEAAkE;IAClE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,sCAAsC,EAAE,SAAS,CAAC,CAAC;IAE1E,wDAAwD;IACxD,gEAAgE;IAChE,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACtD,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACxB,MAAM,IAAI,eAAe,CAAC,aAAa,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,mCAAmC;IACnC,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;YAC1B,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC;YAClC,KAAK,CAAC,SAAS,GAAG,UAAU;YAC5B,KAAK,CAAC,SAAS,GAAG,UAAU,EAC5B,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,4CAA4C,UAAU,KAAK,UAAU,GAAG,CACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,oCAAoC;IACpC,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC;YAC3B,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;YACnC,KAAK,CAAC,UAAU,GAAG,UAAU;YAC7B,KAAK,CAAC,UAAU,GAAG,UAAU,EAC7B,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,6CAA6C,UAAU,KAAK,UAAU,GAAG,CAC1E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,UAAU,EACV,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAiB,SAAiC;YACpD,OAAO,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACjD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/vault-clawback.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Functional VaultClawback factory — frozen-object style.
+ *
+ * Performs a clawback from a Single-asset vault on behalf of a Holder,
+ * exchanging the Holder's vault shares for the underlying asset and
+ * sending the funds to the asset's Issuer. If `Amount` is omitted (or
+ * zero in serialized form) the tx claws back all funds up to the total
+ * shares the Holder owns.
+ *
+ * Validation happens at construction; there is no way to construct an
+ * invalid tx. Compare to the class-based equivalent, which exposes a
+ * separate `.validate()` method you must remember to call.
+ *
+ *   import { vaultClawback } from 'xrplt/fp';
+ *   const tx = vaultClawback({ Account, VaultID, Holder, Amount: IOU_AMT });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Holder: 'r…' });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/vaultclawback
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/vaultClawback.ts
+ * @see XLS-0065 §3.7 (https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0065-single-asset-vault)
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/vault-clawback.ts`, this factory adds
+ * guards the class skips:
+ *
+ * - **VaultID must be a 64-character hex string** (XLS-0065 §3.7.1 declares
+ *   `VaultID` as `HASH256`; the class only checks `isString(VaultID)`).
+ *   - Source: XLS-0065 §3.7.1 Fields table, Internal Type = `HASH256`.
+ *   - Source: xrpl-dev-portal vaultclawback.md, Fields table row for `VaultID`.
+ *
+ * - **Amount `value` must be a non-negative base-10 integer string**
+ *   (the canonical XRPL Number representation; matches the policy used
+ *   by `loanSet`, `vaultCreate`, etc.). The class only checks shape via
+ *   `isClawbackAmount`, which does not check numeric well-formedness.
+ *   - Source: xrpl.org generic Amount spec
+ *     (https://xrpl.org/docs/references/protocol/data-types/basic-data-types#specifying-currency-amounts).
+ *
+ * - **IssuedCurrencyAmount `currency` and `issuer` shape are validated**
+ *   (3-char ASCII or 40-char hex `currency`; `issuer` must be a valid
+ *   XRPL account). The class only delegates to `isClawbackAmount`, which
+ *   does not enforce those sub-fields.
+ *   - Source: xrpl-dev-portal basic-data-types#specifying-currency-amounts.
+ *
+ * - **MPTAmount `mpt_issuance_id` must be a non-empty hex string** with
+ *   reasonable length (24-48). The class only checks key presence.
+ *   - Source: XLS-0033 Multi-Purpose Tokens (mpt_issuance_id is 96-bit
+ *     uint, hex-encoded to ≤ 24 hex chars; we accept a slightly wider
+ *     range to avoid breaking on future widenings).
+ *
+ * - **No `Flags` validation**: per XLS-0065 §3.7 and xrpl.org, VaultClawback
+ *   defines no transaction flags; the factory does not require `Flags`,
+ *   but does accept it as `0` if supplied (BaseTransactionFields
+ *   compatibility). The class inherits `Flags` from its parent and never
+ *   checks it either.
+ *   - Source: xrpl-dev-portal vaultclawback.md "VaultClawback Flags" section.
+ */
+import type { ClawbackAmount } from '../../types/amounts.js';
+export interface VaultClawbackProps {
+    Account: string;
+    /** The ID of the vault from which assets are withdrawn. 64-char hex (HASH256). */
+    VaultID: string;
+    /** The account ID from which to clawback assets. */
+    Holder: string;
+    /**
+     * Optional clawback amount. When omitted, the asset is inferred from the
+     * vault. **NOT** an XRP amount string — only IssuedCurrency or MPT form.
+     */
+    Amount?: ClawbackAmount | undefined;
+    /** No flags defined for VaultClawback; permitted for base-tx parity. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface VaultClawback extends Readonly<VaultClawbackProps> {
+    readonly TransactionType: 'VaultClawback';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<VaultClawbackProps>): VaultClawback;
+}
+export declare function vaultClawback(props: VaultClawbackProps): VaultClawback;
+//# sourceMappingURL=vault-clawback.d.ts.map

package/dist/fp/factories/vault-clawback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault-clawback.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/vault-clawback.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AA6B7D,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACpC,wEAAwE;IACxE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,aACf,SAAQ,QAAQ,CAAC,kBAAkB,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAC1C,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,aAAa,CAAC;CAC7D;AAcD,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,GAAG,aAAa,CA8FtE"}

package/dist/fp/factories/vault-clawback.js

@@ -0,0 +1,91 @@
+import { isAccount, isClawbackAmount, isHex, isIssuedCurrencyAmount, isMPTAmount, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// HASH256 in hex is 64 characters. (XLS-0065 §3.7.1: VaultID is HASH256.)
+const HASH256_HEX_LENGTH = 64;
+// Currency codes are either 3 ASCII characters or 40 hex characters.
+const CURRENCY_ASCII_LENGTH = 3;
+const CURRENCY_HEX_LENGTH = 40;
+// MPT issuance IDs are 192-bit, hex-encoded (≤ 48 chars).
+// We accept 24..48 to leave slack for future widenings / leading-zero
+// encoders. Empty strings are rejected.
+const MPT_ISSUANCE_ID_MIN = 24;
+const MPT_ISSUANCE_ID_MAX = 48;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * XRPLNumber: a non-negative base-10 integer string. Matches the policy
+ * used across other factories (loanSet, vaultCreate).
+ */
+function isXrplNumber(value) {
+    return isString(value) && /^[0-9]+$/u.test(value);
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function vaultClawback(props) {
+    // ── Account ── required, must be a valid XRPL classic address.
+    require(props.Account, 'VaultClawback: Account is required', isAccount);
+    // ── VaultID ── required, 64-char hex (HASH256).
+    if (!isString(props.VaultID) ||
+        !isHex(props.VaultID) ||
+        props.VaultID.length !== HASH256_HEX_LENGTH) {
+        throw new ValidationError('VaultClawback: VaultID must be a 64-character hex string (HASH256)');
+    }
+    // ── Holder ── required, valid XRPL account address.
+    require(props.Holder, 'VaultClawback: Holder is required', isAccount);
+    // ── Amount ── optional, must be a valid ClawbackAmount (IOU/MPT, NOT XRP).
+    if (props.Amount !== undefined) {
+        if (!isClawbackAmount(props.Amount)) {
+            throw new ValidationError('VaultClawback: Amount must be a valid ClawbackAmount (trust line / MPT form, NOT XRP)');
+        }
+        if (isIssuedCurrencyAmount(props.Amount)) {
+            // Currency: 3 ASCII or 40 hex characters.
+            const ccy = props.Amount.currency;
+            if (ccy.length !== CURRENCY_ASCII_LENGTH &&
+                ccy.length !== CURRENCY_HEX_LENGTH) {
+                throw new ValidationError(`VaultClawback: Amount.currency must be ${CURRENCY_ASCII_LENGTH} ASCII characters or ${CURRENCY_HEX_LENGTH} hex characters (actual: ${ccy.length})`);
+            }
+            if (ccy.length === CURRENCY_HEX_LENGTH && !isHex(ccy)) {
+                throw new ValidationError('VaultClawback: Amount.currency (40-char form) must be hex');
+            }
+            // Issuer must be a valid XRPL account.
+            if (!isAccount(props.Amount.issuer)) {
+                throw new ValidationError('VaultClawback: Amount.issuer must be a valid XRPL account address');
+            }
+            // Value: non-negative base-10 integer string.
+            if (!isXrplNumber(props.Amount.value)) {
+                throw new ValidationError('VaultClawback: Amount.value must be a non-negative base-10 integer string');
+            }
+        }
+        else if (isMPTAmount(props.Amount)) {
+            const mptid = props.Amount.mpt_issuance_id;
+            if (mptid.length < MPT_ISSUANCE_ID_MIN ||
+                mptid.length > MPT_ISSUANCE_ID_MAX ||
+                !isHex(mptid)) {
+                throw new ValidationError(`VaultClawback: Amount.mpt_issuance_id must be a ${MPT_ISSUANCE_ID_MIN}-${MPT_ISSUANCE_ID_MAX} character hex string`);
+            }
+            if (!isXrplNumber(props.Amount.value)) {
+                throw new ValidationError('VaultClawback: Amount.value must be a non-negative base-10 integer string');
+            }
+        }
+    }
+    return buildFrozenTx('VaultClawback', props, {
+        validate() {
+            // Validated at construction.
+        },
+        toJSON() {
+            const json = {};
+            for (const k of Object.keys(this)) {
+                if (k === 'validate' || k === 'toJSON' || k === 'with')
+                    continue;
+                const v = this[k];
+                if (v !== undefined)
+                    json[k] = v;
+            }
+            return json;
+        },
+        with(overrides) {
+            return vaultClawback(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=vault-clawback.js.map

package/dist/fp/factories/vault-clawback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault-clawback.js","sourceRoot":"","sources":["../../../src/fp/factories/vault-clawback.ts"],"names":[],"mappings":"AA2DA,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,KAAK,EACL,sBAAsB,EACtB,WAAW,EACX,QAAQ,GACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,0EAA0E;AAC1E,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,qEAAqE;AACrE,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,0DAA0D;AAC1D,sEAAsE;AACtE,wCAAwC;AACxC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AA6B/B,wEAAwE;AAExE;;;GAGG;AACH,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACpD,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,gEAAgE;IAChE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,oCAAoC,EAAE,SAAS,CAAC,CAAC;IAExE,iDAAiD;IACjD,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QACxB,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;QACrB,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,kBAAkB,EAC3C,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,oEAAoE,CACrE,CAAC;IACJ,CAAC;IAED,qDAAqD;IACrD,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,mCAAmC,EAAE,SAAS,CAAC,CAAC;IAEtE,4EAA4E;IAC5E,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,eAAe,CACvB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QAED,IAAI,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACzC,0CAA0C;YAC1C,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;YAClC,IACE,GAAG,CAAC,MAAM,KAAK,qBAAqB;gBACpC,GAAG,CAAC,MAAM,KAAK,mBAAmB,EAClC,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,0CAA0C,qBAAqB,wBAAwB,mBAAmB,4BAA4B,GAAG,CAAC,MAAM,GAAG,CACpJ,CAAC;YACJ,CAAC;YACD,IAAI,GAAG,CAAC,MAAM,KAAK,mBAAmB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtD,MAAM,IAAI,eAAe,CACvB,2DAA2D,CAC5D,CAAC;YACJ,CAAC;YACD,uCAAuC;YACvC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,eAAe,CACvB,mEAAmE,CACpE,CAAC;YACJ,CAAC;YACD,8CAA8C;YAC9C,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,eAAe,CACvB,2EAA2E,CAC5E,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC;YAC3C,IACE,KAAK,CAAC,MAAM,GAAG,mBAAmB;gBAClC,KAAK,CAAC,MAAM,GAAG,mBAAmB;gBAClC,CAAC,KAAK,CAAC,KAAK,CAAC,EACb,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,mDAAmD,mBAAmB,IAAI,mBAAmB,uBAAuB,CACrH,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,eAAe,CACvB,2EAA2E,CAC5E,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,eAAe,EACf,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAsB,SAAsC;YAC9D,OAAO,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACtD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/vault-create.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Functional VaultCreate factory — frozen-object style.
+ *
+ * Creates a single-asset vault on the ledger. The asset can be XRP,
+ * a trust line token, or an MPT. Validation happens at construction;
+ * there is no way to construct an invalid tx.
+ *
+ *   import { vaultCreate } from 'xrplt/fp';
+ *   const tx = vaultCreate({ Account, Asset: IOU_ASSET });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ WithdrawalPolicy: 0x0001 });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/vaultcreate
+ */
+import type { Currency } from '../../types/amounts.js';
+import type { VaultCreateFlagsInterface } from '../../types/flags.js';
+export interface VaultCreateProps {
+    Account: string;
+    /** The asset held in the vault: XRP, a trust line token, or an MPT. */
+    Asset: Currency;
+    /** Optional cap on total assets the vault can hold (base-10 number string). */
+    AssetsMaximum?: string | undefined;
+    /** Optional vault metadata, hex-encoded, 0 < length ≤ 256 bytes. */
+    Data?: string | undefined;
+    /** Optional Permissioned Domain ID (64-char hex). Requires tfVaultPrivate. */
+    DomainID?: string | undefined;
+    /** Optional share-metadata, hex-encoded, 0 < length ≤ 1024 bytes. */
+    MPTokenMetadata?: string | undefined;
+    /** Required when VaultKind = 1 (closed-ended). */
+    RedemptionDate?: number | undefined;
+    /** Decimal precision for share conversion. Fixed at 0 for XRP/MPT. */
+    Scale?: number | undefined;
+    /** Required when VaultKind = 1 (closed-ended). */
+    SubscriptionDate?: number | undefined;
+    /** 0 = open-ended (default); 1 = closed-ended. */
+    VaultKind?: number | undefined;
+    /** Withdrawal strategy. Currently only 0x0001 (FCFS) is supported. */
+    WithdrawalPolicy?: number | undefined;
+    /** Bit-flags for this transaction. */
+    Flags?: number | VaultCreateFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface VaultCreate extends Readonly<VaultCreateProps> {
+    readonly TransactionType: 'VaultCreate';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<VaultCreateProps>): VaultCreate;
+}
+export declare function vaultCreate(props: VaultCreateProps): VaultCreate;
+//# sourceMappingURL=vault-create.d.ts.map

package/dist/fp/factories/vault-create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault-create.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/vault-create.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AA0BtE,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,KAAK,EAAE,QAAQ,CAAC;IAChB,+EAA+E;IAC/E,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,qEAAqE;IACrE,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,kDAAkD;IAClD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,sEAAsE;IACtE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,kDAAkD;IAClD,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IACvD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,WACf,SAAQ,QAAQ,CAAC,gBAAgB,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC;IACxC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;CACzD;AAID,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CAuLhE"}

package/dist/fp/factories/vault-create.js

@@ -0,0 +1,141 @@
+import { isCurrency, isDomainID, isHex, isNumber, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+const MAX_DATA_BYTES = 256;
+const MAX_METADATA_BYTES = 1024;
+const MIN_SCALE = 0;
+const MAX_SCALE = 18;
+const VAULT_KIND_OPEN_ENDED = 0;
+const VAULT_KIND_CLOSED_ENDED = 1;
+const WITHDRAWAL_POLICY_FCFS = 0x0001;
+const MIN_CLOSED_ENDED_GAP_SECONDS = 180;
+const MAX_CLOSED_ENDED_GAP_SECONDS = 946708560; // 30 years
+const TF_VAULT_PRIVATE = 0x00010000;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function vaultCreate(props) {
+    // ── Account ── required, must be a valid XRPL classic address.
+    require(props.Account, 'VaultCreate: Account is required', isString);
+    // ── Asset ── required, must be a valid Currency.
+    if (!isCurrency(props.Asset)) {
+        throw new ValidationError('VaultCreate: Asset must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    // ── Data ── hex, even length, ≤ 256 bytes.
+    if (props.Data !== undefined) {
+        if (!isString(props.Data) || !isHex(props.Data)) {
+            throw new ValidationError('VaultCreate: Data must be a hex string');
+        }
+        if (props.Data.length % 2 !== 0) {
+            throw new ValidationError('VaultCreate: Data must be a hex string with an even number of characters');
+        }
+        const bytes = props.Data.length / 2;
+        if (bytes > MAX_DATA_BYTES) {
+            throw new ValidationError(`VaultCreate: Data exceeds ${MAX_DATA_BYTES} bytes (actual: ${bytes})`);
+        }
+    }
+    // ── MPTokenMetadata ── hex, non-empty, ≤ 1024 bytes.
+    if (props.MPTokenMetadata !== undefined) {
+        if (!isString(props.MPTokenMetadata) || !isHex(props.MPTokenMetadata)) {
+            throw new ValidationError('VaultCreate: MPTokenMetadata must be a valid non-empty hex string');
+        }
+        const bytes = props.MPTokenMetadata.length / 2;
+        if (bytes > MAX_METADATA_BYTES) {
+            throw new ValidationError(`VaultCreate: MPTokenMetadata exceeds ${MAX_METADATA_BYTES} bytes (actual: ${bytes})`);
+        }
+    }
+    // ── WithdrawalPolicy ── currently only 0x0001 supported.
+    if (props.WithdrawalPolicy !== undefined) {
+        if (!isNumber(props.WithdrawalPolicy) ||
+            props.WithdrawalPolicy !== WITHDRAWAL_POLICY_FCFS) {
+            throw new ValidationError(`VaultCreate: WithdrawalPolicy must be 0x${WITHDRAWAL_POLICY_FCFS.toString(16).padStart(4, '0')} (vaultStrategyFirstComeFirstServe)`);
+        }
+    }
+    // ── AssetsMaximum ── non-negative base-10 integer string.
+    if (props.AssetsMaximum !== undefined) {
+        if (!isString(props.AssetsMaximum) ||
+            !/^[0-9]+$/u.test(props.AssetsMaximum)) {
+            throw new ValidationError('VaultCreate: AssetsMaximum must be a non-negative base-10 integer string');
+        }
+    }
+    // ── VaultKind ── 0 or 1 only.
+    if (props.VaultKind !== undefined) {
+        if (!isNumber(props.VaultKind) ||
+            (props.VaultKind !== VAULT_KIND_OPEN_ENDED &&
+                props.VaultKind !== VAULT_KIND_CLOSED_ENDED)) {
+            throw new ValidationError(`VaultCreate: VaultKind must be ${VAULT_KIND_OPEN_ENDED} (open-ended) or ${VAULT_KIND_CLOSED_ENDED} (closed-ended)`);
+        }
+    }
+    // ── Scale ── conditional on Asset type + range.
+    if (props.Scale !== undefined) {
+        if (!isNumber(props.Scale) ||
+            props.Scale < MIN_SCALE ||
+            props.Scale > MAX_SCALE ||
+            !Number.isInteger(props.Scale)) {
+            throw new ValidationError(`VaultCreate: Scale must be an integer in [${MIN_SCALE}, ${MAX_SCALE}]`);
+        }
+        if ('currency' in props.Asset && props.Asset.currency === 'XRP') {
+            throw new ValidationError('VaultCreate: Scale parameter must not be provided for XRP or MPT assets');
+        }
+        else if ('mpt_issuance_id' in props.Asset) {
+            throw new ValidationError('VaultCreate: Scale parameter must not be provided for XRP or MPT assets');
+        }
+    }
+    // ── Closed-ended vault date invariants ──
+    const hasSub = props.SubscriptionDate !== undefined;
+    const hasRed = props.RedemptionDate !== undefined;
+    const isClosedEnded = props.VaultKind === VAULT_KIND_CLOSED_ENDED ||
+        (props.VaultKind === undefined && (hasSub || hasRed));
+    if (props.VaultKind === VAULT_KIND_CLOSED_ENDED) {
+        if (!hasSub || !hasRed) {
+            throw new ValidationError('VaultCreate: VaultKind=1 (closed-ended) requires both SubscriptionDate and RedemptionDate');
+        }
+    }
+    else if (props.VaultKind === VAULT_KIND_OPEN_ENDED) {
+        if (hasSub || hasRed) {
+            throw new ValidationError('VaultCreate: VaultKind=0 (open-ended) must not include SubscriptionDate or RedemptionDate');
+        }
+    }
+    if (isClosedEnded && hasSub && hasRed) {
+        if (!isNumber(props.SubscriptionDate) ||
+            !isNumber(props.RedemptionDate) ||
+            props.SubscriptionDate <= 0 ||
+            props.RedemptionDate <= 0) {
+            throw new ValidationError('VaultCreate: SubscriptionDate and RedemptionDate must be positive integers (seconds since Ripple Epoch)');
+        }
+        const gap = props.RedemptionDate - props.SubscriptionDate;
+        if (gap < MIN_CLOSED_ENDED_GAP_SECONDS ||
+            gap >= MAX_CLOSED_ENDED_GAP_SECONDS) {
+            throw new ValidationError(`VaultCreate: RedemptionDate - SubscriptionDate must be in [${MIN_CLOSED_ENDED_GAP_SECONDS}, ${MAX_CLOSED_ENDED_GAP_SECONDS}) seconds`);
+        }
+    }
+    // ── DomainID ── 64-char hex AND requires tfVaultPrivate flag.
+    if (props.DomainID !== undefined) {
+        if (!isDomainID(props.DomainID)) {
+            throw new ValidationError('VaultCreate: DomainID must be a 64-character hex string');
+        }
+        const flags = props.Flags;
+        if (!flags || (flags & TF_VAULT_PRIVATE) !== TF_VAULT_PRIVATE) {
+            throw new ValidationError('VaultCreate: Cannot set DomainID unless tfVaultPrivate flag is set');
+        }
+    }
+    return buildFrozenTx('VaultCreate', props, {
+        validate() {
+            // Validated at construction.
+        },
+        toJSON() {
+            const json = {};
+            for (const k of Object.keys(this)) {
+                if (k === 'validate' || k === 'toJSON' || k === 'with')
+                    continue;
+                const v = this[k];
+                if (v !== undefined)
+                    json[k] = v;
+            }
+            return json;
+        },
+        with(overrides) {
+            return vaultCreate(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=vault-create.js.map

package/dist/fp/factories/vault-create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault-create.js","sourceRoot":"","sources":["../../../src/fp/factories/vault-create.ts"],"names":[],"mappings":"AAgBA,OAAO,EACL,UAAU,EACV,UAAU,EACV,KAAK,EACL,QAAQ,EACR,QAAQ,GACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAChC,MAAM,SAAS,GAAG,CAAC,CAAC;AACpB,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,MAAM,uBAAuB,GAAG,CAAC,CAAC;AAClC,MAAM,sBAAsB,GAAG,MAAM,CAAC;AACtC,MAAM,4BAA4B,GAAG,GAAG,CAAC;AACzC,MAAM,4BAA4B,GAAG,SAAS,CAAC,CAAC,WAAW;AAC3D,MAAM,gBAAgB,GAAG,UAAU,CAAC;AAwCpC,wEAAwE;AAExE,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,gEAAgE;IAChE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,kCAAkC,EAAE,QAAQ,CAAC,CAAC;IAErE,kDAAkD;IAClD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACvB,4EAA4E,CAC7E,CAAC;IACJ,CAAC;IAED,4CAA4C;IAC5C,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,eAAe,CAAC,wCAAwC,CAAC,CAAC;QACtE,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,0EAA0E,CAC3E,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QACpC,IAAI,KAAK,GAAG,cAAc,EAAE,CAAC;YAC3B,MAAM,IAAI,eAAe,CACvB,6BAA6B,cAAc,mBAAmB,KAAK,GAAG,CACvE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,sDAAsD;IACtD,IAAI,KAAK,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;YACtE,MAAM,IAAI,eAAe,CACvB,mEAAmE,CACpE,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;QAC/C,IAAI,KAAK,GAAG,kBAAkB,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,wCAAwC,kBAAkB,mBAAmB,KAAK,GAAG,CACtF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,0DAA0D;IAC1D,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACzC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC;YACjC,KAAK,CAAC,gBAAgB,KAAK,sBAAsB,EACjD,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,2CAA2C,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,qCAAqC,CACrI,CAAC;QACJ,CAAC;IACH,CAAC;IAED,2DAA2D;IAC3D,IAAI,KAAK,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACtC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC;YAC9B,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,EACtC,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,0EAA0E,CAC3E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,+BAA+B;IAC/B,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;YAC1B,CAAC,KAAK,CAAC,SAAS,KAAK,qBAAqB;gBACxC,KAAK,CAAC,SAAS,KAAK,uBAAuB,CAAC,EAC9C,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,kCAAkC,qBAAqB,oBAAoB,uBAAuB,iBAAiB,CACpH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,iDAAiD;IACjD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACtB,KAAK,CAAC,KAAK,GAAG,SAAS;YACvB,KAAK,CAAC,KAAK,GAAG,SAAS;YACvB,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAC9B,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,6CAA6C,SAAS,KAAK,SAAS,GAAG,CACxE,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;YAChE,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;QACJ,CAAC;aAAM,IAAI,iBAAiB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAC5C,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,2CAA2C;IAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,gBAAgB,KAAK,SAAS,CAAC;IACpD,MAAM,MAAM,GAAG,KAAK,CAAC,cAAc,KAAK,SAAS,CAAC;IAClD,MAAM,aAAa,GACjB,KAAK,CAAC,SAAS,KAAK,uBAAuB;QAC3C,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC;IAExD,IAAI,KAAK,CAAC,SAAS,KAAK,uBAAuB,EAAE,CAAC;QAChD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,eAAe,CACvB,2FAA2F,CAC5F,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,CAAC,SAAS,KAAK,qBAAqB,EAAE,CAAC;QACrD,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;YACrB,MAAM,IAAI,eAAe,CACvB,2FAA2F,CAC5F,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,aAAa,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QACtC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC;YACjC,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;YAC/B,KAAK,CAAC,gBAAgB,IAAI,CAAC;YAC3B,KAAK,CAAC,cAAc,IAAI,CAAC,EACzB,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,yGAAyG,CAC1G,CAAC;QACJ,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC1D,IACE,GAAG,GAAG,4BAA4B;YAClC,GAAG,IAAI,4BAA4B,EACnC,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,8DAA8D,4BAA4B,KAAK,4BAA4B,WAAW,CACvI,CAAC;QACJ,CAAC;IACH,CAAC;IAED,+DAA+D;IAC/D,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,yDAAyD,CAC1D,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,KAA2B,CAAC;QAChD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,GAAG,gBAAgB,CAAC,KAAK,gBAAgB,EAAE,CAAC;YAC9D,MAAM,IAAI,eAAe,CACvB,oEAAoE,CACrE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,aAAa,EACb,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAoB,SAAoC;YAC1D,OAAO,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACpD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/vault-delete.d.ts

@@ -0,0 +1,20 @@
+export interface VaultDeleteProps {
+    Account: string;
+    /** The ID of the vault to delete. 64-char hex; must not be all-zero. */
+    VaultID: string;
+    /**
+     * (LendingProtocolV1_1) Optional hex-encoded reason for the deletion.
+     * If present, the decoded value must be 1–256 bytes.
+     */
+    MemoData?: string | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface VaultDelete extends Readonly<VaultDeleteProps> {
+    readonly TransactionType: 'VaultDelete';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<VaultDeleteProps>): VaultDelete;
+}
+export declare function vaultDelete(props: VaultDeleteProps): VaultDelete;
+//# sourceMappingURL=vault-delete.d.ts.map

package/dist/fp/factories/vault-delete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault-delete.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/vault-delete.ts"],"names":[],"mappings":"AAmDA,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,WACf,SAAQ,QAAQ,CAAC,gBAAgB,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC;IACxC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;CACzD;AAID,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CAyEhE"}

package/dist/fp/factories/vault-delete.js

@@ -0,0 +1,103 @@
+/**
+ * Functional VaultDelete factory — frozen-object style.
+ *
+ * Deletes an existing vault ledger entry. Validation happens at
+ * construction; there is no way to construct an invalid tx.
+ *
+ *   import { vaultDelete } from 'xrplt/fp';
+ *   const tx = vaultDelete({ Account, VaultID });
+ *   const j = tx.toJSON();
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/vaultdelete
+ * @see https://xrpl.org/docs/concepts/tokens/single-asset-vaults
+ *
+ * Affected amendments:
+ *   - `SingleAssetVault`         — base VaultDelete.
+ *   - `LendingProtocolV1_1`     — introduces the optional `MemoData`
+ *                                 field for documenting the deletion reason.
+ *
+ * ## Divergences
+ *
+ * The class-based API at `src/transactions/vault-delete.ts` is missing
+ * two rules that the canonical sources require. The factory fills them:
+ *
+ *   1. Empty `MemoData` is rejected.
+ *      The class treats `""` as a valid `MemoData` because `"" !== undefined`
+ *      and `""` is a valid (empty) hex string. The spec mandates that when
+ *      present the decoded value must be 1–256 bytes.
+ *      Source: XLS-0065 §3.4.2.1 #3 (LendingProtocolV1_1, `temMALFORMED`);
+ *              xrpl-dev-portal `vaultdelete.md` (Error Cases table).
+ *
+ *   2. All-zero `VaultID` is rejected.
+ *      The class only checks that `VaultID` is a 64-char hex string, so a
+ *      64-char string of zeros (`'00…00'`) passes. The spec mandates that
+ *      `VaultID == 0` is malformed.
+ *      Source: XLS-0065 §3.4.2.1 #1 (`temMALFORMED`);
+ *              xrpl-dev-portal `vaultdelete.md` (Error Cases table);
+ *              XLS-0065 §3.4.1 (`HASH256` internal type).
+ */
+import { isHex, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// Maximum decoded MemoData length in bytes (hex is 2 chars per byte).
+const MAX_MEMO_DATA_BYTES = 256;
+// HASH256 serialized length in hex characters.
+const VAULT_ID_LENGTH = 64;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function vaultDelete(props) {
+    // ── Account ── required, must be a valid XRPL classic or X-address.
+    require(props.Account, 'VaultDelete: Account is required', isString);
+    // ── VaultID ── required, 64-char hex, and not all-zero.
+    if (!isString(props.VaultID) ||
+        !isHex(props.VaultID) ||
+        props.VaultID.length !== VAULT_ID_LENGTH) {
+        throw new ValidationError('VaultDelete: VaultID must be a 64-character hex string');
+    }
+    // All-zero VaultID is a separate malformation per XLS-0065 §3.4.2.1 #1.
+    if (/^0+$/u.test(props.VaultID)) {
+        throw new ValidationError('VaultDelete: VaultID must not be zero');
+    }
+    // ── MemoData ── hex, non-empty (≥ 1 byte), even-length, ≤ 256 bytes.
+    if (props.MemoData !== undefined) {
+        if (!isString(props.MemoData)) {
+            throw new ValidationError('VaultDelete: MemoData must be a hex string');
+        }
+        // Empty MemoData is rejected per spec — the decoded value must be
+        // 1–256 bytes when present. Check this before the hex regex so the
+        // error message is specific to the empty case.
+        if (props.MemoData.length === 0) {
+            throw new ValidationError('VaultDelete: MemoData must not be empty (decoded value must be 1–256 bytes)');
+        }
+        if (!isHex(props.MemoData)) {
+            throw new ValidationError('VaultDelete: MemoData must be a hex string');
+        }
+        if (props.MemoData.length % 2 !== 0) {
+            throw new ValidationError('VaultDelete: MemoData must be a hex string with an even number of characters');
+        }
+        const bytes = props.MemoData.length / 2;
+        if (bytes > MAX_MEMO_DATA_BYTES) {
+            throw new ValidationError(`VaultDelete: MemoData exceeds ${MAX_MEMO_DATA_BYTES} bytes (actual: ${bytes})`);
+        }
+    }
+    return buildFrozenTx('VaultDelete', props, {
+        validate() {
+            // Validated at construction.
+        },
+        toJSON() {
+            const json = {};
+            for (const k of Object.keys(this)) {
+                if (k === 'validate' || k === 'toJSON' || k === 'with')
+                    continue;
+                const v = this[k];
+                if (v !== undefined)
+                    json[k] = v;
+            }
+            return json;
+        },
+        with(overrides) {
+            return vaultDelete(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=vault-delete.js.map