xrpjson 0.1.0

package/dist/fp/factories/amm-withdraw.js

@@ -0,0 +1,147 @@
+import { isAccount, isAmount, isCurrency, isIssuedCurrencyAmount, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// xrpl.js `AMMWithdrawFlags` enum — these seven mode flags identify
+// the mutually-exclusive AMM-withdraw modes.
+//   tfLPToken             = 0x00010000
+//   tfWithdrawAll         = 0x00020000
+//   tfOneAssetWithdrawAll = 0x00040000
+//   tfSingleAsset         = 0x00080000
+//   tfTwoAsset            = 0x00100000
+//   tfOneAssetLPToken     = 0x00200000
+//   tfLimitLPToken        = 0x00400000
+//
+// They are non-overlapping single bits, so a "exactly one" check
+// reduces to: popcount(flags & MASK) === 1.
+const AMM_WITHDRAW_FLAG_BITS = [
+    0x00010000, // tfLPToken
+    0x00020000, // tfWithdrawAll
+    0x00040000, // tfOneAssetWithdrawAll
+    0x00080000, // tfSingleAsset
+    0x00100000, // tfTwoAsset
+    0x00200000, // tfOneAssetLPToken
+    0x00400000, // tfLimitLPToken
+];
+const AMM_WITHDRAW_FLAGS_MASK = AMM_WITHDRAW_FLAG_BITS.reduce((acc, bit) => acc | bit, 0);
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Bit-count of a 32-bit integer (popcount). Used to verify that
+ * exactly one of the seven AMM-withdraw mode flag bits is set.
+ */
+function popcount32(n) {
+    // Brian Kernighan's algorithm.
+    let v = n >>> 0;
+    let count = 0;
+    while (v !== 0) {
+        v &= v - 1;
+        count++;
+    }
+    return count;
+}
+/**
+ * Extract the numeric bitmask from `Flags` regardless of whether the
+ * caller passed a numeric value or a boolean `AMMWithdrawFlagsInterface`.
+ */
+function flagsToNumber(flags) {
+    if (flags === undefined)
+        return 0;
+    if (typeof flags === 'number')
+        return flags;
+    let n = 0;
+    if (flags.tfLPToken)
+        n |= 0x00010000;
+    if (flags.tfWithdrawAll)
+        n |= 0x00020000;
+    if (flags.tfOneAssetWithdrawAll)
+        n |= 0x00040000;
+    if (flags.tfSingleAsset)
+        n |= 0x00080000;
+    if (flags.tfTwoAsset)
+        n |= 0x00100000;
+    if (flags.tfOneAssetLPToken)
+        n |= 0x00200000;
+    if (flags.tfLimitLPToken)
+        n |= 0x00400000;
+    return n;
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ammWithdraw(props) {
+    // ── Account ── required, must be a valid XRPL classic address.
+    if (!isString(props.Account) || !isAccount(props.Account)) {
+        throw new ValidationError('AMMWithdraw: Account is required and must be a valid XRPL account address');
+    }
+    // ── Asset ── required, must be a valid Currency.
+    if (!isCurrency(props.Asset)) {
+        throw new ValidationError('AMMWithdraw: Asset must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    // ── Asset2 ── required, must be a valid Currency.
+    if (!isCurrency(props.Asset2)) {
+        throw new ValidationError('AMMWithdraw: Asset2 must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    // ── Amount ── optional; when present, must be a valid Amount.
+    if (props.Amount !== undefined && !isAmount(props.Amount)) {
+        throw new ValidationError('AMMWithdraw: Amount must be a valid Amount (XRP drops, trust line, or MPT form)');
+    }
+    // ── Amount2 ── optional; when present, must be a valid Amount AND
+    //    Amount must also be present (XLS-0030 §2.4.2.3 — "Amount and
+    //    Amount2" is the only Amount2-bearing mode).
+    if (props.Amount2 !== undefined) {
+        if (!isAmount(props.Amount2)) {
+            throw new ValidationError('AMMWithdraw: Amount2 must be a valid Amount (XRP drops, trust line, or MPT form)');
+        }
+        if (props.Amount === undefined) {
+            throw new ValidationError('AMMWithdraw: Amount2 requires Amount to be set (XLS-0030 §2.4.2.3 "Amount and Amount2" mode)');
+        }
+    }
+    // ── EPrice ── optional; when present, must be a valid Amount AND
+    //    Amount must also be present (XLS-0030 §2.4.2.3 — "Amount and
+    //    EPrice" is the only EPrice-bearing mode).
+    if (props.EPrice !== undefined) {
+        if (!isAmount(props.EPrice)) {
+            throw new ValidationError('AMMWithdraw: EPrice must be a valid Amount (XRP drops, trust line, or MPT form)');
+        }
+        if (props.Amount === undefined) {
+            throw new ValidationError('AMMWithdraw: EPrice requires Amount to be set (XLS-0030 §2.4.2.3 "Amount and EPrice" mode)');
+        }
+    }
+    // ── LPTokenIn ── optional; when present, must be an
+    //    IssuedCurrencyAmount. LP tokens are always issued currencies —
+    //    never XRP and never an MPT.
+    if (props.LPTokenIn !== undefined && !isIssuedCurrencyAmount(props.LPTokenIn)) {
+        throw new ValidationError('AMMWithdraw: LPTokenIn must be an IssuedCurrencyAmount (currency + issuer + value)');
+    }
+    // ── Flags ── exactly one AMM-withdraw mode flag bit must be set
+    //    (xrpl.org `ammwithdraw.md`: "You must specify **exactly one**
+    //    of these flags, plus any global flags"). We always validate —
+    //    an absent `Flags`, an explicit `undefined`, and `Flags: 0` all
+    //    represent "no mode flag set" and must throw.
+    const numericFlags = flagsToNumber(props.Flags);
+    const ammFlagBits = numericFlags & AMM_WITHDRAW_FLAGS_MASK;
+    if (ammFlagBits === 0) {
+        throw new ValidationError('AMMWithdraw: Flags must specify exactly one AMM-withdraw mode flag (tfLPToken, tfWithdrawAll, tfOneAssetWithdrawAll, tfSingleAsset, tfTwoAsset, tfOneAssetLPToken, or tfLimitLPToken)');
+    }
+    if (popcount32(ammFlagBits) !== 1) {
+        throw new ValidationError('AMMWithdraw: Flags must specify exactly one AMM-withdraw mode flag (got multiple)');
+    }
+    return buildFrozenTx('AMMWithdraw', 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 ammWithdraw(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=amm-withdraw.js.map

package/dist/fp/factories/amm-withdraw.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amm-withdraw.js","sourceRoot":"","sources":["../../../src/fp/factories/amm-withdraw.ts"],"names":[],"mappings":"AAyFA,OAAO,EACL,SAAS,EACT,QAAQ,EACR,UAAU,EACV,sBAAsB,EACtB,QAAQ,GACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE1D,wEAAwE;AAExE,oEAAoE;AACpE,6CAA6C;AAC7C,uCAAuC;AACvC,uCAAuC;AACvC,uCAAuC;AACvC,uCAAuC;AACvC,uCAAuC;AACvC,uCAAuC;AACvC,uCAAuC;AACvC,EAAE;AACF,iEAAiE;AACjE,4CAA4C;AAC5C,MAAM,sBAAsB,GAAG;IAC7B,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE,wBAAwB;IACpC,UAAU,EAAE,gBAAgB;IAC5B,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,oBAAoB;IAChC,UAAU,EAAE,iBAAiB;CACrB,CAAC;AAEX,MAAM,uBAAuB,GAAG,sBAAsB,CAAC,MAAM,CAC3D,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,EACvB,CAAC,CACF,CAAC;AA8CF,wEAAwE;AAExE;;;GAGG;AACH,SAAS,UAAU,CAAC,CAAS;IAC3B,+BAA+B;IAC/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAChB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACf,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACX,KAAK,EAAE,CAAC;IACV,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACpB,KAAqD;IAErD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,CAAC,CAAC;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,KAAK,CAAC,SAAS;QAAE,CAAC,IAAI,UAAU,CAAC;IACrC,IAAI,KAAK,CAAC,aAAa;QAAE,CAAC,IAAI,UAAU,CAAC;IACzC,IAAI,KAAK,CAAC,qBAAqB;QAAE,CAAC,IAAI,UAAU,CAAC;IACjD,IAAI,KAAK,CAAC,aAAa;QAAE,CAAC,IAAI,UAAU,CAAC;IACzC,IAAI,KAAK,CAAC,UAAU;QAAE,CAAC,IAAI,UAAU,CAAC;IACtC,IAAI,KAAK,CAAC,iBAAiB;QAAE,CAAC,IAAI,UAAU,CAAC;IAC7C,IAAI,KAAK,CAAC,cAAc;QAAE,CAAC,IAAI,UAAU,CAAC;IAC1C,OAAO,CAAC,CAAC;AACX,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,gEAAgE;IAChE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,eAAe,CACvB,2EAA2E,CAC5E,CAAC;IACJ,CAAC;IAED,kDAAkD;IAClD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACvB,4EAA4E,CAC7E,CAAC;IACJ,CAAC;IAED,mDAAmD;IACnD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CACvB,6EAA6E,CAC9E,CAAC;IACJ,CAAC;IAED,+DAA+D;IAC/D,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,eAAe,CACvB,iFAAiF,CAClF,CAAC;IACJ,CAAC;IAED,mEAAmE;IACnE,kEAAkE;IAClE,iDAAiD;IACjD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,eAAe,CACvB,kFAAkF,CACnF,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,8FAA8F,CAC/F,CAAC;QACJ,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,kEAAkE;IAClE,+CAA+C;IAC/C,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,eAAe,CACvB,iFAAiF,CAClF,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,4FAA4F,CAC7F,CAAC;QACJ,CAAC;IACH,CAAC;IAED,qDAAqD;IACrD,oEAAoE;IACpE,iCAAiC;IACjC,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9E,MAAM,IAAI,eAAe,CACvB,oFAAoF,CACrF,CAAC;IACJ,CAAC;IAED,iEAAiE;IACjE,mEAAmE;IACnE,mEAAmE;IACnE,oEAAoE;IACpE,kDAAkD;IAClD,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,YAAY,GAAG,uBAAuB,CAAC;IAC3D,IAAI,WAAW,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,eAAe,CACvB,uLAAuL,CACxL,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,eAAe,CACvB,mFAAmF,CACpF,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/batch.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Functional Batch factory — frozen-object style.
+ *
+ * The Batch transaction (`BatchV1_1` amendment) wraps a list of inner
+ * transactions (`RawTransactions`) into a single atomic submission. The
+ * factory validates at construction; an invalid Batch can never exist.
+ *
+ *   import { batch } from 'xrplt/fp';
+ *   const tx = batch({ Account, Flags, RawTransactions: [...] });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Flags: 0x00020000 }); // tfOnlyOne
+ *
+ * Compare with the class-based equivalent:
+ *
+ *   import { Batch } from 'xrplt';
+ *   const tx = new Batch({ Account, Flags, RawTransactions: [...] });
+ *   tx.validate();   // must be called explicitly
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/batch
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0056-batch
+ *
+ * ## Divergences
+ * The factory enforces seven preclaim checks that the class API
+ * (`src/transactions/batch.ts`) explicitly skips. Each is documented
+ * inline with the corresponding citation.
+ *
+ *   1. `RawTransactions` length must be **2–8** (class: only non-empty).
+ *      Source: XLS-56 §2.1.2 — "There can be up to 8 transactions
+ *      included. There must be at least 2 transactions." Cross-checked
+ *      against xrpl.org error table for `temARRAY_EMPTY` and
+ *      `temARRAY_TOO_LARGE`.
+ *
+ *   2. Outer `Flags` must contain **exactly one** batch-mode flag
+ *      (`tfAllOrNothing` | `tfOnlyOne` | `tfUntilFailure` | `tfIndependent`).
+ *      Source: XLS-56 §2.1.1 — "Exactly one must be specified in a Batch
+ *      transaction." Cross-checked against xrpl.org error table for
+ *      `temINVALID_FLAG` (first clause). The class source comment
+ *      (`src/transactions/batch.ts:33-38`) explicitly defers this to the
+ *      ledger.
+ *
+ *   3. Each inner transaction must set **either** `Sequence` (non-zero)
+ *      **or** `TicketSequence` (positive integer), but not both and not
+ *      neither. Source: XLS-56 §2.3.2.12 — "exactly one of the two must
+ *      be used: a ticketed inner transaction sets `TicketSequence` and
+ *      `Sequence: 0`, and a sequence-based inner transaction sets a
+ *      non-zero `Sequence` and omits `TicketSequence`." Cross-checked
+ *      against xrpl.org error table for `temSEQ_AND_TICKET`.
+ *
+ *   4. No duplicate inner transactions in `RawTransactions` (deep-equal
+ *      by canonical JSON serialization with sorted keys).
+ *      Source: XLS-56 §2.3.2.10 — "There is a duplicate transaction in
+ *      the `RawTransactions` field (`temREDUNDANT`)."
+ *
+ *   5. `BatchSigners` length must be ≤ 24 entries.
+ *      Source: XLS-56 §2.3.3.1 — "The length of `BatchSigners` is greater
+ *      than 24 (`temARRAY_TOO_LARGE`). This is three times the maximum
+ *      number of inner transactions."
+ *
+ *   6. `BatchSigners` must be sorted strictly ascending by `Account` and
+ *      contain no duplicate accounts. Source: XLS-56 §2.1.3 — "The
+ *      entries in `BatchSigners` must be sorted in strictly ascending
+ *      order by `Account`. Duplicate entries are not permitted."
+ *      Cross-checked against xrpl.org `temBAD_SIGNER` (third and fourth
+ *      clauses).
+ *
+ *   7. The outer `Account` may not appear as a `BatchSigner.Account`
+ *      Source: XLS-56 §2.3.3.2 — "The `BatchSigners` field contains a
+ *      signature from the account signing the outer transaction
+ *      (`temBAD_SIGNER`)."
+ *
+ *   8. Each `BatchSigner` must be exclusively either single-sign
+ *      (`SigningPubKey` + `TxnSignature`) or multi-sign (`Signers`); the
+ *      two forms cannot be mixed on the same entry.
+ *      Source: XLS-56 §2.1.3 — "Either the `SigningPubKey` and
+ *      `TxnSignature` fields must be included, or the `Signers` field."
+ *      Cross-checked against xrpl.org note on the `BatchSigners` table.
+ *
+ * Where the class enforces a rule, the factory matches its error wording
+ * so consumers can rely on either API for the same set of guard checks.
+ */
+import type { Signer } from '../../types/common.js';
+import type { BatchFlagsInterface } from '../../types/flags.js';
+/**
+ * A single inner transaction wrapped in the Batch's `RawTransactions`
+ * array. Per BatchV1_1, the wrapping object has exactly one key:
+ * `RawTransaction`.
+ */
+export interface RawTransaction {
+    readonly RawTransaction: Record<string, unknown>;
+}
+/**
+ * A counterparty signature for a multi-account Batch tx. The wrapper
+ * carries a single `BatchSigner` record.
+ */
+export interface BatchSigner {
+    readonly BatchSigner: {
+        readonly Account: string;
+        readonly SigningPubKey?: string;
+        readonly TxnSignature?: string;
+        readonly Signers?: Signer[];
+    };
+}
+export interface BatchProps {
+    /** The unique address of the transaction sender (outer Batch signer). */
+    Account: string;
+    /**
+     * Batch mode flags. Exactly one of `tfAllOrNothing`, `tfOnlyOne`,
+     * `tfUntilFailure`, or `tfIndependent` must be set (XLS-56 §2.1.1).
+     */
+    Flags?: number | BatchFlagsInterface | undefined;
+    /**
+     * 2–8 inner transactions to apply. Each must include the
+     * `tfInnerBatchTxn` flag, `Fee: "0"`, and `SigningPubKey: ""`.
+     */
+    RawTransactions: RawTransaction[];
+    /**
+     * Counterparty signatures for multi-account batches. Optional; if any
+     * inner-tx account is not the outer `Account`, the corresponding
+     * `BatchSigner` entry is required (XLS-56 §2.1.3).
+     */
+    BatchSigners?: BatchSigner[] | undefined;
+    /** Common base fields — pass-through only. */
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface Batch extends Readonly<BatchProps> {
+    readonly TransactionType: 'Batch';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<BatchProps>): Batch;
+}
+export declare function batch(props: BatchProps): Batch;
+//# sourceMappingURL=batch.d.ts.map

package/dist/fp/factories/batch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/batch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAsBhE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,WAAW,EAAE;QACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;QAChC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAAC;IACjD;;;OAGG;IACH,eAAe,EAAE,cAAc,EAAE,CAAC;IAClC;;;;OAIG;IACH,YAAY,CAAC,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;IACzC,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,KAAM,SAAQ,QAAQ,CAAC,UAAU,CAAC;IACjD,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;CAC7C;AA4ED,wBAAgB,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,CA4Q9C"}

package/dist/fp/factories/batch.js

@@ -0,0 +1,264 @@
+import { GlobalFlags } from '../../types/flags.js';
+import { isAccount, isArray, isRecord, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// Minimum number of inner transactions in a Batch (XLS-56 §2.1.2).
+const MIN_RAW_TRANSACTIONS = 2;
+// Maximum number of inner transactions in a Batch (XLS-56 §2.1.2).
+const MAX_RAW_TRANSACTIONS = 8;
+// Maximum number of BatchSigner entries (XLS-56 §2.3.3.1).
+const MAX_BATCH_SIGNERS = 24;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Count how many of the four batch-mode flags are set in `flags`.
+ * Returns 0–4.
+ */
+function countBatchModeFlags(flags) {
+    let count = 0;
+    for (const bit of [
+        0x00010000,
+        0x00020000,
+        0x00040000,
+        0x00080000,
+    ]) {
+        if ((flags & bit) === bit)
+            count += 1;
+    }
+    return count;
+}
+/**
+ * Resolve a possibly-boolean-map `Flags` value to a numeric bitmask.
+ * Falls back to 0 when neither form is supplied.
+ */
+function flagsToNumber(flags) {
+    if (flags === undefined)
+        return 0;
+    if (typeof flags === 'number')
+        return flags;
+    let n = 0;
+    if (flags.tfAllOrNothing)
+        n |= 0x00010000;
+    if (flags.tfOnlyOne)
+        n |= 0x00020000;
+    if (flags.tfUntilFailure)
+        n |= 0x00040000;
+    if (flags.tfIndependent)
+        n |= 0x00080000;
+    if (flags.tfInnerBatchTxn)
+        n |= GlobalFlags.tfInnerBatchTxn;
+    return n;
+}
+/**
+ * Canonical JSON serialization for inner-tx duplicate detection. Sorts
+ * object keys recursively so `{a:1,b:2}` and `{b:2,a:1}` compare equal.
+ *
+ * Not for use as a wire serializer — only as a hash key.
+ */
+function stableStringify(value) {
+    if (value === null)
+        return 'null';
+    if (typeof value === 'number') {
+        if (!Number.isFinite(value))
+            return 'null';
+        return JSON.stringify(value);
+    }
+    if (typeof value === 'string')
+        return JSON.stringify(value);
+    if (typeof value === 'boolean')
+        return value ? 'true' : 'false';
+    if (Array.isArray(value)) {
+        return '[' + value.map(stableStringify).join(',') + ']';
+    }
+    if (typeof value === 'object') {
+        const keys = Object.keys(value).sort();
+        return ('{' +
+            keys
+                .map((k) => JSON.stringify(k) +
+                ':' +
+                stableStringify(value[k]))
+                .join(',') +
+            '}');
+    }
+    return JSON.stringify(String(value));
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function batch(props) {
+    // ── Account ── required, valid XRPL address.
+    require(props.Account, 'Batch: Account is required', isAccount);
+    // ── Outer Flags ── exactly one batch-mode flag must be set.
+    //    XLS-56 §2.1.1 ("Exactly one must be specified").
+    const outerFlags = flagsToNumber(props.Flags);
+    const modeCount = countBatchModeFlags(outerFlags);
+    if (modeCount !== 1) {
+        throw new ValidationError(`Batch: Flags must contain exactly one of tfAllOrNothing, tfOnlyOne, tfUntilFailure, or tfIndependent (found ${modeCount})`);
+    }
+    // ── RawTransactions ── required, 2–8 entries.
+    if (!isArray(props.RawTransactions)) {
+        throw new ValidationError('Batch: RawTransactions must be an array');
+    }
+    if (props.RawTransactions.length < MIN_RAW_TRANSACTIONS) {
+        throw new ValidationError(`Batch: RawTransactions must contain at least ${MIN_RAW_TRANSACTIONS} transactions (found ${props.RawTransactions.length})`);
+    }
+    if (props.RawTransactions.length > MAX_RAW_TRANSACTIONS) {
+        throw new ValidationError(`Batch: RawTransactions must contain at most ${MAX_RAW_TRANSACTIONS} transactions (found ${props.RawTransactions.length})`);
+    }
+    // ── Each inner transaction: shape + inner-tx invariants.
+    const seen = new Set();
+    props.RawTransactions.forEach((wrapper, index) => {
+        if (!isRecord(wrapper)) {
+            throw new ValidationError(`Batch: RawTransactions[${index}] is not an object`);
+        }
+        const inner = wrapper['RawTransaction'];
+        if (inner === undefined) {
+            throw new ValidationError(`Batch: RawTransactions[${index}] is missing the 'RawTransaction' key`);
+        }
+        if (!isRecord(inner)) {
+            throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction is not an object`);
+        }
+        // No nesting: an inner tx cannot itself be a Batch.
+        if (inner['TransactionType'] === 'Batch') {
+            throw new ValidationError(`Batch: RawTransactions[${index}] is a Batch transaction. Cannot nest Batch transactions.`);
+        }
+        // tfInnerBatchTxn flag must be set.
+        const innerFlags = inner['Flags'];
+        if (typeof innerFlags !== 'number' ||
+            (innerFlags & GlobalFlags.tfInnerBatchTxn) !== GlobalFlags.tfInnerBatchTxn) {
+            throw new ValidationError(`Batch: RawTransactions[${index}] must contain the tfInnerBatchTxn flag`);
+        }
+        // Fee must be "0" (or null/undefined, per xrpl.js compatibility).
+        const fee = inner['Fee'];
+        if (fee !== undefined && fee !== null && fee !== '0') {
+            throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction.Fee must be "0" (outer tx pays all fees)`);
+        }
+        // SigningPubKey must be "" (or null/undefined, per xrpl.js).
+        const spk = inner['SigningPubKey'];
+        if (spk !== undefined && spk !== null && spk !== '') {
+            throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction.SigningPubKey must be ""`);
+        }
+        // TxnSignature must be absent.
+        if (inner['TxnSignature'] !== undefined) {
+            throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction.TxnSignature must be absent`);
+        }
+        // Signers must be absent.
+        if (inner['Signers'] !== undefined) {
+            throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction.Signers must be absent`);
+        }
+        // Sequence XOR TicketSequence: exactly one, and Sequence must be
+        // non-zero when used (XLS-56 §2.3.2.12 → temSEQ_AND_TICKET).
+        const hasSeq = inner['Sequence'] !== undefined;
+        const hasTicket = inner['TicketSequence'] !== undefined;
+        if (hasSeq && hasTicket) {
+            throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction must set either Sequence or TicketSequence, not both`);
+        }
+        if (!hasSeq && !hasTicket) {
+            throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction must set either Sequence or TicketSequence`);
+        }
+        if (hasSeq) {
+            const seq = inner['Sequence'];
+            if (typeof seq !== 'number' ||
+                !Number.isInteger(seq) ||
+                seq <= 0) {
+                throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction.Sequence must be a positive integer when used`);
+            }
+        }
+        if (hasTicket) {
+            const ts = inner['TicketSequence'];
+            if (typeof ts !== 'number' ||
+                !Number.isInteger(ts) ||
+                ts <= 0) {
+                throw new ValidationError(`Batch: RawTransactions[${index}].RawTransaction.TicketSequence must be a positive integer when used`);
+            }
+        }
+        // Duplicate detection (XLS-56 §2.3.2.10 → temREDUNDANT).
+        const key = stableStringify(inner);
+        if (seen.has(key)) {
+            throw new ValidationError(`Batch: RawTransactions[${index}] is a duplicate of a previous inner transaction`);
+        }
+        seen.add(key);
+    });
+    // ── BatchSigners ── optional; if present, validate fully.
+    if (props.BatchSigners !== undefined) {
+        if (!isArray(props.BatchSigners)) {
+            throw new ValidationError('Batch: BatchSigners must be an array');
+        }
+        if (props.BatchSigners.length > MAX_BATCH_SIGNERS) {
+            throw new ValidationError(`Batch: BatchSigners must contain at most ${MAX_BATCH_SIGNERS} entries (found ${props.BatchSigners.length})`);
+        }
+        const seenAccounts = [];
+        props.BatchSigners.forEach((signerWrapper, index) => {
+            if (!isRecord(signerWrapper)) {
+                throw new ValidationError(`Batch: BatchSigners[${index}] is not an object`);
+            }
+            const signer = signerWrapper['BatchSigner'];
+            if (!isRecord(signer)) {
+                throw new ValidationError(`Batch: BatchSigners[${index}] is missing the 'BatchSigner' key`);
+            }
+            // Account required, must be a valid XRPL address.
+            const acct = signer['Account'];
+            if (!isString(acct) || !isAccount(acct)) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner.Account is required and must be a valid XRPL account address`);
+            }
+            // Outer Account may not appear here (XLS-56 §2.3.3.2).
+            if (acct === props.Account) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner.Account must not equal the outer Account (the outer signer is implicit)`);
+            }
+            // Strictly ascending by Account; no duplicates (XLS-56 §2.1.3).
+            for (const prior of seenAccounts) {
+                if (prior >= acct) {
+                    throw new ValidationError(`Batch: BatchSigners must be sorted in strictly ascending order by Account (BatchSigners[${index}] out of order)`);
+                }
+            }
+            seenAccounts.push(acct);
+            // Single-sign XOR multi-sign exclusivity
+            // (XLS-56 §2.1.3: "Either ... or ...").
+            const hasSigningPubKey = signer['SigningPubKey'] !== undefined &&
+                signer['SigningPubKey'] !== null;
+            const hasTxnSignature = signer['TxnSignature'] !== undefined &&
+                signer['TxnSignature'] !== null;
+            const hasSigners = signer['Signers'] !== undefined &&
+                signer['Signers'] !== null;
+            // Single-sign requires both SigningPubKey and TxnSignature;
+            // multi-sign uses Signers only. Mixing is forbidden.
+            if (hasSigningPubKey !== hasTxnSignature) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner single-sign form requires both SigningPubKey and TxnSignature (or neither — use Signers for multi-sign)`);
+            }
+            if (hasSigners && (hasSigningPubKey || hasTxnSignature)) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner cannot mix single-sign fields with Signers`);
+            }
+            if (!hasSigners && !hasSigningPubKey && !hasTxnSignature) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner must carry either (SigningPubKey + TxnSignature) or Signers`);
+            }
+            // Field type checks (mirror xrpl.js models/batch.ts:151-162).
+            if (hasSigningPubKey && !isString(signer['SigningPubKey'])) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner.SigningPubKey must be a string`);
+            }
+            if (hasTxnSignature && !isString(signer['TxnSignature'])) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner.TxnSignature must be a string`);
+            }
+            if (hasSigners && !isArray(signer['Signers'])) {
+                throw new ValidationError(`Batch: BatchSigners[${index}].BatchSigner.Signers must be an array`);
+            }
+        });
+    }
+    return buildFrozenTx('Batch', 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 batch(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=batch.js.map

package/dist/fp/factories/batch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../../src/fp/factories/batch.ts"],"names":[],"mappings":"AAkFA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EACL,SAAS,EACT,OAAO,EACP,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,mEAAmE;AACnE,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,mEAAmE;AACnE,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,2DAA2D;AAC3D,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAyD7B,wEAAwE;AAExE;;;GAGG;AACH,SAAS,mBAAmB,CAAC,KAAa;IACxC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,GAAG,IAAI;QAChB,UAAU;QACV,UAAU;QACV,UAAU;QACV,UAAU;KACX,EAAE,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,GAAG;YAAE,KAAK,IAAI,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACpB,KAA+C;IAE/C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,CAAC,CAAC;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,KAAK,CAAC,cAAc;QAAE,CAAC,IAAI,UAAU,CAAC;IAC1C,IAAI,KAAK,CAAC,SAAS;QAAE,CAAC,IAAI,UAAU,CAAC;IACrC,IAAI,KAAK,CAAC,cAAc;QAAE,CAAC,IAAI,UAAU,CAAC;IAC1C,IAAI,KAAK,CAAC,aAAa;QAAE,CAAC,IAAI,UAAU,CAAC;IACzC,IAAI,KAAK,CAAC,eAAe;QAAE,CAAC,IAAI,WAAW,CAAC,eAAe,CAAC;IAC5D,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,KAAc;IACrC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC5D,IAAI,OAAO,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;IAChE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IAC1D,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAgC,CAAC,CAAC,IAAI,EAAE,CAAC;QAClE,OAAO,CACL,GAAG;YACH,IAAI;iBACD,GAAG,CACF,CAAC,CAAC,EAAE,EAAE,CACJ,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;gBACjB,GAAG;gBACH,eAAe,CAAE,KAAiC,CAAC,CAAC,CAAC,CAAC,CACzD;iBACA,IAAI,CAAC,GAAG,CAAC;YACZ,GAAG,CACJ,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,KAAK,CAAC,KAAiB;IACrC,8CAA8C;IAC9C,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,4BAA4B,EAAE,SAAS,CAAC,CAAC;IAEhE,6DAA6D;IAC7D,sDAAsD;IACtD,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAClD,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,eAAe,CACvB,+GAA+G,SAAS,GAAG,CAC5H,CAAC;IACJ,CAAC;IAED,+CAA+C;IAC/C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CACvB,yCAAyC,CAC1C,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;QACxD,MAAM,IAAI,eAAe,CACvB,gDAAgD,oBAAoB,wBAAwB,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,CAC5H,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;QACxD,MAAM,IAAI,eAAe,CACvB,+CAA+C,oBAAoB,wBAAwB,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,CAC3H,CAAC;IACJ,CAAC;IAED,0DAA0D;IAC1D,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;QAC/C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,oBAAoB,CACpD,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACxC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,uCAAuC,CACvE,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,mCAAmC,CACnE,CAAC;QACJ,CAAC;QAED,oDAAoD;QACpD,IAAI,KAAK,CAAC,iBAAiB,CAAC,KAAK,OAAO,EAAE,CAAC;YACzC,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,2DAA2D,CAC3F,CAAC;QACJ,CAAC;QAED,oCAAoC;QACpC,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,IACE,OAAO,UAAU,KAAK,QAAQ;YAC9B,CAAC,UAAU,GAAG,WAAW,CAAC,eAAe,CAAC,KAAK,WAAW,CAAC,eAAe,EAC1E,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,yCAAyC,CACzE,CAAC;QACJ,CAAC;QAED,kEAAkE;QAClE,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;YACrD,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,2DAA2D,CAC3F,CAAC;QACJ,CAAC;QAED,6DAA6D;QAC7D,MAAM,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC,CAAC;QACnC,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;YACpD,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,2CAA2C,CAC3E,CAAC;QACJ,CAAC;QAED,+BAA+B;QAC/B,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,8CAA8C,CAC9E,CAAC;QACJ,CAAC;QAED,0BAA0B;QAC1B,IAAI,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,yCAAyC,CACzE,CAAC;QACJ,CAAC;QAED,iEAAiE;QACjE,6DAA6D;QAC7D,MAAM,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS,CAAC;QAC/C,MAAM,SAAS,GAAG,KAAK,CAAC,gBAAgB,CAAC,KAAK,SAAS,CAAC;QACxD,IAAI,MAAM,IAAI,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,uEAAuE,CACvG,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,6DAA6D,CAC7F,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;YAC9B,IACE,OAAO,GAAG,KAAK,QAAQ;gBACvB,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;gBACtB,GAAG,IAAI,CAAC,EACR,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,gEAAgE,CAChG,CAAC;YACJ,CAAC;QACH,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,EAAE,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;YACnC,IACE,OAAO,EAAE,KAAK,QAAQ;gBACtB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrB,EAAE,IAAI,CAAC,EACP,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,sEAAsE,CACtG,CAAC;YACJ,CAAC;QACH,CAAC;QAED,yDAAyD;QACzD,MAAM,GAAG,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,eAAe,CACvB,0BAA0B,KAAK,kDAAkD,CAClF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,2DAA2D;IAC3D,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,eAAe,CAAC,sCAAsC,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,KAAK,CAAC,YAAY,CAAC,MAAM,GAAG,iBAAiB,EAAE,CAAC;YAClD,MAAM,IAAI,eAAe,CACvB,4CAA4C,iBAAiB,mBAAmB,KAAK,CAAC,YAAY,CAAC,MAAM,GAAG,CAC7G,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,KAAK,EAAE,EAAE;YAClD,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,oBAAoB,CACjD,CAAC;YACJ,CAAC;YACD,MAAM,MAAM,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,oCAAoC,CACjE,CAAC;YACJ,CAAC;YAED,kDAAkD;YAClD,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxC,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,4EAA4E,CACzG,CAAC;YACJ,CAAC;YAED,uDAAuD;YACvD,IAAI,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,uFAAuF,CACpH,CAAC;YACJ,CAAC;YAED,gEAAgE;YAChE,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;gBACjC,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;oBAClB,MAAM,IAAI,eAAe,CACvB,2FAA2F,KAAK,iBAAiB,CAClH,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAExB,yCAAyC;YACzC,wCAAwC;YACxC,MAAM,gBAAgB,GACpB,MAAM,CAAC,eAAe,CAAC,KAAK,SAAS;gBACrC,MAAM,CAAC,eAAe,CAAC,KAAK,IAAI,CAAC;YACnC,MAAM,eAAe,GACnB,MAAM,CAAC,cAAc,CAAC,KAAK,SAAS;gBACpC,MAAM,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC;YAClC,MAAM,UAAU,GACd,MAAM,CAAC,SAAS,CAAC,KAAK,SAAS;gBAC/B,MAAM,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;YAE7B,4DAA4D;YAC5D,qDAAqD;YACrD,IAAI,gBAAgB,KAAK,eAAe,EAAE,CAAC;gBACzC,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,uHAAuH,CACpJ,CAAC;YACJ,CAAC;YACD,IAAI,UAAU,IAAI,CAAC,gBAAgB,IAAI,eAAe,CAAC,EAAE,CAAC;gBACxD,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,0DAA0D,CACvF,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,UAAU,IAAI,CAAC,gBAAgB,IAAI,CAAC,eAAe,EAAE,CAAC;gBACzD,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,2EAA2E,CACxG,CAAC;YACJ,CAAC;YAED,8DAA8D;YAC9D,IAAI,gBAAgB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC;gBAC3D,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,8CAA8C,CAC3E,CAAC;YACJ,CAAC;YACD,IAAI,eAAe,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;gBACzD,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,6CAA6C,CAC1E,CAAC;YACJ,CAAC;YACD,IAAI,UAAU,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBAC9C,MAAM,IAAI,eAAe,CACvB,uBAAuB,KAAK,wCAAwC,CACrE,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,aAAa,CAClB,OAAO,EACP,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,CAAc,SAA8B;YAC9C,OAAO,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAC9C,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,22 @@
+export interface CheckCancelProps {
+    /** The transaction submitter (the Check source, destination, or any
+     *  address if the Check has expired). */
+    Account: string;
+    /** The ID of the Check ledger object to cancel (UInt256, 64-char hex,
+     *  must not be all-zeros). */
+    CheckID: string;
+    /** Bit-flags for this transaction. CheckCancel has no defined
+     *  flags; only `tfFullyCanonicalSig` (global) is meaningful. Accepted
+     *  for parity with the base tx shape. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface CheckCancel extends Readonly<CheckCancelProps> {
+    readonly TransactionType: 'CheckCancel';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<CheckCancelProps>): CheckCancel;
+}
+export declare function checkCancel(props: CheckCancelProps): CheckCancel;
+//# sourceMappingURL=check-cancel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"check-cancel.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/check-cancel.ts"],"names":[],"mappings":"AAwFA,MAAM,WAAW,gBAAgB;IAC/B;6CACyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB;kCAC8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB;;6CAEyC;IACzC,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;AAID,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CA+ChE"}