xrpjson 0.1.0

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

@@ -0,0 +1,257 @@
+/**
+ * Functional OracleSet factory — frozen-object style.
+ *
+ * Creates a new `PriceOracle` ledger entry or updates an existing one,
+ * identified by `(Account, OracleDocumentID)`. Validation happens at
+ * construction; there is no way to construct an invalid tx.
+ *
+ *   import { oracleSet } from 'xrplt/fp';
+ *   const tx = oracleSet({
+ *     Account,
+ *     OracleDocumentID: 34,
+ *     LastUpdateTime: 743609014,
+ *     Provider: '70726F7669646572',
+ *     AssetClass: '63757272656E6379',
+ *     PriceDataSeries: [
+ *       { PriceData: { BaseAsset: 'XRP', QuoteAsset: 'USD', AssetPrice: 740, Scale: 3 } },
+ *     ],
+ *   });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ LastUpdateTime: 743700000 });
+ *
+ * Affected amendment: `PriceOracle` (XLS-47).
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/oracleset
+ * @see https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0047-PriceOracles
+ *
+ * ## Divergences
+ *
+ * The factory enforces six preclaim guards the class API
+ * (`src/transactions/oracle-set.ts`) skips:
+ *
+ *   1. `PriceDataSeries` array length capped at 10 elements.
+ *      Source: XLS-47 §"Transaction for creating or updating PriceOracle
+ *      instance" failure conditions — "Transaction's `PriceDataSeries`
+ *      array size is empty or exceeds ten when creating a new Oracle
+ *      instance or Oracle's instance `PriceDataSeries` array size
+ *      exceeds ten after updating". The class only checks
+ *      `isArray(PriceDataSeries)` and accepts unbounded lengths.
+ *
+ *   2. Each `PriceDataSeries` element has exactly one key: `PriceData`.
+ *      Source: XLS-47 example JSON wraps the inner object as
+ *      `{ "PriceData": { ... } }`. xrpl.js 5.3.0 validateOracleSet()
+ *      enforces `Object.keys(priceData).length !== 1`
+ *      (`packages/xrpl/src/models/transactions/oracleSet.ts:122`).
+ *
+ *   3. `AssetPrice` and `Scale` inside `PriceData` must be BOTH present
+ *      or BOTH omitted. The class does not check this coupling.
+ *      Source: xrpl.js 5.3.0 validateOracleSet() lines 144-151
+ *      (`packages/xrpl/src/models/transactions/oracleSet.ts:144`).
+ *
+ *   4. `Scale` is constrained to `[0, 10]` (integer).
+ *      Source: xrpl.js 5.3.0 validateOracleSet() lines 183-187
+ *      (`packages/xrpl/src/models/transactions/oracleSet.ts:183`).
+ *      Note: XLS-47 README §"Transaction fields" claims valid range
+ *      `{1-20}` but xrpl.js enforces `{0-10}` (uint8 internal type,
+ *      practical chain limit). The factory follows xrpl.js.
+ *
+ *   5. `AssetPrice` is validated as either a number OR a hex string
+ *      of 1-16 characters. The class accepts `Record<string, unknown>`
+ *      for the array element with no inner checks.
+ *      Source: xrpl.js 5.3.0 validateOracleSet() lines 155-176
+ *      (`packages/xrpl/src/models/transactions/oracleSet.ts:155`).
+ *
+ *   6. `Provider` / `URI` / `AssetClass` byte limits (256 / 256 / 16)
+ *      with hex-encoding and printable-ASCII range checks.
+ *      Sources: XLS-47 §"PriceOracle Object" — "`Provider` ... string of
+ *      up to 256 ASCII hex encoded characters (0x20-0x7E)"; "`URI` ...
+ *      limited to 256 bytes"; "`AssetClass` ... string of up to sixteen
+ *      ASCII hex encoded characters (0x20-0x7E)". The class accepts any
+ *      string and does not enforce length or character range.
+ *
+ * ## Field name divergences from the class
+ *
+ * The class source (`src/transactions/oracle-set.ts`) declares two
+ * top-level fields — `AssetBase` and `AssetQuote` — that do NOT exist
+ * in either XLS-47 or xrpl.js 5.3.0. The spec/xrpl.js model puts those
+ * identifiers INSIDE each `PriceDataSeries[i].PriceData` element, named
+ * `BaseAsset` and `QuoteAsset`. The factory follows the spec; it does
+ * not surface `AssetBase` / `AssetQuote`. Source: XLS-47 §"PriceOracle
+ * Object" → `PriceData` subtable; xrpl.js 5.3.0 OracleSet interface
+ * (`packages/xrpl/src/models/transactions/oracleSet.ts:31`).
+ *
+ * Conversely, the class OMITS `AssetClass`, which is a required-on-
+ * create / optional-on-update spec field. The factory includes it.
+ * Source: XLS-47 §"Transaction fields for OracleSet" table;
+ * "The transaction fails if: ... `AssetClass` field length exceeds 16
+ * bytes".
+ */
+import { isArray, isHex, isNumber, isRecord, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+/** XLS-47 §"Transaction fields for OracleSet" — "array of up to ten PriceData objects". */
+const PRICE_DATA_SERIES_MAX_LENGTH = 10;
+/** XLS-47 §"PriceOracle Object" — Provider up to 256 bytes. */
+const MAX_PROVIDER_BYTES = 256;
+/** XLS-47 §"PriceOracle Object" — URI limited to 256 bytes. */
+const MAX_URI_BYTES = 256;
+/** XLS-47 §"PriceOracle Object" — AssetClass up to 16 bytes. */
+const MAX_ASSET_CLASS_BYTES = 16;
+/** XLS-47 §"PriceOracle Object" — printable-ASCII range (0x20..0x7E). */
+const PRINTABLE_ASCII_MIN = 0x20;
+const PRINTABLE_ASCII_MAX = 0x7e;
+/** xrpl.js 5.3.0 validateOracleSet() lines 178-187 — uint8 Scale. */
+const SCALE_MIN = 0;
+const SCALE_MAX = 10;
+/** xrpl.js 5.3.0 validateOracleSet() lines 167-173 — AssetPrice hex length. */
+const MINIMUM_ASSET_PRICE_LENGTH = 1;
+const MAXIMUM_ASSET_PRICE_LENGTH = 16;
+/** UINT32 max (XLS-47 §"Transaction fields" — internal type UINT32). */
+const UINT32_MAX = 0xffffffff;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Validate the "ASCII hex encoded" blob fields per XLS-47 §"PriceOracle
+ * Object": hex-encoded string whose decoded bytes are printable ASCII
+ * (0x20-0x7E) and whose decoded length is ≤ maxBytes.
+ */
+function validateAsciiHexBlob(field, value, maxBytes) {
+    if (!isString(value) || !isHex(value)) {
+        throw new ValidationError(`OracleSet: ${field} must be a hex-encoded string`);
+    }
+    if (value.length % 2 !== 0) {
+        throw new ValidationError(`OracleSet: ${field} must be a hex string with an even number of characters`);
+    }
+    const bytes = value.length / 2;
+    if (bytes > maxBytes) {
+        throw new ValidationError(`OracleSet: ${field} exceeds ${maxBytes} bytes (actual: ${bytes})`);
+    }
+    for (let i = 0; i < value.length; i += 2) {
+        const byte = parseInt(value.slice(i, i + 2), 16);
+        if (byte < PRINTABLE_ASCII_MIN || byte > PRINTABLE_ASCII_MAX) {
+            throw new ValidationError(`OracleSet: ${field} must decode to printable ASCII (0x${PRINTABLE_ASCII_MIN.toString(16)}-0x${PRINTABLE_ASCII_MAX.toString(16)})`);
+        }
+    }
+}
+/**
+ * Validate one `PriceDataSeries` element per XLS-47 and xrpl.js 5.3.0
+ * validateOracleSet() (`packages/xrpl/src/models/transactions/oracleSet.ts:91`).
+ */
+function validatePriceDataSeriesElement(value, index) {
+    if (!isRecord(value)) {
+        throw new ValidationError(`OracleSet: PriceDataSeries[${index}] must be an object`);
+    }
+    if (Object.keys(value).length !== 1) {
+        throw new ValidationError(`OracleSet: PriceDataSeries[${index}] must contain only a single "PriceData" key`);
+    }
+    const inner = value['PriceData'];
+    if (!isRecord(inner)) {
+        throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData must be an object`);
+    }
+    if (!isString(inner['BaseAsset'])) {
+        throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData.BaseAsset must be a string`);
+    }
+    if (!isString(inner['QuoteAsset'])) {
+        throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData.QuoteAsset must be a string`);
+    }
+    // AssetPrice and Scale must be paired (xrpl.js lines 144-151).
+    const hasPrice = 'AssetPrice' in inner && inner['AssetPrice'] !== undefined;
+    const hasScale = 'Scale' in inner && inner['Scale'] !== undefined;
+    if (hasPrice !== hasScale) {
+        throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData must have both AssetPrice and Scale if any are present`);
+    }
+    if (hasPrice) {
+        const assetPrice = inner['AssetPrice'];
+        if (isNumber(assetPrice)) {
+            // accept numbers as-is
+        }
+        else if (isString(assetPrice)) {
+            if (!isHex(assetPrice)) {
+                throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData.AssetPrice must be a valid hex string when provided as a string`);
+            }
+            if (assetPrice.length < MINIMUM_ASSET_PRICE_LENGTH ||
+                assetPrice.length > MAXIMUM_ASSET_PRICE_LENGTH) {
+                throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData.AssetPrice hex length must be between ${MINIMUM_ASSET_PRICE_LENGTH} and ${MAXIMUM_ASSET_PRICE_LENGTH} characters`);
+            }
+        }
+        else {
+            throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData.AssetPrice must be a number or a string`);
+        }
+    }
+    if (hasScale) {
+        const scale = inner['Scale'];
+        if (!isNumber(scale) ||
+            !Number.isInteger(scale) ||
+            scale < SCALE_MIN ||
+            scale > SCALE_MAX) {
+            throw new ValidationError(`OracleSet: PriceDataSeries[${index}].PriceData.Scale must be an integer in [${SCALE_MIN}, ${SCALE_MAX}]`);
+        }
+    }
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function oracleSet(props) {
+    // ── Account ── required, must be a non-empty string.
+    require(props.Account, 'OracleSet: Account is required', isString);
+    if (props.Account.length === 0) {
+        throw new ValidationError('OracleSet: Account is required');
+    }
+    // ── OracleDocumentID ── required, positive integer, UINT32.
+    if (!isNumber(props.OracleDocumentID) || !Number.isInteger(props.OracleDocumentID)) {
+        throw new ValidationError('OracleSet: OracleDocumentID must be an integer');
+    }
+    if (props.OracleDocumentID < 0 || props.OracleDocumentID > UINT32_MAX) {
+        throw new ValidationError(`OracleSet: OracleDocumentID must be in [0, ${UINT32_MAX}] (UINT32)`);
+    }
+    // ── LastUpdateTime ── required, positive integer, UINT32.
+    if (!isNumber(props.LastUpdateTime) || !Number.isInteger(props.LastUpdateTime)) {
+        throw new ValidationError('OracleSet: LastUpdateTime must be an integer');
+    }
+    if (props.LastUpdateTime < 0 || props.LastUpdateTime > UINT32_MAX) {
+        throw new ValidationError(`OracleSet: LastUpdateTime must be in [0, ${UINT32_MAX}] (UINT32)`);
+    }
+    // ── PriceDataSeries ── required, non-empty (per spec), ≤10 elements.
+    if (!isArray(props.PriceDataSeries)) {
+        throw new ValidationError('OracleSet: PriceDataSeries is required and must be an array');
+    }
+    if (props.PriceDataSeries.length === 0) {
+        throw new ValidationError('OracleSet: PriceDataSeries must contain at least one PriceData object');
+    }
+    if (props.PriceDataSeries.length > PRICE_DATA_SERIES_MAX_LENGTH) {
+        throw new ValidationError(`OracleSet: PriceDataSeries must have at most ${PRICE_DATA_SERIES_MAX_LENGTH} PriceData objects`);
+    }
+    for (let i = 0; i < props.PriceDataSeries.length; i++) {
+        validatePriceDataSeriesElement(props.PriceDataSeries[i], i);
+    }
+    // ── Provider ── hex-encoded printable ASCII, ≤256 bytes.
+    if (props.Provider !== undefined) {
+        validateAsciiHexBlob('Provider', props.Provider, MAX_PROVIDER_BYTES);
+    }
+    // ── URI ── hex-encoded, ≤256 bytes.
+    if (props.URI !== undefined) {
+        validateAsciiHexBlob('URI', props.URI, MAX_URI_BYTES);
+    }
+    // ── AssetClass ── hex-encoded printable ASCII, ≤16 bytes.
+    if (props.AssetClass !== undefined) {
+        validateAsciiHexBlob('AssetClass', props.AssetClass, MAX_ASSET_CLASS_BYTES);
+    }
+    return buildFrozenTx('OracleSet', 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 oracleSet(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=oracle-set.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"oracle-set.js","sourceRoot":"","sources":["../../../src/fp/factories/oracle-set.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuFG;AACH,OAAO,EACL,OAAO,EACP,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,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,2FAA2F;AAC3F,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,+DAA+D;AAC/D,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAC/B,+DAA+D;AAC/D,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,gEAAgE;AAChE,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,yEAAyE;AACzE,MAAM,mBAAmB,GAAG,IAAI,CAAC;AACjC,MAAM,mBAAmB,GAAG,IAAI,CAAC;AACjC,qEAAqE;AACrE,MAAM,SAAS,GAAG,CAAC,CAAC;AACpB,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,+EAA+E;AAC/E,MAAM,0BAA0B,GAAG,CAAC,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,wEAAwE;AACxE,MAAM,UAAU,GAAG,UAAU,CAAC;AA6C9B,wEAAwE;AAExE;;;;GAIG;AACH,SAAS,oBAAoB,CAC3B,KAAwC,EACxC,KAAc,EACd,QAAgB;IAEhB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,eAAe,CACvB,cAAc,KAAK,+BAA+B,CACnD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,eAAe,CACvB,cAAc,KAAK,yDAAyD,CAC7E,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;QACrB,MAAM,IAAI,eAAe,CACvB,cAAc,KAAK,YAAY,QAAQ,mBAAmB,KAAK,GAAG,CACnE,CAAC;IACJ,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACjD,IAAI,IAAI,GAAG,mBAAmB,IAAI,IAAI,GAAG,mBAAmB,EAAE,CAAC;YAC7D,MAAM,IAAI,eAAe,CACvB,cAAc,KAAK,sCAAsC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CACnI,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,8BAA8B,CAAC,KAAc,EAAE,KAAa;IACnE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,qBAAqB,CACzD,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,8CAA8C,CAClF,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;IACjC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,+BAA+B,CACnE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,wCAAwC,CAC5E,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,yCAAyC,CAC7E,CAAC;IACJ,CAAC;IACD,+DAA+D;IAC/D,MAAM,QAAQ,GAAG,YAAY,IAAI,KAAK,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,SAAS,CAAC;IAC5E,MAAM,QAAQ,GAAG,OAAO,IAAI,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC;IAClE,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,oEAAoE,CACxG,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACzB,uBAAuB;QACzB,CAAC;aAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvB,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,6EAA6E,CACjH,CAAC;YACJ,CAAC;YACD,IACE,UAAU,CAAC,MAAM,GAAG,0BAA0B;gBAC9C,UAAU,CAAC,MAAM,GAAG,0BAA0B,EAC9C,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,qDAAqD,0BAA0B,QAAQ,0BAA0B,aAAa,CAClK,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,qDAAqD,CACzF,CAAC;QACJ,CAAC;IACH,CAAC;IACD,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC;YAChB,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;YACxB,KAAK,GAAG,SAAS;YACjB,KAAK,GAAG,SAAS,EACjB,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,8BAA8B,KAAK,4CAA4C,SAAS,KAAK,SAAS,GAAG,CAC1G,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,SAAS,CAAC,KAAqB;IAC7C,sDAAsD;IACtD,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,gCAAgC,EAAE,QAAQ,CAAC,CAAC;IACnE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,eAAe,CAAC,gCAAgC,CAAC,CAAC;IAC9D,CAAC;IAED,6DAA6D;IAC7D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,eAAe,CACvB,gDAAgD,CACjD,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,gBAAgB,GAAG,CAAC,IAAI,KAAK,CAAC,gBAAgB,GAAG,UAAU,EAAE,CAAC;QACtE,MAAM,IAAI,eAAe,CACvB,8CAA8C,UAAU,YAAY,CACrE,CAAC;IACJ,CAAC;IAED,2DAA2D;IAC3D,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;QAC/E,MAAM,IAAI,eAAe,CACvB,8CAA8C,CAC/C,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,cAAc,GAAG,CAAC,IAAI,KAAK,CAAC,cAAc,GAAG,UAAU,EAAE,CAAC;QAClE,MAAM,IAAI,eAAe,CACvB,4CAA4C,UAAU,YAAY,CACnE,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CACvB,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,eAAe,CACvB,uEAAuE,CACxE,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,GAAG,4BAA4B,EAAE,CAAC;QAChE,MAAM,IAAI,eAAe,CACvB,gDAAgD,4BAA4B,oBAAoB,CACjG,CAAC;IACJ,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtD,8BAA8B,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,0DAA0D;IAC1D,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACjC,oBAAoB,CAAC,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;IACvE,CAAC;IAED,qCAAqC;IACrC,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QAC5B,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,2DAA2D;IAC3D,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,oBAAoB,CAAC,YAAY,EAAE,KAAK,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;IAC9E,CAAC;IAED,OAAO,aAAa,CAClB,WAAW,EACX,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,CAAkB,SAAkC;YACtD,OAAO,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/payment-channel-claim.d.ts

@@ -0,0 +1,153 @@
+/**
+ * Functional PaymentChannelClaim factory — frozen-object style.
+ *
+ * Claims XRP from a payment channel, adjusts the channel's expiration,
+ * or both. The transaction can be sent by the channel source, the
+ * channel destination, or any account when the channel has already
+ * expired. The destination must supply `Signature` + `PublicKey`; the
+ * source can omit them. Validation happens at construction; there is
+ * no way to construct an invalid tx.
+ *
+ *   import { paymentChannelClaim } from 'xrplt/fp';
+ *   const tx = paymentChannelClaim({ Account, Channel });
+ *   const j = tx.toJSON();
+ *   const tx2 = tx.with({ Balance: '2000000' });
+ *
+ * Affected amendments:
+ *   - `PayChan` (base PaymentChannelClaim)
+ *   - `Credentials` (CredentialIDs field for permissioned-domain auth)
+ *   - `fixPayChanRecipientOwnerDir` (legacy channels with deleted
+ *     destinations have relaxed delivery rules; runtime-only)
+ *
+ * @see https://xrpl.org/docs/references/protocol/transactions/types/paymentchannelclaim
+ * @see https://github.com/XRPLF/rippled/blob/develop/src/libxrpl/tx/transactors/payment_channel/PaymentChannelClaim.cpp
+ *
+ * ## Divergences
+ *
+ * Compared with `src/transactions/payment-channel-claim.ts`, this
+ * factory adds preclaim guards the class API skips:
+ *
+ * 1. **`Channel` must be a 64-character hex string (UInt256).**
+ *    Source: xrpl.org `paymentchannelclaim.md` Fields table — "Channel
+ *    | String - Hexadecimal | UInt256 | Yes". xrpl.js
+ *    `validatePaymentChannelClaim`
+ *    (`packages/xrpl/src/models/transactions/paymentChannelClaim.ts:164`)
+ *    only checks `typeof tx.Channel === 'string'`. The class also
+ *    only checks `isString`. The Channel ID is the SHA-512-half of
+ *    (Account, Destination, Sequence) — i.e. the ledger object hash
+ *    of the PayChannel entry — which is always a 64-char hex string.
+ *
+ * 2. **`Amount` and `Balance` must be strictly-positive XRP drops
+ *    strings (XRP-only — no IOU/MPT object forms).**
+ *    Source: xrpl.org `paymentchannelclaim.md` Fields table — both
+ *    fields are documented as "XRP, in drops". xrpl.js
+ *    `validatePaymentChannelClaim` only checks `typeof tx.Amount === 'string'`
+ *    (no positive/sign guard). The class declares them as `Amount`
+ *    (`string | IssuedCurrencyAmount | MPTAmount`) and runs them
+ *    through `isAmount`, which accepts IOU/MPT objects and arbitrary
+ *    numeric strings (including `'0'` and `'-1'`). The ledger rejects
+ *    IOU/MPT forms outright (`temBAD_AMOUNT`) and a non-positive
+ *    Balance would deliver nothing — this factory rejects both cases
+ *    at construction.
+ *
+ * 3. **`PublicKey`, if provided, must be a hex string of 32 or 33
+ *    bytes (Ed25519 or compressed secp256k1).**
+ *    Source: xrpl.org `paymentchannelclaim.md` Fields table —
+ *    "PublicKey | String - Hexadecimal | Blob". rippled's preflight
+ *    uses `publicKeyType()` to gate this — same set of accepted
+ *    lengths as `PaymentChannelCreate`. xrpl.js only checks
+ *    `typeof tx.PublicKey === 'string'`; the class also only checks
+ *    `isString`. A non-hex or wrong-length PublicKey makes signature
+ *    verification fail with `temMALFORMED`.
+ *
+ * 4. **`Signature`, if provided, must be a hex string.**
+ *    Source: xrpl.org `paymentchannelclaim.md` Fields table —
+ *    "Signature | String - Hexadecimal | Blob". xrpl.js only checks
+ *    `typeof tx.Signature === 'string'`; the class also only checks
+ *    `isString`. Non-hex signature blobs fail signature verification
+ *    with `temMALFORMED`.
+ *
+ * 5. **`CredentialIDs` field is supported (Credentials amendment).**
+ *    Source: xrpl.js `PaymentChannelClaim` interface
+ *    (`packages/xrpl/src/models/transactions/paymentChannelClaim.ts:141`)
+ *    — "CredentialIDs?: string[] — Credentials associated with the
+ *    sender of this transaction. The credentials included must not be
+ *    expired." xrpl.org `paymentchannelclaim.md` Fields table also
+ *    lists `CredentialIDs` as a `Vector256` field. The local class
+ *    silently drops the field.
+ *
+ * 6. **`CredentialIDs` length must be in
+ *    [1, MAX_AUTHORIZED_CREDENTIALS = 8], each entry must be a
+ *    64-character hex string, and duplicates are rejected.**
+ *    Source: xrpl.js `validateCredentialsList`
+ *    (`packages/xrpl/src/models/transactions/common.ts:1106–1148`)
+ *    enforces empty-array reject, length cap, 64-char hex entries,
+ *    and "Credentials cannot contain duplicate elements." The class
+ *    does not model the field.
+ *
+ * 7. **`Account` must be a valid XRPL classic or X-address.**
+ *    Source: protocol-level invariant — every transaction's `Account`
+ *    field must be a parseable address. The class does not validate
+ *    `Account` at all (its `super.validate()` delegates to
+ * `BaseTransaction.validate`, which performs no address format
+ * check).
+ *
+ * Preclaim checks that require ledger state (NOT locally checkable):
+ *   - The `Channel` ledger object must exist (`tecNO_ENTRY`).
+ *   - The sender's authorization (Signature/PublicKey) must verify
+ *     against the channel's stored PublicKey and the claimed
+ *     Amount (`temBAD_AUTH` / `temBAD_SIGNATURE`).
+ *   - `Balance`, when delivering, must exceed channel's current
+ *     `Balance` and must not exceed `Amount` (`temBAD_AMOUNT`).
+ *   - The destination account must exist when this transaction
+ *     delivers XRP (`tecNO_DST`, per XLS-0007 §3.1.3).
+ *   - If the channel's `Expiration` or `CancelAfter` is older than the
+ *     previous ledger's close time, the channel closes regardless of
+ *     the transaction's contents.
+ */
+import type { PaymentChannelClaimFlagsInterface } from '../../types/flags.js';
+export interface PaymentChannelClaimProps {
+    /** The unique address of the transaction sender. */
+    Account: string;
+    /** The unique ID of the payment channel (64-char hex / UInt256). */
+    Channel: string;
+    /**
+     * Total XRP authorized by the signature, in drops. Cumulative across
+     * the channel's lifetime. Required when delivering XRP; must match
+     * the signed message. Must be > 0.
+     */
+    Amount?: string | undefined;
+    /**
+     * Total XRP delivered by the channel after this claim is processed,
+     * in drops. Required to deliver XRP; must be > 0 and strictly
+     * greater than the channel's current `Balance`.
+     */
+    Balance?: string | undefined;
+    /**
+     * Public key used to verify `Signature` (32 or 33-byte hex). Must
+     * match the channel's stored `PublicKey`.
+     */
+    PublicKey?: string | undefined;
+    /**
+     * Claim signature, hex-encoded. Required unless the sender is the
+     * channel's source address.
+     */
+    Signature?: string | undefined;
+    /**
+     * Optional credentials authorizing this claim. Each entry is a
+     * 64-char hex ledger entry ID. Length must be in [1, 8].
+     */
+    CredentialIDs?: string[] | undefined;
+    /** Bit-flags: 0, tfRenew (0x00010000), and/or tfClose (0x00020000). */
+    Flags?: number | PaymentChannelClaimFlagsInterface | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface PaymentChannelClaim extends Readonly<PaymentChannelClaimProps> {
+    readonly TransactionType: 'PaymentChannelClaim';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<PaymentChannelClaimProps>): PaymentChannelClaim;
+}
+export declare function paymentChannelClaim(props: PaymentChannelClaimProps): PaymentChannelClaim;
+//# sourceMappingURL=payment-channel-claim.d.ts.map

package/dist/fp/factories/payment-channel-claim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-channel-claim.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/payment-channel-claim.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AACH,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,sBAAsB,CAAC;AA2B9E,MAAM,WAAW,wBAAwB;IACvC,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACrC,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,GAAG,iCAAiC,GAAG,SAAS,CAAC;IAC/D,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,mBACf,SAAQ,QAAQ,CAAC,wBAAwB,CAAC;IAC1C,QAAQ,CAAC,eAAe,EAAE,qBAAqB,CAAC;IAChD,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CACF,SAAS,EAAE,OAAO,CAAC,wBAAwB,CAAC,GAC3C,mBAAmB,CAAC;CACxB;AAoBD,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,wBAAwB,GAC9B,mBAAmB,CAoIrB"}

package/dist/fp/factories/payment-channel-claim.js

@@ -0,0 +1,118 @@
+import { isAccount, isArray, isHex, isString, } from '../../validation/helpers.js';
+import { ValidationError } from '../../errors.js';
+import { buildFrozenTx, mergeForWith, require } from '../shape.js';
+// ─── Spec constants ──────────────────────────────────────────────────
+// HASH256 in hex is 64 characters. (xrpl.org paymentchannelclaim.md:
+// "Channel | String - Hexadecimal | UInt256 | Yes".)
+const HASH256_HEX_LENGTH = 64;
+// Allowed public-key hex lengths — Ed25519 (32 bytes / 64 hex) or
+// secp256k1 compressed (33 bytes / 66 hex). Same set as rippled's
+// `publicKeyType()` accepts.
+const ALLOWED_PUBLIC_KEY_HEX_LENGTHS = [64, 66];
+// xrpl.js caps non-DomainSet credential arrays at 8 entries
+// (`packages/xrpl/src/models/transactions/common.ts:28`).
+const MAX_CREDENTIAL_IDS = 8;
+// ─── Helpers ─────────────────────────────────────────────────────────
+/**
+ * Validate a strictly-positive XRP drops string. Accepts canonical
+ * decimal-or-scientific mantissa form; rejects zero, negative, and
+ * non-numeric values. Used for `Amount` and `Balance` which are
+ * documented as "XRP, in drops" (XRP-only — no IOU/MPT forms).
+ */
+function isPositiveXrpDrops(value) {
+    if (!isString(value))
+        return false;
+    if (!/^[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$/u.test(value)) {
+        return false;
+    }
+    return parseFloat(value) > 0;
+}
+// ─── Factory ─────────────────────────────────────────────────────────
+export function paymentChannelClaim(props) {
+    // ── Account ── required, must be a valid XRPL classic or X-address.
+    require(props.Account, 'PaymentChannelClaim: Account is required', isAccount);
+    // ── Channel ── required, 64-char hex (UInt256 — the ledger object
+    //    hash of the PayChannel entry).
+    if (!isString(props.Channel) ||
+        !isHex(props.Channel) ||
+        props.Channel.length !== HASH256_HEX_LENGTH) {
+        throw new ValidationError('PaymentChannelClaim: Channel must be a 64-character hex string (UInt256, the PayChannel ledger object hash)');
+    }
+    // ── Amount ── optional, but if supplied must be a strictly-positive
+    //    XRP drops string. Rejects IOU/MPT object forms (those would
+    //    match the class's `isAmount` shape but the ledger is
+    //    XRP-only for this tx).
+    if (props.Amount !== undefined && !isPositiveXrpDrops(props.Amount)) {
+        throw new ValidationError('PaymentChannelClaim: Amount must be a strictly-positive XRP drops string (temBAD_AMOUNT)');
+    }
+    // ── Balance ── optional, but if supplied must be a strictly-positive
+    //    XRP drops string.
+    if (props.Balance !== undefined && !isPositiveXrpDrops(props.Balance)) {
+        throw new ValidationError('PaymentChannelClaim: Balance must be a strictly-positive XRP drops string (temBAD_AMOUNT)');
+    }
+    // ── PublicKey ── optional, but if supplied must be hex of 32 or
+    //    33 bytes (Ed25519 or compressed secp256k1). Matches rippled's
+    //    `publicKeyType()` preflight check.
+    if (props.PublicKey !== undefined) {
+        if (!isString(props.PublicKey) || !isHex(props.PublicKey)) {
+            throw new ValidationError('PaymentChannelClaim: PublicKey must be a hex string');
+        }
+        if (!ALLOWED_PUBLIC_KEY_HEX_LENGTHS.includes(props.PublicKey.length)) {
+            throw new ValidationError(`PaymentChannelClaim: PublicKey hex must be 64 (Ed25519, 32 bytes) or 66 (secp256k1, 33 bytes) characters; got ${props.PublicKey.length} hex chars (temMALFORMED)`);
+        }
+    }
+    // ── Signature ── optional, but if supplied must be a hex string.
+    if (props.Signature !== undefined) {
+        if (!isString(props.Signature) || !isHex(props.Signature)) {
+            throw new ValidationError('PaymentChannelClaim: Signature must be a hex string (temMALFORMED)');
+        }
+    }
+    // ── CredentialIDs ── optional array, but bounds + entry-shape
+    //    enforced when present. Per xrpl.js: length in
+    //    [1, MAX_AUTHORIZED_CREDENTIALS]; each entry a 64-char hex
+    //    string; no duplicates.
+    if (props.CredentialIDs !== undefined) {
+        if (!isArray(props.CredentialIDs)) {
+            throw new ValidationError('PaymentChannelClaim: CredentialIDs must be an array of credential ID strings');
+        }
+        if (props.CredentialIDs.length === 0) {
+            throw new ValidationError('PaymentChannelClaim: CredentialIDs must not be an empty array');
+        }
+        if (props.CredentialIDs.length > MAX_CREDENTIAL_IDS) {
+            throw new ValidationError(`PaymentChannelClaim: CredentialIDs length cannot exceed ${MAX_CREDENTIAL_IDS} elements (actual: ${props.CredentialIDs.length})`);
+        }
+        const seen = new Set();
+        for (let i = 0; i < props.CredentialIDs.length; i++) {
+            const cid = props.CredentialIDs[i];
+            if (!isString(cid) ||
+                !isHex(cid) ||
+                cid.length !== HASH256_HEX_LENGTH) {
+                throw new ValidationError(`PaymentChannelClaim: CredentialIDs[${i}] must be a ${HASH256_HEX_LENGTH}-character hex string`);
+            }
+            if (seen.has(cid)) {
+                throw new ValidationError(`PaymentChannelClaim: CredentialIDs[${i}] is a duplicate of an earlier entry`);
+            }
+            seen.add(cid);
+        }
+    }
+    return buildFrozenTx('PaymentChannelClaim', 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 paymentChannelClaim(mergeForWith(this, overrides));
+        },
+    });
+}
+//# sourceMappingURL=payment-channel-claim.js.map

package/dist/fp/factories/payment-channel-claim.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-channel-claim.js","sourceRoot":"","sources":["../../../src/fp/factories/payment-channel-claim.ts"],"names":[],"mappings":"AA4GA,OAAO,EACL,SAAS,EACT,OAAO,EACP,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,qEAAqE;AACrE,qDAAqD;AACrD,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,kEAAkE;AAClE,kEAAkE;AAClE,6BAA6B;AAC7B,MAAM,8BAA8B,GAAG,CAAC,EAAE,EAAE,EAAE,CAAU,CAAC;AAEzD,4DAA4D;AAC5D,0DAA0D;AAC1D,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAoD7B,wEAAwE;AAExE;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,KAAc;IACxC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,CAAC,4CAA4C,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9D,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AAED,wEAAwE;AAExE,MAAM,UAAU,mBAAmB,CACjC,KAA+B;IAE/B,qEAAqE;IACrE,OAAO,CACL,KAAK,CAAC,OAAO,EACb,0CAA0C,EAC1C,SAAS,CACV,CAAC;IAEF,mEAAmE;IACnE,oCAAoC;IACpC,IACE,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC;QACxB,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC;QACrB,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,kBAAkB,EAC3C,CAAC;QACD,MAAM,IAAI,eAAe,CACvB,6GAA6G,CAC9G,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,iEAAiE;IACjE,0DAA0D;IAC1D,4BAA4B;IAC5B,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACpE,MAAM,IAAI,eAAe,CACvB,0FAA0F,CAC3F,CAAC;IACJ,CAAC;IAED,sEAAsE;IACtE,uBAAuB;IACvB,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,eAAe,CACvB,2FAA2F,CAC5F,CAAC;IACJ,CAAC;IAED,iEAAiE;IACjE,mEAAmE;IACnE,wCAAwC;IACxC,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,eAAe,CACvB,qDAAqD,CACtD,CAAC;QACJ,CAAC;QACD,IACE,CAAC,8BAA8B,CAAC,QAAQ,CACtC,KAAK,CAAC,SAAS,CAAC,MAAiB,CAClC,EACD,CAAC;YACD,MAAM,IAAI,eAAe,CACvB,iHAAiH,KAAK,CAAC,SAAS,CAAC,MAAM,2BAA2B,CACnK,CAAC;QACJ,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,eAAe,CACvB,oEAAoE,CACrE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,+DAA+D;IAC/D,mDAAmD;IACnD,+DAA+D;IAC/D,4BAA4B;IAC5B,IAAI,KAAK,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,eAAe,CACvB,8EAA8E,CAC/E,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,eAAe,CACvB,+DAA+D,CAChE,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,kBAAkB,EAAE,CAAC;YACpD,MAAM,IAAI,eAAe,CACvB,2DAA2D,kBAAkB,sBAAsB,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CACjI,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,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,kBAAkB,EACjC,CAAC;gBACD,MAAM,IAAI,eAAe,CACvB,sCAAsC,CAAC,eAAe,kBAAkB,uBAAuB,CAChG,CAAC;YACJ,CAAC;YACD,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,eAAe,CACvB,sCAAsC,CAAC,sCAAsC,CAC9E,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAClB,qBAAqB,EACrB,KAAK,EACL;QACE,QAAQ;YACN,6BAA6B;QAC/B,CAAC;QACD,MAAM;YACJ,MAAM,IAAI,GAA4B,EAAE,CAAC;YACzC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,MAAM;oBAAE,SAAS;gBACjE,MAAM,CAAC,GAAI,IAA2C,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,CAAC,KAAK,SAAS;oBAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAEF,SAA4C;YAE5C,OAAO,mBAAmB,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/fp/factories/payment-channel-create.d.ts

@@ -0,0 +1,30 @@
+export interface PaymentChannelCreateProps {
+    /** The unique address of the transaction sender (becomes the channel owner). */
+    Account: string;
+    /** Amount of XRP, in drops, to set aside in the channel. Must be > 0. */
+    Amount: string;
+    /** The account that can receive XRP claims against this channel. */
+    Destination: string;
+    /** Seconds the source must wait before closing the channel. UInt32. */
+    SettleDelay: number;
+    /**
+     * 33-byte (secp256k1) or 32-byte (Ed25519) public key in hex.
+     */
+    PublicKey: string;
+    /** Time (seconds since Ripple Epoch) when the channel expires. UInt32. */
+    CancelAfter?: number | undefined;
+    /** Arbitrary tag for the destination. UInt32. */
+    DestinationTag?: number | undefined;
+    /** Bit-flags for this transaction. PaymentChannelCreate has no defined flags. */
+    Flags?: number | undefined;
+    Fee?: string | undefined;
+    Sequence?: number | undefined;
+}
+export interface PaymentChannelCreate extends Readonly<PaymentChannelCreateProps> {
+    readonly TransactionType: 'PaymentChannelCreate';
+    validate(): void;
+    toJSON(): Record<string, unknown>;
+    with(overrides: Partial<PaymentChannelCreateProps>): PaymentChannelCreate;
+}
+export declare function paymentChannelCreate(props: PaymentChannelCreateProps): PaymentChannelCreate;
+//# sourceMappingURL=payment-channel-create.d.ts.map

package/dist/fp/factories/payment-channel-create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-channel-create.d.ts","sourceRoot":"","sources":["../../../src/fp/factories/payment-channel-create.ts"],"names":[],"mappings":"AA0HA,MAAM,WAAW,yBAAyB;IACxC,gFAAgF;IAChF,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAC;IACf,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,iDAAiD;IACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,iFAAiF;IACjF,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,oBACf,SAAQ,QAAQ,CAAC,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,eAAe,EAAE,sBAAsB,CAAC;IACjD,QAAQ,IAAI,IAAI,CAAC;IACjB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CACF,SAAS,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAC5C,oBAAoB,CAAC;CACzB;AAID,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,yBAAyB,GAC/B,oBAAoB,CAgGtB"}