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

package/dist/types/issue.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Issue = void 0;
+const utils_1 = require("@transia/isomorphic/utils");
+const binary_parser_1 = require("../serdes/binary-parser");
+const account_id_1 = require("./account-id");
+const currency_1 = require("./currency");
+const serialized_type_1 = require("./serialized-type");
+const hash_192_1 = require("./hash-192");
+/**
+ * Type guard for Issue Object
+ */
+function isIssueObject(arg) {
+    const keys = Object.keys(arg).sort();
+    const isXRP = keys.length === 1 && keys[0] === 'currency';
+    const isIOU = keys.length === 2 && keys[0] === 'currency' && keys[1] === 'issuer';
+    const isMPT = keys.length === 1 && keys[0] === 'mpt_issuance_id';
+    return isXRP || isIOU || isMPT;
+}
+/**
+ * Class for serializing/Deserializing Amounts
+ */
+class Issue extends serialized_type_1.SerializedType {
+    constructor(bytes) {
+        super(bytes !== null && bytes !== void 0 ? bytes : Issue.ZERO_ISSUED_CURRENCY.bytes);
+    }
+    /**
+     * Construct an amount from an IOU or string amount
+     *
+     * @param value An Amount, object representing an IOU, MPTAmount, or a string
+     *     representing an integer amount
+     * @returns An Issue object
+     */
+    static from(value) {
+        if (value instanceof Issue) {
+            return value;
+        }
+        if (isIssueObject(value)) {
+            if (value.currency) {
+                const currency = currency_1.Currency.from(value.currency.toString()).toBytes();
+                //IOU case
+                if (value.issuer) {
+                    const issuer = account_id_1.AccountID.from(value.issuer.toString()).toBytes();
+                    return new Issue((0, utils_1.concat)([currency, issuer]));
+                }
+                //XRP case
+                return new Issue(currency);
+            }
+            // MPT case
+            if (value.mpt_issuance_id) {
+                const mptIssuanceIdBytes = hash_192_1.Hash192.from(value.mpt_issuance_id.toString()).toBytes();
+                return new Issue(mptIssuanceIdBytes);
+            }
+        }
+        throw new Error('Invalid type to construct an Amount');
+    }
+    /**
+     * Read an amount from a BinaryParser
+     *
+     * @param parser BinaryParser to read the Amount from
+     * @param hint The number of bytes to consume from the parser.
+     * For an MPT amount, pass 24 (the fixed length for Hash192).
+     *
+     * @returns An Issue object
+     */
+    static fromParser(parser, hint) {
+        if (hint === hash_192_1.Hash192.width) {
+            const mptBytes = parser.read(hash_192_1.Hash192.width);
+            return new Issue(mptBytes);
+        }
+        const currency = parser.read(20);
+        if (new currency_1.Currency(currency).toJSON() === 'XRP') {
+            return new Issue(currency);
+        }
+        const currencyAndIssuer = [currency, parser.read(20)];
+        return new Issue((0, utils_1.concat)(currencyAndIssuer));
+    }
+    /**
+     * Get the JSON representation of this Amount
+     *
+     * @returns the JSON interpretation of this.bytes
+     */
+    toJSON() {
+        // If the buffer is exactly 24 bytes, treat it as an MPT amount.
+        if (this.toBytes().length === hash_192_1.Hash192.width) {
+            return {
+                mpt_issuance_id: this.toHex().toUpperCase(),
+            };
+        }
+        const parser = new binary_parser_1.BinaryParser(this.toString());
+        const currency = currency_1.Currency.fromParser(parser);
+        if (currency.toJSON() === 'XRP') {
+            return { currency: currency.toJSON() };
+        }
+        const issuer = account_id_1.AccountID.fromParser(parser);
+        return {
+            currency: currency.toJSON(),
+            issuer: issuer.toJSON(),
+        };
+    }
+    getSType() {
+        return serialized_type_1.SerializedTypeID.STI_ISSUE;
+    }
+}
+exports.Issue = Issue;
+Issue.ZERO_ISSUED_CURRENCY = new Issue(new Uint8Array(20));
+//# sourceMappingURL=issue.js.map

package/dist/types/issue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issue.js","sourceRoot":"","sources":["../../src/types/issue.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAClD,2DAAsD;AAEtD,6CAAwC;AACxC,yCAAqC;AACrC,uDAAgF;AAChF,yCAAoC;AAkBpC;;GAEG;AACH,SAAS,aAAa,CAAC,GAAG;IACxB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACpC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,CAAA;IACzD,MAAM,KAAK,GACT,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAA;IACrE,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAA;IAEhE,OAAO,KAAK,IAAI,KAAK,IAAI,KAAK,CAAA;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,KAAM,SAAQ,gCAAc;IAGhC,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;IAClD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAgC,KAAQ;QACjD,IAAI,KAAK,YAAY,KAAK,EAAE;YAC1B,OAAO,KAAK,CAAA;SACb;QAED,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE;YACxB,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAClB,MAAM,QAAQ,GAAG,mBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;gBAEnE,UAAU;gBACV,IAAI,KAAK,CAAC,MAAM,EAAE;oBAChB,MAAM,MAAM,GAAG,sBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAA;oBAChE,OAAO,IAAI,KAAK,CAAC,IAAA,cAAM,EAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;iBAC7C;gBAED,UAAU;gBACV,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;aAC3B;YAED,WAAW;YACX,IAAI,KAAK,CAAC,eAAe,EAAE;gBACzB,MAAM,kBAAkB,GAAG,kBAAO,CAAC,IAAI,CACrC,KAAK,CAAC,eAAe,CAAC,QAAQ,EAAE,CACjC,CAAC,OAAO,EAAE,CAAA;gBACX,OAAO,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAA;aACrC;SACF;QAED,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB,EAAE,IAAa;QACnD,IAAI,IAAI,KAAK,kBAAO,CAAC,KAAK,EAAE;YAC1B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAO,CAAC,KAAK,CAAC,CAAA;YAC3C,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;SAC3B;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAChC,IAAI,IAAI,mBAAQ,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,KAAK,KAAK,EAAE;YAC7C,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAA;SAC3B;QACD,MAAM,iBAAiB,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QACrD,OAAO,IAAI,KAAK,CAAC,IAAA,cAAM,EAAC,iBAAiB,CAAC,CAAC,CAAA;IAC7C,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,gEAAgE;QAChE,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,KAAK,kBAAO,CAAC,KAAK,EAAE;YAC3C,OAAO;gBACL,eAAe,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE;aAC5C,CAAA;SACF;QAED,MAAM,MAAM,GAAG,IAAI,4BAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEhD,MAAM,QAAQ,GAAG,mBAAQ,CAAC,UAAU,CAAC,MAAM,CAAa,CAAA;QACxD,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,KAAK,EAAE;YAC/B,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAA;SACvC;QACD,MAAM,MAAM,GAAG,sBAAS,CAAC,UAAU,CAAC,MAAM,CAAc,CAAA;QAExD,OAAO;YACL,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE;YAC3B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;SACxB,CAAA;IACH,CAAC;IAED,QAAQ;QACN,OAAO,kCAAgB,CAAC,SAAS,CAAA;IACnC,CAAC;;AAGM,sBAAK;AAlGI,0BAAoB,GAAU,IAAI,KAAK,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAA"}

package/dist/types/json.d.ts

@@ -0,0 +1,169 @@
+import { BinaryParser } from '../serdes/binary-parser';
+import { JsonObject, SerializedType, SerializedTypeID } from './serialized-type';
+import { BinarySerializer } from '../serdes/binary-serializer';
+/**
+ * STJson: Serialized Type for JSON-like structures (objects or arrays).
+ *
+ * Supports two modes:
+ * - Object: Key-value pairs where keys are VL-encoded strings
+ * - Array: Ordered list of values
+ *
+ * Values are [SType marker][VL-encoded SType serialization].
+ * Values can be any SType, including nested STJson.
+ *
+ * Serialization format: [type_byte][VL_length][data...]
+ * - type_byte: 0x00 = Object, 0x01 = Array
+ *
+ * Depth constraint: Maximum nesting depth of 1 level
+ */
+declare class STJson extends SerializedType {
+    private static readonly JsonType;
+    private data;
+    private jsonType;
+    private default_;
+    /**
+     * Construct STJson from bytes
+     * @param bytes - Uint8Array containing serialized JSON
+     */
+    constructor(bytes: Uint8Array);
+    /**
+     * Parse STJson from BinaryParser
+     *
+     * @param parser - BinaryParser positioned at the start of STJson
+     * @returns STJson instance
+     */
+    static fromParser(parser: BinaryParser): STJson;
+    /**
+     * Parse a single key-value pair from the parser
+     */
+    private static parsePair;
+    /**
+     * Factory for SType value from VL blob (with SType marker)
+     */
+    private static makeValueFromVLWithType;
+    /**
+     * Check if this is an array type
+     */
+    isArray(): boolean;
+    /**
+     * Check if this is an object type
+     */
+    isObject(): boolean;
+    /**
+     * Get the JSON type
+     */
+    getType(): number;
+    /**
+     * Get nesting depth (0 = no nesting, 1 = one level of nesting)
+     */
+    getDepth(): number;
+    /**
+     * Validate nesting depth (max 1 level)
+     */
+    private validateDepth;
+    /**
+     * Set a field in an object
+     */
+    setObjectField(key: string, value: SerializedType | null): void;
+    /**
+     * Get a field from an object
+     */
+    getObjectField(key: string): SerializedType | null | undefined;
+    /**
+     * Set a nested object field (one level deep)
+     */
+    setNestedObjectField(key: string, nestedKey: string, value: SerializedType | null): void;
+    /**
+     * Get a nested object field
+     */
+    getNestedObjectField(key: string, nestedKey: string): SerializedType | null | undefined;
+    /**
+     * Get the inner data as a Map (for objects)
+     */
+    getMap(): Map<string, SerializedType | null>;
+    /**
+     * Get the inner data as an array
+     */
+    getArray(): (SerializedType | null)[];
+    /**
+     * Push an element to an array
+     */
+    pushArrayElement(value: SerializedType | null): void;
+    /**
+     * Get an array element by index
+     */
+    getArrayElement(index: number): SerializedType | null | undefined;
+    /**
+     * Set an array element by index
+     */
+    setArrayElement(index: number, value: SerializedType | null): void;
+    /**
+     * Set a field within an array element (element must be an object)
+     */
+    setArrayElementField(index: number, key: string, value: SerializedType | null): void;
+    /**
+     * Get a field within an array element
+     */
+    getArrayElementField(index: number, key: string): SerializedType | null | undefined;
+    /**
+     * Get the size of the array
+     */
+    arraySize(): number;
+    /**
+     * Set a nested array element (array stored in object field)
+     */
+    setNestedArrayElement(key: string, index: number, value: SerializedType | null): void;
+    /**
+     * Set a field within a nested array element
+     */
+    setNestedArrayElementField(key: string, index: number, nestedKey: string, value: SerializedType | null): void;
+    /**
+     * Get a nested array element
+     */
+    getNestedArrayElement(key: string, index: number): SerializedType | null | undefined;
+    /**
+     * Get a field within a nested array element
+     */
+    getNestedArrayElementField(key: string, index: number, nestedKey: string): SerializedType | null | undefined;
+    /**
+     * Serialize to binary
+     */
+    add(s: BinarySerializer): void;
+    /**
+     * Encode a key as VL
+     */
+    private static addVLKey;
+    /**
+     * Encode a value as [SType marker][VL]
+     */
+    private static addVLValue;
+    /**
+     * Convert to JSON representation
+     */
+    toJSON(): JsonObject | JsonObject[];
+    /**
+     * Compare with another STJson for equivalence
+     */
+    isEquivalent(t: SerializedType): boolean;
+    /**
+     * Check if this is the default value
+     */
+    isDefault(): boolean;
+    /**
+     * Get blob representation
+     */
+    toBlob(): Uint8Array;
+    /**
+     * Get the size (number of bytes in serialized form)
+     */
+    size(): number;
+    /**
+     * Set the value from another STJson
+     */
+    setValue(v: STJson): void;
+    /**
+     * Get serialized type ID
+     */
+    getSType(): SerializedTypeID;
+}
+export { STJson };