xrpjson 0.1.0

package/dist/fp/factories/permissioned-domain-set.d.ts

@@ -0,0 +1,118 @@
+/**
+ * Functional PermissionedDomainSet factory — frozen-object style.
+ *
+ * Creates or modifies a PermissionedDomain ledger entry. Validation
+ * happens at construction; there is no way to construct an invalid tx.
+ *
+ *   import { permissionedDomainSet } from 'xrplt/fp';
+ *   const tx = permissionedDomainSet({
+ *     Account,
+ *     AcceptedCredentials: [
+ *       { Credential: { Issuer: iss, CredentialType: '6D795F63726564656E7469616C' } },
+ *     ],
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ DomainID: existingDomainId });
+ *
+ * Affected amendments:
+ *   - `PermissionedDomains` — introduces this transaction type.
+ *   - `Credentials`         — required amendment (PermissionedDomainSet
+ *                             transactions are invalid without it).
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/permissioneddomainset
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0080-permissioned-domains
+ *
+ * ## Divergences
+ *
+ * The class-based API at `src/transactions/permissioned-domain-set.ts`
+ * is missing several rules that the canonical sources require, AND
+ * exposes one field that is not in the spec at all. The factory
+ * corrects both:
+ *
+ *   1. `AcceptedCredentials` is REQUIRED.
+ *      The class marks it optional (`AcceptedCredentials?: unknown[]`).
+ *      XLS-0080 §3.1 (Field table) lists it as required; xrpl.js
+ *      `validatePermissionedDomainSet` calls `validateRequiredField`.
+ *      Source: XLS-0080 §3.1 table row for `AcceptedCredentials`;
+ *              xrpl.js `permissionedDomainSet.ts` lines 40–41.
+ *
+ *   2. `AcceptedCredentials` must be a NON-EMPTY array.
+ *      The class only checks the field is an array, so `[]` passes.
+ *      XLS-0080 §6 invariant 2: "The `AcceptedCredentials` array must
+ *      have length between 1 and 10, if included." XLS-0080 §3.2
+ *      failure: "The `AcceptedCredentials` array is empty or too long."
+ *      Source: XLS-0080 §6 invariant; XLS-0080 §3.2 failure conditions.
+ *
+ *   3. `AcceptedCredentials` must have at most 10 entries.
+ *      The class does not check the length. XLS-0080 §3.2 + §6 invariant
+ *      set the cap at 10. xrpl.js enforces the same cap
+ *      (`MAX_ACCEPTED_CREDENTIALS = 10`).
+ *      Source: XLS-0080 §3.2; xrpl.js `permissionedDomainSet.ts:13`.
+ *
+ *   4. `AcceptedCredentials` cannot contain duplicates.
+ *      The class has no dedupe check. xrpl.js calls
+ *      `validateCredentialsList` which calls `containsDuplicates` on
+ *      `(Issuer, CredentialType)` pairs.
+ *      Source: xrpl-dev-portal `permissioneddomainset.md` (field
+ *              table: "it cannot contain duplicates"); xrpl.js
+ *              `common.ts` `containsDuplicates`.
+ *
+ *   5. Each entry must be a valid `AuthorizeCredential` object form.
+ *      The class types the field as `unknown[]` and accepts any array.
+ *      xrpl.js enforces object form only — strings (credential IDs)
+ *      are explicitly rejected for this transaction.
+ *      Source: xrpl.js `permissionedDomainSet.ts:46` (the `false`
+ *              isStringID argument); xrpl.js `common.ts:1129–1141`.
+ *
+ *   6. `CredentialType` must be a non-empty hex string.
+ *      The class has no per-credential validation. XLS-0070 §2.1.3
+ *      states: "It has a maximum length of 64 bytes, and cannot be an
+ *      empty string." `CredentialType` is encoded as a Blob (hex) per
+ *      XLS-0070 §2.1.
+ *      Source: XLS-0070 §2.1 + §2.1.3; XLS-0080 §3.2 failure
+ *              "Any credential in `AcceptedCredentials` has an empty
+ *              `CredentialType`".
+ *
+ *   7. `CredentialType` must be at most 64 bytes (128 hex chars).
+ *      The class has no length check. XLS-0080 §3.2 failure: "Any
+ *      credential in `AcceptedCredentials` has a `CredentialType`
+ *      longer than 64 bytes (as per XLS-70)." XLS-0070 §2.1.3 sets the
+ *      64-byte limit.
+ *      Source: XLS-0080 §3.2; XLS-0070 §2.1.3.
+ *
+ *   8. `AcceptedAccounts` is NOT in the spec.
+ *      The class exposes `AcceptedAccounts?: string[]` as an
+ *      assignable field, but XLS-0080 §3.1 lists ONLY `DomainID` and
+ *      `AcceptedCredentials`. The factory omits this field entirely —
+ *      no spec source mandates or defines its shape.
+ *      Source: XLS-0080 §3.1 field table; xrpl.js
+ *              `permissionedDomainSet.ts` (no `AcceptedAccounts`).
+ */
+import type { AuthorizeCredential } from '../../types/common.js';
+export interface PermissionedDomainSetProps {
+    /** The account creating or modifying the permissioned domain. */
+    Account: string;
+    /**
+     * The ledger entry ID of an existing permissioned domain to modify.
+     * If omitted, a new domain is created.
+     * 64-character hex string. Must not be the all-zeros HASH256 value.
+     */
+    DomainID?: string | undefined;
+    /**
+     * The list of credentials that grant access to this domain.
+     * Required; must contain 1–10 unique `AuthorizeCredential` entries.
+     */
+    AcceptedCredentials: AuthorizeCredential[];
+    /** Bit-flags for this transaction. (No flags are defined for this tx.) */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface PermissionedDomainSet extends Readonly<PermissionedDomainSetProps> {
+    readonly TransactionType: 'PermissionedDomainSet';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<PermissionedDomainSetProps>): PermissionedDomainSet;
+}
+export declare function permissionedDomainSet(props: PermissionedDomainSetProps): PermissionedDomainSet;
+//# sourceMappingURL=permissioned-domain-set.d.ts.map

package/dist/fp/factories/permissioned-domain-set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissioned-domain-set.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/permissioned-domain-set.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAgBjE,MAAM,WAAW,0BAA0B;IACzC,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,EAAE,CAAC;IAC3C,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,qBACf,SAAQ,QAAQ,CAAC,0BAA0B,CAAC;IAC5C,QAAQ,CAAC,eAAe,EAAE,uBAAuB,CAAC;IAClD,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,0BAA0B,CAAC,GAAG,qBAAqB,CAAC;CAC7E;AAoCD,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,0BAA0B,GAChC,qBAAqB,CAoGvB"}

package/dist/fp/factories/permissioned-domain-set.js

@@ -0,0 +1,100 @@
+import { isAuthorizeCredential, isHex, isString } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// Maximum number of accepted credentials (XLS-0080 §3.2 + §6 invariant 2).
+const MAX_ACCEPTED_CREDENTIALS = 10;
+// HASH256 length in hex characters.
+const DOMAIN_ID_LENGTH = 64;
+// CredentialType is a hex-encoded Blob capped at 64 bytes (XLS-0070 §2.1.3).
+const MAX_CREDENTIAL_TYPE_BYTES = 64;
+// ─── Helpers ─────────────────────────────────────────────────────────
+function validateCredentialType(txType, value) {
+    if (!isString(value)) {
+        throw new ValidationError(`${txType}: Credential.CredentialType must be a hex string`);
+    }
+    if (value.length === 0) {
+        throw new ValidationError(`${txType}: Credential.CredentialType must not be empty`);
+    }
+    if (!isHex(value)) {
+        throw new ValidationError(`${txType}: Credential.CredentialType must be a hex string`);
+    }
+    if (value.length % 2 !== 0) {
+        throw new ValidationError(`${txType}: 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}: Credential.CredentialType exceeds ${MAX_CREDENTIAL_TYPE_BYTES} bytes (actual: ${bytes})`);
+    }
+    return value;
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function permissionedDomainSet(props) {
+    // ── Account ── required, must be a non-empty string.
+    require(props.Account, 'PermissionedDomainSet: Account is required', isString);
+    if (props.Account.length === 0) {
+        throw new ValidationError('PermissionedDomainSet: Account is required');
+    }
+    // ── DomainID ── optional, 64-char hex AND non-zero when present.
+    if (props.DomainID !== undefined) {
+        if (!isString(props.DomainID) ||
+            !isHex(props.DomainID) ||
+            props.DomainID.length !== DOMAIN_ID_LENGTH) {
+            throw new ValidationError('PermissionedDomainSet: DomainID must be a 64-character hex string');
+        }
+        // The all-zeros DomainID is malformed per the `isDomainID` helper
+        // in xrpl.js (`common.ts:1198–1204`) — although rippled itself
+        // currently only checks the format at the transaction boundary,
+        // rejecting it here matches the rest of this library's fp factories
+        // and avoids silently constructing an obviously-bogus tx.
+        if (/^0+$/u.test(props.DomainID)) {
+            throw new ValidationError('PermissionedDomainSet: DomainID must not be the all-zeros HASH256 value');
+        }
+    }
+    // ── AcceptedCredentials ── REQUIRED, 1..10 unique AuthorizeCredential entries.
+    if (props.AcceptedCredentials === undefined) {
+        throw new ValidationError('PermissionedDomainSet: AcceptedCredentials is required');
+    }
+    if (!Array.isArray(props.AcceptedCredentials)) {
+        throw new ValidationError('PermissionedDomainSet: AcceptedCredentials must be an array');
+    }
+    if (props.AcceptedCredentials.length === 0) {
+        throw new ValidationError('PermissionedDomainSet: AcceptedCredentials cannot be an empty array');
+    }
+    if (props.AcceptedCredentials.length > MAX_ACCEPTED_CREDENTIALS) {
+        throw new ValidationError(`PermissionedDomainSet: AcceptedCredentials length cannot exceed ${MAX_ACCEPTED_CREDENTIALS} elements`);
+    }
+    const seen = new Set();
+    props.AcceptedCredentials.forEach((credential, idx) => {
+        if (!isAuthorizeCredential(credential)) {
+            throw new ValidationError(`PermissionedDomainSet: AcceptedCredentials[${idx}] is not a valid AuthorizeCredential`);
+        }
+        const credObj = credential.Credential;
+        validateCredentialType(`PermissionedDomainSet: AcceptedCredentials[${idx}]`, credObj.CredentialType);
+        const key = `${credObj.Issuer}-${credObj.CredentialType}`;
+        if (seen.has(key)) {
+            throw new ValidationError('PermissionedDomainSet: AcceptedCredentials cannot contain duplicate elements');
+        }
+        seen.add(key);
+    });
+    return buildFrozenTx('PermissionedDomainSet', 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 permissionedDomainSet(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=permissioned-domain-set.js.map

package/dist/fp/factories/permissioned-domain-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissioned-domain-set.js","sourceRoot":"","sources":["../../../src/fp/factories/permissioned-domain-set.ts"],"names":[],"mappings":"AA2FA,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnE,wEAAwE;AAExE,2EAA2E;AAC3E,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,oCAAoC;AACpC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,6EAA6E;AAC7E,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAgCrC,wEAAwE;AAExE,SAAS,sBAAsB,CAAC,MAAc,EAAE,KAAc;IAC5D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,kDAAkD,CAC5D,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,+CAA+C,CACzD,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAClB,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,kDAAkD,CAC5D,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAe,CACvB,GAAG,MAAM,oFAAoF,CAC9F,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,uCAAuC,yBAAyB,mBAAmB,KAAK,GAAG,CACrG,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,qBAAqB,CACnC,KAAiC;IAEjC,sDAAsD;IACtD,OAAO,CACL,KAAK,CAAC,OAAO,EACb,4CAA4C,EAC5C,QAAQ,CACT,CAAC;IACF,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,4CAA4C,CAAC,CAAC;IAC1E,CAAC;IAED,kEAAkE;IAClE,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,gBAAgB,EAC1C,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,mEAAmE,CACpE,CAAC;QACJ,CAAC;QACD,kEAAkE;QAClE,+DAA+D;QAC/D,gEAAgE;QAChE,oEAAoE;QACpE,0DAA0D;QAC1D,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,eAAe,CACvB,yEAAyE,CAC1E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,gFAAgF;IAChF,IAAI,KAAK,CAAC,mBAAmB,KAAK,SAAS,EAAE,CAAC;QAC5C,MAAM,IAAI,eAAe,CACvB,wDAAwD,CACzD,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,eAAe,CACvB,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,eAAe,CACvB,qEAAqE,CACtE,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,mBAAmB,CAAC,MAAM,GAAG,wBAAwB,EAAE,CAAC;QAChE,MAAM,IAAI,eAAe,CACvB,mEAAmE,wBAAwB,WAAW,CACvG,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;QACpD,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,eAAe,CACvB,8CAA8C,GAAG,sCAAsC,CACxF,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC;QACtC,sBAAsB,CACpB,8CAA8C,GAAG,GAAG,EACpD,OAAO,CAAC,cAAc,CACvB,CAAC;QACF,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,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,OAAO,aAAa,CAClB,uBAAuB,EACvB,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,SAA8C;YAE9C,OAAO,qBAAqB,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAC9D,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/set-regular-key.d.ts

@@ -0,0 +1,30 @@
+export interface SetRegularKeyProps {
+    /**
+     * The funded account whose regular key is being set/changed/removed.
+     * Required, must be a valid XRPL classic or X-address.
+     */
+    Account: string;
+    /**
+     * Optional. The address of the new regular key pair. Omit (or pass
+     * `undefined`) to remove any existing regular key pair.
+     *
+     * When present, must be a valid XRPL address AND must NOT equal
+     * `Account` — the master key cannot be its own regular key
+     * (`temBAD_REGKEY`).
+     */
+    RegularKey?: string | undefined;
+    /** Bit-flags for this transaction. SetRegularKey has no defined flags. */
+    Flags?: number | undefined;
+    /** Fee in drops. Base transaction field. */
+    Fee?: string | undefined;
+    /** Account sequence number. Base transaction field. */
+    Sequence?: number | undefined;
+}
+export interface SetRegularKey extends Readonly<SetRegularKeyProps> {
+    readonly TransactionType: 'SetRegularKey';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<SetRegularKeyProps>): SetRegularKey;
+}
+export declare function setRegularKey(props: SetRegularKeyProps): SetRegularKey;
+//# sourceMappingURL=set-regular-key.d.ts.map

package/dist/fp/factories/set-regular-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-regular-key.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/set-regular-key.ts"],"names":[],"mappings":"AA2CA,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,4CAA4C;IAC5C,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,uDAAuD;IACvD,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,CA8CtE"}

package/dist/fp/factories/set-regular-key.js

@@ -0,0 +1,81 @@
+/**
+ * Functional SetRegularKey factory — frozen-object style.
+ *
+ * Assigns, changes, or removes the regular key pair associated with the
+ * sending account. Validation happens at construction; there is no way
+ * to construct an invalid tx.
+ *
+ *   import { setRegularKey } from 'xrplt/fp';
+ *   const tx = setRegularKey({ Account, RegularKey });
+ *   tx.validate();   // throws if construction didn't already
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Fee: '12', Sequence: 42 });
+ *
+ * If `RegularKey` is omitted the tx removes any existing regular key
+ * from the account. (Per xrpl.org, "If omitted, removes any existing
+ * regular key pair from the account.")
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/setregularkey
+ *
+ * ## Divergences
+ *
+ * The class-based API at `src/transactions/set-regular-key.ts` is
+ * missing one rule that the canonical sources require. The factory
+ * fills it:
+ *
+ *   1. `temBAD_REGKEY` is not enforced.
+ *      The class never compares `RegularKey` against `Account`, so a
+ *      `SetRegularKey` whose `RegularKey` equals the sender's address
+ *      (i.e. assigns the master key as its own regular key) passes
+ *      class validation and only fails at the ledger with `temBAD_REGKEY`.
+ *      The factory rejects this at construction.
+ *      Source: rippled `src/libxrpl/tx/transactors/account/SetRegularKey.cpp`
+ *              lines 44–47 (`SetRegularKey::preflight` returns `temBAD_REGKEY`
+ *              when `getAccountID(sfRegularKey) == getAccountID(sfAccount)`).
+ *              Confirmed by xrpl-dev-portal `setregularkey.md` Fields table:
+ *              "Must not match the master key pair for the address."
+ */
+import { isAccount } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Factory ─────────────────────────────────────────────────────────
+export function setRegularKey(props) {
+    // ── Account ── required, must be a valid XRPL classic or X-address.
+    require(props.Account, 'SetRegularKey: Account is required', isAccount);
+    // ── RegularKey ── optional.
+    //   xrpl.js validateSetRegularKey (packages/xrpl/src/models/transactions/
+    //   setRegularKey.ts) only checks `typeof RegularKey === 'string'` when
+    //   present. The class uses `isAccount` (format-only regex check). We
+    //   layer on the rippled `temBAD_REGKEY` guard: RegularKey must not equal
+    //   the sending Account.
+    if (props.RegularKey !== undefined) {
+        if (!isAccount(props.RegularKey)) {
+            throw new ValidationError('SetRegularKey: RegularKey must be a valid XRPL address');
+        }
+        // ── temBAD_REGKEY guard ─────────────────────────────────────────
+        // rippled SetRegularKey.cpp:44–47
+        if (props.RegularKey === props.Account) {
+            throw new ValidationError('SetRegularKey: RegularKey must not equal Account (temBAD_REGKEY)');
+        }
+    }
+    return buildFrozenTx('SetRegularKey', 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 setRegularKey(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=set-regular-key.js.map

package/dist/fp/factories/set-regular-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-regular-key.js","sourceRoot":"","sources":["../../../src/fp/factories/set-regular-key.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAkCnE,wEAAwE;AAExE,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,qEAAqE;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,oCAAoC,EAAE,SAAS,CAAC,CAAC;IAExE,6BAA6B;IAC7B,0EAA0E;IAC1E,wEAAwE;IACxE,sEAAsE;IACtE,0EAA0E;IAC1E,yBAAyB;IACzB,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,eAAe,CACvB,wDAAwD,CACzD,CAAC;QACJ,CAAC;QACD,mEAAmE;QACnE,kCAAkC;QAClC,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,IAAI,eAAe,CACvB,kEAAkE,CACnE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,eAAe,EACf,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAsB,SAAsC;YAC9D,OAAO,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QACtD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/signer-list-set.d.ts

@@ -0,0 +1,61 @@
+/**
+ * One entry in the `SignerEntries` array.
+ *
+ * The shape is a nested `SignerEntry` object — exactly the on-ledger
+ * serialization required by ripple-binary-codec. `WalletLocator` is
+ * optional and only meaningful after the `ExpandedSignerList`
+ * amendment.
+ *
+ * @see https://xrpl.org/docs/references/protocol/ledger-data/ledger-entry-types/signerlist#signer-entry-object
+ */
+export interface SignerEntryData {
+    /** An XRPL classic or X-address whose signature contributes to the multi-signature. */
+    readonly SignerEntry: {
+        readonly Account: string;
+        /**
+         * Weight of a signature from this signer. Must be a positive
+         * integer (`>= 1`). rippled raises `temBAD_WEIGHT` on 0 or
+         * negative values.
+         */
+        readonly SignerWeight: number;
+        /**
+         * Optional 256-bit (32-byte) hex identifier (post-ExpandedSignerList).
+         * When present, must be exactly 64 hex characters.
+         */
+        readonly WalletLocator?: string;
+    };
+}
+export interface SignerListSetProps {
+    /** The unique address of the transaction sender. */
+    Account: string;
+    /**
+     * Target number of signer weights. A multi-signature from the list
+     * is valid only if the sum of the signature weights is `>=` this
+     * value. **To delete the signer list, set to `0` AND omit
+     * `SignerEntries`.** Otherwise, `1 <= SignerQuorum <=
+     * sum(SignerWeights)`.
+     */
+    SignerQuorum: number;
+    /**
+     * The list of signers. Required when `SignerQuorum > 0`; must be
+     * omitted entirely when `SignerQuorum === 0`. Each entry's `Account`
+     * must be a valid XRPL address, `SignerWeight` a positive integer,
+     * `WalletLocator` (when present) a 64-char hex string. Signer
+     * accounts must be unique and must not equal `Account`.
+     */
+    SignerEntries?: SignerEntryData[] | undefined;
+    /** Bit-flags for this transaction. SignerListSet has no defined flags. */
+    Flags?: number | undefined;
+    /** Fee in drops. */
+    Fee?: string | undefined;
+    /** Account sequence number. */
+    Sequence?: number | undefined;
+}
+export interface SignerListSet extends Readonly<SignerListSetProps> {
+    readonly TransactionType: 'SignerListSet';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<SignerListSetProps>): SignerListSet;
+}
+export declare function signerListSet(props: SignerListSetProps): SignerListSet;
+//# sourceMappingURL=signer-list-set.d.ts.map

package/dist/fp/factories/signer-list-set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer-list-set.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/signer-list-set.ts"],"names":[],"mappings":"AAwIA;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B,uFAAuF;IACvF,QAAQ,CAAC,WAAW,EAAE;QACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QACzB;;;;WAIG;QACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;QAC9B;;;WAGG;QACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;CACH;AAED,MAAM,WAAW,kBAAkB;IACjC,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,eAAe,EAAE,GAAG,SAAS,CAAC;IAC9C,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,oBAAoB;IACpB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,aACf,SAAQ,QAAQ,CAAC,kBAAkB,CAAC;IACpC,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,CAwKtE"}