xrpjson 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jonathan Dobson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,183 @@
+# xrpjs
+
+Functional transaction factories for the XRP Ledger — 79 frozen-shape
+builders verified against [xrpl.js](https://github.com/XRPLF/xrpl.js),
+[xrpl.org](https://xrpl.org/), and [XLS specs](https://github.com/XRPLF/XRPL-Standards).
+
+```ts
+import { payment, accountSet, vaultCreate } from 'xrpjs';
+
+const tx = payment({
+  Account: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
+  Destination: 'rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe',
+  Amount: '1000000', // 1 XRP in drops
+});
+
+// tx is frozen — every field is validated at construction time.
+// toJSON() produces a wire-format object ready for xrpl.encode().
+const wire = tx.toJSON();
+```
+
+## What it is
+
+`xrpjs` is the functional-programming API for building XRPL transactions.
+Every factory returns a **frozen** transaction object with **eager validation**
+at construction. If a required field is missing, malformed, or violates a
+ledger rule the factory knows about, the call throws — no separate
+`.validate()` step, no silent preclaim failures at submit time.
+
+Each transaction family (`payment`, `vaultCreate`, `ammDeposit`, ...) has
+its own factory. Importing one pulls in only that factory's code (full
+tree-shaking).
+
+## What it covers
+
+**79 transaction types** (every class in v0.7.1's `src/transactions/`,
+including the XLS-38d Sidechain family):
+
+- **Account:** `accountDelete`, `accountSet`
+- **AMM** (7): XLS-0030
+- **Batch:** `batch` (BatchV1_1)
+- **Check** (3): `checkCancel`, `checkCash`, `checkCreate`
+- **Clawback:** `clawback`
+- **ConfidentialMPT** (5): ConfidentialTransfer amendment
+- **Credential** (3): XLS-0070
+- **Delegate:** `delegateSet` (XLS-0085d)
+- **DepositPreauth:** 4-way field rule (XLS-0070)
+- **DID** (2): XLS-0040
+- **Escrow** (3)
+- **LedgerStateFix**
+- **Loan** (4) + **LoanBroker** (5): LendingProtocol amendment
+- **MPT** (4): XLS-0033
+- **NFToken** (6): XLS-0020
+- **Offer** (2)
+- **Oracle** (2)
+- **Payment**
+- **PaymentChannel** (3)
+- **PermissionedDomain** (2)
+- **SetRegularKey**
+- **SignerListSet**
+- **Sponsorship** (2): Sponsor amendment
+- **TicketCreate**
+- **TrustSet**
+- **Vault** (6): SingleAssetVault amendment
+- **XChain** (8): XLS-0038d Sidechain amendment
+
+## What it adds over the class API
+
+Every factory file ships a `## Divergences` header listing the guards it
+adds beyond `src/transactions/<TxName>.ts`. Examples:
+
+- **`vaultCreate`**: rejects `VaultID === '00…00'` (64-char all-zero
+  hex would fail at the ledger with `temMALFORMED`); `Amount` must be
+  strictly positive across all 3 forms (XRP drops / IOU object / MPT
+  object).
+- **`ammDeposit` / `ammWithdraw`**: validates `Asset` and `Asset2` as
+  `Currency` (no MPT), enforces the "Amount2 requires Amount" and
+  "EPrice requires Amount" cross-field rules, plus exactly-one
+  AMM-withdraw mode flag.
+- **`batch`**: validates `RawTransactions` 2..8, exclusive `Flags` on
+  the outer tx, inner-tx `Sequence XOR TicketSequence`, `BatchSigners`
+  ≤ 24 + sorted + no duplicates, outer `Account` not in `BatchSigners`.
+- **`nftokenCreateOffer`**: rejects `Owner` on sell offers, requires
+  `Owner` on buy offers, rejects `Owner === Account`, 64-char hex
+  `NFTokenID`.
+- **`nftokenCancelOffer`**: rejects duplicate offer IDs, max 500
+  entries per rippled `kMaxTokenOfferCancelCount`.
+- **`signerListSet`**: ≤ 32 entries, positive `SignerWeight`, no
+  self-listing, 64-char hex `WalletLocator`.
+- **`xchainCreateBridge` / `xchainModifyBridge`**: enforces 4-key
+  bridge shape (`LockingChainDoor`, `LockingChainIssue`,
+  `IssuingChainDoor`, `IssuingChainIssue`), bridge doors as valid
+  XRPL accounts, `SignatureReward` / `MinAccountCreateAmount` as
+  strictly positive XRP drops strings (XLS-38 §2.1.1.1.3/1.4),
+  `Account === LockingChainDoor` equality.
+
+Every divergence is cited: file path + line number in
+[xrpl.js](https://github.com/XRPLF/xrpl.js),
+[xrpl.org docs](https://xrpl.org/), and the relevant XLS spec.
+
+## Usage
+
+```ts
+import { payment, vaultCreate, nftokenCreateOffer } from 'xrpjs';
+
+// 1. Build a frozen, validated tx.
+const tx = payment({
+  Account: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
+  Destination: 'rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe',
+  Amount: '1000000',
+});
+
+// 2. (optional) derive a new tx with overrides — re-validates.
+const withHigherFee = tx.with({ Fee: '20' });
+
+// 3. Serialize for the wire format.
+const wire = tx.toJSON();
+// wire is a plain object matching the canonical XRPL JSON shape.
+
+// 4. Encode + sign + submit via xrpl.js (or your own client).
+import { encode, sign, submit } from 'xrpl';
+const encoded = encode(wire);
+const signed = sign(wallet, encoded);
+await submit(signed);
+```
+
+The factory is pure — no global state, no I/O, no side effects. You can
+construct thousands of transactions per second.
+
+## Verification discipline
+
+Every factory is verified against **three canonical sources** before
+landing:
+
+1. **xrpl.js 5.3.0** at `~/.mavis/docs.local/xrpl.js/` — the canonical
+   JavaScript validator. We check what `validate<Transaction>` does and
+   *what it skips*.
+2. **xrpl.org docs** at `~/.mavis/docs.local/xrpl-dev-portal/` — the
+   human-readable reference. We extract the field tables, internal
+   types, and error code catalog.
+3. **XLS specs** at `~/.mavis/docs.local/xrpl-standards/` — the
+   authoritative spec text. We read the amendment's field table,
+   preclaim rules, and cross-field invariants.
+
+When the three sources disagree, the XLS spec wins. The factory
+documents the divergence with citation.
+
+## Out of scope (vs. the class-based `xrplt` package)
+
+- Pseudo-transactions: `EnableAmendment`, `LedgerEntry` (state query)
+- Deprecated: `UNLModify`
+- Future amendments not enabled in v0.7.1: `SetFee` (XRPL hook amendment)
+
+If you need these, use the class-based [`xrplt`](https://github.com/Jonathan-Dobson/xrplt) package.
+
+## Development
+
+```bash
+git clone https://github.com/Jonathan-Dobson/xrpjs.git
+cd xrpjs
+npm ci
+npm test        # run the 79 test files (2829 tests)
+npm run lint    # ESLint 9 flat config + typescript-eslint strict
+npm run build   # tsc → dist/
+```
+
+Tests use `vitest`. The factories are pure ESM with TypeScript strict
+mode (`noUncheckedIndexedAccess`, `exactOptionalPropertyTypes`, etc.).
+No runtime dependencies.
+
+## License
+
+MIT
+
+## Related projects
+
+- [`xrplt`](https://github.com/Jonathan-Dobson/xrplt) — class-based
+  transaction builder, full v0.7.1 transaction coverage. `xrpjs` is the
+  fp refactor of `xrplt`'s functional subpath (`xrplt/fp`).
+- [xrpl.js](https://github.com/XRPLF/xrpl.js) — the canonical JavaScript
+  library; `xrpjs` uses xrpl.js as a devDep for test round-tripping
+  (encode/decode).
+- [XRPL Standards](https://github.com/XRPLF/XRPL-Standards) — the
+  amendment specs `xrpjs` verifies against.

package/dist/errors.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Custom error types for the xrplt package.
+ *
+ * These are standalone — no dependency on xrpl's error hierarchy.
+ */
+/**
+ * Thrown when a transaction fails runtime validation.
+ */
+export declare class ValidationError extends Error {
+    readonly name = "ValidationError";
+    constructor(message: string);
+}
+/**
+ * Thrown when a transaction operation fails (e.g. unknown type in registry).
+ */
+export declare class TransactionError extends Error {
+    readonly name = "TransactionError";
+    constructor(message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IACxC,SAAkB,IAAI,qBAAqB;gBAE/B,OAAO,EAAE,MAAM;CAK5B;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,SAAkB,IAAI,sBAAsB;gBAEhC,OAAO,EAAE,MAAM;CAI5B"}

package/dist/errors.js

@@ -0,0 +1,27 @@
+/**
+ * Custom error types for the xrplt package.
+ *
+ * These are standalone — no dependency on xrpl's error hierarchy.
+ */
+/**
+ * Thrown when a transaction fails runtime validation.
+ */
+export class ValidationError extends Error {
+    name = 'ValidationError';
+    constructor(message) {
+        super(message);
+        // Ensure proper prototype chain for instanceof checks
+        Object.setPrototypeOf(this, ValidationError.prototype);
+    }
+}
+/**
+ * Thrown when a transaction operation fails (e.g. unknown type in registry).
+ */
+export class TransactionError extends Error {
+    name = 'TransactionError';
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, TransactionError.prototype);
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACtB,IAAI,GAAG,iBAAiB,CAAC;IAE3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,sDAAsD;QACtD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACzD,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IACvB,IAAI,GAAG,kBAAkB,CAAC;IAE5C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC1D,CAAC;CACF"}

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

@@ -0,0 +1,33 @@
+export interface AccountDeleteProps {
+    Account: string;
+    /**
+     * The address of an account to receive any leftover XRP after deleting
+     * the sending account. Must be a funded account in the ledger, and must
+     * NOT be the sending account (`temDST_IS_SRC`).
+     */
+    Destination: string;
+    /**
+     * Arbitrary destination tag for the recipient. UInt32:
+     * 0 ≤ value ≤ 0xFFFFFFFF.
+     */
+    DestinationTag?: number | undefined;
+    /**
+     * (Credentials amendment) Optional set of credential IDs authorizing
+     * the deletion when the destination requires deposit authorization.
+     * When present: array must be non-empty, length ≤ 8, each entry a
+     * 64-character hex string, no duplicates.
+     */
+    CredentialIDs?: string[] | undefined;
+    /** Bit-flags for this transaction. AccountDelete has no defined flags. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface AccountDelete extends Readonly<AccountDeleteProps> {
+    readonly TransactionType: 'AccountDelete';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AccountDeleteProps>): AccountDelete;
+}
+export declare function accountDelete(props: AccountDeleteProps): AccountDelete;
+//# sourceMappingURL=account-delete.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"account-delete.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/account-delete.ts"],"names":[],"mappings":"AAwEA,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACrC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,aAAc,SAAQ,QAAQ,CAAC,kBAAkB,CAAC;IACjE,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAC1C,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,aAAa,CAAC;CAC7D;AAID,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,GAAG,aAAa,CA8FtE"}

package/dist/fp/factories/account-delete.js

@@ -0,0 +1,138 @@
+/**
+ * Functional AccountDelete factory — frozen-object style.
+ *
+ * Deletes an account and any objects it owns in the XRP Ledger, sending
+ * the leftover XRP to a specified destination account. Validation happens
+ * at construction; there is no way to construct an invalid tx.
+ *
+ *   import { accountDelete } from 'xrplt/fp';
+ *   const tx = accountDelete({ Account, Destination });
+ *   tx.validate();   // throws if construction didn't already
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ DestinationTag: 42 });
+ *
+ * Affected amendments:
+ *   - `DeletableAccounts` — base AccountDelete.
+ *   - `Credentials`       — introduces the optional `CredentialIDs` field
+ *                           for deposit-authorized deletions.
+ *   - `Sponsor`           — `tecNO_SPONSOR_PERMISSION` runtime guard
+ *                           (not locally checkable).
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/accountdelete
+ *
+ * ## Divergences
+ *
+ * The class-based API at `src/transactions/account-delete.ts` is missing
+ * three rules that the canonical sources require. The factory fills them:
+ *
+ *   1. `CredentialIDs` is not declared by the class.
+ *      The class has no `CredentialIDs` field at all, so callers using the
+ *      class API cannot authorize a deletion with deposit credentials. The
+ *      factory adds the field with full xrpl.js validation: when present
+ *      the array must be non-empty, length ≤ `MAX_AUTHORIZED_CREDENTIALS`
+ *      (8), each entry a 64-char hex string, and contain no duplicates.
+ *      Source: xrpl.js `packages/xrpl/src/models/transactions/accountDelete.ts`
+ *      `validateAccountDelete` calls `validateCredentialsList(..., true, 8)`;
+ *              `packages/xrpl/src/models/transactions/common.ts:28`
+ *              `MAX_AUTHORIZED_CREDENTIALS = 8`;
+ *              `validateCredentialsList` (`common.ts:1106`).
+ *              xrpl-dev-portal `accountdelete.md` Fields table
+ *              (`CredentialIDs` is listed as a field).
+ *
+ *   2. `temDST_IS_SRC` is not enforced.
+ *      The class never compares `Destination` against `Account`, so an
+ *      AccountDelete that names itself as the destination passes class
+ *      validation and only fails at the ledger with `temDST_IS_SRC`.
+ *      Source: xrpl-dev-portal `accountdelete.md` Error Cases table
+ *              (`temDST_IS_SRC` — "Destination matches the sender").
+ *
+ *   3. `DestinationTag` UInt32 bounds are not enforced.
+ *      The class only checks `isNumber`, so non-integer, negative, or
+ *      out-of-UInt32-range values pass. The spec defines the field as
+ *      `UInt32` (0 ≤ value ≤ 2^32 − 1).
+ *      Source: xrpl-dev-portal `accountdelete.md` Fields table
+ *              (`DestinationTag` Internal Type: `UInt32`).
+ */
+import { isAccount, isArray, isHex, isNumber, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// XRPL UInt32 max (per rippled STUInt32).
+const UINT32_MAX = 0xffffffff;
+// Credential IDs are 64-char hex (HASH256 — same as ledger entry IDs).
+// xrpl.js caps non-DomainSet credential arrays at 8 entries.
+//   packages/xrpl/src/models/transactions/common.ts: MAX_AUTHORIZED_CREDENTIALS = 8
+const CREDENTIAL_ID_LENGTH = 64;
+const MAX_CREDENTIAL_IDS = 8;
+// ─── Factory ─────────────────────────────────────────────────────────
+export function accountDelete(props) {
+    // ── Account ── required, must be a valid XRPL classic or X-address.
+    require(props.Account, 'AccountDelete: Account is required', isAccount);
+    // ── Destination ── required, must be a valid XRPL address.
+    require(props.Destination, 'AccountDelete: Destination is required', isAccount);
+    // ── temDST_IS_SRC ── Destination must not equal the sender.
+    //   xrpl-dev-portal accountdelete.md Error Cases table.
+    if (props.Destination === props.Account) {
+        throw new ValidationError('AccountDelete: Destination must not equal Account (temDST_IS_SRC)');
+    }
+    // ── DestinationTag ── UInt32 (0 ≤ value ≤ 0xFFFFFFFF, integer).
+    if (props.DestinationTag !== undefined) {
+        if (!isNumber(props.DestinationTag) ||
+            !Number.isInteger(props.DestinationTag) ||
+            props.DestinationTag < 0 ||
+            props.DestinationTag > UINT32_MAX) {
+            throw new ValidationError(`AccountDelete: DestinationTag must be an integer in [0, ${UINT32_MAX}]`);
+        }
+    }
+    // ── CredentialIDs ── optional array; bounds + entry-shape + uniqueness
+    //   enforced when present. Per xrpl.js validateAccountDelete, which calls
+    //   validateCredentialsList with maxCredentials = MAX_AUTHORIZED_CREDENTIALS = 8.
+    if (props.CredentialIDs !== undefined) {
+        if (!isArray(props.CredentialIDs)) {
+            throw new ValidationError('AccountDelete: CredentialIDs must be an array of credential ID strings');
+        }
+        if (props.CredentialIDs.length === 0) {
+            throw new ValidationError('AccountDelete: CredentialIDs must not be an empty array');
+        }
+        if (props.CredentialIDs.length > MAX_CREDENTIAL_IDS) {
+            throw new ValidationError(`AccountDelete: CredentialIDs length cannot exceed ${MAX_CREDENTIAL_IDS} elements (actual: ${props.CredentialIDs.length})`);
+        }
+        for (let i = 0; i < props.CredentialIDs.length; i++) {
+            const cid = props.CredentialIDs[i];
+            if (!isString(cid) ||
+                !isHex(cid) ||
+                cid.length !== CREDENTIAL_ID_LENGTH) {
+                throw new ValidationError(`AccountDelete: CredentialIDs[${i}] must be a ${CREDENTIAL_ID_LENGTH}-character hex string`);
+            }
+        }
+        // xrpl.js validateCredentialsList rejects duplicates; mirror that
+        // (xrpl.js common.ts: containsDuplicates check).
+        const seen = new Set();
+        for (const cid of props.CredentialIDs) {
+            if (seen.has(cid)) {
+                throw new ValidationError('AccountDelete: CredentialIDs cannot contain duplicate elements');
+            }
+            seen.add(cid);
+        }
+    }
+    return buildFrozenTx('AccountDelete', 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 accountDelete(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=account-delete.js.map

package/dist/fp/factories/account-delete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-delete.js","sourceRoot":"","sources":["../../../src/fp/factories/account-delete.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,0CAA0C;AAC1C,MAAM,UAAU,GAAG,UAAU,CAAC;AAE9B,uEAAuE;AACvE,6DAA6D;AAC7D,oFAAoF;AACpF,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAqC7B,wEAAwE;AAExE,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,qEAAqE;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,oCAAoC,EAAE,SAAS,CAAC,CAAC;IAExE,4DAA4D;IAC5D,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,wCAAwC,EAAE,SAAS,CAAC,CAAC;IAEhF,6DAA6D;IAC7D,wDAAwD;IACxD,IAAI,KAAK,CAAC,WAAW,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;QACxC,MAAM,IAAI,eAAe,CACvB,mEAAmE,CACpE,CAAC;IACJ,CAAC;IAED,iEAAiE;IACjE,IAAI,KAAK,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACvC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;YAC/B,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC;YACvC,KAAK,CAAC,cAAc,GAAG,CAAC;YACxB,KAAK,CAAC,cAAc,GAAG,UAAU,EACjC,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,2DAA2D,UAAU,GAAG,CACzE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,wEAAwE;IACxE,0EAA0E;IAC1E,kFAAkF;IAClF,IAAI,KAAK,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,eAAe,CACvB,wEAAwE,CACzE,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,eAAe,CACvB,yDAAyD,CAC1D,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,kBAAkB,EAAE,CAAC;YACpD,MAAM,IAAI,eAAe,CACvB,qDAAqD,kBAAkB,sBAAsB,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAC3H,CAAC;QACJ,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YACnC,IACE,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACd,CAAC,KAAK,CAAC,GAAG,CAAC;gBACX,GAAG,CAAC,MAAM,KAAK,oBAAoB,EACnC,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,gCAAgC,CAAC,eAAe,oBAAoB,uBAAuB,CAC5F,CAAC;YACJ,CAAC;QACH,CAAC;QACD,kEAAkE;QAClE,iDAAiD;QACjD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACtC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,eAAe,CACvB,gEAAgE,CACjE,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,eAAe,EACf,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAsB,SAAsC;YAC9D,OAAO,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACtD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,31 @@
+export interface AccountSetProps {
+    Account: string;
+    /** Flag to clear on the account. */
+    ClearFlag?: number | undefined;
+    /** Domain name associated with this account (hex encoded). */
+    Domain?: string | undefined;
+    /** Email hash (e.g. for Gravatar). */
+    EmailHash?: string | undefined;
+    /** Message key for encrypted messaging. */
+    MessageKey?: string | undefined;
+    /** NFT collection fee (0-50,000). */
+    NFTokenBrokerFee?: number | undefined;
+    /** Flag to enable on the account. */
+    SetFlag?: number | undefined;
+    /** Transfer rate for issued currencies (drops per billion). */
+    TransferRate?: number | undefined;
+    /** Tick size for offer matching (3-15 or 0 to disable). */
+    TickSize?: number | undefined;
+    /** Bit-flags for this transaction. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface AccountSet extends Readonly<AccountSetProps> {
+    readonly TransactionType: 'AccountSet';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AccountSetProps>): AccountSet;
+}
+export declare function accountSet(props: AccountSetProps): AccountSet;
+//# sourceMappingURL=account-set.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"account-set.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/account-set.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,8DAA8D;IAC9D,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,sCAAsC;IACtC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,qCAAqC;IACrC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,UACf,SAAQ,QAAQ,CAAC,eAAe,CAAC;IACjC,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC;IACvC,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,CAAC;CACvD;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,UAAU,CAmD7D"}

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

@@ -0,0 +1,44 @@
+/**
+ * Functional AccountSet factory — frozen-object style.
+ *
+ * Companion prototype to payment.ts. Validates at construction, returns
+ * a frozen object with bound validate/toJSON/with methods.
+ */
+import { isNumber, isString } from '../../validation/helpers.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+export function accountSet(props) {
+    // Validate optional fields when present
+    if (props.TransferRate !== undefined) {
+        require(props.TransferRate, 'AccountSet: TransferRate must be a number', isNumber);
+    }
+    if (props.TickSize !== undefined) {
+        require(props.TickSize, 'AccountSet: TickSize must be a number', isNumber);
+        if (props.TickSize !== 0 &&
+            (props.TickSize < 3 || props.TickSize > 15)) {
+            throw new Error('AccountSet: TickSize must be 3-15 or 0');
+        }
+    }
+    if (props.Domain !== undefined) {
+        require(props.Domain, 'AccountSet: Domain must be a string', isString);
+    }
+    return buildFrozenTx('AccountSet', 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 accountSet(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=account-set.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"account-set.js","sourceRoot":"","sources":["../../../src/fp/factories/account-set.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAkCnE,MAAM,UAAU,UAAU,CAAC,KAAsB;IAC/C,wCAAwC;IACxC,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACrC,OAAO,CACL,KAAK,CAAC,YAAY,EAClB,2CAA2C,EAC3C,QAAQ,CACT,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,OAAO,CACL,KAAK,CAAC,QAAQ,EACd,uCAAuC,EACvC,QAAQ,CACT,CAAC;QACF,IACE,KAAK,CAAC,QAAQ,KAAK,CAAC;YACpB,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC,EAC3C,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,CACL,KAAK,CAAC,MAAM,EACZ,qCAAqC,EACrC,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,OAAO,aAAa,CAClB,YAAY,EACZ,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,CAAmB,SAAmC;YACxD,OAAO,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACnD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,134 @@
+/**
+ * Functional AMMBid factory — frozen-object style.
+ *
+ * Bids on an Automated Market Maker's (AMM's) auction slot. If the
+ * bid wins, the sender can trade against the AMM at a discounted
+ * fee for up to 24 hours. Validation happens at construction;
+ * there is no way to construct an invalid tx.
+ *
+ *   import { ammBid } from 'xrplt/fp';
+ *   const tx = ammBid({
+ *     Account,
+ *     Asset:  { currency: 'XRP' },
+ *     Asset2: { currency: 'TST', issuer: 'r…' },
+ *     BidMax: { currency: '039C99…', issuer: 'r…', value: '100' },
+ *     AuthAccounts: [
+ *       { AuthAccount: { Account: 'r…' } },
+ *     ],
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ BidMax: { …, value: '200' } });
+ *
+ * Affected amendments:
+ *   - `AMM` (base AMMBid)
+ *   - `fixCleanup3_4_0` (minimum-bid floor when trading fee is 0;
+ *     runtime, not locally checkable)
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/ammbid
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0030-automated-market-maker
+ *
+ * ## Divergences
+ * The factory enforces seven preclaim checks that the class API
+ * (`src/transactions/amm-bid.ts`) skips:
+ *
+ *   1. `Asset` must be a valid `Currency` (XRP / IOU / MPT), not
+ *      merely a record. The class API uses `isRecord(this.Asset)`,
+ *      which accepts any object — including an MPT, an arbitrary
+ *      object, or an incomplete IOU object.
+ *      Source: xrpl.js `validateAMMBid` lines 66–72 — throws
+ *      `'AMMBid: missing field Asset'` (undefined/null) and
+ *      `'AMMBid: Asset must be a Currency'`.
+ *      Note: xrpl.js's `validateAMMBid` uses `isIssuedCurrency`
+ *      (XRP-form OR IOU-form, NOT MPT), which is narrower than
+ *      the xrpl.org `ammbid.md` Fields table — "the asset can be
+ *      XRP, a token, or an MPT". The factory uses `isCurrency`
+ *      (XRP / IOU / MPT) to honor the broader spec.
+ *
+ *   2. `Asset2` must be a valid `Currency` (XRP / IOU / MPT).
+ *      Same source as #1, but applied to Asset2 (xrpl.js lines 74–80).
+ *
+ *   3. `BidMin`, when present, must be an `IssuedCurrencyAmount`.
+ *      LP tokens are always issued currencies — never XRP and never
+ *      an MPT — so this guards against malformed bid amounts that
+ *      would be rejected at submit time as `temBAD_AMM_TOKENS`
+ *      (xrpl.org `ammbid.md` Error Cases: "The specified `BidMin`
+ *      or `BidMax` were not specified as the correct LP Tokens for
+ *      this AMM").
+ *      Source: xrpl.js `validateAMMBid` lines 82–84 — throws
+ *      `'AMMBid: BidMin must be an Amount'`. The class API does
+ *      not validate `BidMin` at all.
+ *      (Note: xrpl.js uses `isAmount` here, which allows XRP/MPT
+ *      forms. The factory tightens this to `IssuedCurrencyAmount`
+ *      to match the LP-token semantics and the typed
+ *      `AMMBid.BidMin?: IssuedCurrencyAmount` declaration.)
+ *
+ *   4. `BidMax`, when present, must be an `IssuedCurrencyAmount`.
+ *      Same rationale as #3, applied to `BidMax` (xrpl.js lines
+ *      86–88). The class API does not validate `BidMax`.
+ *
+ *   5. `AuthAccounts`, when present, must be an array. The class
+ *      API types it as `Record<string, string>[]` but performs no
+ *      runtime array check.
+ *      Source: xrpl.js `validateAMMBid` lines 90–95 — throws
+ *      `'AMMBid: AuthAccounts must be an AuthAccount array'`.
+ *
+ *   6. `AuthAccounts.length` must not exceed 4.
+ *      Source: xrpl.js `validateAMMBid` lines 96–100 — throws
+ *      `'AMMBid: AuthAccounts length must not be greater than 4'`;
+ *      xrpl.org `ammbid.md` Fields table — "A list of up to 4
+ *      additional accounts" — and Error Cases: `temMALFORMED`
+ *      "such as a list of `AuthAccounts` that is too long".
+ *
+ *   7. Each element of `AuthAccounts` must have the inner shape
+ *      `{ AuthAccount: { Account: <string> } }`, AND `AuthAccounts`
+ *      must NOT include the sender's address.
+ *      Source: xrpl.js `validateAuthAccounts` lines 105–129 — throws
+ *      `'AMMBid: invalid AuthAccounts'` for malformed inner records
+ *      and `'AMMBid: AuthAccounts must not include sender's address'`
+ *      when the sender is in the list.
+ *      xrpl.org `ammbid.md` Fields table — "This cannot include the
+ *      address of the transaction sender." The class API does no
+ *      inner-shape check and does not check for the sender address.
+ */
+import type { Currency, IssuedCurrencyAmount } from '../../types/amounts.js';
+export interface AmmBidProps {
+    /** The unique address of the transaction sender (the bidder). */
+    Account: string;
+    /** One of the two assets in the AMM's pool (XRP / IOU / MPT). */
+    Asset: Currency;
+    /** The other asset in the AMM's pool (XRP / IOU / MPT). */
+    Asset2: Currency;
+    /**
+     * Pay at least this LP-token amount for the auction slot. Always an
+     * `IssuedCurrencyAmount` — LP tokens are issued currencies, never
+     * XRP and never an MPT.
+     */
+    BidMin?: IssuedCurrencyAmount | undefined;
+    /**
+     * Pay at most this LP-token amount for the auction slot. Always an
+     * `IssuedCurrencyAmount` — LP tokens are issued currencies, never
+     * XRP and never an MPT.
+     */
+    BidMax?: IssuedCurrencyAmount | undefined;
+    /**
+     * Up to 4 additional accounts allowed to trade at the discounted
+     * fee. Must NOT include the sender's address.
+     */
+    AuthAccounts?: ReadonlyArray<{
+        readonly AuthAccount: {
+            readonly Account: string;
+        };
+    }> | undefined;
+    /** Bit-flags for this transaction. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface AmmBid extends Readonly<AmmBidProps> {
+    readonly TransactionType: 'AMMBid';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<AmmBidProps>): AmmBid;
+}
+export declare function ammBid(props: AmmBidProps): AmmBid;
+//# sourceMappingURL=amm-bid.d.ts.map