xrpjson 0.1.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-create.js","sourceRoot":"","sources":["../../../src/fp/factories/amm-create.ts"],"names":[],"mappings":"AAkEA,OAAO,EACL,SAAS,EACT,QAAQ,EACR,KAAK,EACL,sBAAsB,EACtB,WAAW,EACX,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,gEAAgE;AAChE,2DAA2D;AAC3D,MAAM,mBAAmB,GAAG,IAAI,CAAC;AAEjC,qEAAqE;AACrE,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B,oEAAoE;AACpE,qEAAqE;AACrE,wDAAwD;AACxD,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;;;;;;;;;;;GAWG;AACH,SAAS,sBAAsB,CAAC,MAAc,EAAE,IAAY;IAC1D,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,wDAAwD,CAC3E,CAAC;IACJ,CAAC;IAED,6CAA6C;IAC7C,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,sDAAsD,CACzE,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,sCAAsC,CACzD,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,YAAY;IACZ,IAAI,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,kBAAkB;QAClB,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC5B,IACE,GAAG,CAAC,MAAM,KAAK,qBAAqB;YACpC,GAAG,CAAC,MAAM,KAAK,mBAAmB,EAClC,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,qBAAqB,qBAAqB,wBAAwB,mBAAmB,4BAA4B,GAAG,CAAC,MAAM,GAAG,CACjJ,CAAC;QACJ,CAAC;QACD,IAAI,GAAG,CAAC,MAAM,KAAK,mBAAmB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,sCAAsC,CACzD,CAAC;QACJ,CAAC;QACD,SAAS;QACT,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,8CAA8C,CACjE,CAAC;QACJ,CAAC;QACD,yCAAyC;QACzC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,sDAAsD,CACzE,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,GAAG,EAAE,CAAC;YACzB,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,sCAAsC,CACzD,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,YAAY;IACZ,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,MAAM,CAAC,eAAe,CAAC;QACrC,IACE,KAAK,CAAC,MAAM,GAAG,mBAAmB;YAClC,KAAK,CAAC,MAAM,GAAG,mBAAmB;YAClC,CAAC,KAAK,CAAC,KAAK,CAAC,EACb,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,8BAA8B,mBAAmB,IAAI,mBAAmB,uBAAuB,CAClH,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,sDAAsD,CACzE,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,GAAG,EAAE,CAAC;YACzB,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,sCAAsC,CACzD,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,gEAAgE;IAChE,MAAM,IAAI,eAAe,CACvB,cAAc,IAAI,wDAAwD,CAC3E,CAAC;AACJ,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,SAAS,CAAC,KAAqB;IAC7C,oEAAoE;IACpE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,gCAAgC,EAAE,SAAS,CAAC,CAAC;IAEpE,uEAAuE;IACvE,sBAAsB,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC/C,sBAAsB,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAEjD,wDAAwD;IACxD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAChE,MAAM,IAAI,eAAe,CAAC,mCAAmC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,eAAe,CAAC,wCAAwC,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CACvB,mDAAmD,CACpD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,GAAG,mBAAmB,EAAE,CAAC;QACnE,MAAM,IAAI,eAAe,CACvB,+CAA+C,mBAAmB,mBAAmB,KAAK,CAAC,UAAU,GAAG,CACzG,CAAC;IACJ,CAAC;IAED,8DAA8D;IAC9D,+EAA+E;IAC/E,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACxC,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;QACvB,MAAM,IAAI,eAAe,CACvB,yDAAyD,CAC1D,CAAC;IACJ,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/amm-delete.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Functional AMMDelete factory — frozen-object style.
+ *
+ * Deletes an Automated Market Maker (AMM) instance that could not be
+ * fully deleted automatically (e.g. more than 512 empty trust lines
+ * remain after an AMMWithdraw). Anyone can call `AMMDelete`; the ledger
+ * enforces that the AMM is in an empty (`LPTokens == 0`) state.
+ *
+ * Validation happens at construction; there is no way to construct an
+ * invalid tx.
+ *
+ *   import { ammDelete } from 'xrplt/fp';
+ *   const tx = ammDelete({
+ *     Account,
+ *     Asset:  { currency: 'XRP' },
+ *     Asset2: { currency: 'TST', issuer: 'r…' },
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Fee: '10' });
+ *
+ * Affected amendments:
+ *   - `AMM` (base AMMDelete)
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ammdelete
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0030-automated-market-maker
+ *
+ * ## Divergences
+ *
+ * The class-based API at `src/transactions/amm-delete.ts` validates
+ * `Asset` and `Asset2` with `isRecord`, which accepts any object —
+ * including the wrong kind of object (e.g. a `Memo`, a `Signer`, or an
+ * empty `{}`). The factory fills three guards the class skips:
+ *
+ *   1. **`Asset` must be a valid `Currency` (XRP / IOU / MPT).** The
+ *      class accepts any object; the factory rejects with
+ *      `'AMMDelete: Asset must be a valid Currency'` when Asset is
+ *      missing, null, or not a recognized currency shape.
+ *      Source: xrpl.org `ammdelete.md` Fields table — `Asset` row,
+ *      Description column: "The asset can be XRP, a token, or an MPT".
+ *      Source: XLS-0030 §2.3.1, `Asset` row, JSON Type = `object`,
+ *      Internal Type = `ISSUE`. xrpl.js `validateAMMDelete` calls
+ *      `isIssuedCurrency(tx.Asset)` (line 48) and throws
+ *      `'AMMDelete: Asset must be a Currency'`.
+ *      (`isIssuedCurrency` rejects MPT form; `isCurrency` accepts it
+ *      to match the more recent xrpl.org docs. Either is stricter
+ *      than `isRecord`.)
+ *
+ *   2. **`Asset2` must be a valid `Currency` (XRP / IOU / MPT).** Same
+ *      rationale and sources as #1, applied to `Asset2`. The class
+ *      accepts any object; xrpl.js line 56 calls `isIssuedCurrency`
+ *      on `Asset2`; the factory uses `isCurrency` for the same
+ *      docs-aligned coverage as `Asset`.
+ *
+ *   3. **`Account` is validated as a well-formed XRPL classic or
+ *      X-address.** The class delegates Account validation to
+ *      `validateBaseTransaction`, which only checks `isString(Account)`
+ *      and skips `isAccount`. The factory uses `isAccount` so a
+ *      malformed Account is caught at construction rather than at
+ *      `.validate()` time.
+ *      Source: xrpl.js `validateBaseTransaction` calls `isAccount`
+ *      on `tx.Account`. Local helper at `src/validation/helpers.ts`
+ *      lines 55–60.
+ */
+import type { Currency } from '../../types/amounts.js';
+export interface AmmDeleteProps {
+    /** The unique address of the transaction sender (anyone may delete). */
+    Account: string;
+    /** One of the two assets in the AMM's pool (XRP / IOU / MPT). */
+    Asset: Currency;
+    /** The other asset in the AMM's pool (XRP / IOU / MPT). */
+    Asset2: Currency;
+    /** Fee in XRP (drops), base-10 integer string. */
+    Fee?: string | undefined;
+    /** Account sequence number. */
+    Sequence?: number | undefined;
+}
+export interface AmmDelete extends Readonly<AmmDeleteProps> {
+    readonly TransactionType: 'AMMDelete';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AmmDeleteProps>): AmmDelete;
+}
+export declare function ammDelete(props: AmmDeleteProps): AmmDelete;
+//# sourceMappingURL=amm-delete.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-delete.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/amm-delete.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAOvD,MAAM,WAAW,cAAc;IAC7B,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,KAAK,EAAE,QAAQ,CAAC;IAChB,2DAA2D;IAC3D,MAAM,EAAE,QAAQ,CAAC;IACjB,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,+BAA+B;IAC/B,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;AAID,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,CAuC1D"}

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

@@ -0,0 +1,36 @@
+import { isAccount, isCurrency } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ammDelete(props) {
+    // ── Account ── required, must be a valid XRPL classic / X-address.
+    require(props.Account, 'AMMDelete: Account is required', isAccount);
+    // ── Asset ── required, must be a valid Currency (XRP / IOU / MPT).
+    if (!isCurrency(props.Asset)) {
+        throw new ValidationError('AMMDelete: Asset must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    // ── Asset2 ── required, must be a valid Currency (XRP / IOU / MPT).
+    if (!isCurrency(props.Asset2)) {
+        throw new ValidationError('AMMDelete: Asset2 must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    return buildFrozenTx('AMMDelete', 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 ammDelete(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=amm-delete.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-delete.js","sourceRoot":"","sources":["../../../src/fp/factories/amm-delete.ts"],"names":[],"mappings":"AAgEA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAwBnE,wEAAwE;AAExE,MAAM,UAAU,SAAS,CAAC,KAAqB;IAC7C,oEAAoE;IACpE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,gCAAgC,EAAE,SAAS,CAAC,CAAC;IAEpE,oEAAoE;IACpE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACvB,0EAA0E,CAC3E,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CACvB,2EAA2E,CAC5E,CAAC;IACJ,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/amm-deposit.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Functional AMMDeposit factory — frozen-object style.
+ *
+ * Adds liquidity to an AMM instance and receives LP tokens in exchange.
+ * Validation happens at construction; there is no way to construct an
+ * invalid tx.
+ *
+ *   import { ammDeposit } from 'xrplt/fp';
+ *   const tx = ammDeposit({
+ *     Account,
+ *     Asset:  { currency: 'XRP' },
+ *     Asset2: { currency: 'USD', issuer: USD_ISSUER },
+ *     Amount: '1000000',
+ *     Flags:  AMMDepositFlags.tfSingleAsset,
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Amount: '2000000' });
+ *
+ * Affected amendments:
+ *   - `AMM` (base AMMDeposit)
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ammdeposit
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0030-automated-market-maker
+ *
+ * ## Divergences
+ * The factory enforces eight preclaim checks that the class API
+ * (`src/transactions/amm-deposit.ts`) skips:
+ *
+ *   1. `Asset` must be an `IssuedCurrency` (XRP form OR IOU form,
+ *      NOT MPT). The class only checks `isRecord`, which lets
+ *      `{ mpt_issuance_id: '...' }` slip through.
+ *      Source: xrpl.js `validateAMMDeposit` (lines 92–94) calls
+ *      `isIssuedCurrency(tx.Asset)` and throws
+ *      `'AMMDeposit: Asset must be a Currency'`. The class API
+ *      uses `isRecord(this.Asset)` which cannot distinguish
+ *      IssuedCurrency from MPT.
+ *
+ *   2. `Asset2` must be an `IssuedCurrency` (XRP form OR IOU form,
+ *      NOT MPT). Same source as #1, but applied to Asset2
+ *      (xrpl.js lines 100–102).
+ *
+ *   3. `LPTokenOut`, when present, must be an `IssuedCurrencyAmount`.
+ *      Source: xrpl.js `validateAMMDeposit` lines 114–118 — throws
+ *      `'AMMDeposit: LPTokenOut must be an IssuedCurrencyAmount'`.
+ *      The class API does not validate the type of LPTokenOut.
+ *
+ *   4. `Amount`, when present, must be a valid `Amount` (XRP drops
+ *      string, IOU, or MPT). The class API does not validate the
+ *      type of Amount.
+ *      Source: xrpl.js `validateAMMDeposit` lines 120–122.
+ *
+ *   5. `Amount2`, when present, must be a valid `Amount`. Same source
+ *      as #4 but applied to Amount2 (xrpl.js lines 124–126).
+ *
+ *   6. `EPrice`, when present, must be a valid `Amount`. Same source
+ *      as #4 but applied to EPrice (xrpl.js lines 128–130).
+ *
+ *   7. `Amount2` and `EPrice` are not allowed without `Amount`. The
+ *      class API does not check that Amount2 / EPrice are paired
+ *      with Amount.
+ *      Source: xrpl.js `validateAMMDeposit` lines 104–112 — throws
+ *      `'AMMDeposit: must set Amount with Amount2'` and
+ *      `'AMMDeposit: must set Amount with EPrice'`.
+ *
+ *   8. At least one of `LPTokenOut` or `Amount` must be present.
+ *      The class API does not enforce the minimal field set.
+ *      Source: xrpl.js `validateAMMDeposit` lines 108–112 — throws
+ *      `'AMMDeposit: must set at least LPTokenOut or Amount'`.
+ */
+import type { Amount, IssuedCurrencyAmount } from '../../types/amounts.js';
+import type { AMMDepositFlagsInterface } from '../../types/flags.js';
+export interface AmmDepositProps {
+    /** The unique address of the transaction sender (the LP). */
+    Account: string;
+    /** One of the two pool assets (XRP form or IOU form, NOT MPT). */
+    Asset: {
+        readonly currency: 'XRP';
+    } | {
+        readonly currency: string;
+        readonly issuer: string;
+    };
+    /** The other pool asset (XRP form or IOU form, NOT MPT). */
+    Asset2: {
+        readonly currency: 'XRP';
+    } | {
+        readonly currency: string;
+        readonly issuer: string;
+    };
+    /** Amount of `Asset` to deposit. Required unless `LPTokenOut` is set. */
+    Amount?: Amount | undefined;
+    /** Amount of `Asset2` to deposit. Requires `Amount`. */
+    Amount2?: Amount | undefined;
+    /** Max effective price per LP token. Requires `Amount`. */
+    EPrice?: Amount | undefined;
+    /** Target LP tokens out (IssuedCurrencyAmount). */
+    LPTokenOut?: IssuedCurrencyAmount | undefined;
+    /** Bit-flags for this transaction. Numeric or boolean map. */
+    Flags?: number | AMMDepositFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface AmmDeposit extends Readonly<AmmDepositProps> {
+    readonly TransactionType: 'AMMDeposit';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AmmDepositProps>): AmmDeposit;
+}
+export declare function ammDeposit(props: AmmDepositProps): AmmDeposit;
+//# sourceMappingURL=amm-deposit.d.ts.map

package/dist/fp/factories/amm-deposit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amm-deposit.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/amm-deposit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAYrE,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,KAAK,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7F,4DAA4D;IAC5D,MAAM,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9F,yEAAyE;IACzE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,mDAAmD;IACnD,UAAU,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC9C,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS,CAAC;IACtD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,UAAW,SAAQ,QAAQ,CAAC,eAAe,CAAC;IAC3D,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC;IACvC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,CAAC;CACvD;AAID,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,CA8E7D"}

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

@@ -0,0 +1,68 @@
+import { isAccount, isAmount, isIssuedCurrency, isIssuedCurrencyAmount, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ammDeposit(props) {
+    // ── Account ── required, must be a valid XRPL classic address.
+    require(props.Account, 'AMMDeposit: Account is required', isAccount);
+    // ── Asset ── required, must be an IssuedCurrency (XRP or IOU, NOT MPT).
+    if (props.Asset === undefined) {
+        throw new ValidationError('AMMDeposit: missing field Asset');
+    }
+    if (!isIssuedCurrency(props.Asset)) {
+        throw new ValidationError('AMMDeposit: Asset must be a Currency (XRP form or IOU form, NOT MPT)');
+    }
+    // ── Asset2 ── required, must be an IssuedCurrency (XRP or IOU, NOT MPT).
+    if (props.Asset2 === undefined) {
+        throw new ValidationError('AMMDeposit: missing field Asset2');
+    }
+    if (!isIssuedCurrency(props.Asset2)) {
+        throw new ValidationError('AMMDeposit: Asset2 must be a Currency (XRP form or IOU form, NOT MPT)');
+    }
+    // ── Combinatorial rules (xrpl.js `validateAMMDeposit` lines 104–112). ──
+    if (props.Amount2 !== undefined && props.Amount === undefined) {
+        throw new ValidationError('AMMDeposit: must set Amount with Amount2');
+    }
+    if (props.EPrice !== undefined && props.Amount === undefined) {
+        throw new ValidationError('AMMDeposit: must set Amount with EPrice');
+    }
+    if (props.LPTokenOut === undefined && props.Amount === undefined) {
+        throw new ValidationError('AMMDeposit: must set at least LPTokenOut or Amount');
+    }
+    // ── LPTokenOut ── if present, must be an IssuedCurrencyAmount.
+    if (props.LPTokenOut !== undefined) {
+        if (!isIssuedCurrencyAmount(props.LPTokenOut)) {
+            throw new ValidationError('AMMDeposit: LPTokenOut must be an IssuedCurrencyAmount');
+        }
+    }
+    // ── Amount / Amount2 / EPrice ── if present, must be a valid Amount.
+    if (props.Amount !== undefined && !isAmount(props.Amount)) {
+        throw new ValidationError('AMMDeposit: Amount must be an Amount');
+    }
+    if (props.Amount2 !== undefined && !isAmount(props.Amount2)) {
+        throw new ValidationError('AMMDeposit: Amount2 must be an Amount');
+    }
+    if (props.EPrice !== undefined && !isAmount(props.EPrice)) {
+        throw new ValidationError('AMMDeposit: EPrice must be an Amount');
+    }
+    return buildFrozenTx('AMMDeposit', 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 ammDeposit(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=amm-deposit.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-deposit.js","sourceRoot":"","sources":["../../../src/fp/factories/amm-deposit.ts"],"names":[],"mappings":"AAuEA,OAAO,EACL,SAAS,EACT,QAAQ,EACR,gBAAgB,EAChB,sBAAsB,GACvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAgCnE,wEAAwE;AAExE,MAAM,UAAU,UAAU,CAAC,KAAsB;IAC/C,gEAAgE;IAChE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,iCAAiC,EAAE,SAAS,CAAC,CAAC;IAErE,yEAAyE;IACzE,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CAAC,iCAAiC,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,eAAe,CACvB,sEAAsE,CACvE,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,kCAAkC,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CACvB,uEAAuE,CACxE,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC9D,MAAM,IAAI,eAAe,CAAC,0CAA0C,CAAC,CAAC;IACxE,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC7D,MAAM,IAAI,eAAe,CAAC,yCAAyC,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjE,MAAM,IAAI,eAAe,CACvB,oDAAoD,CACrD,CAAC;IACJ,CAAC;IAED,gEAAgE;IAChE,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,eAAe,CACvB,wDAAwD,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,eAAe,CAAC,sCAAsC,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,eAAe,CAAC,uCAAuC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,eAAe,CAAC,sCAAsC,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,aAAa,CAClB,YAAY,EACZ,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,CAAmB,SAAmC;YACxD,OAAO,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACnD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/amm-vote.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Functional AMMVote factory — frozen-object style.
+ *
+ * Votes on the trading fee for an Automated Market Maker (AMM) instance.
+ * Up to 8 accounts can vote in proportion to the amount of the AMM's
+ * LP Tokens they hold; the new trading fee is recomputed as a weighted
+ * average of the active votes. Validation happens at construction;
+ * there is no way to construct an invalid tx.
+ *
+ *   import { ammVote } from 'xrplt/fp';
+ *   const tx = ammVote({
+ *     Account,
+ *     Asset:  { currency: 'XRP' },
+ *     Asset2: { currency: 'TST', issuer: 'r…' },
+ *     TradingFee: 600,
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ TradingFee: 700 });
+ *
+ * Affected amendments:
+ *   - `AMM` (base AMMVote)
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ammvote
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0030-automated-market-maker
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/amm-vote.ts`, this factory adds
+ * preclaim guards the class API skips. The class only calls `isRecord`
+ * on `Asset` / `Asset2` and only checks the [0, 1000] numeric range on
+ * `TradingFee` — it accepts any object for the asset fields and any
+ * non-integer in range for the fee. Citing the docs:
+ *
+ * 1. **`Asset` must be a valid `Currency` (XRP / IOU / MPT), not just
+ *    a record.** Source: xrpl.org `ammvote.md` Fields table — `Asset`
+ *    row, Description column: "The asset can be XRP, a token, or an
+ *    MPT". Source: XLS-0030 §3.2.1, `Asset` row, Internal Type = `ISSUE`.
+ *    xrpl.js `validateAMMVote` (line 50) calls `isIssuedCurrency(tx.Asset)`
+ *    and throws `'AMMVote: Asset must be a Currency'`. The class API
+ *    uses `isRecord(this.Asset)`, which cannot distinguish IssuedCurrency
+ *    or MPT form from any other object.
+ *
+ * 2. **`Asset2` must be a valid `Currency` (XRP / IOU / MPT), not just
+ *    a record.** Same sources and rationale as #1, applied to `Asset2`
+ *    (xrpl.js line 58).
+ *
+ * 3. **`TradingFee` must be an integer.** Source: XLS-0030 §3.2.1,
+ *    `TradingFee` row, Internal Type = `UINT16`. The class accepts any
+ *    number in [0, 1000], including non-integer values like 0.5.
+ *
+ * 4. **`Account` must be a valid XRPL classic or X-address.** The class
+ *    delegates Account validation to `validateBaseTransaction`, which
+ *    only checks `isString(Account)`. The factory uses `isAccount` so
+ *    a malformed Account is caught at construction rather than at
+ *    `.validate()` time.
+ *    Source: xrpl.js `validateBaseTransaction` calls `isAccount`
+ *    on `tx.Account`. Local helper at `src/validation/helpers.ts`
+ *    lines 55–60.
+ */
+import type { Currency } from '../../types/amounts.js';
+export interface AmmVoteProps {
+    /** The unique address of the transaction sender (an LP of the AMM). */
+    Account: string;
+    /** One of the two assets in the AMM's pool (XRP / IOU / MPT). */
+    Asset: Currency;
+    /** The other asset in the AMM's pool (XRP / IOU / MPT). */
+    Asset2: Currency;
+    /**
+     * The proposed trading fee, in units of 1/100,000 (1 = 0.001%). Must
+     * be an integer in [0, 1000] inclusive. UINT16.
+     */
+    TradingFee: number;
+    /** Fee in XRP (drops), base-10 integer string. */
+    Fee?: string | undefined;
+    /** Account sequence number. */
+    Sequence?: number | undefined;
+    /** Bit-flags for this transaction (AMMVote defines no transaction-specific flags). */
+    Flags?: number | undefined;
+}
+export interface AmmVote extends Readonly<AmmVoteProps> {
+    readonly TransactionType: 'AMMVote';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AmmVoteProps>): AmmVote;
+}
+export declare function ammVote(props: AmmVoteProps): AmmVote;
+//# sourceMappingURL=amm-vote.d.ts.map

package/dist/fp/factories/amm-vote.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amm-vote.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/amm-vote.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAiBvD,MAAM,WAAW,YAAY;IAC3B,uEAAuE;IACvE,OAAO,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,KAAK,EAAE,QAAQ,CAAC;IAChB,2DAA2D;IAC3D,MAAM,EAAE,QAAQ,CAAC;IACjB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,sFAAsF;IACtF,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,OAAQ,SAAQ,QAAQ,CAAC,YAAY,CAAC;IACrD,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;IACpC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;CACjD;AAID,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAyDpD"}

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

@@ -0,0 +1,53 @@
+import { isAccount, isCurrency, isNumber, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// TradingFee is UINT16 with a ledger-enforced range of 0–1000
+// (0%–1%). (XLS-0030 §3.2.1; xrpl.js AMM_MAX_TRADING_FEE.)
+const AMM_MAX_TRADING_FEE = 1000;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ammVote(props) {
+    // ── Account ── required, must be a valid XRPL classic / X-address.
+    require(props.Account, 'AMMVote: Account is required', isAccount);
+    // ── Asset ── required, must be a valid Currency (XRP / IOU / MPT).
+    if (!isCurrency(props.Asset)) {
+        throw new ValidationError('AMMVote: Asset must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    // ── Asset2 ── required, must be a valid Currency (XRP / IOU / MPT).
+    if (!isCurrency(props.Asset2)) {
+        throw new ValidationError('AMMVote: Asset2 must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    // ── TradingFee ── required, integer, 0–1000 inclusive (UINT16).
+    if (props.TradingFee === undefined || props.TradingFee === null) {
+        throw new ValidationError('AMMVote: TradingFee is required');
+    }
+    if (!isNumber(props.TradingFee)) {
+        throw new ValidationError('AMMVote: TradingFee must be a number');
+    }
+    if (!Number.isInteger(props.TradingFee)) {
+        throw new ValidationError('AMMVote: TradingFee must be an integer (UINT16)');
+    }
+    if (props.TradingFee < 0 || props.TradingFee > AMM_MAX_TRADING_FEE) {
+        throw new ValidationError(`AMMVote: TradingFee must be between 0 and ${AMM_MAX_TRADING_FEE} inclusive (got ${props.TradingFee})`);
+    }
+    return buildFrozenTx('AMMVote', 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 ammVote(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=amm-vote.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-vote.js","sourceRoot":"","sources":["../../../src/fp/factories/amm-vote.ts"],"names":[],"mappings":"AA4DA,OAAO,EACL,SAAS,EACT,UAAU,EACV,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,8DAA8D;AAC9D,2DAA2D;AAC3D,MAAM,mBAAmB,GAAG,IAAI,CAAC;AA+BjC,wEAAwE;AAExE,MAAM,UAAU,OAAO,CAAC,KAAmB;IACzC,oEAAoE;IACpE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,8BAA8B,EAAE,SAAS,CAAC,CAAC;IAElE,oEAAoE;IACpE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACvB,wEAAwE,CACzE,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;IACJ,CAAC;IAED,iEAAiE;IACjE,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;QAChE,MAAM,IAAI,eAAe,CAAC,iCAAiC,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,eAAe,CAAC,sCAAsC,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CACvB,iDAAiD,CAClD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,UAAU,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,GAAG,mBAAmB,EAAE,CAAC;QACnE,MAAM,IAAI,eAAe,CACvB,6CAA6C,mBAAmB,mBAAmB,KAAK,CAAC,UAAU,GAAG,CACvG,CAAC;IACJ,CAAC;IAED,OAAO,aAAa,CAClB,SAAS,EACT,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,CAAgB,SAAgC;YAClD,OAAO,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAChD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/amm-withdraw.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Functional AMMWithdraw factory — frozen-object style.
+ *
+ * Withdraws assets from an Automated Market Maker (AMM) instance by
+ * returning the AMM's liquidity provider tokens (LP Tokens). The factory
+ * enforces the seven mutually-exclusive AMM-withdraw modes at
+ * construction; there is no way to construct an invalid tx.
+ *
+ *   import { ammWithdraw } from 'xrplt/fp';
+ *   const tx = ammWithdraw({
+ *     Account,
+ *     Asset:  { currency: 'XRP' },
+ *     Asset2: { currency: 'TST', issuer: 'r…' },
+ *     Amount: '1000',
+ *     Flags:  AMMWithdrawFlags.tfSingleAsset,
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Amount: '2000' });
+ *
+ * Affected amendments:
+ *   - `AMM` (base AMMWithdraw)
+ *   - `fixAMMv1_3` (LP-token precision-loss error path; runtime)
+ *   - `fixCleanup3_3_0` (frozen/locked asset error path; runtime)
+ *   - `fixCleanup3_4_0` (replaces `tefEXCEPTION` with `tecAMM_FAILED`;
+ *     runtime)
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ammwithdraw
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0030-automated-market-maker
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/amm-withdraw.ts`, this factory adds
+ * preclaim guards the class API skips. The class only calls `isRecord`
+ * on `Asset` / `Asset2` and does not validate any of the optional
+ * amount fields, the field-combination rules, or the
+ * one-AMMWithdraw-flag rule. Citing `temMALFORMED` from
+ * xrpl.org `ammwithdraw.md` Error Cases: "The transaction specified an
+ * invalid combination of fields. See AMMWithdraw Modes."
+ *
+ * 1. **`Asset` and `Asset2` must each be a valid `Currency` (XRP / IOU /
+ *    MPT), not merely a record.** Source: XLS-0030 §2.4.2.1 — both
+ *    fields are typed `object` with internal type `ISSUE`, and
+ *    xrpl.org `ammwithdraw.md` Fields table — "The asset can be XRP,
+ *    a token, or an MPT". xrpl.js `validateAMMWithdraw` enforces
+ *    `isIssuedCurrency(Asset)` and `isIssuedCurrency(Asset2)` and
+ *    rejects with `'AMMWithdraw: Asset must be a Currency'`. The class
+ *    accepts any object.
+ *
+ * 2. **`Amount2` requires `Amount` (XLS-0030 §2.4.2.3 — "Amount and
+ *    Amount2" combination).** Source: xrpl.js
+ *    `validateAMMWithdraw` lines 102–106 — `if (tx.Amount2 != null &&
+ *    tx.Amount == null) throw 'AMMWithdraw: must set Amount with
+ *    Amount2'`. The class accepts Amount2 alone.
+ *
+ * 3. **`EPrice` requires `Amount` (XLS-0030 §2.4.2.3 — "Amount and
+ *    EPrice" combination; EPrice is only meaningful for single-sided
+ *    withdrawals).** Source: xrpl.js `validateAMMWithdraw` lines
+ *    104–106 — `if (tx.EPrice != null && tx.Amount == null) throw
+ *    'AMMWithdraw: must set Amount with EPrice'`. The class accepts
+ *    EPrice alone.
+ *
+ * 4. **`LPTokenIn` must be an `IssuedCurrencyAmount` (LP tokens are
+ *    always an issued currency — never XRP and never an MPT).**
+ *    Source: xrpl.js `validateAMMWithdraw` lines 108–112 — `if
+ *    (tx.LPTokenIn != null && !isIssuedCurrencyAmount(tx.LPTokenIn))
+ *    throw 'AMMWithdraw: LPTokenIn must be an IssuedCurrencyAmount'`.
+ *    xrpl.js interface `AMMWithdraw.LPTokenIn` is typed
+ *    `IssuedCurrencyAmount`. The class accepts anything (no
+ *    validation).
+ *
+ * 5. **Exactly one of the seven `AMMWithdraw` mode flags must be set in
+ *    `Flags`.** Source: xrpl.org `ammwithdraw.md` AMMWithdraw Flags
+ *    section — "You must specify **exactly one** of these flags, plus
+ *    any global flags." The seven flags (`tfLPToken = 0x00010000`,
+ *    `tfWithdrawAll = 0x00020000`, `tfOneAssetWithdrawAll = 0x00040000`,
+ *    `tfSingleAsset = 0x00080000`, `tfTwoAsset = 0x00100000`,
+ *    `tfOneAssetLPToken = 0x00200000`, `tfLimitLPToken = 0x00400000`)
+ *    are non-overlapping single-bit values defined in
+ *    xrpl.js `AMMWithdrawFlags` enum. The class performs no flag-mode
+ *    validation at all; an empty `Flags` is silently accepted.
+ *
+ * 6. **`Amount`, `Amount2`, `EPrice` must each be a valid `Amount`
+ *    (string / IssuedCurrencyAmount / MPTAmount) when provided.**
+ *    Source: xrpl.js `validateAMMWithdraw` lines 114–124 — each of
+ *    the three amount fields is gated with `isAmount`. The class
+ *    accepts anything (no validation).
+ */
+import type { Amount, IssuedCurrencyAmount, Currency } from '../../types/amounts.js';
+import type { AMMWithdrawFlagsInterface } from '../../types/flags.js';
+export interface AmmWithdrawProps {
+    /** The unique address of the transaction sender. */
+    Account: string;
+    /** One of the two assets in the AMM's pool (XRP / IOU / MPT). */
+    Asset: Currency;
+    /** The other asset in the AMM's pool (XRP / IOU / MPT). */
+    Asset2: Currency;
+    /**
+     * Amount of one asset to withdraw. Optional — when omitted, the
+     * mode flag (`tfLPToken`, `tfWithdrawAll`) specifies the
+     * withdrawal amount.
+     */
+    Amount?: Amount | undefined;
+    /**
+     * Amount of the other asset to withdraw. Requires `Amount` and the
+     * `tfTwoAsset` flag (XLS-0030 §2.4.2.3).
+     */
+    Amount2?: Amount | undefined;
+    /**
+     * Minimum effective price, in LP Token returned, to pay per unit of
+     * the asset to withdraw. Requires `Amount` and the `tfLimitLPToken`
+     * flag.
+     */
+    EPrice?: Amount | undefined;
+    /**
+     * How many of the AMM's LP Tokens to redeem. Always an
+     * `IssuedCurrencyAmount` (LP tokens are never XRP or MPT).
+     */
+    LPTokenIn?: IssuedCurrencyAmount | undefined;
+    /** AMM-withdraw mode flag bitmask + any global flags. */
+    Flags?: number | AMMWithdrawFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface AmmWithdraw extends Readonly<AmmWithdrawProps> {
+    readonly TransactionType: 'AMMWithdraw';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AmmWithdrawProps>): AmmWithdraw;
+}
+export declare function ammWithdraw(props: AmmWithdrawProps): AmmWithdraw;
+//# sourceMappingURL=amm-withdraw.d.ts.map

package/dist/fp/factories/amm-withdraw.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amm-withdraw.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/amm-withdraw.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AA0CtE,MAAM,WAAW,gBAAgB;IAC/B,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,KAAK,EAAE,QAAQ,CAAC;IAChB,2DAA2D;IAC3D,MAAM,EAAE,QAAQ,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,SAAS,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC7C,yDAAyD;IACzD,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,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;AAyCD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CA6GhE"}