xrpjson 0.1.0

package/dist/fp/factories/sponsorship-transfer.d.ts

@@ -0,0 +1,173 @@
+/**
+ * Functional SponsorshipTransfer factory — frozen-object style.
+ *
+ * Create, transfer, or end reserve sponsorship for a ledger object or
+ * account. Operates in one of three mutually-exclusive modes, selected by
+ * exactly one of:
+ *   - `tfSponsorshipEnd`      (0x00010000)
+ *   - `tfSponsorshipCreate`   (0x00020000)
+ *   - `tfSponsorshipReassign` (0x00040000)
+ *
+ *   import { sponsorshipTransfer } from 'xrplt/fp';
+ *   const tx = sponsorshipTransfer({
+ *     Account,
+ *     Flags: 0x00020000,                  // tfSponsorshipCreate
+ *     ObjectID: '...64 hex...',
+ *     Sponsor: 'rNEW_SPONSOR',
+ *     SponsorFlags: 0x00000002,           // spfSponsorReserve
+ *   });
+ *   const tx2 = tx.with({ Flags: 0x00010000 });   // tfSponsorshipEnd
+ *   const j = tx.toJSON();
+ *
+ * Affected amendments:
+ *   - `Sponsor` (base SponsorshipTransfer + the three sponsorship scenarios)
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/sponsortransfer
+ * @see xrpl.js `validateSponsorshipTransfer`
+ *      (`~/.mavis/docs.local/xrpl.js/repo/packages/xrpl/src/models/
+ *       transactions/sponsorshipTransfer.ts`)
+ *
+ * ## Divergences
+ *
+ * The factory enforces eight preclaim rules that the class API
+ * (`src/transactions/sponsorship-transfer.ts`) skips. Each one is mandated
+ * by the Sponsor amendment / `validateSponsorshipTransfer` /
+ * `sponsorshiptransfer.md`.
+ *
+ *   1. `ObjectID`, when present, must be a 64-character hex string
+ *      (HASH256 form).
+ *      Source: xrpl.js `validateSponsorshipTransfer` (lines 141–145) —
+ *      "ObjectID should be a 64-character hex string (ledger object ID)".
+ *      The class only checks `isString(ObjectID)` and accepts any string.
+ *
+ *   2. `Sponsor` is REQUIRED for `tfSponsorshipCreate` and
+ *      `tfSponsorshipReassign`; the field must NOT be present for
+ *      `tfSponsorshipEnd`.
+ *      Source: xrpl-dev-portal `sponsorshiptransfer.md` Error Cases —
+ *      `temMALFORMED`: "The `Sponsor` field is missing when creating or
+ *      reassigning a sponsorship." / "The `Sponsor` field is present when
+ *      ending a sponsorship." xrpl.js lines 149–163 enforce both.
+ *      The class does not accept the `Sponsor` field at all.
+ *
+ *   3. `Sponsor` must be a valid XRPL account address AND must not equal
+ *      `Account`.
+ *      Source: xrpl.js lines 166–183 (validates with `isAccount` and
+ *      `areAddressesEqual(Account, Sponsor)`). The class does not check
+ *      this because it doesn't accept the field.
+ *
+ *   4. `SponsorFlags` is REQUIRED for Create/Reassign and must have the
+ *      `spfSponsorReserve` (0x00000002) bit set; the field must NOT be
+ *      present for `tfSponsorshipEnd`.
+ *      Source: xrpl-dev-portal `sponsorshiptransfer.md` Create / Reassign
+ *      tabs — "Provide the `Sponsor` field with the
+ *      `SponsorFlags.spfSponsorReserve` flag." End tab — "Do not include
+ *      the `Sponsor` and `SponsorFlags` fields." xrpl.js lines 187–199
+ *      enforce the required-bit. The class does not accept the field at
+ *      all.
+ *
+ *   5. `SponsorSignature` is REQUIRED for **account-level** Create/Reassign
+ *      (i.e. when `ObjectID` is omitted); optional (but allowed) for
+ *      object-level Create/Reassign.
+ *      Source: xrpl-dev-portal `sponsorshiptransfer.md` Create / Reassign
+ *      tabs — "Include the `SponsorSignature` when sponsoring an account.
+ *      This is optional when sponsoring an object." xrpl.js lines
+ *      205–212 enforce this. The class does not accept the field at all.
+ *
+ *   6. `SponsorSignature`, when present, must be a well-formed object
+ *      with EITHER single-sign fields (`SigningPubKey` + `TxnSignature`)
+ *      OR a `Signers` array (multi-sign), but not both.
+ *      Source: xrpl.js `SponsorSignature` type
+ *      (`packages/xrpl/src/models/common/index.ts` lines 57–69) and
+ *      rippled's `STObject` deserialization rules. The class doesn't
+ *      validate shape because it doesn't accept the field.
+ *
+ *   7. `Sponsee` must not equal `Account`.
+ *      Source: xrpl.js lines 231–235 (uses `areAddressesEqual`).
+ *      The class does not check identity.
+ *
+ *   8. Both numeric and boolean-map `Flags` forms are accepted (matching
+ *      xrpl.js), and the two forms are normalised — but neither may carry
+ *      any unknown mode bits. The class accepts the object form only and
+ *      does not validate bit values against the three documented modes.
+ *
+ * Note: the factory is the **only** place that distinguishes "object-level
+ * sponsorship" (ObjectID present) from "account-level sponsorship"
+ * (ObjectID omitted) for the SponsorSignature-required check. The class
+ * lets you build a Create/Reassign tx with no ObjectID and no
+ * SponsorSignature, which the ledger rejects with `temMALFORMED`.
+ */
+import type { SponsorshipTransferFlagsInterface } from '../../types/flags.js';
+/**
+ * Sponsor authorization signature. Mirrors the xrpl.js `SponsorSignature`
+ * discriminated union: either single-sign fields OR multi-sign Signers,
+ * but not both.
+ *
+ * The factory validates this shape locally; no need for the consumer to
+ * depend on xrpl.js for the type.
+ */
+export type SponsorSignatureProps = {
+    /** The sponsor's public key (for single-signing). */
+    SigningPubKey: string;
+    /** The sponsor's signature (for single-signing). */
+    TxnSignature: string;
+    Signers?: never;
+} | {
+    SigningPubKey?: never;
+    TxnSignature?: never;
+    /** Array of sponsor signatures (for multi-signing). */
+    Signers: readonly {
+        readonly Signer: {
+            readonly Account: string;
+            readonly TxnSignature: string;
+            readonly SigningPubKey: string;
+        };
+    }[];
+};
+export interface SponsorshipTransferProps {
+    /** The unique address of the transaction sender (sponsee or sponsor). */
+    Account: string;
+    /**
+     * The mode flag. Must be exactly one of `tfSponsorshipEnd`,
+     * `tfSponsorshipCreate`, or `tfSponsorshipReassign`. Numeric or
+     * boolean-map form is accepted (canonical form is numeric).
+     */
+    Flags?: number | SponsorshipTransferFlagsInterface | undefined;
+    /**
+     * The ID of the ledger entry whose sponsorship is being changed.
+     * 64-char hex. Required when sponsoring / ending sponsorship for an
+     * object; omit for account-level sponsorship.
+     */
+    ObjectID?: string | undefined;
+    /**
+     * The sponsee account whose sponsorship is being ended. Only valid for
+     * `tfSponsorshipEnd`; omit when `Account` itself is the sponsee. Must
+     * not be present for Create / Reassign.
+     */
+    Sponsee?: string | undefined;
+    /**
+     * The new sponsor for Create / Reassign. Must NOT be present for End.
+     * Required for Create / Reassign.
+     */
+    Sponsor?: string | undefined;
+    /**
+     * Sponsor flags. Must include `spfSponsorReserve` (0x00000002) for
+     * Create / Reassign; must NOT be present for End. Required for
+     * Create / Reassign.
+     */
+    SponsorFlags?: number | undefined;
+    /**
+     * Sponsor's signature. Required for account-level (no ObjectID)
+     * Create / Reassign; optional for object-level Create / Reassign.
+     */
+    SponsorSignature?: SponsorSignatureProps | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface SponsorshipTransfer extends Readonly<SponsorshipTransferProps> {
+    readonly TransactionType: 'SponsorshipTransfer';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<SponsorshipTransferProps>): SponsorshipTransfer;
+}
+export declare function sponsorshipTransfer(props: SponsorshipTransferProps): SponsorshipTransfer;
+//# sourceMappingURL=sponsorship-transfer.d.ts.map

package/dist/fp/factories/sponsorship-transfer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sponsorship-transfer.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/sponsorship-transfer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiGG;AACH,OAAO,KAAK,EACV,iCAAiC,EAClC,MAAM,sBAAsB,CAAC;AAmB9B;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,GAC7B;IACE,qDAAqD;IACrD,aAAa,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,GACD;IACE,aAAa,CAAC,EAAE,KAAK,CAAC;IACtB,YAAY,CAAC,EAAE,KAAK,CAAC;IACrB,uDAAuD;IACvD,OAAO,EAAE,SAAS;QAChB,QAAQ,CAAC,MAAM,EAAE;YACf,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;YACzB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;YAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;SAChC,CAAC;KACH,EAAE,CAAC;CACL,CAAC;AAEN,MAAM,WAAW,wBAAwB;IACvC,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,iCAAiC,GAAG,SAAS,CAAC;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACrD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAoB,SAAQ,QAAQ,CAAC,wBAAwB,CAAC;IAC7E,QAAQ,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAChD,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAAG,mBAAmB,CAAC;CACzE;AAmHD,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,wBAAwB,GAC9B,mBAAmB,CAyJrB"}

package/dist/fp/factories/sponsorship-transfer.js

@@ -0,0 +1,195 @@
+import { SponsorshipTransferFlags } from '../../types/flags.js';
+import { isAccount, isHex, isRecord, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// HASH256 ledger entry ID — 32 bytes = 64 hex characters.
+const HASH256_LENGTH = 64;
+// Sponsor flags bitfield. Mirrors the xrpl.js `SponsorFlags` enum
+// (`packages/xrpl/src/models/transactions/common.ts` lines 660–665).
+// For the three documented scenarios only `spfSponsorReserve` is set;
+// any other bit is rejected by the factory.
+const SPF_SPONSOR_RESERVE = 0x00000002;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Extract the three mode-flag booleans and the numeric flag value from
+ * either the numeric or boolean-map form. Mirrors xrpl.js
+ * `validateSponsorshipTransfer` lines 96–115.
+ */
+function getModeFlags(rawFlags) {
+    let numericFlags = 0;
+    let isEnd = false;
+    let isCreate = false;
+    let isReassign = false;
+    if (typeof rawFlags === 'number') {
+        numericFlags = rawFlags;
+        isEnd = (numericFlags & SponsorshipTransferFlags.tfSponsorshipEnd) !== 0;
+        isCreate =
+            (numericFlags & SponsorshipTransferFlags.tfSponsorshipCreate) !== 0;
+        isReassign =
+            (numericFlags & SponsorshipTransferFlags.tfSponsorshipReassign) !== 0;
+    }
+    else if (isRecord(rawFlags)) {
+        isEnd = rawFlags['tfSponsorshipEnd'] === true;
+        isCreate = rawFlags['tfSponsorshipCreate'] === true;
+        isReassign = rawFlags['tfSponsorshipReassign'] === true;
+        numericFlags =
+            (isEnd ? SponsorshipTransferFlags.tfSponsorshipEnd : 0) |
+                (isCreate ? SponsorshipTransferFlags.tfSponsorshipCreate : 0) |
+                (isReassign ? SponsorshipTransferFlags.tfSponsorshipReassign : 0);
+    }
+    return { numericFlags, isEnd, isCreate, isReassign };
+}
+/**
+ * Validate the shape of a SponsorSignature object. Mirrors the xrpl.js
+ * `SponsorSignature` discriminated union
+ * (`packages/xrpl/src/models/common/index.ts` lines 57–69).
+ */
+function validateSponsorSignature(value, path) {
+    if (!isRecord(value)) {
+        throw new ValidationError(`${path}: SponsorSignature must be an object`);
+    }
+    const hasSingleSign = value['SigningPubKey'] !== undefined ||
+        value['TxnSignature'] !== undefined;
+    const hasMultiSign = value['Signers'] !== undefined;
+    if (hasSingleSign && hasMultiSign) {
+        throw new ValidationError(`${path}: SponsorSignature must not combine SigningPubKey/TxnSignature with Signers`);
+    }
+    if (!hasSingleSign && !hasMultiSign) {
+        throw new ValidationError(`${path}: SponsorSignature must include either single-sign fields or Signers`);
+    }
+    if (hasSingleSign) {
+        if (!isString(value['SigningPubKey']) || value['SigningPubKey'].length === 0) {
+            throw new ValidationError(`${path}: SponsorSignature.SigningPubKey must be a non-empty string`);
+        }
+        if (!isString(value['TxnSignature']) || value['TxnSignature'].length === 0) {
+            throw new ValidationError(`${path}: SponsorSignature.TxnSignature must be a non-empty string`);
+        }
+    }
+    else {
+        const signers = value['Signers'];
+        if (!Array.isArray(signers) || signers.length === 0) {
+            throw new ValidationError(`${path}: SponsorSignature.Signers must be a non-empty array`);
+        }
+        for (let i = 0; i < signers.length; i++) {
+            const entry = signers[i];
+            if (!isRecord(entry)) {
+                throw new ValidationError(`${path}: SponsorSignature.Signers[${i}] must be an object`);
+            }
+            const inner = entry['Signer'];
+            if (!isRecord(inner)) {
+                throw new ValidationError(`${path}: SponsorSignature.Signers[${i}].Signer must be an object`);
+            }
+            if (!isString(inner['Account']) ||
+                !isString(inner['TxnSignature']) ||
+                !isString(inner['SigningPubKey'])) {
+                throw new ValidationError(`${path}: SponsorSignature.Signers[${i}].Signer must include Account, TxnSignature, and SigningPubKey strings`);
+            }
+        }
+    }
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function sponsorshipTransfer(props) {
+    // ── Account ── required, must be a valid XRPL classic or X-address.
+    require(props.Account, 'SponsorshipTransfer: Account is required', isAccount);
+    // ── Mode flag dispatch ── exactly one of three mode bits must be set.
+    const { isEnd, isCreate, isReassign } = getModeFlags(props.Flags);
+    const scenarioCount = (isEnd ? 1 : 0) + (isCreate ? 1 : 0) + (isReassign ? 1 : 0);
+    if (scenarioCount === 0) {
+        throw new ValidationError('SponsorshipTransfer: must specify exactly one scenario flag (tfSponsorshipEnd, tfSponsorshipCreate, or tfSponsorshipReassign)');
+    }
+    if (scenarioCount > 1) {
+        throw new ValidationError('SponsorshipTransfer: cannot specify multiple scenario flags (tfSponsorshipEnd, tfSponsorshipCreate, tfSponsorshipReassign are mutually exclusive)');
+    }
+    // ── ObjectID ── if present, 64-char hex.
+    if (props.ObjectID !== undefined) {
+        if (!isString(props.ObjectID) ||
+            !isHex(props.ObjectID) ||
+            props.ObjectID.length !== HASH256_LENGTH) {
+            throw new ValidationError('SponsorshipTransfer: ObjectID must be a 64-character hexadecimal string');
+        }
+    }
+    // ── End-mode rules ──
+    //   - Sponsee is allowed (and optional).
+    //   - Sponsor / SponsorFlags must NOT be present.
+    if (isEnd) {
+        if (props.Sponsor !== undefined) {
+            throw new ValidationError('SponsorshipTransfer: Sponsor field must not be present for tfSponsorshipEnd scenario');
+        }
+        if (props.SponsorFlags !== undefined) {
+            throw new ValidationError('SponsorshipTransfer: SponsorFlags field must not be present for tfSponsorshipEnd scenario');
+        }
+    }
+    // ── Create / Reassign rules ──
+    //   - Sponsor REQUIRED, must be a valid account, must not equal Account.
+    //   - SponsorFlags REQUIRED with spfSponsorReserve bit set.
+    //   - Sponsee MUST NOT be present.
+    //   - SponsorSignature REQUIRED when ObjectID is omitted (account-level).
+    if (isCreate || isReassign) {
+        if (props.Sponsee !== undefined) {
+            throw new ValidationError('SponsorshipTransfer: Sponsee field must not be present for tfSponsorshipCreate or tfSponsorshipReassign scenarios');
+        }
+        if (props.Sponsor === undefined) {
+            throw new ValidationError('SponsorshipTransfer: Sponsor field is required for tfSponsorshipCreate and tfSponsorshipReassign scenarios');
+        }
+        if (!isAccount(props.Sponsor)) {
+            throw new ValidationError('SponsorshipTransfer: Sponsor must be a valid account address');
+        }
+        if (props.Sponsor === props.Account) {
+            throw new ValidationError('SponsorshipTransfer: Account and Sponsor cannot be the same');
+        }
+        if (props.SponsorFlags === undefined) {
+            throw new ValidationError('SponsorshipTransfer: SponsorFlags is required for tfSponsorshipCreate and tfSponsorshipReassign scenarios');
+        }
+        if (typeof props.SponsorFlags !== 'number') {
+            throw new ValidationError('SponsorshipTransfer: SponsorFlags must be a number');
+        }
+        if ((props.SponsorFlags & SPF_SPONSOR_RESERVE) !== SPF_SPONSOR_RESERVE) {
+            throw new ValidationError('SponsorshipTransfer: SponsorFlags must have the spfSponsorReserve bit set for tfSponsorshipCreate and tfSponsorshipReassign scenarios');
+        }
+        // Other bits in SponsorFlags are reserved / not allowed for the
+        // three documented scenarios. Reject anything beyond the reserve
+        // bit to surface client mistakes early.
+        if ((props.SponsorFlags & ~SPF_SPONSOR_RESERVE) !== 0) {
+            throw new ValidationError('SponsorshipTransfer: SponsorFlags may only set the spfSponsorReserve bit (0x00000002)');
+        }
+        // Account-level sponsorship: no ObjectID, so the sponsor must
+        // explicitly co-sign via SponsorSignature.
+        if (props.ObjectID === undefined && props.SponsorSignature === undefined) {
+            throw new ValidationError('SponsorshipTransfer: SponsorSignature is required for account-level tfSponsorshipCreate or tfSponsorshipReassign (no ObjectID)');
+        }
+    }
+    // ── Sponsee ── valid account + identity check (End mode only).
+    if (props.Sponsee !== undefined) {
+        if (!isAccount(props.Sponsee)) {
+            throw new ValidationError('SponsorshipTransfer: Sponsee must be a valid account address');
+        }
+        if (props.Sponsee === props.Account) {
+            throw new ValidationError('SponsorshipTransfer: Account and Sponsee cannot be the same');
+        }
+    }
+    // ── SponsorSignature ── validate shape whenever present.
+    if (props.SponsorSignature !== undefined) {
+        validateSponsorSignature(props.SponsorSignature, 'SponsorshipTransfer');
+    }
+    return buildFrozenTx('SponsorshipTransfer', 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 sponsorshipTransfer(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=sponsorship-transfer.js.map

package/dist/fp/factories/sponsorship-transfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sponsorship-transfer.js","sourceRoot":"","sources":["../../../src/fp/factories/sponsorship-transfer.ts"],"names":[],"mappings":"AAqGA,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,0DAA0D;AAC1D,MAAM,cAAc,GAAG,EAAE,CAAC;AAE1B,kEAAkE;AAClE,qEAAqE;AACrE,sEAAsE;AACtE,4CAA4C;AAC5C,MAAM,mBAAmB,GAAG,UAAU,CAAC;AAiFvC,wEAAwE;AAExE;;;;GAIG;AACH,SAAS,YAAY,CAAC,QAAiB;IAMrC,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,UAAU,GAAG,KAAK,CAAC;IAEvB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,YAAY,GAAG,QAAQ,CAAC;QACxB,KAAK,GAAG,CAAC,YAAY,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACzE,QAAQ;YACN,CAAC,YAAY,GAAG,wBAAwB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QACtE,UAAU;YACR,CAAC,YAAY,GAAG,wBAAwB,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC1E,CAAC;SAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,KAAK,GAAG,QAAQ,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC;QAC9C,QAAQ,GAAG,QAAQ,CAAC,qBAAqB,CAAC,KAAK,IAAI,CAAC;QACpD,UAAU,GAAG,QAAQ,CAAC,uBAAuB,CAAC,KAAK,IAAI,CAAC;QACxD,YAAY;YACV,CAAC,KAAK,CAAC,CAAC,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvD,CAAC,QAAQ,CAAC,CAAC,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7D,CAAC,UAAU,CAAC,CAAC,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AACvD,CAAC;AAED;;;;GAIG;AACH,SAAS,wBAAwB,CAC/B,KAAc,EACd,IAAY;IAEZ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,sCAAsC,CAC9C,CAAC;IACJ,CAAC;IACD,MAAM,aAAa,GACjB,KAAK,CAAC,eAAe,CAAC,KAAK,SAAS;QACpC,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS,CAAC;IACtC,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC;IAEpD,IAAI,aAAa,IAAI,YAAY,EAAE,CAAC;QAClC,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,6EAA6E,CACrF,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,aAAa,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,sEAAsE,CAC9E,CAAC;IACJ,CAAC;IACD,IAAI,aAAa,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7E,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,6DAA6D,CACrE,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3E,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,4DAA4D,CACpE,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,sDAAsD,CAC9D,CAAC;QACJ,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,8BAA8B,CAAC,qBAAqB,CAC5D,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,8BAA8B,CAAC,4BAA4B,CACnE,CAAC;YACJ,CAAC;YACD,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;gBAC3B,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;gBAChC,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,EACjC,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,GAAG,IAAI,8BAA8B,CAAC,wEAAwE,CAC/G,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,mBAAmB,CACjC,KAA+B;IAE/B,qEAAqE;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,0CAA0C,EAAE,SAAS,CAAC,CAAC;IAE9E,uEAAuE;IACvE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAClE,MAAM,aAAa,GACjB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,IAAI,aAAa,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,eAAe,CACvB,+HAA+H,CAChI,CAAC;IACJ,CAAC;IACD,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,eAAe,CACvB,mJAAmJ,CACpJ,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;YACzB,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YACtB,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,cAAc,EACxC,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,uBAAuB;IACvB,yCAAyC;IACzC,kDAAkD;IAClD,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,sFAAsF,CACvF,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,IAAI,eAAe,CACvB,2FAA2F,CAC5F,CAAC;QACJ,CAAC;IACH,CAAC;IAED,gCAAgC;IAChC,yEAAyE;IACzE,4DAA4D;IAC5D,mCAAmC;IACnC,0EAA0E;IAC1E,IAAI,QAAQ,IAAI,UAAU,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,mHAAmH,CACpH,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,4GAA4G,CAC7G,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,eAAe,CACvB,8DAA8D,CAC/D,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,IAAI,eAAe,CACvB,6DAA6D,CAC9D,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACrC,MAAM,IAAI,eAAe,CACvB,2GAA2G,CAC5G,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC3C,MAAM,IAAI,eAAe,CACvB,oDAAoD,CACrD,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,mBAAmB,CAAC,KAAK,mBAAmB,EAAE,CAAC;YACvE,MAAM,IAAI,eAAe,CACvB,uIAAuI,CACxI,CAAC;QACJ,CAAC;QACD,gEAAgE;QAChE,iEAAiE;QACjE,wCAAwC;QACxC,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,eAAe,CACvB,uFAAuF,CACxF,CAAC;QACJ,CAAC;QAED,8DAA8D;QAC9D,2CAA2C;QAC3C,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACzE,MAAM,IAAI,eAAe,CACvB,gIAAgI,CACjI,CAAC;QACJ,CAAC;IACH,CAAC;IAED,gEAAgE;IAChE,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,eAAe,CACvB,8DAA8D,CAC/D,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,IAAI,eAAe,CACvB,6DAA6D,CAC9D,CAAC;QACJ,CAAC;IACH,CAAC;IAED,0DAA0D;IAC1D,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACzC,wBAAwB,CACtB,KAAK,CAAC,gBAAgB,EACtB,qBAAqB,CACtB,CAAC;IACJ,CAAC;IAED,OAAO,aAAa,CAClB,qBAAqB,EACrB,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,CAEF,SAA4C;YAE5C,OAAO,mBAAmB,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/ticket-create.d.ts

@@ -0,0 +1,20 @@
+export interface TicketCreateProps {
+    /** The unique address of the transaction sender. */
+    Account: string;
+    /** How many Tickets to create. Must be an integer in [1, 250]. */
+    TicketCount: number;
+    /** Bit-flags for this transaction. TicketCreate has no defined flags. */
+    Flags?: number | undefined;
+    /** Fee to pay, in drops of XRP. */
+    Fee?: string | undefined;
+    /** Account sequence number (auto-filled by the client in normal use). */
+    Sequence?: number | undefined;
+}
+export interface TicketCreate extends Readonly<TicketCreateProps> {
+    readonly TransactionType: 'TicketCreate';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<TicketCreateProps>): TicketCreate;
+}
+export declare function ticketCreate(props: TicketCreateProps): TicketCreate;
+//# sourceMappingURL=ticket-create.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ticket-create.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/ticket-create.ts"],"names":[],"mappings":"AAuFA,MAAM,WAAW,iBAAiB;IAChC,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,mCAAmC;IACnC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,YAAa,SAAQ,QAAQ,CAAC,iBAAiB,CAAC;IAC/D,QAAQ,CAAC,eAAe,EAAE,cAAc,CAAC;IACzC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,YAAY,CAAC;CAC3D;AAID,wBAAgB,YAAY,CAAC,KAAK,EAAE,iBAAiB,GAAG,YAAY,CA+CnE"}

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

@@ -0,0 +1,120 @@
+/**
+ * Functional TicketCreate factory — frozen-object style.
+ *
+ * Sets aside one or more sequence numbers as Tickets so the account can
+ * submit later transactions without worrying about ordering or
+ * cancellation races. The class-based equivalent at
+ * `src/transactions/ticket-create.ts` requires a separate `.validate()`
+ * call after construction; this factory validates at construction so an
+ * invalid tx can never exist.
+ *
+ *   import { ticketCreate } from 'xrplt/fp';
+ *   const tx = ticketCreate({ Account, TicketCount: 10 });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ TicketCount: 25 });
+ *
+ * Required amendment: `TicketBatch` (XLS-0013). The per-account cap of
+ * 250 simultaneous Tickets also comes from XLS-0013.
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ticketcreate
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0013-tickets
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/ticket-create.ts`, this factory adds
+ * preclaim guards the class API skips and emits more specific error
+ * messages than the class's single-message range check.
+ *
+ * 1. **`TicketCount` must be an integer.** The class accepts any number
+ *    via `!isNumber(TicketCount) || TicketCount < 1 || TicketCount > 250`
+ *    (ticket-create.ts:34), so `12.5`, `-0`, and `NaN`-adjacent values
+ *    silently pass. xrpl.js explicitly enforces `Number.isInteger` and
+ *    maps the failure to `temINVALID_COUNT` ("must be an integer from
+ *    1 to 250").
+ *    - Source: xrpl.js
+ *      `repo/packages/xrpl/src/models/transactions/ticketCreate.ts:41-49`
+ *      — `!Number.isInteger(TicketCount) || TicketCount < 1 ||
+ *      TicketCount > MAX_TICKETS` ⇒ "TicketCreate: TicketCount must be
+ *      an integer from 1 to 250".
+ *
+ * 2. **Distinct error messages for missing-vs-wrong-type-vs-out-of-range.**
+ *    The class collapses every failure into `"TicketCount must be
+ *    between 1 and 250"`, which makes debugging ambiguous (is `undefined`
+ *    a "missing field" or "out of range"?). xrpl.js emits three
+ *    separate messages — `"missing field TicketCount"`,
+ *    `"TicketCount must be a number"`, and
+ *    `"TicketCount must be an integer from 1 to 250"`. The factory
+ *    mirrors that ordering for parity with the canonical validator.
+ *    - Source: xrpl.js `ticketCreate.ts:33-49`.
+ *
+ * 3. **`Account` must be a valid XRPL classic or X-address.** The class
+ *    inherits `validateBaseTransaction`'s `isString(Account)` check
+ *    (transactions/common.ts validateBaseTransaction: `validateRequiredField(common, 'Account', isString)`),
+ *    which accepts any string — typos like `"r…"` slip through. The
+ *    factory uses `isAccount` so an obvious typo is caught at
+ *    construction.
+ *    - Source: xrpl-dev-portal basic-data-types.md (`AccountID` is a
+ *      classic address or X-address).
+ *
+ * 4. **`TicketCount` upper bound is per-tx, not per-account.** The
+ *    factory enforces only the per-transaction maximum of 250 (XLS-0013
+ *    §"TicketBatch" / `temINVALID_COUNT`). The cross-field invariant
+ *    "account already owns ≥ (250 − TicketCount) Tickets ⇒ `tecDIR_FULL`"
+ *    requires querying the ledger and is out of scope for a stateless
+ *    constructor. The factory documents this so callers know to use
+ *    `account_info` to pre-check `account_data.TicketCount` before
+ *    submitting a large batch.
+ *    - Source: XLS-0013 §"New Transactions: TicketBatch" line 561-563
+ *      and xrpl-dev-portal `ticketcreate.md` Error Cases row
+ *      `tecDIR_FULL`.
+ */
+import { isAccount, isNumber } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+/**
+ * Maximum number of Tickets a single `TicketCreate` transaction can
+ * create. From XLS-0013 §"New Transactions: TicketBatch" line 561: "A
+ * `TicketCreate` transaction can create up to 250 `Ticket`s in a single
+ * transaction." Also exported as the canonical `MAX_TICKETS` constant
+ * in xrpl.js `ticketCreate.ts:21`.
+ */
+const MAX_TICKETS_PER_TX = 250;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function ticketCreate(props) {
+    // ── Account ── required, must be a valid XRPL classic or X-address.
+    require(props.Account, 'TicketCreate: Account is required and must be a valid XRPL address', isAccount);
+    // ── TicketCount ── required. Three distinct errors (xrpl.js parity):
+    //    "missing field", "must be a number", "must be an integer from 1 to 250".
+    if (props.TicketCount === undefined) {
+        throw new ValidationError('TicketCreate: missing field TicketCount');
+    }
+    if (!isNumber(props.TicketCount)) {
+        throw new ValidationError('TicketCreate: TicketCount must be a number');
+    }
+    if (!Number.isInteger(props.TicketCount) ||
+        props.TicketCount < 1 ||
+        props.TicketCount > MAX_TICKETS_PER_TX) {
+        throw new ValidationError(`TicketCreate: TicketCount must be an integer from 1 to ${MAX_TICKETS_PER_TX}`);
+    }
+    return buildFrozenTx('TicketCreate', 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 ticketCreate(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=ticket-create.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ticket-create.js","sourceRoot":"","sources":["../../../src/fp/factories/ticket-create.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;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;;;;;;GAMG;AACH,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAwB/B,wEAAwE;AAExE,MAAM,UAAU,YAAY,CAAC,KAAwB;IACnD,qEAAqE;IACrE,OAAO,CACL,KAAK,CAAC,OAAO,EACb,oEAAoE,EACpE,SAAS,CACV,CAAC;IAEF,sEAAsE;IACtE,8EAA8E;IAC9E,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CAAC,yCAAyC,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,eAAe,CAAC,4CAA4C,CAAC,CAAC;IAC1E,CAAC;IACD,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC;QACpC,KAAK,CAAC,WAAW,GAAG,CAAC;QACrB,KAAK,CAAC,WAAW,GAAG,kBAAkB,EACtC,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,0DAA0D,kBAAkB,EAAE,CAC/E,CAAC;IACJ,CAAC;IAED,OAAO,aAAa,CAClB,cAAc,EACd,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,CAAqB,SAAqC;YAC5D,OAAO,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACrD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/trust-set.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Functional TrustSet factory — frozen-object style.
+ *
+ * Creates, modifies, or deletes a trust line linking `Account` to a peer
+ * for an issued (IOU) currency. Validation happens at construction;
+ * there is no way to construct an invalid tx.
+ *
+ *   import { trustSet } from 'xrplt/fp';
+ *   const tx = trustSet({
+ *     Account,
+ *     LimitAmount: { currency: 'USD', issuer: GATEWAY, value: '100' },
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Flags: 0x00020000 }); // tfSetNoRipple
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/trustset
+ *
+ * ## Divergences
+ * The factory enforces six preclaim guards the class API
+ * (`src/transactions/trust-set.ts`) skips. The class only checks that
+ * `LimitAmount` passes `isAmount`, which accepts all three Amount forms
+ * (XRP drops, IssuedCurrency, MPT) — none of which is the shape the spec
+ * actually mandates for a trustline.
+ *
+ *   1. `LimitAmount` must be an `IssuedCurrencyAmount` (currency +
+ *      issuer + value), not a generic `Amount`.
+ *      Source: xrpl-dev-portal
+ *      `docs/references/protocol/transactions/types/trustset.md` line 38:
+ *      "`LimitAmount`.`currency` ... 'XRP' is invalid". XRP amounts are
+ *      rejected as well as MPT amounts (`docs/concepts/tokens/fungible-tokens/trust-line-tokens.md`:
+ *      "Trust lines tokens ... are tracked in trust lines ... in contrast
+ *      to [Multi-Purpose Tokens]"). xrpl.js `validateTrustSet` calls
+ *      `isAmount(LimitAmount)` which accepts XRP drops strings and
+ *      `MPTAmount` objects; the class inherits that gap.
+ *
+ *   2. `LimitAmount.currency` must not be the literal `"XRP"`.
+ *      Source: xrpl-dev-portal
+ *      `docs/references/protocol/transactions/types/trustset.md` line 38:
+ *      "`LimitAmount`.`currency` ... 'XRP' is invalid". The class does
+ *      not distinguish the rejected `"XRP"` case from any other valid
+ *      currency code.
+ *
+ *   3. `LimitAmount.issuer` must be a valid XRPL classic or X-address.
+ *      Source: xrpl-dev-portal
+ *      `docs/references/protocol/transactions/types/trustset.md` line 40:
+ *      "`LimitAmount`.`issuer` | String | (Amount.issuer) | The address
+ *      of the account to extend trust to". The class validates the
+ *      issuer as a free-form string; xrpl.js's `isIssuedCurrencyAmount`
+ *      checks only that the field is a string.
+ *
+ *   4. `LimitAmount.value` must be a non-negative XRPL string-number
+ *      (decimal or scientific).
+ *      Source: xrpl-dev-portal
+ *      `docs/references/protocol/data-types/currency-formats.md` line 63
+ *      (`value` column of the issued-currency amount table) — "Quoted
+ *      decimal representation of the amount of the token. This can
+ *      include scientific notation". Line 28 — "Minimum value: `0`.
+ *      (Cannot be negative.)" The class accepts any string and does
+ *      not parse or sign-check the value.
+ *
+ *   5. `Account` must be a valid XRPL classic or X-address.
+ *      Source: xrpl-dev-portal
+ *      `docs/references/protocol/transactions/types/trustset.md` line 18
+ *      — example `"Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX"`.
+ *      The class only checks `typeof === 'string'` via the base
+ *      validator; the factory uses `isAccount`.
+ *
+ *   6. `QualityIn` and `QualityOut` must be non-negative integers in the
+ *      UInt32 range [0, 0xFFFFFFFF].
+ *      Source: xrpl-dev-portal
+ *      `docs/references/protocol/transactions/types/trustset.md`
+ *      lines 41–42 — `QualityIn | Number | UInt32` and `QualityOut |
+ *      Number | UInt32`. xrpl.js `validateTrustSet` checks only
+ *      `typeof === 'number'`; the class inherits that gap and accepts
+ *      negatives, non-integers, and out-of-range values.
+ */
+import type { IssuedCurrencyAmount } from '../../types/amounts.js';
+import type { TrustSetFlagsInterface } from '../../types/flags.js';
+export interface TrustSetProps {
+    /** The unique address of the transaction sender (the trustor). */
+    Account: string;
+    /** The limit and currency for the trust line. */
+    LimitAmount: IssuedCurrencyAmount;
+    /** Quality of incoming liquidity (UInt32; 0 = 100%). */
+    QualityIn?: number | undefined;
+    /** Quality of outgoing liquidity (UInt32; 0 = 100%). */
+    QualityOut?: number | undefined;
+    /** Bit-flags for this transaction. */
+    Flags?: number | TrustSetFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface TrustSet extends Readonly<TrustSetProps> {
+    readonly TransactionType: 'TrustSet';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<TrustSetProps>): TrustSet;
+}
+export declare function trustSet(props: TrustSetProps): TrustSet;
+//# sourceMappingURL=trust-set.d.ts.map

package/dist/fp/factories/trust-set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trust-set.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/trust-set.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAiBnE,MAAM,WAAW,aAAa;IAC5B,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,WAAW,EAAE,oBAAoB,CAAC;IAClC,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,sCAAsC;IACtC,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,QAAS,SAAQ,QAAQ,CAAC,aAAa,CAAC;IACvD,QAAQ,CAAC,eAAe,EAAE,UAAU,CAAC;IACrC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;CACnD;AAqED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,QAAQ,CA4DvD"}