xrpjson 0.1.0

package/dist/fp/factories/check-cancel.js

@@ -0,0 +1,119 @@
+/**
+ * Functional CheckCancel factory — frozen-object style.
+ *
+ * Cancels an unredeemed Check, removing it from the ledger without
+ * sending any money. The source or the destination of the Check can
+ * cancel it at any time; once expired, any address can cancel it.
+ * Validation happens at construction; there is no way to construct
+ * an invalid tx.
+ *
+ *   import { checkCancel } from 'xrplt/fp';
+ *   const tx = checkCancel({ Account, CheckID });
+ *   const j = tx.toJSON();
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/checkcancel
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/CheckCancel.ts
+ *
+ * Affected amendments:
+ *   - `Checks`           — base CheckCancel.
+ *   - `fixCleanup3_3_0`  — moves the all-zeros CheckID rejection from
+ *                          `tecNO_ENTRY` (a post-ledger lookup failure)
+ *                          to `temMALFORMED` (a preclaim rejection).
+ *                          The factory enforces this preclaim form.
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/check-cancel.ts`, this factory adds
+ * two preclaim guards the class skips (or that xrpl.js / xrpl.org
+ * mandate but the class omits):
+ *
+ * - **`CheckID` must be a 64-character hexadecimal string (UInt256).**
+ *   xrpl.org `checkcancel.md` line 34 explicitly states
+ *   "`CheckID` | String | UInt256 … as a 64-character hexadecimal
+ *   string." A UInt256 in hex is exactly 64 characters. xrpl.js's
+ *   `validateCheckCancel` (lines 31–33) only checks
+ *   `typeof tx.CheckID !== 'string'`, accepting any non-string value
+ *   and any string of any length. The class inherits the same laxness
+ *   (`isString(this.CheckID)`). The factory enforces 64-char hex.
+ *   - Source: xrpl.org `checkcancel.md` line 34 (`UInt256`,
+ *     "64-character hexadecimal string").
+ *   - Source: xrpl.js `CheckCancel.ts` lines 31–33 (lax `typeof`
+ *     check; no length or hex validation).
+ *   - Cross-ref: rippled parses `CheckID` as `uint256` in
+ *     `CheckCancel.cpp`; uint256 is 32 bytes = 64 hex chars.
+ *
+ * - **All-zeros `CheckID` is rejected (`fixCleanup3_3_0` amendment).**
+ *   xrpl.org `checkcancel.md` Error Cases line 38 states: "If the
+ *   `CheckID` is an all-zero value, the transaction fails with the
+ *   result `temMALFORMED`. Previously, the transaction would fail
+ *   with the result `tecNO_ENTRY`." This is a preclaim (malformed)
+ *   failure, not a post-ledger lookup failure — the factory catches
+ *   it at construction. The class does not guard against this case at
+ *   all (any 64-char hex passes `isString`).
+ *   - Source: xrpl.org `checkcancel.md` line 38 (`temMALFORMED` for
+ *     all-zero CheckID; `fixCleanup3_3_0`).
+ *   - Source: rippled `CheckCancel.cpp` `preflight` (gates the
+ *     zero-check on the `fixCleanup3_3_0` amendment; preclaim
+ *     rejection).
+ *   - Cross-ref: same HASH256 zero-rejection pattern is used by
+ *     `check-cash.ts`, `nftoken-burn.ts`, `nftoken-modify.ts` for
+ *     their respective IDs.
+ *
+ * - **`Flags` accepted for parity with the base transaction shape.**
+ *   CheckCancel itself defines no transaction-specific flags; only
+ *   `tfFullyCanonicalSig` (global) is normally meaningful. The class
+ *   does not declare a `Flags` field at all. We accept a numeric
+ *   bitmask for parity with `check-cash.ts` and `nftoken-burn.ts`.
+ *   This is a permissive addition, not a tightening — callers who
+ *   pass a non-zero Flags get the value stored verbatim.
+ */
+import { isAccount, isHex, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// UInt256 hex length: 32 bytes = 64 hex chars.
+// (xrpl.org checkcancel.md line 34: "as a 64-character hexadecimal
+// string".)
+const CHECK_ID_HEX_LENGTH = 64;
+// All-zeros HASH256 is reserved / malformed per `fixCleanup3_3_0`.
+// (xrpl.org checkcancel.md line 38: temMALFORMED for the zero
+// CheckID.)
+const CHECK_ID_ZERO = '0000000000000000000000000000000000000000000000000000000000000000';
+// ─── Factory ─────────────────────────────────────────────────────────
+export function checkCancel(props) {
+    // ── Account ── required, must be a valid XRPL classic or X-address.
+    require(props.Account, 'CheckCancel: Account is required', isAccount);
+    // ── CheckID ── required, 64-char hex (UInt256) AND non-zero.
+    if (!isString(props.CheckID)) {
+        throw new ValidationError('CheckCancel: CheckID is required and must be a string');
+    }
+    if (!isHex(props.CheckID)) {
+        throw new ValidationError('CheckCancel: CheckID must be a hex-encoded string');
+    }
+    if (props.CheckID.length !== CHECK_ID_HEX_LENGTH) {
+        throw new ValidationError(`CheckCancel: CheckID must be exactly ${CHECK_ID_HEX_LENGTH} hex characters (UInt256)`);
+    }
+    if (props.CheckID === CHECK_ID_ZERO) {
+        throw new ValidationError('CheckCancel: CheckID must not be the all-zeros HASH256 value (xrpl.org fixCleanup3_3_0: temMALFORMED)');
+    }
+    return buildFrozenTx('CheckCancel', 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 checkCancel(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=check-cancel.js.map

package/dist/fp/factories/check-cancel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-cancel.js","sourceRoot":"","sources":["../../../src/fp/factories/check-cancel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,+CAA+C;AAC/C,mEAAmE;AACnE,YAAY;AACZ,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,mEAAmE;AACnE,8DAA8D;AAC9D,YAAY;AACZ,MAAM,aAAa,GACjB,kEAAkE,CAAC;AA0BrE,wEAAwE;AAExE,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,qEAAqE;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,kCAAkC,EAAE,SAAS,CAAC,CAAC;IAEtE,8DAA8D;IAC9D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACvB,uDAAuD,CACxD,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,eAAe,CACvB,mDAAmD,CACpD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,mBAAmB,EAAE,CAAC;QACjD,MAAM,IAAI,eAAe,CACvB,wCAAwC,mBAAmB,2BAA2B,CACvF,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,KAAK,aAAa,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CACvB,uGAAuG,CACxG,CAAC;IACJ,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/check-cash.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Functional CheckCash factory — frozen-object style.
+ *
+ * Cashes an existing Check that was created by `checkCreate`. Validation
+ * happens at construction; there is no way to construct an invalid tx.
+ *
+ *   import { checkCash } from 'xrplt/fp';
+ *   const tx = checkCash({ Account, CheckID, Amount: '100000000' });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Amount: '200000000' });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/checkcash
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/check-cash.ts`, this factory enforces
+ * five preclaim guards that the class API omits. The class only checks
+ * that `CheckID` is a string, that `Amount`/`DeliverMin` are not both
+ * present, and that at least one is present — it does no shape, range,
+ * semantic-equivalence, or zero-check on those fields.
+ *
+ *   1. **`CheckID` must be a 64-character hex string (UInt256).**
+ *      Source: xrpl.org `checkcash.md` field table — `CheckID | String |
+ *      UInt256`. xrpl.js `validateCheckCash` accepts any string for
+ *      `CheckID` (`packages/xrpl/src/models/transactions/checkCash.ts:69`
+ *      `typeof tx.CheckID !== 'string'`). The class only calls
+ *      `isString(this.CheckID)`.
+ *
+ *   2. **`CheckID` must not be the all-zeros HASH256.**
+ *      Source: xrpl.org `checkcash.md` Error Cases — "If the `CheckID`
+ *      is an all-zero value, the transaction fails with the result
+ *      `temMALFORMED`. Previously, the transaction would fail with the
+ *      result `tecNO_ENTRY`." (Amended by `fixCleanup3_3_0`.) The class
+ *      does not reject the zero CheckID; xrpl.js only checks it is a
+ *      string. The runtime check has moved from `tecNO_ENTRY` to
+ *      `temMALFORMED` (preclaim) — a guard the factory must enforce.
+ *
+ *   3. **`Amount` must be a valid `Amount` shape (XRP drops string,
+ *      `IssuedCurrencyAmount`, or `MPTAmount`).**
+ *      Source: xrpl.js `validateCheckCash` (lines 56–58) calls
+ *      `isAmount(tx.Amount)`; xrpl.org `checkcash.md` field table —
+ *      `Amount | Currency Amount | Amount`. The class only enforces
+ *      presence ("must have either Amount or DeliverMin") and never
+ *      checks the shape of `Amount` when present — a malformed `Amount`
+ *      would slip through `src/transactions/check-cash.ts:42–48`.
+ *
+ *   4. **`Amount` must be strictly positive (non-zero, non-negative).**
+ *      Source: xrpl.org `tem-codes.md` — `temBAD_AMOUNT` — "An amount
+ *      specified by the transaction … was invalid, possibly because it
+ *      was a negative number." xrpl.js does NOT check the sign of
+ *      `Amount` or `DeliverMin`; the class inherits that gap.
+ *
+ *   5. **`DeliverMin` must be a valid `Amount` shape AND strictly
+ *      positive.** Same sources as items 3 and 4.
+ */
+import type { Amount, MPTAmount } from '../../types/amounts.js';
+export interface CheckCashProps {
+    /** The unique address of the transaction sender (the Check cashier). */
+    Account: string;
+    /** The ID of the Check ledger object to cash (UInt256, 64-char hex). */
+    CheckID: string;
+    /**
+     * Redeem the Check for exactly this amount, if possible. Must be a valid
+     * `Amount` and strictly positive. Required XOR `DeliverMin`.
+     */
+    Amount?: Amount | MPTAmount | undefined;
+    /**
+     * Redeem the Check for at least this amount and as much as possible.
+     * Must be a valid `Amount` and strictly positive. Required XOR `Amount`.
+     */
+    DeliverMin?: Amount | MPTAmount | undefined;
+    /** Bit-flags for this transaction. CheckCash has no defined flags. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface CheckCash extends Readonly<CheckCashProps> {
+    readonly TransactionType: 'CheckCash';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<CheckCashProps>): CheckCash;
+}
+export declare function checkCash(props: CheckCashProps): CheckCash;
+//# sourceMappingURL=check-cash.d.ts.map

package/dist/fp/factories/check-cash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-cash.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/check-cash.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAkBhE,MAAM,WAAW,cAAc;IAC7B,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IACxC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;IAC5C,sEAAsE;IACtE,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,SAAU,SAAQ,QAAQ,CAAC,cAAc,CAAC;IACzD,QAAQ,CAAC,eAAe,EAAE,WAAW,CAAC;IACtC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;CACrD;AA4BD,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,CAmF1D"}

package/dist/fp/factories/check-cash.js

@@ -0,0 +1,95 @@
+import { isAccount, isAmount, isHex, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// UInt256 hex length: 32 bytes = 64 hex chars.
+// (xrpl.org `checkcash.md` field table: CheckID | String | UInt256.)
+const CHECK_ID_HEX_LENGTH = 64;
+// All-zeros HASH256 is reserved / malformed per `fixCleanup3_3_0`.
+// (xrpl.org `checkcash.md` Error Cases: temMALFORMED for the zero CheckID.)
+const CHECK_ID_ZERO = '0000000000000000000000000000000000000000000000000000000000000000';
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Per xrpl.org `tem-codes.md` `temBAD_AMOUNT`: Amount or DeliverMin that
+ * is zero or negative is rejected. Validates the sign of an Amount in
+ * all three accepted forms (XRP drops string, `IssuedCurrencyAmount`,
+ * `MPTAmount`).
+ */
+function isPositiveAmount(amount) {
+    if (typeof amount === 'string') {
+        if (!/^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$/u.test(amount)) {
+            return false;
+        }
+        return parseFloat(amount) > 0;
+    }
+    if (typeof amount !== 'object' || amount === null)
+        return false;
+    const value = amount.value;
+    if (typeof value !== 'string')
+        return false;
+    if (!/^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$/u.test(value)) {
+        return false;
+    }
+    return parseFloat(value) > 0;
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function checkCash(props) {
+    // ── Account ── required, must be a valid XRPL classic/X-address.
+    require(props.Account, 'CheckCash: missing or invalid Account', isAccount);
+    // ── CheckID ── required, 64-char hex (UInt256) AND non-zero.
+    if (!isString(props.CheckID) ||
+        !isHex(props.CheckID) ||
+        props.CheckID.length !== CHECK_ID_HEX_LENGTH) {
+        throw new ValidationError(`CheckCash: CheckID must be a ${CHECK_ID_HEX_LENGTH}-character hex string (UInt256)`);
+    }
+    if (props.CheckID === CHECK_ID_ZERO) {
+        throw new ValidationError('CheckCash: CheckID must not be the all-zeros HASH256 value (xrpl.org fixCleanup3_3_0: temMALFORMED)');
+    }
+    // ── Amount / DeliverMin ── exactly one of the two is required.
+    const hasAmount = props.Amount !== undefined;
+    const hasDeliverMin = props.DeliverMin !== undefined;
+    if (hasAmount && hasDeliverMin) {
+        throw new ValidationError('CheckCash: cannot have both Amount and DeliverMin');
+    }
+    if (!hasAmount && !hasDeliverMin) {
+        throw new ValidationError('CheckCash: must have either Amount or DeliverMin');
+    }
+    // ── Amount ── shape check + positivity.
+    if (hasAmount) {
+        if (!isAmount(props.Amount)) {
+            throw new ValidationError('CheckCash: Amount must be a valid Amount (XRP drops / IssuedCurrencyAmount / MPTAmount)');
+        }
+        if (!isPositiveAmount(props.Amount)) {
+            throw new ValidationError('CheckCash: Amount must be strictly positive (non-zero, non-negative)');
+        }
+    }
+    // ── DeliverMin ── shape check + positivity (mirrors Amount).
+    if (hasDeliverMin) {
+        if (!isAmount(props.DeliverMin)) {
+            throw new ValidationError('CheckCash: DeliverMin must be a valid Amount (XRP drops / IssuedCurrencyAmount / MPTAmount)');
+        }
+        if (!isPositiveAmount(props.DeliverMin)) {
+            throw new ValidationError('CheckCash: DeliverMin must be strictly positive (non-zero, non-negative)');
+        }
+    }
+    return buildFrozenTx('CheckCash', 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 checkCash(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=check-cash.js.map

package/dist/fp/factories/check-cash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-cash.js","sourceRoot":"","sources":["../../../src/fp/factories/check-cash.ts"],"names":[],"mappings":"AAwDA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,+CAA+C;AAC/C,qEAAqE;AACrE,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,mEAAmE;AACnE,4EAA4E;AAC5E,MAAM,aAAa,GACjB,kEAAkE,CAAC;AAgCrE,wEAAwE;AAExE;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,MAA0B;IAClD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,8CAA8C,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACjE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAChE,MAAM,KAAK,GAAI,MAA8B,CAAC,KAAK,CAAC;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,CAAC,8CAA8C,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,SAAS,CAAC,KAAqB;IAC7C,kEAAkE;IAClE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,uCAAuC,EAAE,SAAS,CAAC,CAAC;IAE3E,8DAA8D;IAC9D,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QACxB,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;QACrB,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,mBAAmB,EAC5C,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,gCAAgC,mBAAmB,iCAAiC,CACrF,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,KAAK,aAAa,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CACvB,qGAAqG,CACtG,CAAC;IACJ,CAAC;IAED,gEAAgE;IAChE,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC;IAC7C,MAAM,aAAa,GAAG,KAAK,CAAC,UAAU,KAAK,SAAS,CAAC;IACrD,IAAI,SAAS,IAAI,aAAa,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CACvB,mDAAmD,CACpD,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,SAAS,IAAI,CAAC,aAAa,EAAE,CAAC;QACjC,MAAM,IAAI,eAAe,CACvB,kDAAkD,CACnD,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzC,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,eAAe,CACvB,yFAAyF,CAC1F,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,eAAe,CACvB,sEAAsE,CACvE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,8DAA8D;IAC9D,IAAI,aAAa,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,6FAA6F,CAC9F,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,eAAe,CACvB,0EAA0E,CAC3E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,WAAW,EACX,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,CAAkB,SAAkC;YACtD,OAAO,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,82 @@
+/**
+ * Functional CheckCreate factory — frozen-object style.
+ *
+ * Creates an on-ledger Check that can be cashed by `Destination` for up to
+ * `SendMax` of the source currency. Validation happens at construction;
+ * there is no way to construct an invalid tx.
+ *
+ *   import { checkCreate } from 'xrplt/fp';
+ *   const tx = checkCreate({ Account, Destination, SendMax });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Expiration: 570113521 });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/checkcreate
+ *
+ * ## Divergences
+ * The factory enforces five preclaim guards that the class API
+ * (`src/transactions/check-create.ts`) skips. The class only checks
+ * type — it does not check ranges, semantic equivalence, or self-send.
+ *
+ *   1. `Destination` must not equal `Account` (self-send is rejected).
+ *      Source: xrpl.org `checkcreate.md` Error Cases — `temREDUNDANT`
+ *      "The Destination is the sender of the transaction". The class
+ *      only checks `isAccount(this.Destination)` and accepts the
+ *      sender's own address. (Cross-referenced: `temDST_IS_SRC` in
+ *      `tem-codes.md` — "The transaction improperly specified a
+ *      destination address as the Account sending the transaction".)
+ *
+ *   2. `SendMax` must be strictly positive in all three Amount forms
+ *      (XRP drops string, `IssuedCurrencyAmount.value`,
+ *      `MPTAmount.value`).
+ *      Source: xrpl.org `tem-codes.md` — `temBAD_AMOUNT` — "An amount
+ *      specified by the transaction (for example the destination Amount
+ *      or SendMax values of a Payment) was invalid, possibly because it
+ *      was a negative number." xrpl.js `validateCheckCreate` accepts any
+ *      string Amount or any `IssuedCurrencyAmount` and never checks the
+ *      sign of the `value` sub-field; the class inherits that gap.
+ *
+ *   3. `DestinationTag` must be a non-negative UInt32
+ *      (0 ≤ value ≤ 0xFFFFFFFF), not just any number.
+ *      Source: xrpl.org `checkcreate.md` field table — `DestinationTag |
+ *      Number | UInt32`. xrpl.js `validateOptionalField(tx,
+ *      'DestinationTag', isNumber)` accepts negatives and non-integers;
+ *      the class uses `isNumber` too.
+ *
+ *   4. `Expiration` must be a non-negative UInt32
+ *      (0 ≤ value ≤ 0xFFFFFFFF), not just any number.
+ *      Source: xrpl.org `checkcreate.md` field table — `Expiration |
+ *      Number | UInt32`. xrpl.js `typeof tx.Expiration !== 'number'`
+ *      accepts any number; the class uses `isNumber`.
+ *
+ *   5. `InvoiceID` must be a 64-character hex string (UInt256 = 32 bytes).
+ *      Source: xrpl.org `checkcreate.md` field table — `InvoiceID |
+ *      String | UInt256`. xrpl.js `typeof tx.InvoiceID !== 'string'`
+ *      accepts any string; the class uses `isString`.
+ */
+import type { Amount, MPTAmount } from '../../types/amounts.js';
+export interface CheckCreateProps {
+    /** The unique address of the transaction sender (the Check writer). */
+    Account: string;
+    /** The account that may cash the Check. */
+    Destination: string;
+    /** Maximum source-currency amount the Check may debit the sender. */
+    SendMax: Amount | MPTAmount;
+    /** Arbitrary destination tag for the recipient (UInt32). */
+    DestinationTag?: number | undefined;
+    /** Expiration time in seconds since the Ripple Epoch (UInt32). */
+    Expiration?: number | undefined;
+    /** Arbitrary 256-bit hash identifying the purpose of this Check. */
+    InvoiceID?: string | undefined;
+    /** Bit-flags for this transaction. CheckCreate has no defined flags. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface CheckCreate extends Readonly<CheckCreateProps> {
+    readonly TransactionType: 'CheckCreate';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<CheckCreateProps>): CheckCreate;
+}
+export declare function checkCreate(props: CheckCreateProps): CheckCreate;
+//# sourceMappingURL=check-create.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check-create.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/check-create.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAehE,MAAM,WAAW,gBAAgB;IAC/B,uEAAuE;IACvE,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,qEAAqE;IACrE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,4DAA4D;IAC5D,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,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,WAAY,SAAQ,QAAQ,CAAC,gBAAgB,CAAC;IAC7D,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;AA8BD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CA2FhE"}

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

@@ -0,0 +1,101 @@
+import { isAccount, isAmount, isHex, isNumber, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// UInt32 bounds (per xrpl.org `checkcreate.md` field table).
+const UINT32_MIN = 0;
+const UINT32_MAX = 0xffffffff;
+// UInt256 hex length: 32 bytes = 64 hex chars.
+const INVOICE_ID_LENGTH = 64;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Per xrpl.org `tem-codes.md` `temBAD_AMOUNT`: SendMax that is zero or
+ * negative is rejected. Validates the sign of an Amount in all three
+ * accepted forms:
+ *   - XRP drops — a decimal or scientific-mantissa string.
+ *   - IssuedCurrency — object with a `value` sub-string.
+ *   - MPT — object with a `value` sub-string.
+ */
+function isPositiveAmount(amount) {
+    if (typeof amount === 'string') {
+        if (!/^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$/u.test(amount)) {
+            return false;
+        }
+        return parseFloat(amount) > 0;
+    }
+    if (typeof amount !== 'object' || amount === null)
+        return false;
+    const value = amount.value;
+    if (typeof value !== 'string')
+        return false;
+    if (!/^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$/u.test(value)) {
+        return false;
+    }
+    return parseFloat(value) > 0;
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function checkCreate(props) {
+    // ── Account ── required, must be a valid XRPL classic/X-address.
+    require(props.Account, 'CheckCreate: missing or invalid Account', isAccount);
+    // ── Destination ── required, must be a valid XRPL classic/X-address
+    //    AND must not equal the sender (xrpl.org `temREDUNDANT`).
+    if (!isAccount(props.Destination)) {
+        throw new ValidationError('CheckCreate: missing or invalid Destination');
+    }
+    if (props.Destination === props.Account) {
+        throw new ValidationError('CheckCreate: Destination must not equal Account (sender cannot write a Check to themselves)');
+    }
+    // ── SendMax ── required, must be a valid Amount AND strictly positive.
+    if (!isAmount(props.SendMax)) {
+        throw new ValidationError('CheckCreate: missing or invalid SendMax');
+    }
+    if (!isPositiveAmount(props.SendMax)) {
+        throw new ValidationError('CheckCreate: SendMax must be strictly positive (non-zero, non-negative)');
+    }
+    // ── DestinationTag ── optional UInt32 (xrpl.org field table).
+    if (props.DestinationTag !== undefined) {
+        if (!isNumber(props.DestinationTag) ||
+            !Number.isInteger(props.DestinationTag) ||
+            props.DestinationTag < UINT32_MIN ||
+            props.DestinationTag > UINT32_MAX) {
+            throw new ValidationError(`CheckCreate: DestinationTag must be a UInt32 in [${UINT32_MIN}, ${UINT32_MAX}]`);
+        }
+    }
+    // ── Expiration ── optional UInt32 (xrpl.org field table).
+    if (props.Expiration !== undefined) {
+        if (!isNumber(props.Expiration) ||
+            !Number.isInteger(props.Expiration) ||
+            props.Expiration < UINT32_MIN ||
+            props.Expiration > UINT32_MAX) {
+            throw new ValidationError(`CheckCreate: Expiration must be a UInt32 in [${UINT32_MIN}, ${UINT32_MAX}] (seconds since the Ripple Epoch)`);
+        }
+    }
+    // ── InvoiceID ── optional 64-char hex (UInt256, xrpl.org field table).
+    if (props.InvoiceID !== undefined) {
+        if (!isString(props.InvoiceID) ||
+            !isHex(props.InvoiceID) ||
+            props.InvoiceID.length !== INVOICE_ID_LENGTH) {
+            throw new ValidationError(`CheckCreate: InvoiceID must be a ${INVOICE_ID_LENGTH}-character hex string (UInt256)`);
+        }
+    }
+    return buildFrozenTx('CheckCreate', 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 checkCreate(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=check-create.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check-create.js","sourceRoot":"","sources":["../../../src/fp/factories/check-create.ts"],"names":[],"mappings":"AAwDA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,6DAA6D;AAC7D,MAAM,UAAU,GAAG,CAAC,CAAC;AACrB,MAAM,UAAU,GAAG,UAAU,CAAC;AAC9B,+CAA+C;AAC/C,MAAM,iBAAiB,GAAG,EAAE,CAAC;AA8B7B,wEAAwE;AAExE;;;;;;;GAOG;AACH,SAAS,gBAAgB,CAAC,MAA0B;IAClD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,8CAA8C,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACjE,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAChE,MAAM,KAAK,GAAI,MAA8B,CAAC,KAAK,CAAC;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,CAAC,8CAA8C,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,kEAAkE;IAClE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,yCAAyC,EAAE,SAAS,CAAC,CAAC;IAE7E,qEAAqE;IACrE,8DAA8D;IAC9D,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,eAAe,CACvB,6CAA6C,CAC9C,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,WAAW,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CACvB,6FAA6F,CAC9F,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACvB,yCAAyC,CAC1C,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;IACJ,CAAC;IAED,+DAA+D;IAC/D,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACvC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;YAC/B,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;YACvC,KAAK,CAAC,cAAc,GAAG,UAAU;YACjC,KAAK,CAAC,cAAc,GAAG,UAAU,EACjC,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,oDAAoD,UAAU,KAAK,UAAU,GAAG,CACjF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,2DAA2D;IAC3D,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,gDAAgD,UAAU,KAAK,UAAU,oCAAoC,CAC9G,CAAC;QACJ,CAAC;IACH,CAAC;IAED,wEAAwE;IACxE,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC;YAC1B,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;YACvB,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,iBAAiB,EAC5C,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,oCAAoC,iBAAiB,iCAAiC,CACvF,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"}