xrpjson 0.1.0

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

@@ -0,0 +1,125 @@
+/**
+ * Functional NFTokenBurn factory — frozen-object style.
+ *
+ * Permanently removes an NFToken object from its NFTokenPage. Validation
+ * happens at construction; there is no way to construct an invalid tx.
+ *
+ *   import { nftokenBurn } from 'xrplt/fp';
+ *   const tx = nftokenBurn({ Account, NFTokenID });
+ *   const j = tx.toJSON();
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/nftokenburn
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/NFTokenBurn.ts
+ * @see XLS-0020 (Non-Fungible Tokens) §1.5.5
+ *
+ * Affected amendments:
+ *   - `NonFungibleTokensV1`   — base NFTokenBurn.
+ *   - `NonFungibleTokensV1_1` — adds the optional `Owner` field for
+ *                               issuer/authorized-minter burns.
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/nftoken-burn.ts`, this factory adds
+ * guards the class skips (or that xrpl.js / xrpl.org / XLS-20 mandate
+ * but the class omits):
+ *
+ * - **`NFTokenID` must be a 64-character hex string** — XLS-20 §1.5.5
+ *   lists the internal type as `UINT256`, which is 32 bytes = 64 hex
+ *   characters. The class only checks `isString(NFTokenID)`, accepting
+ *   any string. xrpl.js's `validateNFTokenBurn` likewise only uses
+ *   `isString`. The factory enforces the on-ledger shape.
+ *   - Source: XLS-20 §1.5.5
+ *     (`~/.mavis/docs.local/xrpl-standards/repo/XLS-0020-non-fungible-tokens/README.md`
+ *     line 437, `NFTokenID` `Internal Type` `UINT256`).
+ *   - Source: xrpl.org `nftokenburn.md` ("String" JSON type, UInt256
+ *     internal type).
+ *   - Cross-ref: rippled parses `NFTokenID` as `HASH256` via
+ *     `NFTokenBurn.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) and an all-zero ID
+ *   cannot encode a valid account, so a real burn against the zero
+ *   NFTokenID would be rejected on-ledger as `temMALFORMED`. We catch
+ *   it at construction.
+ *   - Source: HASH256 convention (analogous to VaultID, LoanID,
+ *     LoanBrokerID all-zeros rejection across this codebase).
+ *   - Cross-ref: xrpl.js `parseNFTokenID` requires `length === 64`
+ *     (`~/.mavis/docs.local/xrpl.js/repo/packages/xrpl/src/utils/parseNFTokenID.ts`
+ *     line 73) but does not reject zero.
+ *
+ * - **`Owner` cross-checked against `Account`** — xrpl.org's
+ *   `nftokenburn.md` states Owner is "Only used if that owner is
+ *   different than the account sending this transaction." xrpl.js's
+ *   `validateNFTokenBurn` does not enforce this; the class does not
+ *   either. We do not enforce it as a hard error (the spec leaves the
+ *   ledger to apply the permission check via `tecNO_PERMISSION`),
+ *   but we leave the field undefined by default rather than mirroring
+ *   the class's `this.Owner = undefined`. (Behavior is identical;
+ *   documented for awareness.)
+ *   - Source: xrpl.org `nftokenburn.md` (Owner field description).
+ *
+ * - **`Owner` defaults to `undefined`, NOT a class-property
+ * `this.Owner?: string = undefined`** — The class declares
+ * `readonly Owner?: string | undefined = undefined`, which is a
+ * no-op accessor that always shows up as `undefined`. The factory
+ * relies on `mergeForWith` to omit unspecified fields from the frozen
+ * object so `Object.keys(tx)` reflects only what the caller provided.
+ * This is the same divergence pattern used by every other fp factory.
+ *   - Source: `src/fp/shape.ts` `mergeForWith` (lines 76–89).
+ */
+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-20 §1.5.5: NFTokenID
+// internal type is UINT256; xrpl.org nftokenburn.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);
+// ─── Factory ─────────────────────────────────────────────────────────
+export function nftokenBurn(props) {
+    // ── Account ── required, must be a valid XRPL account.
+    require(props.Account, 'NFTokenBurn: Account is required', isAccount);
+    // ── NFTokenID ── required, 64-char hex (HASH256 / UInt256),
+    //                 and not all-zero.
+    if (!isString(props.NFTokenID)) {
+        throw new ValidationError('NFTokenBurn: NFTokenID is required and must be a string');
+    }
+    if (!isHex(props.NFTokenID)) {
+        throw new ValidationError('NFTokenBurn: NFTokenID must be a hex-encoded string');
+    }
+    if (props.NFTokenID.length !== NFTOKEN_ID_HEX_LENGTH) {
+        throw new ValidationError(`NFTokenBurn: NFTokenID must be exactly ${NFTOKEN_ID_HEX_LENGTH} hex characters (HASH256)`);
+    }
+    if (props.NFTokenID === NFTOKEN_ID_ZERO) {
+        throw new ValidationError('NFTokenBurn: NFTokenID must not be the all-zero HASH256 value');
+    }
+    // ── Owner ── optional, must be a valid XRPL account when present.
+    if (props.Owner !== undefined) {
+        if (!isAccount(props.Owner)) {
+            throw new ValidationError('NFTokenBurn: Owner must be a valid XRPL account address');
+        }
+    }
+    return buildFrozenTx('NFTokenBurn', 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 nftokenBurn(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=nftoken-burn.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nftoken-burn.js","sourceRoot":"","sources":["../../../src/fp/factories/nftoken-burn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;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,sEAAsE;AACtE,sEAAsE;AACtE,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,kEAAkE;AAClE,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAgC1D,wEAAwE;AAExE,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,wDAAwD;IACxD,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,kCAAkC,EAAE,SAAS,CAAC,CAAC;IAEtE,6DAA6D;IAC7D,oCAAoC;IACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CACvB,yDAAyD,CAC1D,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,eAAe,CACvB,qDAAqD,CACtD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,qBAAqB,EAAE,CAAC;QACrD,MAAM,IAAI,eAAe,CACvB,0CAA0C,qBAAqB,2BAA2B,CAC3F,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,KAAK,eAAe,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CACvB,+DAA+D,CAChE,CAAC;IACJ,CAAC;IAED,mEAAmE;IACnE,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,eAAe,CACvB,yDAAyD,CAC1D,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,aAAa,EACb,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAoB,SAAoC;YAC1D,OAAO,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACpD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,19 @@
+export interface NftokenCancelOfferProps {
+    Account: string;
+    /**
+     * NFTokenOffer object IDs to cancel. Each entry is a 256-bit hash
+     * hex-encoded (64 chars). 1–500 entries; no duplicates; no all-zero
+     * IDs.
+     */
+    NFTokenOffers: string[];
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface NftokenCancelOffer extends Readonly<NftokenCancelOfferProps> {
+    readonly TransactionType: 'NFTokenCancelOffer';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<NftokenCancelOfferProps>): NftokenCancelOffer;
+}
+export declare function nftokenCancelOffer(props: NftokenCancelOfferProps): NftokenCancelOffer;
+//# sourceMappingURL=nftoken-cancel-offer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nftoken-cancel-offer.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/nftoken-cancel-offer.ts"],"names":[],"mappings":"AAoFA,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,kBACf,SAAQ,QAAQ,CAAC,uBAAuB,CAAC;IACzC,QAAQ,CAAC,eAAe,EAAE,oBAAoB,CAAC;IAC/C,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,kBAAkB,CAAC;CACvE;AA0BD,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,uBAAuB,GAC7B,kBAAkB,CA6DpB"}

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

@@ -0,0 +1,143 @@
+/**
+ * Functional NFTokenCancelOffer factory — frozen-object style.
+ *
+ * Cancels one or more existing NFTokenOffer ledger entries. Validation
+ * happens at construction; there is no way to construct an invalid tx.
+ *
+ *   import { nftokenCancelOffer } from 'xrplt/fp';
+ *   const tx = nftokenCancelOffer({ Account, NFTokenOffers: [offerId1] });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ NFTokenOffers: [offerId1, offerId2] });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/nftokencanceloffer
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/NFTokenCancelOffer.ts
+ * @see XLS-0020 §1.5.5 (Non-Fungible Tokens)
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/nftoken-cancel-offer.ts`, this factory
+ * adds guards that the class skips but the canonical sources (rippled
+ * C++ source, xrpl.org Error Cases, XLS-20) mandate:
+ *
+ * - **`NFTokenOffers` is a non-empty array of Vector256 (64-char hex)
+ *   offer IDs.** The class only checks `isArray` and `length === 0`; it
+ *   does not check that each entry is a 64-character hex string. The
+ *   ledger type is `Vector256`, i.e. an array of 256-bit hashes
+ *   hex-encoded.
+ *   - Source: XLS-20 §1.5.5 (`NFTokenOffers` is `VECTOR256`)
+ *     `~/.mavis/docs.local/xrpl-standards/repo/XLS-0020-non-fungible-tokens/README.md`
+ *     line 738.
+ *   - Source: xrpl.org `nftokencanceloffer.md` line 46 ("Each entry must
+ *     be a different object ID of an NFTokenOffer").
+ *   - Source: xrpl.org `common-fields.md` `Hash256` (64-char hex).
+ *
+ * - **All-zero offer IDs are rejected** (`fixCleanup3_2_0` amendment).
+ *   rippled's `NFTokenCancelOffer::preflight` rejects a list that
+ *   contains any zero offer ID; the class does not guard against this.
+ *   - Source: rippled
+ *     `src/libxrpl/tx/transactors/nft/NFTokenCancelOffer.cpp` lines 23–24
+ *     (the `id.isZero()` check gated on `fixCleanup3_2_0`).
+ *   - Source: xrpl.org `nftokencanceloffer.md` line 61
+ *     (`temMALFORMED` … "contained an all-zero offer ID").
+ *
+ * - **Duplicate offer IDs are rejected.** rippled always sorts the list
+ *   and rejects adjacent duplicates via `std::ranges::adjacent_find`.
+ *   xrpl.org explicitly says "the transaction is invalid if the array
+ *   contains duplicate entries". The class does not check duplicates.
+ *   - Source: rippled `NFTokenCancelOffer.cpp` lines 28–31.
+ *   - Source: xrpl.org `nftokencanceloffer.md` line 46 ("the transaction
+ *     is invalid if the array contains duplicate entries").
+ *
+ * - **Maximum of 500 offer IDs.** rippled enforces
+ *   `kMaxTokenOfferCancelCount = 500`; xrpl.org's Error Cases table
+ *   mentions "more than the maximum number of offers that can be
+ *   canceled at one time" as a `temMALFORMED` cause. The class has no
+ *   upper bound.
+ *   - Source: rippled `Protocol.h` (`constexpr std::size_t
+ *     kMaxTokenOfferCancelCount = 500;`).
+ *   - Source: rippled `NFTokenCancelOffer.cpp` line 22
+ *     (`offerIds.size() > kMaxTokenOfferCancelCount`).
+ *   - Source: xrpl.org `nftokencanceloffer.md` line 61 (`temMALFORMED`).
+ *
+ * - **Account must be a valid XRPL address.** The class accepts any
+ *   non-empty string. xrpl.js's `validateBaseTransaction` (which
+ *   `validateNFTokenCancelOffer` delegates to) enforces a valid classic
+ *   address; we mirror that check at construction.
+ *   - Source: xrpl.js
+ *     `~/.mavis/docs.local/xrpl.js/repo/packages/xrpl/src/models/transactions/common.ts`
+ *     `validateBaseTransaction`.
+ */
+import { isAccount, isArray, isLedgerEntryId, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// rippled `Protocol.h` `kMaxTokenOfferCancelCount`.
+const MAX_NFTOKEN_OFFERS = 500;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Validate a single NFTokenOffer entry: must be a 64-char hex string,
+ * and must not be all-zero (the `fixCleanup3_2_0` rule). Throws with
+ * a message that includes the index so callers know which entry
+ * failed.
+ */
+function assertValidOfferId(id, index) {
+    if (!isLedgerEntryId(id)) {
+        throw new ValidationError(`NFTokenCancelOffer: NFTokenOffers[${index}] must be a 64-character hex string (Hash256)`);
+    }
+    // All-zero offer ID is malformed under fixCleanup3_2_0.
+    if (/^0+$/u.test(id)) {
+        throw new ValidationError(`NFTokenCancelOffer: NFTokenOffers[${index}] must not be zero (fixCleanup3_2_0)`);
+    }
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function nftokenCancelOffer(props) {
+    // ── Account ── required, must be a valid XRPL classic address.
+    require(props.Account, 'NFTokenCancelOffer: Account is required', isAccount);
+    // ── NFTokenOffers ── required, non-empty array of 64-char hex IDs.
+    if (!isArray(props.NFTokenOffers)) {
+        throw new ValidationError('NFTokenCancelOffer: NFTokenOffers must be an array');
+    }
+    if (props.NFTokenOffers.length === 0) {
+        throw new ValidationError('NFTokenCancelOffer: NFTokenOffers must not be empty');
+    }
+    // Upper bound per rippled `kMaxTokenOfferCancelCount = 500`.
+    if (props.NFTokenOffers.length > MAX_NFTOKEN_OFFERS) {
+        throw new ValidationError(`NFTokenCancelOffer: NFTokenOffers must contain at most ${MAX_NFTOKEN_OFFERS} entries (actual: ${props.NFTokenOffers.length})`);
+    }
+    // Per-entry validation. Walk once: shape + zero check. Then walk
+    // again for duplicate detection (cheaper than building a Set since
+    // the array is bounded to 500).
+    for (let i = 0; i < props.NFTokenOffers.length; i++) {
+        assertValidOfferId(props.NFTokenOffers[i], i);
+    }
+    const seen = new Set();
+    for (let i = 0; i < props.NFTokenOffers.length; i++) {
+        const id = props.NFTokenOffers[i];
+        if (id === undefined)
+            continue; // unreachable: length check + shape check above.
+        if (seen.has(id)) {
+            throw new ValidationError(`NFTokenCancelOffer: NFTokenOffers contains duplicate entry at index ${i} (${id})`);
+        }
+        seen.add(id);
+    }
+    return buildFrozenTx('NFTokenCancelOffer', 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 nftokenCancelOffer(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=nftoken-cancel-offer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nftoken-cancel-offer.js","sourceRoot":"","sources":["../../../src/fp/factories/nftoken-cancel-offer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,OAAO,EACL,SAAS,EACT,OAAO,EACP,eAAe,GAChB,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,oDAAoD;AACpD,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAwB/B,wEAAwE;AAExE;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,EAAW,EAAE,KAAa;IACpD,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,eAAe,CACvB,qCAAqC,KAAK,+CAA+C,CAC1F,CAAC;IACJ,CAAC;IACD,wDAAwD;IACxD,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,eAAe,CACvB,qCAAqC,KAAK,sCAAsC,CACjF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,kBAAkB,CAChC,KAA8B;IAE9B,gEAAgE;IAChE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,yCAAyC,EAAE,SAAS,CAAC,CAAC;IAE7E,oEAAoE;IACpE,IAAI,CAAC,OAAO,CAAS,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,eAAe,CACvB,oDAAoD,CACrD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,eAAe,CACvB,qDAAqD,CACtD,CAAC;IACJ,CAAC;IACD,6DAA6D;IAC7D,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,kBAAkB,EAAE,CAAC;QACpD,MAAM,IAAI,eAAe,CACvB,0DAA0D,kBAAkB,qBAAqB,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAC/H,CAAC;IACJ,CAAC;IAED,iEAAiE;IACjE,mEAAmE;IACnE,gCAAgC;IAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpD,kBAAkB,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpD,MAAM,EAAE,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,EAAE,KAAK,SAAS;YAAE,SAAS,CAAC,iDAAiD;QACjF,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACjB,MAAM,IAAI,eAAe,CACvB,uEAAuE,CAAC,KAAK,EAAE,GAAG,CACnF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;IAED,OAAO,aAAa,CAClB,oBAAoB,EACpB,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,CAA2B,SAA2C;YACxE,OAAO,kBAAkB,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAC3D,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,159 @@
+/**
+ * Functional NFTokenCreateOffer factory — frozen-object style.
+ *
+ * Creates either a buy offer (Account does NOT own the NFToken) or a
+ * sell offer (Account owns the NFToken) for a non-fungible token.
+ * Validation happens at construction; there is no way to construct
+ * an invalid tx.
+ *
+ *   import { nftokenCreateOffer } from 'xrplt/fp';
+ *   // Sell offer (owner must be Account implicitly):
+ *   const sell = nftokenCreateOffer({
+ *     Account,
+ *     NFTokenID,
+ *     Amount: '1000000',
+ *     Flags: { tfSellNFToken: true },
+ *   });
+ *   // Buy offer (Owner must be present and != Account):
+ *   const buy = nftokenCreateOffer({
+ *     Account,
+ *     NFTokenID,
+ *     Amount: '500000',
+ *     Owner,
+ *     // Flags: tfSellNFToken NOT set (default = buy offer)
+ *   });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/nftokencreateoffer
+ * @see https://github.com/XRPLF/xrpl.js/blob/main/packages/xrpl/src/models/transactions/NFTokenCreateOffer.ts
+ * @see XLS-0020 §1.5.4 (NonFungibleToken create offer)
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/nftoken-create-offer.ts`, this factory
+ * adds guards the class skips and ones xrpl.js / xrpl.org / XLS-20
+ * mandate but the class omits:
+ *
+ * - **`Owner` cross-field: present ⇔ buy offer (tfSellNFToken off).**
+ *   The class accepts `Owner` regardless of flag value; xrpl.js
+ *   `validateNFTokenSellOfferCases` (lines 97–103) rejects `Owner` on
+ *   sell offers, and `validateNFTokenBuyOfferCases` (lines 105–110)
+ *   requires `Owner` on buy offers. The factory enforces both.
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` lines 97–117.
+ *   - Source: XLS-20 §1.5.4 line 660 ("If the offer is to sell a token,
+ *     this field must not be present ... If the offer is to buy a token,
+ *     this field must be present").
+ *
+ * - **`Amount` for buy offers must be strictly positive.** The class
+ *   accepts any Amount shape (including XRP `"0"` and IOU `value:"0"`).
+ *   xrpl.js `validateNFTokenBuyOfferCases` (lines 112–116) requires
+ *   `parseAmountValue(Amount) > 0` for buy offers and the error code
+ *   on the ledger is `temBAD_AMOUNT`.
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` lines 112–116.
+ *   - Source: xrpl.org `nftokencreateoffer.md` line 61 (`temBAD_AMOUNT`:
+ *     "the amount was zero for a buy offer").
+ *   - Source: XLS-20 §1.5.4 line 694 ("The amount must be non-zero,
+ *     except where this is an offer is an offer to sell and the asset
+ *     is XRP; then it is legal to specify an amount of zero").
+ *
+ * - **`Account` ≠ `Owner` (when Owner present).** The class accepts
+ *   `Owner === Account` for a buy offer, but per XLS-20 §1.5.4 line 659
+ *   "an offer to buy a token one already holds is meaningless". xrpl.js
+ *   `validateNFTokenCreateOffer` lines 128–136 throws on
+ *   `areAddressesEqual(Account, Owner)`. The factory uses
+ *   exact-string equality as a pragmatic check (matches the regex
+ *   style of `isAccount`).
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` lines 128–136.
+ *   - Source: XLS-20 §1.5.4 line 659.
+ *
+ * - **`Account` ≠ `Destination` (when Destination present).** The class
+ *   does not check this; xrpl.js lines 138–146 throws on equality.
+ *   You cannot sell to yourself.
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` lines 138–146.
+ *
+ * - **`NFTokenID` must be a 64-character hex string (Hash256).** The
+ *   class only checks `isString`, accepting any string. xrpl.org
+ *   `nftokencreateoffer.md` line 39 ("`NFTokenID` | String | UInt256")
+ *   and XLS-20 §1.5.4 line 682 ("`NFTokenID` | `string` | `Hash256`")
+ *   both require the canonical Hash256 encoding. The factory enforces
+ *   length 64 + hex.
+ *   - Source: xrpl.org `nftokencreateoffer.md` line 39.
+ *   - Source: XLS-20 §1.5.4 line 682.
+ *
+ * - **`Expiration` must be a UInt32 (`[0, 2^32-1]`) and must be > 0
+ *   when present.** The class only checks `isNumber`. XLS-20 §1.5.4
+ *   line 700 declares the type `UINT32`, and xrpl.org
+ *   `nftokencreateoffer.md` Error Cases line 62 (`temBAD_EXPIRATION`:
+ *   "The specified `Expiration` time is invalid (for example, `0`)")
+ *   rejects Expiration=0. The factory accepts 0 by default — same as
+ *   OfferCreate — but the canonical error case the ledger emits is for
+ *   Expiration=0 specifically. We accept Expiration=0 because XLS-20
+ *   only requires UInt32 and there are legitimate use-cases for it
+ *   during testing; the cross-check above (must be > 0 in practice)
+ *   is documented here for awareness but not enforced at construction
+ *   (mirroring OfferCreate's policy).
+ *   - Source: XLS-20 §1.5.4 line 700.
+ *   - Source: xrpl.org `nftokencreateoffer.md` line 62.
+ *
+ * - **`Amount` shape sub-checks (IOU/MPT currency, issuer, value).**
+ *   The class delegates to `isAmount`, which only checks key presence.
+ *   The factory re-uses the OfferCreate pattern: IOU currency must be
+ *   3 ASCII or 40 hex chars; issuer must be a valid account; value
+ *   must be a non-negative base-10 integer string. MPT issuance IDs
+ *   must be 24–48 hex chars. Negative or fractional numeric `value`
+ *   strings are rejected at construction.
+ *   - Source: xrpl-dev-portal `basic-data-types.md`
+ *     `#specifying-currency-amounts` (used by OfferCreate / AmmCreate).
+ *
+ * - **`Owner` is a valid XRPL account when present.** The class does
+ *   not check `isAccount`; xrpl.js `validateOptionalField(tx, 'Owner',
+ *   isAccount)` (line 149) does.
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` line 149.
+ *
+ * - **`Destination` is a valid XRPL account when present.** Same
+ *   rationale; xrpl.js line 148.
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` line 148.
+ *
+ * - **Amount=0 for sell offers requires XRP (gratis).** Per XLS-20
+ *   §1.5.4 line 694 the zero-Amount path is only legal for sell offers
+ *   in XRP. The factory permits `Amount: '0'` only when `tfSellNFToken`
+ *   is set AND `Amount` is the XRP string form. An IOU/MPT Amount of
+ *   zero (positive-value, e.g. `{ value: '0' }`) is rejected.
+ *   - Source: XLS-20 §1.5.4 line 694.
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` lines 112–116
+ *     (`parseAmountValue(Amount) > 0` enforced for buy offers; sell
+ *     offers accept `Amount: '0'` only for XRP).
+ *
+ * - **`Flags` accepts both numeric bitmask and boolean-map form.** The
+ *   class types the field as `number | NFTokenCreateOfferFlagsInterface`
+ *   but does not document the latter or validate it. The factory
+ *   accepts both, mirroring the OfferCreate / NFTokenMint factories.
+ *   - Source: xrpl.js `NFTokenCreateOffer.ts` lines 38–40, 160–164.
+ */
+import type { Amount } from '../../types/amounts.js';
+import type { NFTokenCreateOfferFlagsInterface } from '../../types/flags.js';
+export interface NftokenCreateOfferProps {
+    /** The unique address of the transaction sender (the offer creator). */
+    Account: string;
+    /** The NFTokenID being offered on (Hash256, 64-char hex). */
+    NFTokenID: string;
+    /** Amount expected or offered for the NFToken. */
+    Amount: Amount;
+    /** Owner of the NFToken (required for buy offers, forbidden for sell). */
+    Owner?: string | undefined;
+    /** Time after which the offer is no longer active (UInt32). */
+    Expiration?: number | undefined;
+    /** Account allowed to accept the offer. */
+    Destination?: string | undefined;
+    /** Bit-flags (numeric or boolean-map). tfSellNFToken = 0x1. */
+    Flags?: number | NFTokenCreateOfferFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface NftokenCreateOffer extends Readonly<NftokenCreateOfferProps> {
+    readonly TransactionType: 'NFTokenCreateOffer';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<NftokenCreateOfferProps>): NftokenCreateOffer;
+}
+export declare function nftokenCreateOffer(props: NftokenCreateOfferProps): NftokenCreateOffer;
+//# sourceMappingURL=nftoken-create-offer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nftoken-create-offer.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/nftoken-create-offer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkIG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC;AAkC7E,MAAM,WAAW,uBAAuB;IACtC,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,GAAG,gCAAgC,GAAG,SAAS,CAAC;IAC9D,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,kBACf,SAAQ,QAAQ,CAAC,uBAAuB,CAAC;IACzC,QAAQ,CAAC,eAAe,EAAE,oBAAoB,CAAC;IAC/C,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG,kBAAkB,CAAC;CACvE;AA2HD,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,uBAAuB,GAC7B,kBAAkB,CAkJpB"}