@transia/ripple-binary-codec 1.4.6-alpha.9 → 2.5.1

package/dist/src/types/serialized-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialized-type.js","sourceRoot":"","sources":["../../../src/types/serialized-type.ts"],"names":[],"mappings":";;;AAAA,mEAAuD;AAGvD,qDAAsD;AAEtD;;;GAGG;AACH,IAAY,gBA+BX;AA/BD,WAAY,gBAAgB;IAC1B,2EAAkB,CAAA;IAClB,mEAAc,CAAA;IACd,mEAAc,CAAA;IACd,mEAAc,CAAA;IACd,qEAAe,CAAA;IACf,qEAAe,CAAA;IACf,mEAAc,CAAA;IACd,2DAAU,CAAA;IACV,qEAAe,CAAA;IACf,mEAAc,CAAA;IACd,kEAAc,CAAA;IACd,kEAAc,CAAA;IAEd,oEAAe,CAAA;IACf,kEAAc,CAAA;IAEd,kEAAc,CAAA;IACd,sEAAgB,CAAA;IAChB,sEAAgB,CAAA;IAChB,0EAAkB,CAAA;IAClB,oEAAe,CAAA;IACf,sEAAgB,CAAA;IAChB,sEAAgB,CAAA;IAChB,sEAAgB,CAAA;IAChB,kEAAc,CAAA;IACd,kFAAsB,CAAA;IACtB,wEAAiB,CAAA;IACjB,gEAAa,CAAA;IACb,wEAAiB,CAAA;IACjB,gEAAa,CAAA;AACf,CAAC,EA/BW,gBAAgB,gCAAhB,gBAAgB,QA+B3B;AAED;;GAEG;AACU,QAAA,iBAAiB,GAAqC;IACjE,UAAU,EAAE,gBAAgB,CAAC,cAAc;IAC3C,MAAM,EAAE,gBAAgB,CAAC,UAAU;IACnC,MAAM,EAAE,gBAAgB,CAAC,UAAU;IACnC,MAAM,EAAE,gBAAgB,CAAC,UAAU;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,MAAM,EAAE,gBAAgB,CAAC,UAAU;IACnC,EAAE,EAAE,gBAAgB,CAAC,MAAM;IAC3B,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,MAAM,EAAE,gBAAgB,CAAC,UAAU;IACnC,KAAK,EAAE,gBAAgB,CAAC,SAAS;IACjC,KAAK,EAAE,gBAAgB,CAAC,SAAS;IAEjC,MAAM,EAAE,gBAAgB,CAAC,UAAU;IACnC,KAAK,EAAE,gBAAgB,CAAC,SAAS;IAEjC,KAAK,EAAE,gBAAgB,CAAC,SAAS;IACjC,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,SAAS,EAAE,gBAAgB,CAAC,aAAa;IACzC,MAAM,EAAE,gBAAgB,CAAC,UAAU;IACnC,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,OAAO,EAAE,gBAAgB,CAAC,WAAW;IACrC,KAAK,EAAE,gBAAgB,CAAC,SAAS;IACjC,aAAa,EAAE,gBAAgB,CAAC,iBAAiB;IACjD,QAAQ,EAAE,gBAAgB,CAAC,YAAY;IACvC,IAAI,EAAE,gBAAgB,CAAC,QAAQ;IAC/B,QAAQ,EAAE,gBAAgB,CAAC,YAAY;IACvC,IAAI,EAAE,gBAAgB,CAAC,QAAQ;CAChC,CAAA;AAED;;GAEG;AACU,QAAA,iBAAiB,GAAqC;IACjE,CAAC,EAAE,gBAAgB,CAAC,cAAc;IAClC,CAAC,EAAE,gBAAgB,CAAC,UAAU;IAC9B,CAAC,EAAE,gBAAgB,CAAC,UAAU;IAC9B,CAAC,EAAE,gBAAgB,CAAC,UAAU;IAC9B,CAAC,EAAE,gBAAgB,CAAC,WAAW;IAC/B,CAAC,EAAE,gBAAgB,CAAC,WAAW;IAC/B,CAAC,EAAE,gBAAgB,CAAC,UAAU;IAC9B,CAAC,EAAE,gBAAgB,CAAC,MAAM;IAC1B,CAAC,EAAE,gBAAgB,CAAC,WAAW;IAC/B,CAAC,EAAE,gBAAgB,CAAC,UAAU;IAC9B,EAAE,EAAE,gBAAgB,CAAC,SAAS;IAC9B,EAAE,EAAE,gBAAgB,CAAC,SAAS;IAE9B,EAAE,EAAE,gBAAgB,CAAC,UAAU;IAC/B,EAAE,EAAE,gBAAgB,CAAC,SAAS;IAE9B,EAAE,EAAE,gBAAgB,CAAC,SAAS;IAC9B,EAAE,EAAE,gBAAgB,CAAC,WAAW;IAChC,EAAE,EAAE,gBAAgB,CAAC,WAAW;IAChC,EAAE,EAAE,gBAAgB,CAAC,aAAa;IAClC,EAAE,EAAE,gBAAgB,CAAC,UAAU;IAC/B,EAAE,EAAE,gBAAgB,CAAC,WAAW;IAChC,EAAE,EAAE,gBAAgB,CAAC,WAAW;IAChC,EAAE,EAAE,gBAAgB,CAAC,WAAW;IAChC,EAAE,EAAE,gBAAgB,CAAC,SAAS;IAC9B,EAAE,EAAE,gBAAgB,CAAC,iBAAiB;IACtC,EAAE,EAAE,gBAAgB,CAAC,YAAY;IACjC,EAAE,EAAE,gBAAgB,CAAC,QAAQ;IAC7B,EAAE,EAAE,gBAAgB,CAAC,YAAY;IACjC,EAAE,EAAE,gBAAgB,CAAC,QAAQ;CAC9B,CAAA;AAED;;GAEG;AACU,QAAA,iBAAiB,GAAqC;IACjE,CAAC,gBAAgB,CAAC,cAAc,CAAC,EAAE,EAAE;IACrC,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ;IACvC,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ;IACvC,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ;IACvC,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ;IACvC,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,IAAI;IAC/B,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ;IACvC,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,OAAO;IACrC,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,OAAO;IAErC,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ;IACvC,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,OAAO;IAErC,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,OAAO;IACrC,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,aAAa,CAAC,EAAE,WAAW;IAC7C,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ;IACvC,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,SAAS;IACzC,CAAC,gBAAgB,CAAC,SAAS,CAAC,EAAE,OAAO;IACrC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,eAAe;IACrD,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,UAAU;IAC3C,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,MAAM;IACnC,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,UAAU;IAC3C,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,MAAM;CACpC,CAAA;AAMD;;GAEG;AACH,MAAM,cAAc;IAGlB,YAAY,KAAkB;QAFX,UAAK,GAAe,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;QAGtD,IAAI,CAAC,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;IACzC,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,MAAoB,EAAE,IAAa;QACnD,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC7C,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAqC;QAC/C,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAe;QACzB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,OAAO,IAAA,kBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACnC,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,IAAI,CAAC,KAAK,CAAA;SAClB;QACD,MAAM,KAAK,GAAG,IAAI,6BAAS,EAAE,CAAA;QAC7B,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QACvB,OAAO,KAAK,CAAC,OAAO,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,YAAkC,EAAE,UAAmB;QAC5D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IACxB,CAAC;CACF;AA0CQ,wCAAc;AAxCvB;;;;;;;GAOG;AACH,MAAM,UAA6B,SAAQ,cAAc;IACvD,EAAE,CAAC,KAAQ;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,EAAE,CAAC,KAAQ;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACpC,CAAC;IAED,EAAE,CAAC,KAAQ;QACT,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED,GAAG,CAAC,KAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IACnC,CAAC;IAED,GAAG,CAAC,KAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAClC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,KAAQ;QAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,CAAC,QAAQ,EAAE,QAAQ,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IAC9E,CAAC;CACF;AAEwB,gCAAU"}

package/dist/src/types/st-array.d.ts

@@ -0,0 +1,32 @@
+import { XrplDefinitionsBase } from '../enums';
+import { SerializedType, JsonObject, SerializedTypeID } from './serialized-type';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Class for serializing and deserializing Arrays of Objects
+ */
+declare class STArray extends SerializedType {
+    /**
+     * Construct an STArray from a BinaryParser
+     *
+     * @param parser BinaryParser to parse an STArray from
+     * @returns An STArray Object
+     */
+    static fromParser(parser: BinaryParser): STArray;
+    /**
+     * Construct an STArray from an Array of JSON Objects
+     *
+     * @param value STArray or Array of Objects to parse into an STArray
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns An STArray object
+     */
+    static from<T extends STArray | Array<JsonObject>>(value: T, definitions?: XrplDefinitionsBase): STArray;
+    /**
+     * Return the JSON representation of this.bytes
+     *
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns An Array of JSON objects
+     */
+    toJSON(definitions?: XrplDefinitionsBase): Array<JsonObject>;
+    getSType(): SerializedTypeID;
+}
+export { STArray };

package/dist/src/types/st-array.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STArray = void 0;
+const enums_1 = require("../enums");
+const serialized_type_1 = require("./serialized-type");
+const st_object_1 = require("./st-object");
+const binary_parser_1 = require("../serdes/binary-parser");
+const utils_1 = require("@transia/isomorphic/utils");
+const ARRAY_END_MARKER = Uint8Array.from([0xf1]);
+const ARRAY_END_MARKER_NAME = 'ArrayEndMarker';
+const OBJECT_END_MARKER = Uint8Array.from([0xe1]);
+/**
+ * TypeGuard for Array<JsonObject>
+ */
+function isObjects(args) {
+    return (Array.isArray(args) &&
+        args.every((arg) => typeof arg === 'object' &&
+            Object.keys(arg).length === 1 &&
+            typeof Object.values(arg)[0] === 'object'));
+}
+/**
+ * Class for serializing and deserializing Arrays of Objects
+ */
+class STArray extends serialized_type_1.SerializedType {
+    /**
+     * Construct an STArray from a BinaryParser
+     *
+     * @param parser BinaryParser to parse an STArray from
+     * @returns An STArray Object
+     */
+    static fromParser(parser) {
+        const bytes = [];
+        while (!parser.end()) {
+            const field = parser.readField();
+            if (field.name === ARRAY_END_MARKER_NAME) {
+                break;
+            }
+            bytes.push(field.header, parser.readFieldValue(field).toBytes(), OBJECT_END_MARKER);
+        }
+        bytes.push(ARRAY_END_MARKER);
+        return new STArray((0, utils_1.concat)(bytes));
+    }
+    /**
+     * Construct an STArray from an Array of JSON Objects
+     *
+     * @param value STArray or Array of Objects to parse into an STArray
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns An STArray object
+     */
+    static from(value, definitions = enums_1.DEFAULT_DEFINITIONS) {
+        if (value instanceof STArray) {
+            return value;
+        }
+        if (isObjects(value)) {
+            const bytes = [];
+            value.forEach((obj) => {
+                bytes.push(st_object_1.STObject.from(obj, undefined, definitions).toBytes());
+            });
+            bytes.push(ARRAY_END_MARKER);
+            return new STArray((0, utils_1.concat)(bytes));
+        }
+        throw new Error('Cannot construct STArray from value given');
+    }
+    /**
+     * Return the JSON representation of this.bytes
+     *
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns An Array of JSON objects
+     */
+    toJSON(definitions = enums_1.DEFAULT_DEFINITIONS) {
+        const result = [];
+        const arrayParser = new binary_parser_1.BinaryParser(this.toString(), definitions);
+        while (!arrayParser.end()) {
+            const field = arrayParser.readField();
+            if (field.name === ARRAY_END_MARKER_NAME) {
+                break;
+            }
+            const outer = {};
+            outer[field.name] = st_object_1.STObject.fromParser(arrayParser).toJSON(definitions);
+            result.push(outer);
+        }
+        return result;
+    }
+    getSType() {
+        return serialized_type_1.SerializedTypeID.STI_ARRAY;
+    }
+}
+exports.STArray = STArray;
+//# sourceMappingURL=st-array.js.map

package/dist/src/types/st-array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"st-array.js","sourceRoot":"","sources":["../../../src/types/st-array.ts"],"names":[],"mappings":";;;AAAA,oCAAmE;AACnE,uDAAgF;AAChF,2CAAsC;AACtC,2DAAsD;AACtD,qDAAkD;AAElD,MAAM,gBAAgB,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;AAChD,MAAM,qBAAqB,GAAG,gBAAgB,CAAA;AAE9C,MAAM,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;AAEjD;;GAEG;AACH,SAAS,SAAS,CAAC,IAAI;IACrB,OAAO,CACL,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACnB,IAAI,CAAC,KAAK,CACR,CAAC,GAAG,EAAE,EAAE,CACN,OAAO,GAAG,KAAK,QAAQ;YACvB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC;YAC7B,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,CAC5C,CACF,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAQ,SAAQ,gCAAc;IAClC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,KAAK,GAAsB,EAAE,CAAA;QAEnC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;YAChC,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE;gBACxC,MAAK;aACN;YAED,KAAK,CAAC,IAAI,CACR,KAAK,CAAC,MAAM,EACZ,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EACtC,iBAAiB,CAClB,CAAA;SACF;QAED,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC5B,OAAO,IAAI,OAAO,CAAC,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;IACnC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CACT,KAAQ,EACR,cAAmC,2BAAmB;QAEtD,IAAI,KAAK,YAAY,OAAO,EAAE;YAC5B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,KAAK,GAAsB,EAAE,CAAA;YACnC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACpB,KAAK,CAAC,IAAI,CAAC,oBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;YAClE,CAAC,CAAC,CAAA;YAEF,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;YAC5B,OAAO,IAAI,OAAO,CAAC,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC,CAAA;SAClC;QAED,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,cAAmC,2BAAmB;QAEtD,MAAM,MAAM,GAAsB,EAAE,CAAA;QAEpC,MAAM,WAAW,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAA;QAElE,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,EAAE,CAAA;YACrC,IAAI,KAAK,CAAC,IAAI,KAAK,qBAAqB,EAAE;gBACxC,MAAK;aACN;YAED,MAAM,KAAK,GAAG,EAAE,CAAA;YAChB,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;YACxE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACnB;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IAED,QAAQ;QACN,OAAO,kCAAgB,CAAC,SAAS,CAAA;IACnC,CAAC;CACF;AAEQ,0BAAO"}

package/dist/src/types/st-number.d.ts

@@ -0,0 +1,55 @@
+import { BinaryParser } from '../serdes/binary-parser';
+import { SerializedType, SerializedTypeID } from './serialized-type';
+/**
+ * STNumber: Encodes XRPL's "Number" type.
+ *
+ * - Always encoded as 12 bytes: 8-byte signed mantissa, 4-byte signed exponent, both big-endian.
+ * - Can only be constructed from a valid number string or another STNumber instance.
+ *
+ * Usage:
+ *   STNumber.from("1.2345e5")
+ *   STNumber.from("-123")
+ *   STNumber.fromParser(parser)
+ */
+export declare class STNumber extends SerializedType {
+    /** 12 zero bytes, represents canonical zero. */
+    static defaultBytes: Uint8Array;
+    /**
+     * Construct a STNumber from 12 bytes (8 for mantissa, 4 for exponent).
+     * @param bytes - 12-byte Uint8Array
+     * @throws Error if input is not a Uint8Array of length 12.
+     */
+    constructor(bytes?: Uint8Array);
+    /**
+     * Construct from a number string (or another STNumber).
+     *
+     * @param value - A string, or STNumber instance.
+     * @returns STNumber instance.
+     * @throws Error if not a string or STNumber.
+     */
+    static from(value: unknown): STNumber;
+    /**
+     * Construct from a number string (integer, decimal, or scientific notation).
+     * Handles normalization to XRPL Number constraints.
+     *
+     * @param val - The number as a string (e.g. '1.23', '-123e5').
+     * @returns STNumber instance
+     * @throws Error if val is not a valid number string.
+     */
+    static fromValue(val: string): STNumber;
+    /**
+     * Read a STNumber from a BinaryParser stream (12 bytes).
+     * @param parser - BinaryParser positioned at the start of a number
+     * @returns STNumber instance
+     */
+    static fromParser(parser: BinaryParser): STNumber;
+    /**
+     * Convert this STNumber to a normalized string representation.
+     * The output is decimal or scientific notation, depending on exponent range.
+     * Follows XRPL convention: zero is "0", other values are normalized to a canonical string.
+     *
+     * @returns String representation of the value
+     */
+    toJSON(): string;
+    getSType(): SerializedTypeID;
+}

package/dist/src/types/st-number.js

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STNumber = void 0;
+const serialized_type_1 = require("./serialized-type");
+const utils_1 = require("../utils");
+/**
+ * Constants for mantissa and exponent normalization per XRPL Number spec.
+ * These define allowed magnitude for mantissa and exponent after normalization.
+ */
+const MIN_MANTISSA = BigInt('1000000000000000');
+const MAX_MANTISSA = BigInt('9999999999999999');
+const MIN_EXPONENT = -32768;
+const MAX_EXPONENT = 32768;
+const DEFAULT_VALUE_EXPONENT = -2147483648;
+/**
+ * Extract mantissa, exponent, and sign from a number string.
+ *
+ * @param val - The string representing the number (may be integer, decimal, or scientific notation).
+ * @returns Object containing mantissa (BigInt), exponent (number), and isNegative (boolean).
+ * @throws Error if the string cannot be parsed as a valid number.
+ *
+ * Examples:
+ *   '123'        -> { mantissa: 123n, exponent: 0, isNegative: false }
+ *   '-00123.45'  -> { mantissa: -12345n, exponent: -2, isNegative: true }
+ *   '+7.1e2'     -> { mantissa: 71n, exponent: -1 + 2 = 1, isNegative: false }
+ */
+function extractNumberPartsFromString(val) {
+    /**
+     * Regex for parsing decimal/float/scientific number strings with optional sign, integer, decimal, and exponent parts.
+     *
+     * Pattern: /^([-+]?)([0-9]+)(?:\.([0-9]+))?(?:[eE]([+-]?[0-9]+))?$/
+     *
+     * Breakdown:
+     *   1. ([-+]?)         - Optional '+' or '-' sign at the start.
+     *   2. ([0-9]+)        - Integer part: one or more digits (leading zeros allowed).
+     *   3. (?:\.([0-9]+))? - Optional decimal point followed by one or more digits.
+     *   4. (?:[eE]([+-]?[0-9]+))? - Optional exponent, starting with 'e' or 'E', optional sign, and digits.
+     *
+     * Notes:
+     *   - Leading zeros are accepted and normalized by code after parsing.
+     *   - Empty decimal ('123.') and missing integer ('.456') are NOT matched—must be fully specified.
+     */
+    // eslint-disable-next-line prefer-named-capture-group
+    const regex = /^([-+]?)([0-9]+)(?:\.([0-9]+))?(?:[eE]([+-]?[0-9]+))?$/;
+    const match = regex.exec(val);
+    if (!match)
+        throw new Error(`Unable to parse number from string: ${val}`);
+    const [, sign, intPart, fracPart, expPart] = match;
+    // Remove leading zeros (unless the entire intPart is zeros)
+    const cleanIntPart = intPart.replace(/^0+(?=\d)/, '') || '0';
+    let mantissaStr = cleanIntPart;
+    let exponent = 0;
+    if (fracPart) {
+        mantissaStr += fracPart;
+        exponent -= fracPart.length;
+    }
+    if (expPart)
+        exponent += parseInt(expPart, 10);
+    let mantissa = BigInt(mantissaStr);
+    if (sign === '-')
+        mantissa = -mantissa;
+    const isNegative = mantissa < BigInt(0);
+    return { mantissa, exponent, isNegative };
+}
+/**
+ * Normalize the mantissa and exponent to XRPL constraints.
+ *
+ * Ensures that after normalization, the mantissa is between MIN_MANTISSA and MAX_MANTISSA (unless zero).
+ * Adjusts the exponent as needed by shifting the mantissa left/right (multiplying/dividing by 10).
+ *
+ * @param mantissa - The unnormalized mantissa (BigInt).
+ * @param exponent - The unnormalized exponent (number).
+ * @returns An object with normalized mantissa and exponent.
+ * @throws Error if the number cannot be normalized within allowed exponent range.
+ */
+function normalize(mantissa, exponent) {
+    let m = mantissa < BigInt(0) ? -mantissa : mantissa;
+    const isNegative = mantissa < BigInt(0);
+    while (m !== BigInt(0) && m < MIN_MANTISSA && exponent > MIN_EXPONENT) {
+        exponent -= 1;
+        m *= BigInt(10);
+    }
+    while (m > MAX_MANTISSA) {
+        if (exponent >= MAX_EXPONENT)
+            throw new Error('Mantissa and exponent are too large');
+        exponent += 1;
+        m /= BigInt(10);
+    }
+    if (isNegative)
+        m = -m;
+    return { mantissa: m, exponent };
+}
+/**
+ * STNumber: Encodes XRPL's "Number" type.
+ *
+ * - Always encoded as 12 bytes: 8-byte signed mantissa, 4-byte signed exponent, both big-endian.
+ * - Can only be constructed from a valid number string or another STNumber instance.
+ *
+ * Usage:
+ *   STNumber.from("1.2345e5")
+ *   STNumber.from("-123")
+ *   STNumber.fromParser(parser)
+ */
+class STNumber extends serialized_type_1.SerializedType {
+    /**
+     * Construct a STNumber from 12 bytes (8 for mantissa, 4 for exponent).
+     * @param bytes - 12-byte Uint8Array
+     * @throws Error if input is not a Uint8Array of length 12.
+     */
+    constructor(bytes) {
+        const used = bytes !== null && bytes !== void 0 ? bytes : STNumber.defaultBytes;
+        if (!(used instanceof Uint8Array) || used.length !== 12) {
+            throw new Error(`STNumber must be constructed from a 12-byte Uint8Array, got ${used === null || used === void 0 ? void 0 : used.length}`);
+        }
+        super(used);
+    }
+    /**
+     * Construct from a number string (or another STNumber).
+     *
+     * @param value - A string, or STNumber instance.
+     * @returns STNumber instance.
+     * @throws Error if not a string or STNumber.
+     */
+    static from(value) {
+        if (value instanceof STNumber) {
+            return value;
+        }
+        if (typeof value === 'string') {
+            return STNumber.fromValue(value);
+        }
+        throw new Error('STNumber.from: Only string or STNumber instance is supported');
+    }
+    /**
+     * Construct from a number string (integer, decimal, or scientific notation).
+     * Handles normalization to XRPL Number constraints.
+     *
+     * @param val - The number as a string (e.g. '1.23', '-123e5').
+     * @returns STNumber instance
+     * @throws Error if val is not a valid number string.
+     */
+    static fromValue(val) {
+        const { mantissa, exponent, isNegative } = extractNumberPartsFromString(val);
+        let normalizedMantissa;
+        let normalizedExponent;
+        if (mantissa === BigInt(0) && exponent === 0 && !isNegative) {
+            normalizedMantissa = BigInt(0);
+            normalizedExponent = DEFAULT_VALUE_EXPONENT;
+        }
+        else {
+            ;
+            ({ mantissa: normalizedMantissa, exponent: normalizedExponent } =
+                normalize(mantissa, exponent));
+        }
+        const bytes = new Uint8Array(12);
+        (0, utils_1.writeInt64BE)(bytes, normalizedMantissa, 0);
+        (0, utils_1.writeInt32BE)(bytes, normalizedExponent, 8);
+        return new STNumber(bytes);
+    }
+    /**
+     * Read a STNumber from a BinaryParser stream (12 bytes).
+     * @param parser - BinaryParser positioned at the start of a number
+     * @returns STNumber instance
+     */
+    static fromParser(parser) {
+        return new STNumber(parser.read(12));
+    }
+    /**
+     * Convert this STNumber to a normalized string representation.
+     * The output is decimal or scientific notation, depending on exponent range.
+     * Follows XRPL convention: zero is "0", other values are normalized to a canonical string.
+     *
+     * @returns String representation of the value
+     */
+    // eslint-disable-next-line complexity -- required
+    toJSON() {
+        const b = this.bytes;
+        if (!b || b.length !== 12)
+            throw new Error('STNumber internal bytes not set or wrong length');
+        // Signed 64-bit mantissa
+        const mantissa = (0, utils_1.readInt64BE)(b, 0);
+        // Signed 32-bit exponent
+        const exponent = (0, utils_1.readInt32BE)(b, 8);
+        // Special zero: XRPL encodes canonical zero as mantissa=0, exponent=DEFAULT_VALUE_EXPONENT.
+        if (mantissa === BigInt(0) && exponent === DEFAULT_VALUE_EXPONENT) {
+            return '0';
+        }
+        if (exponent === 0)
+            return mantissa.toString();
+        // Use scientific notation for small/large exponents, decimal otherwise
+        if (exponent < -25 || exponent > -5) {
+            return `${mantissa}e${exponent}`;
+        }
+        // Decimal rendering for -25 <= exp <= -5
+        const isNegative = mantissa < BigInt(0);
+        const mantissaAbs = mantissa < BigInt(0) ? -mantissa : mantissa;
+        const padPrefix = 27;
+        const padSuffix = 23;
+        const mantissaStr = mantissaAbs.toString();
+        const rawValue = '0'.repeat(padPrefix) + mantissaStr + '0'.repeat(padSuffix);
+        const OFFSET = exponent + 43;
+        const integerPart = rawValue.slice(0, OFFSET).replace(/^0+/, '') || '0';
+        const fractionPart = rawValue.slice(OFFSET).replace(/0+$/, '');
+        return `${isNegative ? '-' : ''}${integerPart}${fractionPart ? '.' + fractionPart : ''}`;
+    }
+    getSType() {
+        return serialized_type_1.SerializedTypeID.STI_NUMBER;
+    }
+}
+exports.STNumber = STNumber;
+/** 12 zero bytes, represents canonical zero. */
+STNumber.defaultBytes = new Uint8Array(12);
+//# sourceMappingURL=st-number.js.map

package/dist/src/types/st-number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"st-number.js","sourceRoot":"","sources":["../../../src/types/st-number.ts"],"names":[],"mappings":";;;AACA,uDAAoE;AACpE,oCAA+E;AAE/E;;;GAGG;AACH,MAAM,YAAY,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAC/C,MAAM,YAAY,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAA;AAC/C,MAAM,YAAY,GAAG,CAAC,KAAK,CAAA;AAC3B,MAAM,YAAY,GAAG,KAAK,CAAA;AAC1B,MAAM,sBAAsB,GAAG,CAAC,UAAU,CAAA;AAE1C;;;;;;;;;;;GAWG;AACH,SAAS,4BAA4B,CAAC,GAAW;IAK/C;;;;;;;;;;;;;;OAcG;IACH,sDAAsD;IACtD,MAAM,KAAK,GAAG,wDAAwD,CAAA;IACtE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC7B,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,GAAG,EAAE,CAAC,CAAA;IAEzE,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,KAAK,CAAA;IAClD,4DAA4D;IAC5D,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,GAAG,CAAA;IAE5D,IAAI,WAAW,GAAG,YAAY,CAAA;IAC9B,IAAI,QAAQ,GAAG,CAAC,CAAA;IAEhB,IAAI,QAAQ,EAAE;QACZ,WAAW,IAAI,QAAQ,CAAA;QACvB,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAA;KAC5B;IACD,IAAI,OAAO;QAAE,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAE9C,IAAI,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAA;IAClC,IAAI,IAAI,KAAK,GAAG;QAAE,QAAQ,GAAG,CAAC,QAAQ,CAAA;IACtC,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IAEvC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAA;AAC3C,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,SAAS,CAChB,QAAgB,EAChB,QAAgB;IAEhB,IAAI,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAA;IACnD,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IAEvC,OAAO,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,YAAY,IAAI,QAAQ,GAAG,YAAY,EAAE;QACrE,QAAQ,IAAI,CAAC,CAAA;QACb,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAA;KAChB;IACD,OAAO,CAAC,GAAG,YAAY,EAAE;QACvB,IAAI,QAAQ,IAAI,YAAY;YAC1B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,QAAQ,IAAI,CAAC,CAAA;QACb,CAAC,IAAI,MAAM,CAAC,EAAE,CAAC,CAAA;KAChB;IACD,IAAI,UAAU;QAAE,CAAC,GAAG,CAAC,CAAC,CAAA;IACtB,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAA;AAClC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAa,QAAS,SAAQ,gCAAc;IAI1C;;;;OAIG;IACH,YAAY,KAAkB;QAC5B,MAAM,IAAI,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,QAAQ,CAAC,YAAY,CAAA;QAC3C,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE;YACvD,MAAM,IAAI,KAAK,CACb,+DAA+D,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAC9E,CAAA;SACF;QACD,KAAK,CAAC,IAAI,CAAC,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,KAAc;QACxB,IAAI,KAAK,YAAY,QAAQ,EAAE;YAC7B,OAAO,KAAK,CAAA;SACb;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;SACjC;QACD,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CAAC,GAAW;QAC1B,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,4BAA4B,CAAC,GAAG,CAAC,CAAA;QAC5E,IAAI,kBAA0B,CAAA;QAC9B,IAAI,kBAA0B,CAAA;QAE9B,IAAI,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE;YAC3D,kBAAkB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YAC9B,kBAAkB,GAAG,sBAAsB,CAAA;SAC5C;aAAM;YACL,CAAC;YAAA,CAAC,EAAE,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,kBAAkB,EAAE;gBAC9D,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAA;SACjC;QAED,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;QAChC,IAAA,oBAAY,EAAC,KAAK,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAA;QAC1C,IAAA,oBAAY,EAAC,KAAK,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAA;QAC1C,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;IACtC,CAAC;IAED;;;;;;OAMG;IACH,kDAAkD;IAClD,MAAM;QACJ,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAA;QACpB,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QAEpE,yBAAyB;QACzB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAClC,yBAAyB;QACzB,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAElC,4FAA4F;QAC5F,IAAI,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,QAAQ,KAAK,sBAAsB,EAAE;YACjE,OAAO,GAAG,CAAA;SACX;QACD,IAAI,QAAQ,KAAK,CAAC;YAAE,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAA;QAE9C,uEAAuE;QACvE,IAAI,QAAQ,GAAG,CAAC,EAAE,IAAI,QAAQ,GAAG,CAAC,CAAC,EAAE;YACnC,OAAO,GAAG,QAAQ,IAAI,QAAQ,EAAE,CAAA;SACjC;QAED,yCAAyC;QACzC,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACvC,MAAM,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAA;QAE/D,MAAM,SAAS,GAAG,EAAE,CAAA;QACpB,MAAM,SAAS,GAAG,EAAE,CAAA;QACpB,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAA;QAC1C,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QAC5E,MAAM,MAAM,GAAG,QAAQ,GAAG,EAAE,CAAA;QAC5B,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,CAAA;QACvE,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QAE9D,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,GAC3C,YAAY,CAAC,CAAC,CAAC,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,EACtC,EAAE,CAAA;IACJ,CAAC;IAED,QAAQ;QACN,OAAO,kCAAgB,CAAC,UAAU,CAAA;IACpC,CAAC;;AA1HH,4BA2HC;AA1HC,gDAAgD;AACzC,qBAAY,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA"}

package/dist/src/types/st-object.d.ts

@@ -0,0 +1,33 @@
+import { XrplDefinitionsBase } from '../enums';
+import { SerializedType, JsonObject, SerializedTypeID } from './serialized-type';
+import { BinaryParser } from '../serdes/binary-parser';
+/**
+ * Class for Serializing/Deserializing objects
+ */
+declare class STObject extends SerializedType {
+    /**
+     * Construct a STObject from a BinaryParser
+     *
+     * @param parser BinaryParser to read STObject from
+     * @returns A STObject object
+     */
+    static fromParser(parser: BinaryParser): STObject;
+    /**
+     * Construct a STObject from a JSON object
+     *
+     * @param value An object to include
+     * @param filter optional, denote which field to include in serialized object
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns a STObject object
+     */
+    static from<T extends STObject | JsonObject>(value: T, filter?: (...any: any[]) => boolean, definitions?: XrplDefinitionsBase): STObject;
+    /**
+     * Get the JSON interpretation of this.bytes
+     * @param definitions rippled definitions used to parse the values of transaction types and such.
+     *                          Can be customized for sidechains and amendments.
+     * @returns a JSON object
+     */
+    toJSON(definitions?: XrplDefinitionsBase): JsonObject;
+    getSType(): SerializedTypeID;
+}
+export { STObject };

package/dist/src/types/st-object.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STObject = void 0;
+const enums_1 = require("../enums");
+const serialized_type_1 = require("./serialized-type");
+const ripple_address_codec_1 = require("@transia/ripple-address-codec");
+const binary_parser_1 = require("../serdes/binary-parser");
+const binary_serializer_1 = require("../serdes/binary-serializer");
+const st_array_1 = require("./st-array");
+const uint_64_1 = require("./uint-64");
+const OBJECT_END_MARKER_BYTE = Uint8Array.from([0xe1]);
+const OBJECT_END_MARKER = 'ObjectEndMarker';
+const ST_OBJECT = 'STObject';
+const DESTINATION = 'Destination';
+const ACCOUNT = 'Account';
+const SOURCE_TAG = 'SourceTag';
+const DEST_TAG = 'DestinationTag';
+/**
+ * Break down an X-Address into an account and a tag
+ *
+ * @param field Name of field
+ * @param xAddress X-Address corresponding to the field
+ */
+function handleXAddress(field, xAddress) {
+    const decoded = (0, ripple_address_codec_1.xAddressToClassicAddress)(xAddress);
+    let tagName;
+    if (field === DESTINATION)
+        tagName = DEST_TAG;
+    else if (field === ACCOUNT)
+        tagName = SOURCE_TAG;
+    else if (decoded.tag !== false)
+        throw new Error(`${field} cannot have an associated tag`);
+    return decoded.tag !== false
+        ? { [field]: decoded.classicAddress, [tagName]: decoded.tag }
+        : { [field]: decoded.classicAddress };
+}
+/**
+ * Validate that two objects don't both have the same tag fields
+ *
+ * @param obj1 First object to check for tags
+ * @param obj2 Second object to check for tags
+ * @throws When both objects have SourceTag or DestinationTag
+ */
+function checkForDuplicateTags(obj1, obj2) {
+    if (!(obj1[SOURCE_TAG] === undefined || obj2[SOURCE_TAG] === undefined))
+        throw new Error('Cannot have Account X-Address and SourceTag');
+    if (!(obj1[DEST_TAG] === undefined || obj2[DEST_TAG] === undefined))
+        throw new Error('Cannot have Destination X-Address and DestinationTag');
+}
+/**
+ * Class for Serializing/Deserializing objects
+ */
+class STObject extends serialized_type_1.SerializedType {
+    /**
+     * Construct a STObject from a BinaryParser
+     *
+     * @param parser BinaryParser to read STObject from
+     * @returns A STObject object
+     */
+    static fromParser(parser) {
+        const list = new binary_serializer_1.BytesList();
+        const bytes = new binary_serializer_1.BinarySerializer(list);
+        while (!parser.end()) {
+            const field = parser.readField();
+            if (field.name === OBJECT_END_MARKER) {
+                break;
+            }
+            const associatedValue = parser.readFieldValue(field);
+            bytes.writeFieldAndValue(field, associatedValue);
+            if (field.type.name === ST_OBJECT) {
+                bytes.put(OBJECT_END_MARKER_BYTE);
+            }
+        }
+        return new STObject(list.toBytes());
+    }
+    /**
+     * Construct a STObject from a JSON object
+     *
+     * @param value An object to include
+     * @param filter optional, denote which field to include in serialized object
+     * @param definitions optional, types and values to use to encode/decode a transaction
+     * @returns a STObject object
+     */
+    static from(value, filter, definitions = enums_1.DEFAULT_DEFINITIONS) {
+        if (value instanceof STObject) {
+            return value;
+        }
+        const list = new binary_serializer_1.BytesList();
+        const bytes = new binary_serializer_1.BinarySerializer(list);
+        let isUnlModify = false;
+        const xAddressDecoded = Object.entries(value).reduce((acc, [key, val]) => {
+            let handled = undefined;
+            if (val && (0, ripple_address_codec_1.isValidXAddress)(val.toString())) {
+                handled = handleXAddress(key, val.toString());
+                checkForDuplicateTags(handled, value);
+            }
+            return Object.assign(acc, handled !== null && handled !== void 0 ? handled : { [key]: val });
+        }, {});
+        function isValidFieldInstance(f) {
+            return (f !== undefined &&
+                xAddressDecoded[f.name] !== undefined &&
+                f.isSerialized);
+        }
+        let sorted = Object.keys(xAddressDecoded)
+            .map((f) => {
+            if (!(f in definitions.field)) {
+                if (f[0] === f[0].toLowerCase())
+                    return undefined;
+                throw new Error(`Field ${f} is not defined in the definitions`);
+            }
+            return definitions.field[f];
+        })
+            .filter(isValidFieldInstance)
+            .sort((a, b) => {
+            return a.ordinal - b.ordinal;
+        });
+        if (filter !== undefined) {
+            sorted = sorted.filter(filter);
+        }
+        sorted.forEach((field) => {
+            var _a;
+            const associatedValue = field.type.name === ST_OBJECT
+                ? this.from(xAddressDecoded[field.name], undefined, definitions)
+                : field.type.name === 'STArray'
+                    ? st_array_1.STArray.from(xAddressDecoded[field.name], definitions)
+                    : field.type.name === 'UInt64'
+                        ? uint_64_1.UInt64.from(xAddressDecoded[field.name], field.name)
+                        : ((_a = field.associatedType) === null || _a === void 0 ? void 0 : _a.from)
+                            ? field.associatedType.from(xAddressDecoded[field.name])
+                            : (() => {
+                                throw new Error(`Type ${field.type.name} for field ${field.name} is missing associatedType.from`);
+                            })();
+            if (associatedValue == undefined) {
+                throw new TypeError(`Unable to interpret "${field.name}: ${xAddressDecoded[field.name]}".`);
+            }
+            if (associatedValue.name === 'UNLModify') {
+                // triggered when the TransactionType field has a value of 'UNLModify'
+                isUnlModify = true;
+            }
+            // true when in the UNLModify pseudotransaction (after the transaction type has been processed) and working with the
+            // Account field
+            // The Account field must not be a part of the UNLModify pseudotransaction encoding, due to a bug in rippled
+            const isUnlModifyWorkaround = field.name == 'Account' && isUnlModify;
+            bytes.writeFieldAndValue(field, associatedValue, isUnlModifyWorkaround);
+            if (field.type.name === ST_OBJECT) {
+                bytes.put(OBJECT_END_MARKER_BYTE);
+            }
+        });
+        return new STObject(list.toBytes());
+    }
+    /**
+     * Get the JSON interpretation of this.bytes
+     * @param definitions rippled definitions used to parse the values of transaction types and such.
+     *                          Can be customized for sidechains and amendments.
+     * @returns a JSON object
+     */
+    toJSON(definitions) {
+        const objectParser = new binary_parser_1.BinaryParser(this.toString(), definitions);
+        const accumulator = {};
+        while (!objectParser.end()) {
+            const field = objectParser.readField();
+            if (field.name === OBJECT_END_MARKER) {
+                break;
+            }
+            accumulator[field.name] = objectParser
+                .readFieldValue(field)
+                .toJSON(definitions, field.name);
+        }
+        return accumulator;
+    }
+    getSType() {
+        return serialized_type_1.SerializedTypeID.STI_OBJECT;
+    }
+}
+exports.STObject = STObject;
+//# sourceMappingURL=st-object.js.map

package/dist/src/types/st-object.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"st-object.js","sourceRoot":"","sources":["../../../src/types/st-object.ts"],"names":[],"mappings":";;;AAAA,oCAKiB;AACjB,uDAAgF;AAChF,wEAGsC;AACtC,2DAAsD;AACtD,mEAAyE;AAEzE,yCAAoC;AACpC,uCAAkC;AAElC,MAAM,sBAAsB,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;AACtD,MAAM,iBAAiB,GAAG,iBAAiB,CAAA;AAC3C,MAAM,SAAS,GAAG,UAAU,CAAA;AAC5B,MAAM,WAAW,GAAG,aAAa,CAAA;AACjC,MAAM,OAAO,GAAG,SAAS,CAAA;AACzB,MAAM,UAAU,GAAG,WAAW,CAAA;AAC9B,MAAM,QAAQ,GAAG,gBAAgB,CAAA;AAEjC;;;;;GAKG;AACH,SAAS,cAAc,CAAC,KAAa,EAAE,QAAgB;IACrD,MAAM,OAAO,GAAG,IAAA,+CAAwB,EAAC,QAAQ,CAAC,CAAA;IAElD,IAAI,OAAO,CAAA;IACX,IAAI,KAAK,KAAK,WAAW;QAAE,OAAO,GAAG,QAAQ,CAAA;SACxC,IAAI,KAAK,KAAK,OAAO;QAAE,OAAO,GAAG,UAAU,CAAA;SAC3C,IAAI,OAAO,CAAC,GAAG,KAAK,KAAK;QAC5B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,gCAAgC,CAAC,CAAA;IAE3D,OAAO,OAAO,CAAC,GAAG,KAAK,KAAK;QAC1B,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,EAAE;QAC7D,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,EAAE,CAAA;AACzC,CAAC;AAED;;;;;;GAMG;AACH,SAAS,qBAAqB,CAAC,IAAgB,EAAE,IAAgB;IAC/D,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,SAAS,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;IAChE,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;AAC3E,CAAC;AAED;;GAEG;AACH,MAAM,QAAS,SAAQ,gCAAc;IACnC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;QACpC,MAAM,IAAI,GAAc,IAAI,6BAAS,EAAE,CAAA;QACvC,MAAM,KAAK,GAAqB,IAAI,oCAAgB,CAAC,IAAI,CAAC,CAAA;QAE1D,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,CAAA;YAChC,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBACpC,MAAK;aACN;YAED,MAAM,eAAe,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;YAEpD,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAA;YAChD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;gBACjC,KAAK,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;aAClC;SACF;QAED,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACT,KAAQ,EACR,MAA4B,EAC5B,cAAmC,2BAAmB;QAEtD,IAAI,KAAK,YAAY,QAAQ,EAAE;YAC7B,OAAO,KAAK,CAAA;SACb;QAED,MAAM,IAAI,GAAc,IAAI,6BAAS,EAAE,CAAA;QACvC,MAAM,KAAK,GAAqB,IAAI,oCAAgB,CAAC,IAAI,CAAC,CAAA;QAE1D,IAAI,WAAW,GAAG,KAAK,CAAA;QAEvB,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YACvE,IAAI,OAAO,GAA2B,SAAS,CAAA;YAC/C,IAAI,GAAG,IAAI,IAAA,sCAAe,EAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,EAAE;gBAC1C,OAAO,GAAG,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC7C,qBAAqB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;aACtC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;QACtD,CAAC,EAAE,EAAE,CAAC,CAAA;QAEN,SAAS,oBAAoB,CAC3B,CAA4B;YAE5B,OAAO,CACL,CAAC,KAAK,SAAS;gBACf,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS;gBACrC,CAAC,CAAC,YAAY,CACf,CAAA;QACH,CAAC;QAED,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;aACtC,GAAG,CAAC,CAAC,CAAS,EAA6B,EAAE;YAC5C,IAAI,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;gBAC7B,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;oBAAE,OAAO,SAAS,CAAA;gBACjD,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,oCAAoC,CAAC,CAAA;aAChE;YACD,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,CAAkB,CAAA;QAC9C,CAAC,CAAC;aACD,MAAM,CAAC,oBAAoB,CAAC;aAC5B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACb,OAAO,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAA;QAC9B,CAAC,CAAC,CAAA;QAEJ,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;SAC/B;QAED,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;;YACvB,MAAM,eAAe,GACnB,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS;gBAC3B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC;gBAChE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS;oBAC/B,CAAC,CAAC,kBAAO,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC;oBACxD,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;wBAC9B,CAAC,CAAC,gBAAM,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC;wBACtD,CAAC,CAAC,CAAA,MAAA,KAAK,CAAC,cAAc,0CAAE,IAAI;4BAC5B,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;4BACxD,CAAC,CAAC,CAAC,GAAG,EAAE;gCACJ,MAAM,IAAI,KAAK,CACb,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,cAAc,KAAK,CAAC,IAAI,iCAAiC,CACjF,CAAA;4BACH,CAAC,CAAC,EAAE,CAAA;YAEV,IAAI,eAAe,IAAI,SAAS,EAAE;gBAChC,MAAM,IAAI,SAAS,CACjB,wBAAwB,KAAK,CAAC,IAAI,KAChC,eAAe,CAAC,KAAK,CAAC,IAAI,CAC5B,IAAI,CACL,CAAA;aACF;YAED,IAAK,eAAoC,CAAC,IAAI,KAAK,WAAW,EAAE;gBAC9D,sEAAsE;gBACtE,WAAW,GAAG,IAAI,CAAA;aACnB;YACD,oHAAoH;YACpH,gBAAgB;YAChB,4GAA4G;YAC5G,MAAM,qBAAqB,GAAG,KAAK,CAAC,IAAI,IAAI,SAAS,IAAI,WAAW,CAAA;YACpE,KAAK,CAAC,kBAAkB,CAAC,KAAK,EAAE,eAAe,EAAE,qBAAqB,CAAC,CAAA;YACvE,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;gBACjC,KAAK,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;aAClC;QACH,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAiC;QACtC,MAAM,YAAY,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAA;QACnE,MAAM,WAAW,GAAG,EAAE,CAAA;QAEtB,OAAO,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE;YAC1B,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,EAAE,CAAA;YACtC,IAAI,KAAK,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBACpC,MAAK;aACN;YAED,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,YAAY;iBACnC,cAAc,CAAC,KAAK,CAAC;iBACrB,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;SACnC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,QAAQ;QACN,OAAO,kCAAgB,CAAC,UAAU,CAAA;IACpC,CAAC;CACF;AAEQ,4BAAQ"}