xrpjson 0.1.0

package/dist/fp/factories/nftoken-modify.js

@@ -0,0 +1,209 @@
+/**
+ * Functional NFTokenModify factory — frozen-object style.
+ *
+ * Modifies an existing dynamic NFToken (one minted with the `tfMutable`
+ * flag enabled, per XLS-46). Currently the only mutable field is `URI`.
+ * Validation happens at construction; there is no way to construct an
+ * invalid tx.
+ *
+ *   import { nftokenModify } from 'xrplt/fp';
+ *   const tx = nftokenModify({ Account, NFTokenID });
+ *   const tx2 = nftokenModify({
+ *     Account, NFTokenID,
+ *     URI: '697066733A2F2F62616679',
+ *     Owner: 'rogue5HnPRSszD9CWGSUz8UGHMVwSSKF6',
+ *   });
+ *   const j = tx2.toJSON();
+ *   const tx3 = tx2.with({ URI: '6F746865726D657461' });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/nftokenmodify
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/NFTokenModify.ts
+ * @see XLS-0046 (Dynamic Non-Fungible Tokens) §3.2
+ *     (`~/.mavis/docs.local/xrpl-standards/repo/XLS-0046-dynamic-non-fungible-tokens/README.md`
+ *     lines 49–95)
+ *
+ * Affected amendments:
+ *   - `DynamicNFT` — required for the transaction to be accepted.
+ *   - `NonFungibleTokensV1` (XLS-20) — base NFToken support.
+ *   - `NonFungibleTokensV1_1` — adds the optional `Owner` field.
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/nftoken-modify.ts`, this factory adds
+ * guards the class skips (or that xrpl.js / xrpl.org / XLS-46 mandate
+ * but the class omits):
+ *
+ * - **`NFTokenID` must be a 64-character hexadecimal string** — XLS-46
+ *   §3.2 line 69 declares `NFTokenID` as `UINT256`. xrpl.org
+ *   `nftokenmodify.md` line 37 labels it "String - Hexadecimal" with
+ *   internal type `UInt256`. A UInt256 in hex is 64 characters.
+ *   xrpl.js's `validateNFTokenModify` (line 55) only checks `isString`,
+ *   and the class inherits the same laxness. The factory enforces the
+ *   on-ledger shape.
+ *   - Source: XLS-46 §3.2 line 69 (`UINT256`).
+ *   - Source: xrpl.org `nftokenmodify.md` line 37 (UInt256, String -
+ *     Hexadecimal).
+ *   - Cross-ref: rippled parses `NFTokenID` as `HASH256` via
+ *     `NFTokenModify.cpp`; HASH256 is 32 bytes = 64 hex chars.
+ *
+ * - **All-zero `NFTokenID` is rejected** — HASH256 zero is malformed
+ *   by general convention. The class permits `'00…00'` because any
+ *   64-char hex passes `isString` + length check. The decoded
+ *   NFTokenID contains a 160-bit account ID in bytes [8, 48); an
+ *   all-zero ID cannot encode a valid account, so a real modify
+ *   against the zero NFTokenID would be rejected on-ledger as
+ *   `temMALFORMED`. We catch it at construction.
+ *   - Source: HASH256 convention (analogous to VaultID, LoanID,
+ *     LoanBrokerID, NFTokenBurn.NFTokenID all-zeros rejection across
+ *     this codebase; see `src/fp/factories/nftoken-burn.ts`).
+ *
+ * - **`URI` must be hex-encoded** — XLS-46 §3.2 line 76 declares `URI`
+ *   as `BLOB`. xrpl.js's `validateNFTokenModify` (lines 59–65) checks
+ *   `isHex` when URI is a non-empty string. The class accepts any
+ *   string. We enforce hex at construction.
+ *   - Source: XLS-46 §3.2 line 76 (`BLOB`).
+ *   - Source: xrpl.js `NFTokenModify.ts` lines 59–65.
+ *   - Source: xrpl.org `nftokenmodify.md` line 38 ("In JSON, this
+ *     should be encoded as a string of hexadecimal").
+ *
+ * - **`URI` must not be an empty string** — xrpl.js
+ *   `validateNFTokenModify` (lines 60–62) rejects `''`. xrpl.org
+ *   `nftokenmodify.md` line 38 documents that omitting the field
+ *   deletes any existing URI, but setting it to `""` is distinct from
+ *   omitting it. The class accepts `''`. We mirror xrpl.js.
+ *   - Source: xrpl.js `NFTokenModify.ts` lines 60–62.
+ *   - Source: xrpl.org `nftokenmodify.md` line 38 ("Omit it from the
+ *     transaction… if you do not use it" — i.e., `""` ≠ omitted).
+ *
+ * - **`URI` length capped at 256 bytes (512 hex chars)** — xrpl.org
+ *   `nftokenmodify.md` line 38 states "Up to 256 bytes of arbitrary
+ *   data." XLS-46 §3.2 line 76 declares the type as `BLOB` with no
+ *   explicit limit, but the on-ledger cap matches XLS-20 §1.3.3
+ *   (`NFTokenMint.URI` is also limited to 256 bytes). The class does
+ *   not enforce this. The factory enforces 256 bytes (512 hex chars)
+ *   and also rejects odd-length hex so byte-alignment is preserved.
+ *   - Source: xrpl.org `nftokenmodify.md` line 38 ("limited to a
+ *     maximum length of 256 bytes" — same wording as nftokenmint.md
+ *     line 53).
+ *   - Cross-ref: XLS-20 §1.3.3 line 134 (256-byte BLOB cap applied to
+ *     NFTokenMint.URI; NFTokenModify reuses the same wire field).
+ *
+ * - **`Owner` must not equal `Account`** — XLS-46 §3.2 line 59 says
+ *   "in case of `Owner` not specified, it's implied that the
+ *   submitting `account` is also the `Owner` of the NFT." xrpl.org
+ *   `nftokenmodify.md` line 36 says "If the `Account` and `Owner` are
+ *   the same address, omit this field." Including `Owner: Account` is
+ *   therefore redundant and confusing; xrpl.js does not enforce it
+ *   (passes through `validateOptionalField(tx, 'Owner', isAccount)`),
+ *   and the class does not enforce it either. We reject it for
+ *   clarity — this also catches the common "I forgot to omit Owner"
+ *   bug at construction time.
+ *   - Source: xrpl.org `nftokenmodify.md` line 36 ("If the `Account`
+ *     and `Owner` are the same address, omit this field").
+ *   - Source: XLS-46 §3.2 line 59.
+ *
+ * - **`URI` omitted is permitted (deletes existing URI)** — xrpl.org
+ *   `nftokenmodify.md` line 38 documents that omitting URI deletes any
+ *   existing URI on the token. The class permits this by leaving
+ *   `this.URI` undefined. We mirror the permissive behavior — there is
+ *   no cross-field rule binding URI to other fields, and the field is
+ *   genuinely optional in the protocol sense.
+ *   - Source: xrpl.org `nftokenmodify.md` line 38 ("If you do not
+ *     specify a URI, the existing URI is deleted").
+ *
+ * - **`Flags` accepted for parity with the base transaction shape** —
+ *   NFTokenModify itself defines no transaction-specific flags; only
+ *   `tfFullyCanonicalSig` (global) is normally meaningful. The class
+ *   does not declare a Flags field. We accept a numeric bitmask for
+ *   parity with the base tx shape (matches `nftoken-burn.ts` pattern).
+ *   This is a permissive addition, not a tightening; callers who pass
+ *   a non-zero Flags get the value stored verbatim. (Divergence is
+ *   documented for awareness; no spec source requires flag rejection
+ *   for NFTokenModify.)
+ */
+import { isAccount, isHex, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// HASH256 (UInt256) in hex is 64 characters. XLS-46 §3.2 line 69:
+// NFTokenID internal type is UINT256; xrpl.org nftokenmodify.md
+// confirms UInt256.
+const NFTOKEN_ID_HEX_LENGTH = 64;
+// All-zero HASH256 is reserved / malformed by general convention.
+const NFTOKEN_ID_ZERO = '0'.repeat(NFTOKEN_ID_HEX_LENGTH);
+// XLS-46 §3.2 line 76 / xrpl.org nftokenmodify.md line 38: URI is a BLOB
+// with max 256 bytes.
+const MAX_URI_BYTES = 256;
+const MAX_URI_HEX_CHARS = MAX_URI_BYTES * 2;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function nftokenModify(props) {
+    // ── Account ── required, must be a valid XRPL account.
+    require(props.Account, 'NFTokenModify: Account is required', isAccount);
+    // ── NFTokenID ── required, 64-char hex (HASH256 / UInt256),
+    //                 and not all-zero.
+    if (!isString(props.NFTokenID)) {
+        throw new ValidationError('NFTokenModify: NFTokenID is required and must be a string');
+    }
+    if (!isHex(props.NFTokenID)) {
+        throw new ValidationError('NFTokenModify: NFTokenID must be a hex-encoded string');
+    }
+    if (props.NFTokenID.length !== NFTOKEN_ID_HEX_LENGTH) {
+        throw new ValidationError(`NFTokenModify: NFTokenID must be exactly ${NFTOKEN_ID_HEX_LENGTH} hex characters (HASH256)`);
+    }
+    if (props.NFTokenID === NFTOKEN_ID_ZERO) {
+        throw new ValidationError('NFTokenModify: NFTokenID must not be the all-zero HASH256 value');
+    }
+    // ── URI ── optional, non-empty hex, even length, ≤ 256 bytes
+    //          (512 hex chars). Odd-length hex is invalid by the BLOB
+    //          spec; omitting URI is permitted (deletes existing URI on
+    //          the token).
+    if (props.URI !== undefined) {
+        if (!isString(props.URI)) {
+            throw new ValidationError('NFTokenModify: URI must be a hex-encoded string');
+        }
+        if (props.URI.length === 0) {
+            throw new ValidationError('NFTokenModify: URI must not be an empty string');
+        }
+        if (!isHex(props.URI)) {
+            throw new ValidationError('NFTokenModify: URI must be a hex-encoded string');
+        }
+        if (props.URI.length % 2 !== 0) {
+            throw new ValidationError('NFTokenModify: URI must have an even number of hex characters (BLOB is byte-aligned)');
+        }
+        if (props.URI.length > MAX_URI_HEX_CHARS) {
+            throw new ValidationError(`NFTokenModify: URI exceeds ${MAX_URI_BYTES} bytes (${MAX_URI_HEX_CHARS} hex chars); actual: ${props.URI.length}`);
+        }
+    }
+    // ── Owner ── optional, must be a valid XRPL account when present,
+    //             and must NOT equal Account (xrpl.org nftokenmodify.md
+    //             line 36: "If the `Account` and `Owner` are the same
+    //             address, omit this field").
+    if (props.Owner !== undefined) {
+        if (!isAccount(props.Owner)) {
+            throw new ValidationError('NFTokenModify: Owner must be a valid XRPL account address');
+        }
+        if (props.Owner === props.Account) {
+            throw new ValidationError('NFTokenModify: Owner must not equal Account (omit Owner instead; xrpl.org nftokenmodify.md)');
+        }
+    }
+    return buildFrozenTx('NFTokenModify', 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 nftokenModify(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=nftoken-modify.js.map

package/dist/fp/factories/nftoken-modify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nftoken-modify.js","sourceRoot":"","sources":["../../../src/fp/factories/nftoken-modify.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0HG;AACH,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,kEAAkE;AAClE,gEAAgE;AAChE,oBAAoB;AACpB,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,kEAAkE;AAClE,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAC1D,yEAAyE;AACzE,sBAAsB;AACtB,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,iBAAiB,GAAG,aAAa,GAAG,CAAC,CAAC;AAiC5C,wEAAwE;AAExE,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,wDAAwD;IACxD,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,oCAAoC,EAAE,SAAS,CAAC,CAAC;IAExE,6DAA6D;IAC7D,oCAAoC;IACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CACvB,2DAA2D,CAC5D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,eAAe,CACvB,uDAAuD,CACxD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,qBAAqB,EAAE,CAAC;QACrD,MAAM,IAAI,eAAe,CACvB,4CAA4C,qBAAqB,2BAA2B,CAC7F,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,KAAK,eAAe,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CACvB,iEAAiE,CAClE,CAAC;IACJ,CAAC;IAED,8DAA8D;IAC9D,kEAAkE;IAClE,oEAAoE;IACpE,uBAAuB;IACvB,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,eAAe,CACvB,iDAAiD,CAClD,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,eAAe,CACvB,gDAAgD,CACjD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,eAAe,CACvB,iDAAiD,CAClD,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,sFAAsF,CACvF,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,GAAG,iBAAiB,EAAE,CAAC;YACzC,MAAM,IAAI,eAAe,CACvB,8BAA8B,aAAa,WAAW,iBAAiB,wBAAwB,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAClH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,mEAAmE;IACnE,oEAAoE;IACpE,kEAAkE;IAClE,0CAA0C;IAC1C,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,eAAe,CACvB,2DAA2D,CAC5D,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YAClC,MAAM,IAAI,eAAe,CACvB,6FAA6F,CAC9F,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,eAAe,EACf,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAsB,SAAsC;YAC9D,OAAO,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACtD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,21 @@
+export interface OfferCancelProps {
+    /** The unique address of the transaction sender (the offer owner). */
+    Account: string;
+    /**
+     * The sequence number (or Ticket number) of a previous OfferCreate
+     * transaction. If specified, cancel any offer object in the ledger
+     * that was created by that transaction. It is not considered an
+     * error if the offer specified does not exist.
+     */
+    OfferSequence: number;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface OfferCancel extends Readonly<OfferCancelProps> {
+    readonly TransactionType: 'OfferCancel';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<OfferCancelProps>): OfferCancel;
+}
+export declare function offerCancel(props: OfferCancelProps): OfferCancel;
+//# sourceMappingURL=offer-cancel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"offer-cancel.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/offer-cancel.ts"],"names":[],"mappings":"AA8DA,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,WACf,SAAQ,QAAQ,CAAC,gBAAgB,CAAC;IAClC,QAAQ,CAAC,eAAe,EAAE,aAAa,CAAC;IACxC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,CAAC;CACzD;AAID,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CAsDhE"}

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

@@ -0,0 +1,99 @@
+/**
+ * Functional OfferCancel factory — frozen-object style.
+ *
+ * Cancels an existing offer on the DEX. Validation happens at
+ * construction; there is no way to construct an invalid tx.
+ *
+ *   import { offerCancel } from 'xrplt/fp';
+ *   const tx = offerCancel({ Account, OfferSequence: 6 });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ OfferSequence: 7 });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/offercancel
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/offerCancel.ts
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/offer-cancel.ts`, this factory adds
+ * guards the class skips and tightens the spec compliance:
+ *
+ * - **`OfferSequence` must be a UInt32.** The class only checks
+ *   `isNumber(this.OfferSequence)`, which accepts any JS number —
+ *   including negative numbers, NaN, Infinity, and non-integers, and
+ *   values larger than `2^32 - 1`. rippled rejects these with
+ *   `temMALFORMED` ("Unspecified problem with the format of the
+ *   transaction"). The factory additionally requires an integer in
+ *   `[0, 0xffffffff]`.
+ *   - Source: xrpl-dev-portal `offercancel.md` Fields table
+ *     `OfferSequence | Number | UInt32`.
+ *   - Source: xrpl.js `validateOfferCancel` (`offerCancel.ts` line 34)
+ *     checks `typeof tx.OfferSequence === 'number'` only.
+ *
+ * - **`OfferSequence` may not equal the transaction's own `Sequence`.**
+ *   rippled rejects this with `temBAD_SEQUENCE` ("The transaction is
+ *   references a sequence number that is higher than its own `Sequence`
+ *   number"). A cancel that targets its own slot is meaningless and
+ *   spec-illegal. The class skips this cross-field invariant entirely.
+ *   - Source: xrpl-dev-portal `offercancel.md` (implicit via
+ *     OfferSequence's role as a previous-tx reference).
+ *   - Source: xrpl-dev-portal `tem-codes.md` row `temBAD_SEQUENCE`
+ *     ("trying to cancel an offer that would have to be placed after
+ *     the transaction that cancels it").
+ *
+ * - **`Account` must be a valid XRPL classic or X-address.** The class
+ *   inherits only `validateBaseTransaction`'s `isString(Account)` check
+ *   (or none at all, since `OfferTransaction` itself is empty). The
+ *   factory uses `isAccount` so an obvious typo (e.g. `"r…"`) is caught
+ *   at construction.
+ *   - Source: xrpl-dev-portal basic-data-types.md (`AccountID` is a
+ *     classic address or X-address).
+ */
+import { isAccount, isNumber } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// UInt32 bounds (per xrpl-dev-portal offercancel.md Fields table).
+const UINT32_MIN = 0;
+const UINT32_MAX = 0xffffffff;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function offerCancel(props) {
+    // ── Account ── required, must be a valid XRPL classic / X-address.
+    require(props.Account, 'OfferCancel: Account is required', isAccount);
+    // ── OfferSequence ── required, must be an integer in [0, 0xffffffff].
+    if (!isNumber(props.OfferSequence)) {
+        throw new ValidationError('OfferCancel: missing or invalid OfferSequence');
+    }
+    if (!Number.isInteger(props.OfferSequence) ||
+        props.OfferSequence < UINT32_MIN ||
+        props.OfferSequence > UINT32_MAX) {
+        throw new ValidationError(`OfferCancel: OfferSequence must be a UInt32 in [${UINT32_MIN}, ${UINT32_MAX}]`);
+    }
+    // ── Cross-field: OfferSequence may not equal the tx's own Sequence.
+    // (xrpl-dev-portal tem-codes.md temBAD_SEQUENCE row.)
+    if (props.Sequence !== undefined &&
+        isNumber(props.Sequence) &&
+        Number.isInteger(props.Sequence) &&
+        props.OfferSequence === props.Sequence) {
+        throw new ValidationError('OfferCancel: OfferSequence must not equal the transaction Sequence (temBAD_SEQUENCE)');
+    }
+    return buildFrozenTx('OfferCancel', 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 offerCancel(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=offer-cancel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"offer-cancel.js","sourceRoot":"","sources":["../../../src/fp/factories/offer-cancel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,mEAAmE;AACnE,MAAM,UAAU,GAAG,CAAC,CAAC;AACrB,MAAM,UAAU,GAAG,UAAU,CAAC;AA0B9B,wEAAwE;AAExE,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,oEAAoE;IACpE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,kCAAkC,EAAE,SAAS,CAAC,CAAC;IAEtE,uEAAuE;IACvE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,eAAe,CACvB,+CAA+C,CAChD,CAAC;IACJ,CAAC;IACD,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC;QACtC,KAAK,CAAC,aAAa,GAAG,UAAU;QAChC,KAAK,CAAC,aAAa,GAAG,UAAU,EAChC,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,mDAAmD,UAAU,KAAK,UAAU,GAAG,CAChF,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,sDAAsD;IACtD,IACE,KAAK,CAAC,QAAQ,KAAK,SAAS;QAC5B,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QACxB,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;QAChC,KAAK,CAAC,aAAa,KAAK,KAAK,CAAC,QAAQ,EACtC,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,sFAAsF,CACvF,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/offer-create.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Functional OfferCreate factory — frozen-object style.
+ *
+ * Places an offer on the Decentralized Exchange (DEX). The class-based
+ * equivalent requires a separate `.validate()` call after construction;
+ * this factory validates at construction so an invalid tx can never exist.
+ *
+ *   import { offerCreate } from 'xrplt/fp';
+ *   const tx = offerCreate({ Account, TakerGets: '1000000', TakerPays: { … } });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Expiration: 770000000 });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/offercreate
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/offerCreate.ts
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/offer-create.ts`, this factory adds
+ * guards the class skips and fixes a flag-value bug:
+ *
+ * - **The class hard-codes `tfHybrid = 0x00400000` in `validate()` but
+ *   the spec value is `0x00100000`.** The class therefore fails to detect
+ *   tfHybrid offers that use the correct bit and (worse) would falsely
+ *   pass the tfHybrid-without-DomainID guard for an invalid-bit tx.
+ *   The factory uses `0x00100000` directly so it matches the canonical
+ *   spec.
+ *   - Source: xrpl.js `OfferCreateFlags.tfHybrid = 0x00100000`
+ *     (xrpl.js repo packages/xrpl/src/models/transactions/offerCreate.ts
+ *     line 52) and the canonical XRPL definitions table
+ *     (xrpl.js repo packages/ripple-binary-codec/src/enums/definitions.json
+ *     line 5275: `"tfHybrid": 1048576` = `0x00100000`).
+ *   - Source: xrpl-dev-portal `offercreate.md` flag table
+ *     `tfHybrid | 0x00100000 | 1048576`.
+ *
+ * - **`tfImmediateOrCancel` and `tfFillOrKill` are mutually exclusive.**
+ *   The class doesn't check this — only the single-flag `tfHybrid`
+ *   guard. Both flags are uint32 values; their bits overlap with
+ *   nothing else, but rippled rejects the combination with
+ *   `temINVALID_FLAG` ("such as both `tfImmediateOrCancel` and
+ *   `tfFillOrKill`").
+ *   - Source: xrpl-dev-portal `offercreate.md` Error Cases row
+ *     `temINVALID_FLAG`: "The transaction specifies an invalid flag
+ *     combination, such as both `tfImmediateOrCancel` and `tfFillOrKill`."
+ *
+ * - **Both `TakerGets` and `TakerPays` must be strictly positive amounts.**
+ *   The class only checks shape via `isAmount`, which allows the XRP
+ *   string `"0"` and any numeric string for IOU/MPT `value`. rippled
+ *   rejects negative or zero amounts with `temBAD_OFFER` ("The offer
+ *   tries to trade XRP for XRP, or tries to trade an invalid or negative
+ *   amount of a token"). The factory performs the same positive-value
+ *   check used by `ammCreate` for `Amount`/`Amount2`.
+ *   - Source: xrpl-dev-portal `offercreate.md` Error Cases
+ *     `temBAD_OFFER` row.
+ *
+ * - **`TakerGets` and `TakerPays` may not be the same currency (same
+ *   issuer + currency code, or both XRP).** This catches both the
+ *   XRP-for-XRP case (`temBAD_OFFER`) and the IOU-for-same-IOU case
+ *   (`temREDUNDANT`). The class skips this cross-field invariant entirely.
+ *   - Source: xrpl-dev-portal `offercreate.md` Error Cases
+ *     `temBAD_OFFER` row ("The offer tries to trade XRP for XRP") and
+ *     `temREDUNDANT` row ("The transaction would trade a token for the
+ *     same token (same issuer and currency code)").
+ *
+ * - **`Account` must be a valid XRPL classic or X-address.** The class
+ *   inherits only `validateBaseTransaction`'s `isString(Account)` check,
+ *   which accepts any string. The factory uses `isAccount` so an
+ *   obvious typo (e.g. `"r…"`) is caught at construction.
+ *   - Source: xrpl-dev-portal basic-data-types.md (`AccountID` is a
+ *     classic address or X-address).
+ *
+ * - **`Expiration` must be a UInt32.** The class accepts any number via
+ *   `super.validate()` (none) — i.e. no check at all. The factory checks
+ *   that, when present, the value is an integer in `[0, 0xffffffff]`.
+ *   - Source: xrpl-dev-portal `offercreate.md` Fields table
+ *     `Expiration | Number | UInt32`.
+ *
+ * - **`OfferSequence` must be a UInt32.** Same rationale as `Expiration`.
+ *   The factory additionally rejects `OfferSequence > Sequence` here
+ *   only when `Sequence` is also provided, per
+ *   `temBAD_SEQUENCE` ("the `OfferSequence` ... is higher than the
+ *   transaction's own `Sequence` number").
+ *   - Source: xrpl-dev-portal `offercreate.md` Fields table
+ *     `OfferSequence | Number | UInt32`; Error Cases `temBAD_SEQUENCE`.
+ *
+ * - **`IssuedCurrencyAmount` shape is validated** (currency length /
+ *   hex, issuer must be a valid account, value must be a positive
+ *   XRPLNumber). The class delegates to `isAmount`, which only checks
+ *   key presence.
+ *   - Source: xrpl-dev-portal basic-data-types.md
+ *     `#specifying-currency-amounts`.
+ *
+ * - **`MPTAmount.mpt_issuance_id` must be 24–48 hex characters.** The
+ *   class only checks key presence via `isAmount`.
+ *   - Source: XLS-0033 Multi-Purpose Tokens (192-bit issuance ID,
+ *     hex-encoded; the 24–48 char window matches the policy used by
+ *     `ammCreate` and `vaultClawback`).
+ */
+import type { Amount } from '../../types/amounts.js';
+import type { OfferCreateFlagsInterface } from '../../types/flags.js';
+export interface OfferCreateProps {
+    /** The unique address of the transaction sender (the offer creator). */
+    Account: string;
+    /** The amount and type of currency being sold by the offer creator. */
+    TakerGets: Amount;
+    /** The amount and type of currency being bought by the offer creator. */
+    TakerPays: Amount;
+    /** Time after which the offer is no longer active (UInt32, seconds since the Ripple Epoch). */
+    Expiration?: number | undefined;
+    /** An Offer to delete first, specified the same way as OfferCancel. */
+    OfferSequence?: number | undefined;
+    /** Permissioned Domain ID (64-char hex). Required when tfHybrid is set. */
+    DomainID?: string | undefined;
+    /** Bit-flags for this transaction. */
+    Flags?: number | OfferCreateFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface OfferCreate extends Readonly<OfferCreateProps> {
+    readonly TransactionType: 'OfferCreate';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<OfferCreateProps>): OfferCreate;
+}
+export declare function offerCreate(props: OfferCreateProps): OfferCreate;
+//# sourceMappingURL=offer-create.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"offer-create.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/offer-create.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgGG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AA4CtE,MAAM,WAAW,gBAAgB;IAC/B,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;IAClB,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;IAClB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAC;IACvD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,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;AA2KD,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,WAAW,CA8HhE"}