xrpjson 0.1.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-bid.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/amm-bid.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAkB7E,MAAM,WAAW,WAAW;IAC1B,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,KAAK,EAAE,QAAQ,CAAC;IAChB,2DAA2D;IAC3D,MAAM,EAAE,QAAQ,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC1C;;;;OAIG;IACH,MAAM,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC1C;;;OAGG;IACH,YAAY,CAAC,EACT,aAAa,CAAC;QAAE,QAAQ,CAAC,WAAW,EAAE;YAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,GACrE,SAAS,CAAC;IACd,sCAAsC;IACtC,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,MAAO,SAAQ,QAAQ,CAAC,WAAW,CAAC;IACnD,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC;IACnC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC;CAC/C;AAID,wBAAgB,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAgGjD"}

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

@@ -0,0 +1,82 @@
+import { isAccount, isCurrency, isIssuedCurrencyAmount, isRecord, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+/** xrpl.js `MAX_AUTH_ACCOUNTS = 4` (xrpl.js AMMBid.ts line 13). */
+const MAX_AUTH_ACCOUNTS = 4;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ammBid(props) {
+    // ── Account ── required, must be a valid XRPL classic address.
+    if (!isString(props.Account) || !isAccount(props.Account)) {
+        throw new ValidationError('AMMBid: Account is required and must be a valid XRPL account address');
+    }
+    // ── Asset ── required, must be a valid Currency (XRP / IOU / MPT).
+    if (props.Asset === undefined) {
+        throw new ValidationError('AMMBid: missing field Asset');
+    }
+    if (!isCurrency(props.Asset)) {
+        throw new ValidationError('AMMBid: Asset must be a Currency (XRP, trust line, or MPT form)');
+    }
+    // ── Asset2 ── required, must be a valid Currency (XRP / IOU / MPT).
+    if (props.Asset2 === undefined) {
+        throw new ValidationError('AMMBid: missing field Asset2');
+    }
+    if (!isCurrency(props.Asset2)) {
+        throw new ValidationError('AMMBid: Asset2 must be a Currency (XRP, trust line, or MPT form)');
+    }
+    // ── BidMin / BidMax ── when present, must be an IssuedCurrencyAmount
+    //    (LP tokens are always issued currencies, never XRP and never MPT).
+    if (props.BidMin !== undefined && !isIssuedCurrencyAmount(props.BidMin)) {
+        throw new ValidationError('AMMBid: BidMin must be an IssuedCurrencyAmount (LP tokens are an issued currency, never XRP and never MPT)');
+    }
+    if (props.BidMax !== undefined && !isIssuedCurrencyAmount(props.BidMax)) {
+        throw new ValidationError('AMMBid: BidMax must be an IssuedCurrencyAmount (LP tokens are an issued currency, never XRP and never MPT)');
+    }
+    // ── AuthAccounts ── optional, but when present must be an array of
+    //    up to MAX_AUTH_ACCOUNTS `{ AuthAccount: { Account } }` records,
+    //    and must not include the sender's address.
+    if (props.AuthAccounts !== undefined) {
+        if (!Array.isArray(props.AuthAccounts)) {
+            throw new ValidationError('AMMBid: AuthAccounts must be an AuthAccount array');
+        }
+        if (props.AuthAccounts.length > MAX_AUTH_ACCOUNTS) {
+            throw new ValidationError(`AMMBid: AuthAccounts length must not be greater than ${MAX_AUTH_ACCOUNTS}`);
+        }
+        for (const entry of props.AuthAccounts) {
+            if (!isRecord(entry)) {
+                throw new ValidationError('AMMBid: invalid AuthAccounts');
+            }
+            const inner = entry['AuthAccount'];
+            if (!isRecord(inner)) {
+                throw new ValidationError('AMMBid: invalid AuthAccounts');
+            }
+            const acct = inner['Account'];
+            if (acct === undefined || acct === null || typeof acct !== 'string') {
+                throw new ValidationError('AMMBid: invalid AuthAccounts');
+            }
+            if (acct === props.Account) {
+                throw new ValidationError("AMMBid: AuthAccounts must not include sender's address");
+            }
+        }
+    }
+    return buildFrozenTx('AMMBid', 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 ammBid(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=amm-bid.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-bid.js","sourceRoot":"","sources":["../../../src/fp/factories/amm-bid.ts"],"names":[],"mappings":"AA6FA,OAAO,EACL,SAAS,EACT,UAAU,EACV,sBAAsB,EACtB,QAAQ,EACR,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,mEAAmE;AACnE,MAAM,iBAAiB,GAAG,CAAC,CAAC;AA2C5B,wEAAwE;AAExE,MAAM,UAAU,MAAM,CAAC,KAAkB;IACvC,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,sEAAsE,CACvE,CAAC;IACJ,CAAC;IAED,oEAAoE;IACpE,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CAAC,6BAA6B,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,eAAe,CACvB,iEAAiE,CAClE,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CACvB,kEAAkE,CACnE,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,wEAAwE;IACxE,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACxE,MAAM,IAAI,eAAe,CACvB,4GAA4G,CAC7G,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACxE,MAAM,IAAI,eAAe,CACvB,4GAA4G,CAC7G,CAAC;IACJ,CAAC;IAED,oEAAoE;IACpE,qEAAqE;IACrE,gDAAgD;IAChD,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,eAAe,CACvB,mDAAmD,CACpD,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,YAAY,CAAC,MAAM,GAAG,iBAAiB,EAAE,CAAC;YAClD,MAAM,IAAI,eAAe,CACvB,wDAAwD,iBAAiB,EAAE,CAC5E,CAAC;QACJ,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;YACvC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,KAAK,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;YACnC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;YAC9B,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpE,MAAM,IAAI,eAAe,CAAC,8BAA8B,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;gBAC3B,MAAM,IAAI,eAAe,CACvB,wDAAwD,CACzD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,QAAQ,EACR,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,CAAe,SAA+B;YAChD,OAAO,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAC/C,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,166 @@
+/**
+ * Functional AMMClawback factory — frozen-object style.
+ *
+ * Claw back tokens from a holder that has deposited the issuer's issued
+ * tokens into an AMM pool. The submitter (`Account`) must be the issuer
+ * of `Asset`. If `Amount` is omitted, all of the holder's tokens in
+ * the AMM pool are clawed back.
+ *
+ * Validation happens at construction; there is no way to construct an
+ * invalid tx.
+ *
+ *   import { ammClawback } from 'xrplt/fp';
+ *   const tx = ammClawback({
+ *     Account,
+ *     Holder,
+ *     Asset:  { currency: 'USD', issuer: Account },
+ *     Asset2: { currency: 'XRP' },
+ *     Amount: { currency: 'USD', issuer: Account, value: '1000' },
+ *     Flags:  AMMClawbackFlags.tfClawTwoAssets,
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Amount: { currency: 'USD', issuer: Account, value: '500' } });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ammclawback
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/AMMClawback.ts
+ * @see XLS-0073 §2.3 (https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0073-amm-clawback)
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/amm-clawback.ts`, this factory adds
+ * preclaim guards the class API skips. Each is cited to the canonical
+ * source.
+ *
+ * - **`Account` must be a valid XRPL classic (or X-) address.**
+ *   The class inherits only `validateBaseTransaction`'s `isString(Account)`
+ *   check, which lets `"not-an-address"` through.
+ *   - Source: xrpl-dev-portal ammclawback.md, `Holder` row, Internal
+ *     Type = `AccountID` (same encoding as `Account`).
+ *
+ * - **`Holder` must be a valid XRPL account** (format check).
+ *   The class delegates to `isAccount`, which is fine — kept identical.
+ *
+ * - **`Holder` and `Asset.issuer` must be distinct.**
+ *   The class only checks `isAccount(this.Holder)` and never compares
+ *   it against `Asset.issuer`. The ledger rejects this with `temMALFORMED`
+ *   ("Account is the same as the Holder" — docs use the word Account but
+ *     the canonical check is against the asset issuer / submitter).
+ *   - Source: xrpl.js `validateAMMClawback` lines 86–92, message
+ *     `'AMMClawback: Holder and Asset.issuer must be distinct'`.
+ *   - Source: xrpl-dev-portal ammclawback.md "Error Cases" table —
+ *     `temMALFORMED` row.
+ *
+ * - **`Account` must equal `Asset.issuer`.**
+ *   The class never compares them. Per the docs, this mismatches with
+ *   `temMALFORMED` / `tecNO_PERMISSION`.
+ *   - Source: xrpl.js `validateAMMClawback` lines 94–98, message
+ *     `'AMMClawback: Account must be the same as Asset.issuer'`.
+ *   - Source: xrpl-dev-portal ammclawback.md `Asset` row, Description:
+ *     "The issuer must be the sender of this transaction."
+ *   - Source: XLS-0073 §2.3, `Asset` row: "Asset's issuer should match
+ *     with `Account`. Otherwise, `temMALFORMED` will be returned."
+ *
+ * - **`Asset` must be an IOU (`{ currency, issuer }`), NOT XRP and NOT MPT.**
+ *   The class types `Asset` as `{ currency: string; issuer?: string }`,
+ *   so callers can pass `{ currency: 'XRP' }` and the class accepts it.
+ *   The ledger rejects `Asset` as XRP with `temMALFORMED`.
+ *   - Source: xrpl.js `validateAMMClawback` line 84,
+ *     `validateRequiredField(tx, 'Asset', isIssuedCurrency)`.
+ *   - Source: xrpl-dev-portal ammclawback.md "Error Cases" table —
+ *     `temMALFORMED` row, third bullet: "or `Asset` is XRP."
+ *   - Source: XLS-0073 §2.3, `Asset` row: `Asset` is the token the issuer
+ *     wants to claw back — by construction an IOU (the issuer is named).
+ *
+ * - **`Asset2` must be a valid `Currency`** (XRP, trust line IOU, or MPT).
+ *   The class types `Asset2` as `{ currency: string; issuer?: string }`
+ *   and never validates the object shape; MPT form slips through.
+ *   - Source: xrpl.js `validateAMMClawback` line 100,
+ *     `validateRequiredField(tx, 'Asset2', isIssuedCurrency)`.
+ *   - Source: xrpl-dev-portal ammclawback.md `Asset2` row, Description:
+ *     "The asset can be XRP, a trust line token, or an MPT."
+ *   - Source: XLS-0073 §2.3, `Asset2` row: paired token in the AMM pool.
+ *
+ * - **`Amount` must be an `IssuedCurrencyAmount` — NOT an XRP drops
+ *   string, NOT an MPTAmount.** The class types `Amount?: Amount`
+ *   which accepts all three forms. Per the docs / xrpl.js, `Amount` is
+ *   strictly IOU.
+ *   - Source: xrpl.js `validateAMMClawback` line 102,
+ *     `validateOptionalField(tx, 'Amount', isIssuedCurrencyAmount)`.
+ *   - Source: xrpl-dev-portal ammclawback.md `Amount` row, JSON Type
+ *     `Currency Amount`, Internal Type `Amount` (IOU-only for clawback).
+ *
+ * - **`Amount.currency` must equal `Asset.currency`.**
+ *   The class never compares them.
+ *   - Source: xrpl.js `validateAMMClawback` lines 104–108.
+ *   - Source: xrpl-dev-portal ammclawback.md "Error Cases" table —
+ *     `temBAD_AMOUNT` row: "the `currency` and `issuer` subfields don't
+ *     match between `Amount` and `Asset`."
+ *
+ * - **`Amount.issuer` must equal `Asset.issuer`.**
+ *   The class never compares them.
+ *   - Source: xrpl.js `validateAMMClawback` lines 110–114 (note: xrpl.js
+ *     source has a typo in the error message, "Amount.issuer must match
+ *     Amount.issuer" — we keep the obvious correct intent: must match
+ *     `Asset.issuer`).
+ *   - Source: xrpl-dev-portal ammclawback.md `Amount` row, Description:
+ *     "The `currency` and `issuer` subfields should match the `Asset`
+ *     subfields."
+ *
+ * - **`Amount.value` must be a positive base-10 integer string.**
+ *   The class delegates to `isAmount` which only checks shape; the docs
+ *   say `Amount.value <= 0 → temBAD_AMOUNT`.
+ *   - Source: xrpl-dev-portal ammclawback.md "Error Cases" table —
+ *     `temBAD_AMOUNT` row: "the `Amount` field ... is less than or equal
+ *     to 0".
+ *   - Source: xrpl.org generic Amount spec
+ *     (basic-data-types#specifying-currency-amounts).
+ *
+ * - **IssuedCurrencyAmount `currency` and `issuer` shape are validated**
+ *   (3-char ASCII or 40-char hex `currency`; `issuer` must be a valid
+ *   XRPL account). The class only checks `isAmount`, which does not
+ *   enforce those sub-fields.
+ *   - Source: xrpl-dev-portal basic-data-types#specifying-currency-amounts.
+ *
+ * - **`Flags` is restricted to 0 or `tfClawTwoAssets` (0x00000001).**
+ *   The class inherits `Flags` from the parent and never inspects it.
+ *   The ledger rejects other bit values with `temINVALID_FLAG`.
+ *   - Source: xrpl-dev-portal ammclawback.md "AMMClawback Flags" section
+ *     (only `tfClawTwoAssets` defined) + "Error Cases" table —
+ *     `temINVALID_FLAG` row: "if you try enabling flags besides
+ *     `tfClawTwoAssets`."
+ */
+import type { IssuedCurrency, IssuedCurrencyAmount, Currency } from '../../types/amounts.js';
+import type { ClawbackFlagsInterface } from '../../types/flags.js';
+export interface AmmClawbackProps {
+    /** The issuer submitting the clawback (must equal `Asset.issuer`). */
+    Account: string;
+    /** The holder whose tokens will be clawed back from the AMM pool. */
+    Holder: string;
+    /**
+     * The asset being clawed back — must be an IOU the submitter issued.
+     * NOT the XRP form, NOT an MPT.
+     */
+    Asset: IssuedCurrency;
+    /**
+     * The other asset in the AMM pool. Can be XRP, an IOU, or an MPT.
+     */
+    Asset2: Currency;
+    /**
+     * Optional maximum amount to claw back (IssuedCurrencyAmount; NOT
+     * XRP drops, NOT MPT). If omitted, all the holder's tokens are
+     * clawed back. When present, `currency`/`issuer` must match `Asset`.
+     */
+    Amount?: IssuedCurrencyAmount | undefined;
+    /** Bit-flags: only `tfClawTwoAssets` (0x00000001) is defined. */
+    Flags?: number | ClawbackFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface AmmClawback extends Readonly<AmmClawbackProps> {
+    readonly TransactionType: 'AMMClawback';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AmmClawbackProps>): AmmClawback;
+}
+export declare function ammClawback(props: AmmClawbackProps): AmmClawback;
+//# sourceMappingURL=amm-clawback.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-clawback.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/amm-clawback.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkIG;AACH,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAkCnE,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,EAAE,cAAc,CAAC;IACtB;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC1C,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAAC;IACpD,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;AA4BD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CA+IhE"}

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

@@ -0,0 +1,143 @@
+import { isAccount, isCurrency, isHex, isIssuedCurrencyAmount, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// Only AMMClawback-specific bit flag defined by the protocol.
+// xrpl-dev-portal ammclawback.md "AMMClawback Flags" section.
+// tfClawTwoAssets is 0x00000001 (matches xrpl.js AMMClawbackFlags enum
+// and the project's src/types/flags.ts ClawbackFlags enum).
+const TF_CLAW_TWO_ASSETS = 0x00000001;
+// Global transaction flags (NonFungibleTokensV1_1 etc.) — also legal,
+// per xrpl.js `GlobalFlagsInterface` / base transaction semantics.
+const TF_INNER_BATCH = 0x40000000;
+const TF_BATCH = 0x80000000;
+// Combined mask: only tfClawTwoAssets + the two global batch flags are
+// legal. Anything else triggers `temINVALID_FLAG`.
+const LEGAL_AMM_CLAWBACK_FLAGS_MASK = TF_CLAW_TWO_ASSETS | TF_BATCH | TF_INNER_BATCH;
+// Currency codes are either 3 ASCII characters or 40 hex characters.
+const CURRENCY_ASCII_LENGTH = 3;
+const CURRENCY_HEX_LENGTH = 40;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * XRPLNumber: a non-negative base-10 integer string. Matches the policy
+ * used across other factories (ammCreate, vaultClawback, loanSet).
+ */
+function isXrplNumber(value) {
+    return isString(value) && /^[0-9]+$/u.test(value);
+}
+/**
+ * Extract the numeric bitmask from `Flags` regardless of whether the
+ * caller passed a numeric value or a boolean `ClawbackFlagsInterface`.
+ */
+function flagsToNumber(flags) {
+    if (flags === undefined)
+        return 0;
+    if (typeof flags === 'number')
+        return flags;
+    let n = 0;
+    if (flags.tfClawTwoAssets)
+        n |= TF_CLAW_TWO_ASSETS;
+    return n;
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ammClawback(props) {
+    // ── Account ── required, valid XRPL classic / X-address.
+    require(props.Account, 'AMMClawback: Account is required', isAccount);
+    // ── Holder ── required, valid XRPL classic / X-address.
+    require(props.Holder, 'AMMClawback: Holder is required', isAccount);
+    // ── Asset ── required, IOU form (`{ currency, issuer }`).
+    // xrpl.js uses `isIssuedCurrency` which would also accept XRP form,
+    // but per docs (temMALFORMED if Asset is XRP) we explicitly reject it.
+    if (props.Asset === undefined) {
+        throw new ValidationError('AMMClawback: missing field Asset');
+    }
+    if (!isString(props.Asset.currency) ||
+        isString(props.Asset.mpt_issuance_id) ||
+        props.Asset.currency === 'XRP') {
+        throw new ValidationError('AMMClawback: Asset must be an IOU (currency + issuer; NOT XRP, NOT MPT)');
+    }
+    if (!isString(props.Asset.issuer)) {
+        throw new ValidationError('AMMClawback: Asset.issuer is required (Asset must be an IOU)');
+    }
+    // Asset currency shape: 3 ASCII or 40 hex characters.
+    const assetCcy = props.Asset.currency;
+    if (assetCcy.length !== CURRENCY_ASCII_LENGTH &&
+        assetCcy.length !== CURRENCY_HEX_LENGTH) {
+        throw new ValidationError(`AMMClawback: Asset.currency must be ${CURRENCY_ASCII_LENGTH} ASCII characters or ${CURRENCY_HEX_LENGTH} hex characters (actual: ${assetCcy.length})`);
+    }
+    if (assetCcy.length === CURRENCY_HEX_LENGTH && !isHex(assetCcy)) {
+        throw new ValidationError('AMMClawback: Asset.currency (40-char form) must be hex');
+    }
+    // Asset.issuer must be a valid XRPL account.
+    if (!isAccount(props.Asset.issuer)) {
+        throw new ValidationError('AMMClawback: Asset.issuer must be a valid XRPL account address');
+    }
+    // ── Holder ≠ Asset.issuer ── (xrpl.js `validateAMMClawback` lines 86–92).
+    if (props.Holder === props.Asset.issuer) {
+        throw new ValidationError('AMMClawback: Holder and Asset.issuer must be distinct');
+    }
+    // ── Account === Asset.issuer ── (xrpl.js lines 94–98).
+    if (props.Account !== props.Asset.issuer) {
+        throw new ValidationError('AMMClawback: Account must be the same as Asset.issuer');
+    }
+    // ── Asset2 ── required, valid Currency (XRP, IOU, or MPT).
+    if (props.Asset2 === undefined) {
+        throw new ValidationError('AMMClawback: missing field Asset2');
+    }
+    if (!isCurrency(props.Asset2)) {
+        throw new ValidationError('AMMClawback: Asset2 must be a valid Currency (XRP, trust line, or MPT form)');
+    }
+    // ── Amount ── optional; when present, must be an IssuedCurrencyAmount
+    //    (NOT XRP drops string, NOT MPT).
+    if (props.Amount !== undefined) {
+        if (!isIssuedCurrencyAmount(props.Amount)) {
+            throw new ValidationError('AMMClawback: Amount must be an IssuedCurrencyAmount (NOT XRP drops, NOT MPT)');
+        }
+        // Amount.currency === Asset.currency.
+        if (props.Amount.currency !== props.Asset.currency) {
+            throw new ValidationError('AMMClawback: Amount.currency must match Asset.currency');
+        }
+        // Amount.issuer === Asset.issuer.
+        if (props.Amount.issuer !== props.Asset.issuer) {
+            throw new ValidationError('AMMClawback: Amount.issuer must match Asset.issuer');
+        }
+        // Amount sub-field validation (issuer is a valid account).
+        if (!isAccount(props.Amount.issuer)) {
+            throw new ValidationError('AMMClawback: Amount.issuer must be a valid XRPL account address');
+        }
+        // Amount.value must be a positive base-10 integer string.
+        if (!isXrplNumber(props.Amount.value)) {
+            throw new ValidationError('AMMClawback: Amount.value must be a non-negative base-10 integer string');
+        }
+        if (props.Amount.value === '0') {
+            throw new ValidationError('AMMClawback: Amount must be a positive amount (got "0")');
+        }
+    }
+    // ── Flags ── only tfClawTwoAssets (+ global batch flags) are legal.
+    //    (xrpl-dev-portal ammclawback.md "AMMClawback Flags" + temINVALID_FLAG row.)
+    const numericFlags = flagsToNumber(props.Flags);
+    const unknownBits = numericFlags & ~LEGAL_AMM_CLAWBACK_FLAGS_MASK;
+    if (unknownBits !== 0) {
+        throw new ValidationError(`AMMClawback: Flags may only set tfClawTwoAssets (0x${TF_CLAW_TWO_ASSETS.toString(16)}); unknown bit(s): 0x${unknownBits.toString(16)}`);
+    }
+    return buildFrozenTx('AMMClawback', 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 ammClawback(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=amm-clawback.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-clawback.js","sourceRoot":"","sources":["../../../src/fp/factories/amm-clawback.ts"],"names":[],"mappings":"AAqIA,OAAO,EACL,SAAS,EACT,UAAU,EACV,KAAK,EACL,sBAAsB,EACtB,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,8DAA8D;AAC9D,uEAAuE;AACvE,4DAA4D;AAC5D,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAEtC,sEAAsE;AACtE,mEAAmE;AACnE,MAAM,cAAc,GAAG,UAAU,CAAC;AAClC,MAAM,QAAQ,GAAG,UAAU,CAAC;AAE5B,uEAAuE;AACvE,mDAAmD;AACnD,MAAM,6BAA6B,GAAG,kBAAkB,GAAG,QAAQ,GAAG,cAAc,CAAC;AAErF,qEAAqE;AACrE,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAqC/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;;;GAGG;AACH,SAAS,aAAa,CACpB,KAAkD;IAElD,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,eAAe;QAAE,CAAC,IAAI,kBAAkB,CAAC;IACnD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,0DAA0D;IAC1D,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,kCAAkC,EAAE,SAAS,CAAC,CAAC;IAEtE,yDAAyD;IACzD,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,iCAAiC,EAAE,SAAS,CAAC,CAAC;IAEpE,2DAA2D;IAC3D,oEAAoE;IACpE,uEAAuE;IACvE,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CAAC,kCAAkC,CAAC,CAAC;IAChE,CAAC;IACD,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;QAC/B,QAAQ,CAAE,KAAK,CAAC,KAA4C,CAAC,eAAe,CAAC;QAC7E,KAAK,CAAC,KAAK,CAAC,QAAQ,KAAK,KAAK,EAC9B,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,eAAe,CACvB,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,sDAAsD;IACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;IACtC,IACE,QAAQ,CAAC,MAAM,KAAK,qBAAqB;QACzC,QAAQ,CAAC,MAAM,KAAK,mBAAmB,EACvC,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,uCAAuC,qBAAqB,wBAAwB,mBAAmB,4BAA4B,QAAQ,CAAC,MAAM,GAAG,CACtJ,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,KAAK,mBAAmB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,eAAe,CACvB,wDAAwD,CACzD,CAAC;IACJ,CAAC;IACD,6CAA6C;IAC7C,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,eAAe,CACvB,gEAAgE,CACjE,CAAC;IACJ,CAAC;IAED,2EAA2E;IAC3E,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CACvB,uDAAuD,CACxD,CAAC;IACJ,CAAC;IAED,wDAAwD;IACxD,IAAI,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACzC,MAAM,IAAI,eAAe,CACvB,uDAAuD,CACxD,CAAC;IACJ,CAAC;IAED,4DAA4D;IAC5D,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,mCAAmC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,eAAe,CACvB,6EAA6E,CAC9E,CAAC;IACJ,CAAC;IAED,uEAAuE;IACvE,sCAAsC;IACtC,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,eAAe,CACvB,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,sCAAsC;QACtC,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnD,MAAM,IAAI,eAAe,CACvB,wDAAwD,CACzD,CAAC;QACJ,CAAC;QACD,kCAAkC;QAClC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC/C,MAAM,IAAI,eAAe,CACvB,oDAAoD,CACrD,CAAC;QACJ,CAAC;QACD,2DAA2D;QAC3D,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,eAAe,CACvB,iEAAiE,CAClE,CAAC;QACJ,CAAC;QACD,0DAA0D;QAC1D,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,KAAK,GAAG,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,yDAAyD,CAC1D,CAAC;QACJ,CAAC;IACH,CAAC;IAED,qEAAqE;IACrE,iFAAiF;IACjF,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,YAAY,GAAG,CAAC,6BAA6B,CAAC;IAClE,IAAI,WAAW,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,eAAe,CACvB,sDAAsD,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,wBAAwB,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CACxI,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/amm-create.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Functional AMMCreate factory — frozen-object style.
+ *
+ * Creates a new Automated Market Maker (AMM) instance for trading a pair
+ * of assets (XRP, IOU, or MPT). The class-based equivalent requires a
+ * separate `.validate()` call after construction; this factory validates
+ * at construction so an invalid tx can never exist.
+ *
+ *   import { ammCreate } from 'xrplt/fp';
+ *   const tx = ammCreate({ Account, Amount, Amount2, TradingFee });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ TradingFee: 250 });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ammcreate
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/AMMCreate.ts
+ * @see XLS-0030 §2.2 (https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0030-automated-market-maker)
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/amm-create.ts`, this factory adds
+ * guards the class skips:
+ *
+ * - **Account must be a valid XRPL classic (or X-) address**. The class
+ *   inherits only `validateBaseTransaction`'s `isString(Account)` check.
+ *   - Source: xrpl-dev-portal basic-data-types (AccountID is a classic
+ *     address or X-address).
+ *
+ * - **Each Amount must be strictly positive** (per the docs: "This must
+ *   be a positive amount"). The class only checks shape via `isAmount`,
+ *   which does not check numeric well-formedness or sign.
+ *   - Source: xrpl-dev-portal ammcreate.md, Fields table — `Amount` and
+ *     `Amount2` rows, both Description columns end with "This must be a
+ *     positive amount."
+ *   - Source: XLS-0030 §2.2.1 (both Amount and Amount2 are required
+ *     currency amounts that must be positive).
+ *
+ * - **Amount `value` must be a non-negative base-10 integer string** (the
+ *   canonical XRPL Number representation). The class does not check this.
+ *   - Source: xrpl.org generic Amount spec
+ *     (https://xrpl.org/docs/references/protocol/data-types/basic-data-types#specifying-currency-amounts).
+ *
+ * - **IssuedCurrencyAmount `currency` and `issuer` shape are validated**
+ *   (3-char ASCII or 40-char hex `currency`; `issuer` must be a valid
+ *   XRPL account). The class delegates to `isAmount`, which only checks
+ *   that the keys exist as strings.
+ *   - Source: xrpl-dev-portal basic-data-types#specifying-currency-amounts.
+ *
+ * - **MPTAmount `mpt_issuance_id` must be a 24–48-character hex string**
+ *   (192-bit issuance ID, hex-encoded). The class only checks key
+ *   presence.
+ *   - Source: XLS-0033 Multi-Purpose Tokens (mpt_issuance_id is a 192-bit
+ *     uint; we accept 24–48 hex chars to leave slack for future
+ *     widenings / leading-zero encoders).
+ *
+ * - **TradingFee must be an integer** (XLS-0030 §2.2.1 declares the
+ *   internal type as `UINT16`). The class accepts any number ≤ 1000,
+ *   including 1.5, etc.
+ *   - Source: XLS-0030 §2.2.1, Fields table, `TradingFee` row, Internal
+ *     Type = `UINT16`.
+ *
+ * - **At most one of Amount and Amount2 can be XRP**. The class does not
+ *   enforce this cross-field invariant.
+ *   - Source: xrpl-dev-portal ammcreate.md prose line immediately after
+ *     the Fields table: "at most one of them can be XRP."
+ */
+import type { Amount } from '../../types/amounts.js';
+export interface AmmCreateProps {
+    /** The unique address of the transaction sender (LP / pool creator). */
+    Account: string;
+    /** The first of the two assets to fund this AMM with (positive). */
+    Amount: Amount;
+    /** The second of the two assets to fund this AMM with (positive). */
+    Amount2: Amount;
+    /**
+     * The fee to charge for trades against this AMM, in 1/100,000 units
+     * (1 = 0.001%). Must be in [0, 1000] inclusive. UINT16 integer.
+     */
+    TradingFee: number;
+    /** Bit-flags for this transaction (AMMCreate defines no flags). */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface AmmCreate extends Readonly<AmmCreateProps> {
+    readonly TransactionType: 'AMMCreate';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AmmCreateProps>): AmmCreate;
+}
+export declare function ammCreate(props: AmmCreateProps): AmmCreate;
+//# sourceMappingURL=amm-create.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"amm-create.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/amm-create.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AA+BrD,MAAM,WAAW,cAAc;IAC7B,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,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;AAoHD,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,CAyD1D"}

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

@@ -0,0 +1,140 @@
+import { isAccount, isAmount, isHex, isIssuedCurrencyAmount, isMPTAmount, isNumber, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// TradingFee is a UINT16 with a ledger-enforced range of 0–1000
+// (0%–1%). (XLS-0030 §2.2.1; xrpl.js AMM_MAX_TRADING_FEE.)
+const AMM_MAX_TRADING_FEE = 1000;
+// Currency codes are either 3 ASCII characters or 40 hex characters.
+const CURRENCY_ASCII_LENGTH = 3;
+const CURRENCY_HEX_LENGTH = 40;
+// MPT issuance IDs are 192-bit, hex-encoded (≤ 48 chars). We accept
+// 24–48 to leave slack for future widenings / leading-zero encoders.
+// (XLS-0033; matches the policy used by vaultClawback.)
+const MPT_ISSUANCE_ID_MIN = 24;
+const MPT_ISSUANCE_ID_MAX = 48;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * XRPLNumber: a non-negative base-10 integer string. Matches the policy
+ * used across other factories (loanSet, vaultCreate, vaultClawback).
+ */
+function isXrplNumber(value) {
+    return isString(value) && /^[0-9]+$/u.test(value);
+}
+/**
+ * Deep-validate an Amount that must be strictly > 0 (used for
+ * AMMCreate.Amount and Amount2).
+ *
+ * Performs:
+ *  - shape check via `isAmount`
+ *  - for IOU: currency length / hex check, issuer is a valid account,
+ *    value is a positive base-10 integer string (rejects 0 and "-1")
+ *  - for MPT: mpt_issuance_id length / hex check, value is a positive
+ *    base-10 integer string
+ *  - for XRP string: must be a positive base-10 integer string
+ */
+function validatePositiveAmount(amount, path) {
+    if (!isAmount(amount)) {
+        throw new ValidationError(`AMMCreate: ${path} must be a valid Amount (XRP string, IOU, or MPT form)`);
+    }
+    // XRP path: positive base-10 integer string.
+    if (isString(amount)) {
+        if (!isXrplNumber(amount)) {
+            throw new ValidationError(`AMMCreate: ${path} (XRP) must be a non-negative base-10 integer string`);
+        }
+        if (amount === '0') {
+            throw new ValidationError(`AMMCreate: ${path} must be a positive amount (got "0")`);
+        }
+        return;
+    }
+    // IOU path.
+    if (isIssuedCurrencyAmount(amount)) {
+        // currency length
+        const ccy = amount.currency;
+        if (ccy.length !== CURRENCY_ASCII_LENGTH &&
+            ccy.length !== CURRENCY_HEX_LENGTH) {
+            throw new ValidationError(`AMMCreate: ${path}.currency must be ${CURRENCY_ASCII_LENGTH} ASCII characters or ${CURRENCY_HEX_LENGTH} hex characters (actual: ${ccy.length})`);
+        }
+        if (ccy.length === CURRENCY_HEX_LENGTH && !isHex(ccy)) {
+            throw new ValidationError(`AMMCreate: ${path}.currency (40-char form) must be hex`);
+        }
+        // issuer
+        if (!isAccount(amount.issuer)) {
+            throw new ValidationError(`AMMCreate: ${path}.issuer must be a valid XRPL account address`);
+        }
+        // value: positive base-10 integer string
+        if (!isXrplNumber(amount.value)) {
+            throw new ValidationError(`AMMCreate: ${path}.value must be a non-negative base-10 integer string`);
+        }
+        if (amount.value === '0') {
+            throw new ValidationError(`AMMCreate: ${path} must be a positive amount (got "0")`);
+        }
+        return;
+    }
+    // MPT path.
+    if (isMPTAmount(amount)) {
+        const mptid = amount.mpt_issuance_id;
+        if (mptid.length < MPT_ISSUANCE_ID_MIN ||
+            mptid.length > MPT_ISSUANCE_ID_MAX ||
+            !isHex(mptid)) {
+            throw new ValidationError(`AMMCreate: ${path}.mpt_issuance_id must be a ${MPT_ISSUANCE_ID_MIN}-${MPT_ISSUANCE_ID_MAX} character hex string`);
+        }
+        if (!isXrplNumber(amount.value)) {
+            throw new ValidationError(`AMMCreate: ${path}.value must be a non-negative base-10 integer string`);
+        }
+        if (amount.value === '0') {
+            throw new ValidationError(`AMMCreate: ${path} must be a positive amount (got "0")`);
+        }
+        return;
+    }
+    // isAmount returned true but we didn't classify it — defensive.
+    throw new ValidationError(`AMMCreate: ${path} must be a valid Amount (XRP string, IOU, or MPT form)`);
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ammCreate(props) {
+    // ── Account ── required, must be a valid XRPL classic / X-address.
+    require(props.Account, 'AMMCreate: Account is required', isAccount);
+    // ── Amount / Amount2 ── required, must be a strictly positive Amount.
+    validatePositiveAmount(props.Amount, 'Amount');
+    validatePositiveAmount(props.Amount2, 'Amount2');
+    // ── TradingFee ── required, integer, 0–1000 inclusive.
+    if (props.TradingFee === undefined || props.TradingFee === null) {
+        throw new ValidationError('AMMCreate: TradingFee is required');
+    }
+    if (!isNumber(props.TradingFee)) {
+        throw new ValidationError('AMMCreate: TradingFee must be a number');
+    }
+    if (!Number.isInteger(props.TradingFee)) {
+        throw new ValidationError('AMMCreate: TradingFee must be an integer (UINT16)');
+    }
+    if (props.TradingFee < 0 || props.TradingFee > AMM_MAX_TRADING_FEE) {
+        throw new ValidationError(`AMMCreate: TradingFee must be between 0 and ${AMM_MAX_TRADING_FEE} inclusive (got ${props.TradingFee})`);
+    }
+    // ── Cross-field: at most one of Amount / Amount2 may be XRP.
+    // (xrpl-dev-portal ammcreate.md prose line: "at most one of them can be XRP.")
+    const a1IsXrp = isString(props.Amount);
+    const a2IsXrp = isString(props.Amount2);
+    if (a1IsXrp && a2IsXrp) {
+        throw new ValidationError('AMMCreate: at most one of Amount and Amount2 can be XRP');
+    }
+    return buildFrozenTx('AMMCreate', 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 ammCreate(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=amm-create.js.map