xrpjson 0.1.0

package/dist/fp/factories/delegate-set.js

@@ -0,0 +1,190 @@
+/**
+ * Functional DelegateSet factory — frozen-object style.
+ *
+ * Authorizes another account (the `Authorize` field) to issue a set of
+ * transaction types on behalf of the sender. Validation happens at
+ * construction; there is no way to construct an invalid tx.
+ *
+ *   import { delegateSet } from 'xrplt/fp';
+ *   const tx = delegateSet({
+ *     Account,
+ *     Authorize: OTHER_ACCOUNT,
+ *     Permissions: [
+ *       { Permission: { PermissionValue: 'Payment' } },
+ *     ],
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Fee: '12', Sequence: 42 });
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/delegateSet
+ * @see xrpl.js `dist/npm/models/transactions/delegateSet.ts`
+ *      (validateDelegateSet — source of every guard below).
+ *
+ * ## Divergences
+ *
+ * The factory implements the canonical XRPL DelegateSet shape from
+ * xrpl.js / XLS-85d, which is a strict superset of the current class
+ * API at `src/transactions/delegate-set.ts`. The class is a placeholder
+ * skeleton — it accepts a single `Delegate` field and does not model
+ * the `Permissions` array at all. Concretely:
+ *
+ *   1. **Field rename: `Delegate` → `Authorize`.** The class
+ *      `src/transactions/delegate-set.ts` exposes `Delegate: string` as
+ *      its sole body field. Canonical xrpl.js names the field
+ *      `Authorize: Account` (`node_modules/xrpl/src/models/transactions/
+ *      delegateSet.ts:36-48`). The factory follows xrpl.js / XLS-85d
+ *      and uses `Authorize`. Any caller passing `Delegate` will not
+ *      see it on the wire — the fp output goes through
+ *      `ripple-binary-codec` which would silently drop the unknown
+ *      field. Source: xrpl.js `DelegateSet` interface (Authorize field).
+ *
+ *   2. **`Permissions` array is required.** xrpl.js requires
+ *      `validateRequiredField(tx, 'Permissions', Array.isArray)`
+ *      (xrpl.js `validateDelegateSet.ts:68`). The class does not model
+ *      `Permissions` at all. Without it the tx is malformed and rippled
+ *      rejects with `temMALFORMED`. Source: xrpl.js
+ *      `validateDelegateSet.ts:68`; ripple-binary-codec
+ *      `definitions.json` `DelegateSet: Permissions [ required ]`.
+ *
+ *   3. **`Permissions` length cap is 10.** xrpl.js enforces
+ *      `permissions.length > PERMISSIONS_MAX_LENGTH`
+ *      (`PERMISSIONS_MAX_LENGTH = 10`) and rejects longer arrays
+ *      (xrpl.js `validateDelegateSet.ts:72-76`). The factory mirrors
+ *      this with a `ValidationError` at construction.
+ *
+ *   4. **Each `Permission` element must have exactly `{ Permission: {
+ *      PermissionValue: string } }` shape.** xrpl.js rejects:
+ *      null elements, more than one outer key, missing `Permission`,
+ *      more than one key under `Permission`, missing `PermissionValue`,
+ *      non-string `PermissionValue` (xrpl.js `validateDelegateSet.ts:
+ *      79-99`). The factory runs the same shape checks at
+ *      construction. The class does not model `Permissions` so cannot
+ *      reason about its shape at all.
+ *
+ *   5. **`PermissionValue` must not be a non-delegatable transaction.**
+ *      xrpl.js maintains `NON_DELEGABLE_TRANSACTIONS = { AccountSet,
+ *      SetRegularKey, SignerListSet, DelegateSet, AccountDelete, Batch,
+ *      EnableAmendment, SetFee, UNLModify }` (xrpl.js
+ *      `validateDelegateSet.ts:12-25, 102-104`) and rejects any
+ *      `PermissionValue` in that set. The factory encodes the same set
+ *      and rejects at construction. Self-delegation via `DelegateSet`
+ *      is therefore blocked preclaim, matching rippled's behaviour.
+ *
+ *   6. **`Authorize` must differ from `Account`.** xrpl.js throws
+ *      `'DelegateSet: Authorize and Account must be different.'`
+ *      (xrpl.js `validateDelegateSet.ts:62-66`). The class does not
+ *      check this — `delegateSet({ Account: A, Delegate: A })` would
+ *      pass the class's `isAccount(this.Delegate)` check.
+ *
+ *   7. **No duplicate `PermissionValue`s.** xrpl.js maintains a Set
+ *      while iterating and throws if
+ *      `permissions.length !== permissionValueSet.size`
+ *      (`validateDelegateSet.ts:107-111`). The factory mirrors this.
+ *
+ *   8. **`Account` is validated as a classic/X-address via
+ *      `isAccount`, not just as a non-empty string.** The class
+ *      delegates `Account` to the base class's
+ *      `validateBaseTransaction`, which only requires
+ *      `typeof Account === 'string'` (`src/validation/base.ts:42-49`).
+ *      The factory is consistent with all other MPT/Loan/Vault
+ *      factories.
+ */
+import { isAccount, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+/**
+ * Maximum number of `Permission` entries in a single DelegateSet
+ * transaction. Mirrors xrpl.js `PERMISSIONS_MAX_LENGTH`.
+ */
+const PERMISSIONS_MAX_LENGTH = 10;
+/**
+ * Transactions that cannot be delegated, per XLS-85d / xrpl.js
+ * `NON_DELEGABLE_TRANSACTIONS`. Self-delegation is included so a user
+ * cannot grant themselves rights they already have by definition.
+ */
+const NON_DELEGABLE_TRANSACTIONS = new Set([
+    'AccountSet',
+    'SetRegularKey',
+    'SignerListSet',
+    'DelegateSet',
+    'AccountDelete',
+    'Batch',
+    // Pseudo transactions:
+    'EnableAmendment',
+    'SetFee',
+    'UNLModify',
+]);
+// ─── Factory ─────────────────────────────────────────────────────────
+/**
+ * Build a frozen DelegateSet. Throws `ValidationError` on construction
+ * if any required field is missing or malformed.
+ *
+ * The class-based equivalent validates lazily (caller must invoke
+ * `.validate()`); this functional version validates at construction.
+ * There is no way to build an invalid tx — `with()` re-runs the
+ * factory, so overrides are re-validated too.
+ */
+export function delegateSet(props) {
+    // ── Account ── required, must be a valid XRPL classic/X-address.
+    require(props.Account, 'DelegateSet: missing or invalid Account', isAccount);
+    // ── Authorize ── required, must be a valid XRPL account AND must
+    //    not equal Account (no self-delegation).
+    require(props.Authorize, 'DelegateSet: missing or invalid Authorize', isAccount);
+    if (props.Authorize === props.Account) {
+        throw new ValidationError('DelegateSet: Authorize and Account must be different');
+    }
+    // ── Permissions ── required, must be an array.
+    if (!Array.isArray(props.Permissions)) {
+        throw new ValidationError('DelegateSet: missing or invalid Permissions (array required)');
+    }
+    if (props.Permissions.length > PERMISSIONS_MAX_LENGTH) {
+        throw new ValidationError(`DelegateSet: Permissions array length cannot be greater than ${PERMISSIONS_MAX_LENGTH} (actual: ${props.Permissions.length})`);
+    }
+    // ── Permissions ── shape + non-delegatable + duplicate checks.
+    const seen = new Set();
+    for (const permission of props.Permissions) {
+        if (permission == null ||
+            typeof permission !== 'object' ||
+            Object.keys(permission).length !== 1 ||
+            permission.Permission == null ||
+            typeof permission.Permission !== 'object' ||
+            Object.keys(permission.Permission).length !== 1) {
+            throw new ValidationError('DelegateSet: Permissions array element is malformed (expected { Permission: { PermissionValue: string } })');
+        }
+        const permissionValue = permission.Permission.PermissionValue;
+        if (permissionValue === undefined || permissionValue === null) {
+            throw new ValidationError('DelegateSet: PermissionValue must be defined');
+        }
+        if (!isString(permissionValue)) {
+            throw new ValidationError('DelegateSet: PermissionValue must be a string');
+        }
+        if (NON_DELEGABLE_TRANSACTIONS.has(permissionValue)) {
+            throw new ValidationError(`DelegateSet: PermissionValue contains a non-delegatable transaction ${permissionValue}`);
+        }
+        if (seen.has(permissionValue)) {
+            throw new ValidationError(`DelegateSet: Permissions array cannot contain duplicate values (${permissionValue})`);
+        }
+        seen.add(permissionValue);
+    }
+    return buildFrozenTx('DelegateSet', 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 delegateSet(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=delegate-set.js.map

package/dist/fp/factories/delegate-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delegate-set.js","sourceRoot":"","sources":["../../../src/fp/factories/delegate-set.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0FG;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;;;GAGG;AACH,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC;;;;GAIG;AACH,MAAM,0BAA0B,GAAwB,IAAI,GAAG,CAAC;IAC9D,YAAY;IACZ,eAAe;IACf,eAAe;IACf,aAAa;IACb,eAAe;IACf,OAAO;IACP,uBAAuB;IACvB,iBAAiB;IACjB,QAAQ;IACR,WAAW;CACZ,CAAC,CAAC;AAiDH,wEAAwE;AAExE;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAuB;IACjD,kEAAkE;IAClE,OAAO,CACL,KAAK,CAAC,OAAO,EACb,yCAAyC,EACzC,SAAS,CACV,CAAC;IAEF,kEAAkE;IAClE,6CAA6C;IAC7C,OAAO,CACL,KAAK,CAAC,SAAS,EACf,2CAA2C,EAC3C,SAAS,CACV,CAAC;IACF,IAAI,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;QACtC,MAAM,IAAI,eAAe,CACvB,sDAAsD,CACvD,CAAC;IACJ,CAAC;IAED,gDAAgD;IAChD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,eAAe,CACvB,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,sBAAsB,EAAE,CAAC;QACtD,MAAM,IAAI,eAAe,CACvB,gEAAgE,sBAAsB,aAAa,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAC/H,CAAC;IACJ,CAAC;IAED,gEAAgE;IAChE,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QAC3C,IACE,UAAU,IAAI,IAAI;YAClB,OAAO,UAAU,KAAK,QAAQ;YAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC;YACpC,UAAU,CAAC,UAAU,IAAI,IAAI;YAC7B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;YACzC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,EAC/C,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,4GAA4G,CAC7G,CAAC;QACJ,CAAC;QAED,MAAM,eAAe,GAAG,UAAU,CAAC,UAAU,CAAC,eAAe,CAAC;QAC9D,IAAI,eAAe,KAAK,SAAS,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;YAC9D,MAAM,IAAI,eAAe,CACvB,8CAA8C,CAC/C,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,+CAA+C,CAChD,CAAC;QACJ,CAAC;QACD,IAAI,0BAA0B,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,eAAe,CACvB,uEAAuE,eAAe,EAAE,CACzF,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,eAAe,CACvB,mEAAmE,eAAe,GAAG,CACtF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC5B,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/deposit-preauth.d.ts

@@ -0,0 +1,183 @@
+/**
+ * Functional DepositPreauth factory — frozen-object style.
+ *
+ * Grant or revoke preauthorization for another account (or a set of
+ * credentials) to deliver payments to the sender. Preauthorization is
+ * only meaningful when the sender has [Deposit Authorization][depauth]
+ * enabled, but the tx can be submitted ahead of time so the switch
+ * is seamless.
+ *
+ *   import { depositPreauth } from 'xrplt/fp';
+ *   const tx = depositPreauth({
+ *     Account,
+ *     Authorize: OTHER_ACCOUNT,
+ *   });
+ *   tx.validate();   // no-op — already validated at construction
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Fee: '12', Sequence: 42 });
+ *
+ * Four mutually exclusive "payload" fields are supported by the
+ * binary codec: exactly one of `Authorize`, `Unauthorize`,
+ * `AuthorizeCredentials`, or `UnauthorizeCredentials` MUST be
+ * supplied. Per XRPL.org: "You must provide exactly one of …"
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/depositpreauth
+ * @see XLS-9d  (DepositPreauth amendment)
+ * @see XLS-70  (Credentials — adds the credential preauth fields)
+ * @see xrpl.js `packages/xrpl/src/models/transactions/DepositPreauth.ts`
+ *      (`validateDepositPreauth` and `validateSingleAuthorizationFieldProvided`
+ *       — source of every guard below except the X-address `Account`
+ *       equality check, which is slightly more permissive here).
+ *
+ * ## Divergences
+ *
+ * The factory implements the canonical XRPL DepositPreauth shape from
+ * xrpl.js / XLS-9d / XLS-70 / XRPL.org, which is a strict superset of
+ * the validation the class API performs. The class at
+ * `src/transactions/deposit-preauth.ts` is a pre-Credentials
+ * placeholder — it only models the two single-account fields
+ * (`Authorize` / `Unauthorize`) and the "exactly one of two" rule.
+ * Concretely:
+ *
+ *   1. **Validation is eager, not lazy.** The class lets callers
+ *      construct a tx without immediately validating it; the factory
+ *      runs every guard at construction so an invalid `DepositPreauth`
+ *      is a type error (the call throws). There is no way to construct
+ *      an invalid frozen tx. Source: class `validate()` only runs when
+ *      explicitly called (`src/transactions/deposit-preauth.ts:36-50`);
+ *      the factory mirrors the xrpl.js guard sequence
+ *      (`DepositPreauth.ts:63-86`) at construction time.
+ *
+ *   2. **`Account` is validated as a classic/X-address via
+ *      `isAccount`, not just as a non-empty string.** The class
+ *      delegates `Account` to the base class, which only requires
+ *      `typeof Account === 'string'`. The factory enforces the format
+ *      regex at construction, matching the rest of the M4 fp family
+ *      (delegateSet, setRegularKey, didSet, payment, etc.).
+ *
+ *   3. **"Exactly one of four" instead of "exactly one of two".**
+ *      The class enforces the rule on two fields
+ *      (`src/transactions/deposit-preauth.ts:38-43`):
+ *      `Authorize XOR Unauthorize`. XRPL.org and xrpl.js both require
+ *      EXACTLY ONE of `Authorize`, `Unauthorize`,
+ *      `AuthorizeCredentials`, `UnauthorizeCredentials`. The factory
+ *      enforces the 4-way XOR per xrpl.js
+ *      `validateSingleAuthorizationFieldProvided`
+ *      (`DepositPreauth.ts:88-104`) and XRPL.org
+ *      `depositpreauth.md:66` "You must provide exactly one of …".
+ *      Source: xrpl.js `DepositPreauth.ts:88-104`; XRPL.org
+ *      `depositpreauth.md:66`.
+ *
+ *   4. **`AuthorizeCredentials` and `UnauthorizeCredentials` are
+ *      modelled (XLS-70).** The class does not declare these fields
+ *      at all. The binary codec accepts them (per
+ *      `ripple-binary-codec definitions.json` DepositPreauth
+ *      definition), but the class refuses them via TypeScript.
+ *      Without these fields a caller cannot preauthorize or
+ *      unauthorize a credential — a common workflow under the
+ *      Credentials amendment. The factory exposes both. Source:
+ *      xrpl.js `DepositPreauth.ts:33-38`; XRPL.org
+ *      `depositpreauth.md:36-53` (the Credential preauthorization
+ *      JSON example); XLS-70 §3.
+ *
+ *   5. **`Account` cannot equal `Authorize` or `Unauthorize`
+ *      (`temCANNOT_PREAUTH_SELF`).** xrpl.js rejects this via
+ *      `validateAuthorizationField` and `areAddressesEqual`
+ *      (`DepositPreauth.ts:41-55`); XRPL.org documents the resulting
+ *      error code `temCANNOT_PREAUTH_SELF` ("You cannot preauthorize
+ *      yourself") at `depositpreauth.md:91`. The class does NOT check
+ *      this — the class validator only requires `isAccount(...)` and
+ *      does not compare against `Account`. The factory rejects
+ *      self-preauth at construction. Source: xrpl.js
+ *      `DepositPreauth.ts:41-55`; XRPL.org `depositpreauth.md:91`.
+ *
+ *   6. **`AuthorizeCredentials` / `UnauthorizeCredentials` list
+ *      validation.** xrpl.js calls `validateCredentialsList`
+ *      (`DepositPreauth.ts:71-85`) with `MAX_AUTHORIZED_CREDENTIALS =
+ *      8`. The factory mirrors this: the list must be a non-empty
+ *      array, length ≤ 8, each entry must be a valid
+ *      `AuthorizeCredential` object form (NOT a string credential
+ *      ID), and there must be no duplicate (Issuer, CredentialType)
+ *      pairs. The class has no equivalent field, so the class has no
+ *      equivalent rule. Source: xrpl.js
+ *      `DepositPreauth.ts:71-85`; xrpl.js `common.ts:28,1106-1148`;
+ *      XRPL.org `depositpreauth.md:71-78` (per-entry field table).
+ *
+ *   7. **Per-credential validation: `CredentialType` must be non-empty
+ *      hex (Blob) ≤ 64 bytes; `Issuer` must be a valid XRPL account.**
+ *      xrpl.js's `validateCredentialsList` calls `isAuthorizeCredential`
+ *      which only checks object shape + string types
+ *      (`common.ts:179-191`); it does NOT enforce hex validity on
+ *      `CredentialType` or address format on `Issuer`. The factory
+ *      adds these checks so a malformed credential surfaces at
+ *      construction rather than at the binary codec layer
+ *      (`CredentialType` is `Blob` per XRPL.org
+ *      `depositpreauth.md:78`, and `Issuer` is `AccountID` per
+ *      `depositpreauth.md:77`). Source: xrpl.js `common.ts:179-191`;
+ *      XRPL.org `depositpreauth.md:71-78`; XLS-70 §2.1.3 (64-byte
+ *      CredentialType cap).
+ */
+import type { AuthorizeCredential } from '../../types/common.js';
+/**
+ * Props for the `DepositPreauth` factory.
+ *
+ * Four mutually exclusive "payload" fields are supported by the
+ * binary codec. Exactly one of them MUST be supplied (per XRPL.org
+ * and xrpl.js `validateSingleAuthorizationFieldProvided`).
+ */
+export interface DepositPreauthProps {
+    /**
+     * The unique address of the transaction sender. The owner of the
+     * deposit-authorization slot. Required, must be a valid XRPL
+     * classic or X-address.
+     */
+    Account: string;
+    /**
+     * An account to preauthorize (grant the right to deliver payments
+     * to `Account`). Must differ from `Account` (`temCANNOT_PREAUTH_SELF`).
+     * Mutually exclusive with `Unauthorize`, `AuthorizeCredentials`,
+     * `UnauthorizeCredentials`.
+     */
+    Authorize?: string | undefined;
+    /**
+     * An account whose preauthorization should be revoked. Must differ
+     * from `Account`. Mutually exclusive with the other three payload
+     * fields.
+     */
+    Unauthorize?: string | undefined;
+    /**
+     * A list of credentials to preauthorize (XLS-70). 1–8 unique
+     * `AuthorizeCredential` entries. Mutually exclusive with the other
+     * three payload fields.
+     */
+    AuthorizeCredentials?: AuthorizeCredential[] | undefined;
+    /**
+     * A list of credentials whose preauthorization should be revoked
+     * (XLS-70). 1–8 unique `AuthorizeCredential` entries. Mutually
+     * exclusive with the other three payload fields.
+     */
+    UnauthorizeCredentials?: AuthorizeCredential[] | undefined;
+    /**
+     * Bit-flags for this transaction. DepositPreauth defines no
+     * transaction-specific flags; only the universal
+     * `tfFullyCanonicalSig` (0x80000000) is meaningful.
+     */
+    Flags?: number | undefined;
+    /** Fee in XRP (drops), base-10 integer string. */
+    Fee?: string | undefined;
+    /** Account sequence number. */
+    Sequence?: number | undefined;
+}
+export interface DepositPreauth extends Readonly<DepositPreauthProps> {
+    readonly TransactionType: 'DepositPreauth';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<DepositPreauthProps>): DepositPreauth;
+}
+/**
+ * Build a frozen DepositPreauth. Throws `ValidationError` on
+ * construction if any required field is missing, malformed, or if
+ * the mutually-exclusive-payload rule is violated.
+ */
+export declare function depositPreauth(props: DepositPreauthProps): DepositPreauth;
+//# sourceMappingURL=deposit-preauth.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deposit-preauth.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/deposit-preauth.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsHG;AACH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AA2BjE;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,EAAE,GAAG,SAAS,CAAC;IAEzD;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,mBAAmB,EAAE,GAAG,SAAS,CAAC;IAE3D;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,cACf,SAAQ,QAAQ,CAAC,mBAAmB,CAAC;IACrC,QAAQ,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAC3C,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,cAAc,CAAC;CAC/D;AAuGD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,mBAAmB,GAAG,cAAc,CA6GzE"}

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

@@ -0,0 +1,159 @@
+import { isAccount, isAuthorizeCredential, isHex, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+/**
+ * Maximum number of credentials accepted in `AuthorizeCredentials` /
+ * `UnauthorizeCredentials`. Mirrors xrpl.js `MAX_AUTHORIZED_CREDENTIALS`.
+ * Source: xrpl.js `common.ts:28`.
+ */
+const MAX_AUTHORIZED_CREDENTIALS = 8;
+/**
+ * `CredentialType` is a hex-encoded Blob capped at 64 bytes per
+ * XLS-0070 §2.1.3.
+ */
+const MAX_CREDENTIAL_TYPE_BYTES = 64;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Validate a single `AuthorizeCredential.CredentialType` payload per
+ * XLS-0070 §2.1.3: hex string, non-empty, even length, ≤ 64 bytes.
+ */
+function validateCredentialType(txType, path, value) {
+    if (!isString(value)) {
+        throw new ValidationError(`${txType}: ${path}.Credential.CredentialType must be a hex string`);
+    }
+    if (value.length === 0) {
+        throw new ValidationError(`${txType}: ${path}.Credential.CredentialType must not be empty`);
+    }
+    if (!isHex(value)) {
+        throw new ValidationError(`${txType}: ${path}.Credential.CredentialType must be a hex string`);
+    }
+    if (value.length % 2 !== 0) {
+        throw new ValidationError(`${txType}: ${path}.Credential.CredentialType must be a hex string with an even number of characters`);
+    }
+    const bytes = value.length / 2;
+    if (bytes > MAX_CREDENTIAL_TYPE_BYTES) {
+        throw new ValidationError(`${txType}: ${path}.Credential.CredentialType exceeds ${MAX_CREDENTIAL_TYPE_BYTES} bytes (actual: ${bytes})`);
+    }
+    return value;
+}
+/**
+ * Validate a credentials list (`AuthorizeCredentials` or
+ * `UnauthorizeCredentials`). Mirrors xrpl.js `validateCredentialsList`
+ * for DepositPreauth (object-form, not string-IDs; cap 8; no dupes),
+ * plus stricter per-element validation (hex CredentialType, valid
+ * Issuer address).
+ */
+function validateCredentialsArray(txType, fieldName, list) {
+    if (!Array.isArray(list)) {
+        throw new ValidationError(`${txType}: ${fieldName} must be an array`);
+    }
+    if (list.length === 0) {
+        throw new ValidationError(`${txType}: ${fieldName} cannot be an empty array`);
+    }
+    if (list.length > MAX_AUTHORIZED_CREDENTIALS) {
+        throw new ValidationError(`${txType}: ${fieldName} length cannot exceed ${MAX_AUTHORIZED_CREDENTIALS} elements (actual: ${list.length})`);
+    }
+    const seen = new Set();
+    list.forEach((credential, idx) => {
+        if (!isAuthorizeCredential(credential)) {
+            throw new ValidationError(`${txType}: ${fieldName}[${idx}] is not a valid AuthorizeCredential object`);
+        }
+        const credObj = credential.Credential;
+        // ── Issuer must be a valid XRPL account (XRPL.org says
+        //    AccountID; class has no equivalent field so no precedent).
+        if (!isAccount(credObj.Issuer)) {
+            throw new ValidationError(`${txType}: ${fieldName}[${idx}].Credential.Issuer must be a valid XRPL address`);
+        }
+        // ── CredentialType must be a non-empty hex Blob ≤ 64 bytes.
+        validateCredentialType(txType, `${fieldName}[${idx}]`, credObj.CredentialType);
+        // ── No duplicate (Issuer, CredentialType) pairs (XLS-0070).
+        const key = `${credObj.Issuer}-${credObj.CredentialType}`;
+        if (seen.has(key)) {
+            throw new ValidationError(`${txType}: ${fieldName} cannot contain duplicate elements`);
+        }
+        seen.add(key);
+    });
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+/**
+ * Build a frozen DepositPreauth. Throws `ValidationError` on
+ * construction if any required field is missing, malformed, or if
+ * the mutually-exclusive-payload rule is violated.
+ */
+export function depositPreauth(props) {
+    // ── Account ── required, must be a valid XRPL classic/X-address.
+    require(props.Account, 'DepositPreauth: missing or invalid Account', isAccount);
+    // ── "Exactly one of four" payload XOR ──
+    // xrpl.js `validateSingleAuthorizationFieldProvided`
+    // (`DepositPreauth.ts:88-104`) and XRPL.org
+    // `depositpreauth.md:66`.
+    const hasAuth = props.Authorize !== undefined;
+    const hasUnauth = props.Unauthorize !== undefined;
+    const hasAuthCreds = props.AuthorizeCredentials !== undefined;
+    const hasUnauthCreds = props.UnauthorizeCredentials !== undefined;
+    const payloadCount = Number(hasAuth) +
+        Number(hasUnauth) +
+        Number(hasAuthCreds) +
+        Number(hasUnauthCreds);
+    if (payloadCount !== 1) {
+        throw new ValidationError('DepositPreauth: requires exactly one of Authorize, Unauthorize, AuthorizeCredentials, or UnauthorizeCredentials');
+    }
+    // ── Authorize ── if present, must be a valid account and must not
+    //    equal Account (`temCANNOT_PREAUTH_SELF`).
+    if (hasAuth) {
+        if (!isString(props.Authorize)) {
+            throw new ValidationError('DepositPreauth: Authorize must be a string');
+        }
+        if (!isAccount(props.Authorize)) {
+            throw new ValidationError('DepositPreauth: Authorize must be a valid XRPL address');
+        }
+        if (props.Authorize === props.Account) {
+            throw new ValidationError('DepositPreauth: Account cannot preauthorize itself (temCANNOT_PREAUTH_SELF)');
+        }
+    }
+    // ── Unauthorize ── if present, must be a valid account and must
+    //    not equal Account (symmetric `temCANNOT_PREAUTH_SELF` rule
+    //    via xrpl.js `validateAuthorizationField`).
+    if (hasUnauth) {
+        if (!isString(props.Unauthorize)) {
+            throw new ValidationError('DepositPreauth: Unauthorize must be a string');
+        }
+        if (!isAccount(props.Unauthorize)) {
+            throw new ValidationError('DepositPreauth: Unauthorize must be a valid XRPL address');
+        }
+        if (props.Unauthorize === props.Account) {
+            throw new ValidationError('DepositPreauth: Account cannot unauthorize itself (temCANNOT_PREAUTH_SELF)');
+        }
+    }
+    // ── AuthorizeCredentials ── if present, must be a valid 1..8
+    //    list of unique AuthorizeCredential objects.
+    if (hasAuthCreds) {
+        validateCredentialsArray('DepositPreauth', 'AuthorizeCredentials', props.AuthorizeCredentials);
+    }
+    // ── UnauthorizeCredentials ── if present, must be a valid 1..8
+    //    list of unique AuthorizeCredential objects.
+    if (hasUnauthCreds) {
+        validateCredentialsArray('DepositPreauth', 'UnauthorizeCredentials', props.UnauthorizeCredentials);
+    }
+    return buildFrozenTx('DepositPreauth', 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 depositPreauth(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=deposit-preauth.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"deposit-preauth.js","sourceRoot":"","sources":["../../../src/fp/factories/deposit-preauth.ts"],"names":[],"mappings":"AAwHA,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,KAAK,EACL,QAAQ,GACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE;;;;GAIG;AACH,MAAM,0BAA0B,GAAG,CAAC,CAAC;AAErC;;;GAGG;AACH,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAoErC,wEAAwE;AAExE;;;GAGG;AACH,SAAS,sBAAsB,CAC7B,MAAc,EACd,IAAY,EACZ,KAAc;IAEd,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,IAAI,iDAAiD,CACpE,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,IAAI,8CAA8C,CACjE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,IAAI,iDAAiD,CACpE,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,IAAI,mFAAmF,CACtG,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,IAAI,KAAK,GAAG,yBAAyB,EAAE,CAAC;QACtC,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,IAAI,sCAAsC,yBAAyB,mBAAmB,KAAK,GAAG,CAC7G,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAC/B,MAAc,EACd,SAA4D,EAC5D,IAAa;IAEb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,SAAS,mBAAmB,CAC3C,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,SAAS,2BAA2B,CACnD,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,0BAA0B,EAAE,CAAC;QAC7C,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,SAAS,yBAAyB,0BAA0B,sBAAsB,IAAI,CAAC,MAAM,GAAG,CAC/G,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;QAC/B,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,SAAS,IAAI,GAAG,6CAA6C,CAC5E,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC;QACtC,wDAAwD;QACxD,gEAAgE;QAChE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,SAAS,IAAI,GAAG,kDAAkD,CACjF,CAAC;QACJ,CAAC;QACD,6DAA6D;QAC7D,sBAAsB,CACpB,MAAM,EACN,GAAG,SAAS,IAAI,GAAG,GAAG,EACtB,OAAO,CAAC,cAAc,CACvB,CAAC;QACF,6DAA6D;QAC7D,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;QAC1D,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,KAAK,SAAS,oCAAoC,CAC5D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,wEAAwE;AAExE;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,KAA0B;IACvD,kEAAkE;IAClE,OAAO,CACL,KAAK,CAAC,OAAO,EACb,4CAA4C,EAC5C,SAAS,CACV,CAAC;IAEF,0CAA0C;IAC1C,qDAAqD;IACrD,4CAA4C;IAC5C,0BAA0B;IAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;IAC9C,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,KAAK,SAAS,CAAC;IAClD,MAAM,YAAY,GAAG,KAAK,CAAC,oBAAoB,KAAK,SAAS,CAAC;IAC9D,MAAM,cAAc,GAAG,KAAK,CAAC,sBAAsB,KAAK,SAAS,CAAC;IAClE,MAAM,YAAY,GAChB,MAAM,CAAC,OAAO,CAAC;QACf,MAAM,CAAC,SAAS,CAAC;QACjB,MAAM,CAAC,YAAY,CAAC;QACpB,MAAM,CAAC,cAAc,CAAC,CAAC;IACzB,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,eAAe,CACvB,iHAAiH,CAClH,CAAC;IACJ,CAAC;IAED,mEAAmE;IACnE,+CAA+C;IAC/C,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,eAAe,CACvB,4CAA4C,CAC7C,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,eAAe,CACvB,wDAAwD,CACzD,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,eAAe,CACvB,6EAA6E,CAC9E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,iEAAiE;IACjE,gEAAgE;IAChE,gDAAgD;IAChD,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,eAAe,CACvB,8CAA8C,CAC/C,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,eAAe,CACvB,0DAA0D,CAC3D,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,WAAW,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACxC,MAAM,IAAI,eAAe,CACvB,4EAA4E,CAC7E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,8DAA8D;IAC9D,iDAAiD;IACjD,IAAI,YAAY,EAAE,CAAC;QACjB,wBAAwB,CACtB,gBAAgB,EAChB,sBAAsB,EACtB,KAAK,CAAC,oBAAoB,CAC3B,CAAC;IACJ,CAAC;IAED,gEAAgE;IAChE,iDAAiD;IACjD,IAAI,cAAc,EAAE,CAAC;QACnB,wBAAwB,CACtB,gBAAgB,EAChB,wBAAwB,EACxB,KAAK,CAAC,sBAAsB,CAC7B,CAAC;IACJ,CAAC;IAED,OAAO,aAAa,CAClB,gBAAgB,EAChB,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,CAAuB,SAAuC;YAChE,OAAO,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACvD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/did-delete.d.ts

@@ -0,0 +1,22 @@
+export interface DIDDeleteProps {
+    /** The unique address of the transaction sender. Must own a DID. */
+    Account: string;
+    /**
+     * Optional bit-flags. DIDDelete defines no per-tx flags; only the
+     * two global flags `tfFullyCanonicalSig` (0x80000000) and
+     * `tfInnerBatchTxn` (0x40000000) are valid.
+     */
+    Flags?: number | undefined;
+    /** Fee in XRP (drops), base-10 integer string. */
+    Fee?: string | undefined;
+    /** Account sequence number. */
+    Sequence?: number | undefined;
+}
+export interface DIDDelete extends Readonly<DIDDeleteProps> {
+    readonly TransactionType: 'DIDDelete';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<DIDDeleteProps>): DIDDelete;
+}
+export declare function didDelete(props: DIDDeleteProps): DIDDelete;
+//# sourceMappingURL=did-delete.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"did-delete.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/did-delete.ts"],"names":[],"mappings":"AA6FA,MAAM,WAAW,cAAc;IAC7B,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,kDAAkD;IAClD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,SAAU,SAAQ,QAAQ,CAAC,cAAc,CAAC;IACzD,QAAQ,CAAC,eAAe,EAAE,WAAW,CAAC;IACtC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;CACrD;AAID,wBAAgB,SAAS,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,CA6C1D"}