@fleet-sdk/serializer 0.8.3 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @fleet-sdk/serializer
 
+## 0.9.0
+
+### Patch Changes
+
+- c558227: Memoize `SConstant` bytes for efficient re-encoding
+- ed7e44c: Add `SigmaByteReader#readRemainingBytes` method
+
+## 0.8.5
+
+### Patch Changes
+
+- be6867a: Add `deserializeBox` function
+- 3b2a774: Add `deserializeTransaction` function
+- 2e627a5: Add `SBox` constant serialization and deserialization.
+- Updated dependencies [07bafd5]
+  - @fleet-sdk/common@0.8.5
+  - @fleet-sdk/crypto@0.8.5
+
 ## 0.8.3
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,20 +1,33 @@
 import { ByteInput as ByteInput$1, blake2b256, Coder } from '@fleet-sdk/crypto';
-import { Box, Amount, BoxCandidate, UnsignedInput, DataInput, SignedTransaction } from '@fleet-sdk/common';
+import { Box, Amount, BoxCandidate, UnsignedTransaction, SignedTransaction } from '@fleet-sdk/common';
 
 declare class SigmaByteReader {
     #private;
     get isEmpty(): boolean;
+    get bytes(): Uint8Array;
+    get cursor(): number;
     constructor(bytes: ByteInput$1);
+    readArray<T>(readFn: (reader: SigmaByteReader, index: number) => T): Array<T>;
     readBool(): boolean;
     readBits(length: number): ArrayLike<boolean>;
     readByte(): number;
     readBytes(length: number): Uint8Array;
-    readVlq(): number;
+    readUInt(): number;
+    readBigUInt(): bigint;
     readI8(): number;
     readI16(): number;
     readI32(): number;
     readI64(): bigint;
     readI256(): bigint;
+    readRemainingBytes(): Uint8Array;
+    /**
+     * Returns bytes without advancing the cursor.
+     */
+    peek(count: number, offset?: number): Uint8Array;
+    /**
+     * Checks if the current position in the byte array starts with the given bytes.
+     */
+    match(bytes: Uint8Array, offset?: number): boolean;
 }
 
 declare class SigmaByteWriter {
@@ -22,8 +35,8 @@ declare class SigmaByteWriter {
     get length(): number;
     constructor(length: number);
     writeBool(value: boolean): SigmaByteWriter;
-    writeVLQ(value: number): SigmaByteWriter;
-    writeBigVLQ(value: bigint): SigmaByteWriter;
+    writeUInt(value: number): SigmaByteWriter;
+    writeBigUInt(value: bigint): SigmaByteWriter;
     writeI16(value: number): SigmaByteWriter;
     writeI32(value: number): SigmaByteWriter;
     writeI64(value: bigint): SigmaByteWriter;
@@ -33,6 +46,16 @@ declare class SigmaByteWriter {
     writeHex(bytesHex: string): SigmaByteWriter;
     writeBits(bits: ArrayLike<boolean>): SigmaByteWriter;
     writeChecksum(length?: number, hashFn?: typeof blake2b256): SigmaByteWriter;
+    /**
+     * Writes a length-delimited array of items to the byte stream using a provided
+     * serializer function.
+     *
+     * @typeParam T - The type of items in the array.
+     * @param items - The array of items to serialize and write.
+     * @param serializer - A function that serializes each item and writes it using the provided SigmaByteWriter.
+     * @returns The current instance of SigmaByteWriter for method chaining.
+     */
+    writeArray<T>(items: T[], serializer: (writer: SigmaByteWriter, item: T) => void): SigmaByteWriter;
     encode<T>(coder: Coder<Uint8Array, T>): T;
     toBytes(): Uint8Array;
 }
@@ -81,6 +104,10 @@ declare class SUnitType extends SMonomorphicType<undefined> {
     get code(): 0x62;
     toString(): string;
 }
+declare class SBoxType extends SMonomorphicType<SConstant<Box<bigint>>> {
+    get code(): 0x63;
+    toString(): string;
+}
 
 type BigIntInput = string | bigint;
 type ByteInput = Uint8Array | string;
@@ -97,8 +124,10 @@ declare const SLong: SProxy<SLongType, BigIntInput, bigint>;
 declare const SBigInt: SProxy<SBigIntType, BigIntInput, bigint>;
 declare const SGroupElement: SProxy<SGroupElementType, ByteInput, Uint8Array<ArrayBufferLike>>;
 declare const SSigmaProp: SProxy<SSigmaPropType, SConstant<Uint8Array<ArrayBufferLike>, SType<unknown, unknown>>, SConstant<Uint8Array<ArrayBufferLike>, SType<unknown, unknown>>>;
-type SUnit = (value?: undefined) => SConstant<undefined, SUnitType>;
+type SUnit = () => SConstant<undefined, SUnitType>;
 declare const SUnit: SUnit;
+type SBox = (value?: Box) => SConstant<Box<bigint>, SBoxType>;
+declare const SBox: SBox;
 type SColl = {
     <D, T extends SByteType>(type: SConstructor<D, T>, elements: ByteInput | D[]): SConstant<Uint8Array, T>;
     <D, T extends SByteType>(type: SConstructor<D, T>, elements: ByteInput[]): SConstant<Uint8Array[], T>;
@@ -155,9 +184,22 @@ declare function isTuple(type: SType): type is STupleType;
 declare class SConstant<D = unknown, T extends SType = SType> {
     #private;
     constructor(type: T, data: D);
-    static from<D, T extends SType = SType>(bytes: ByteInput$1): SConstant<D, T>;
+    static from<D, T extends SType = SType>(bytes: ByteInput$1 | SigmaByteReader): SConstant<D, T>;
     get type(): T;
     get data(): D;
+    /**
+     * Returns the serialized representation of the current instance as a `Uint8Array`.
+     * If the bytes have already been computed and cached, returns the cached value.
+     * Otherwise, serializes the instance and returns the resulting bytes.
+     */
+    get bytes(): Uint8Array;
+    /**
+     * Serializes the current object into a `Uint8Array`.
+     */
+    serialize(): Uint8Array;
+    /**
+     * @deprecated use `serialize` instead
+     */
     toBytes(): Uint8Array;
     toHex(): string;
 }
@@ -185,21 +227,31 @@ declare function parse<T>(constant: ByteInput$1, mode: "strict"): T;
 /** @deprecated use `decode` instead */
 declare function parse<T>(constant: ByteInput$1 | undefined, mode: "safe"): T | undefined;
 
-declare function serializeBox(box: Box<Amount>): SigmaByteWriter;
-declare function serializeBox(box: Box<Amount>, writer: SigmaByteWriter): SigmaByteWriter;
-declare function serializeBox(box: BoxCandidate<Amount>, writer: SigmaByteWriter, distinctTokenIds: string[]): SigmaByteWriter;
+declare function serializeBox(box: Box<Amount> | BoxCandidate<Amount>, writer?: SigmaByteWriter, distinctTokenIds?: string[]): SigmaByteWriter;
 /**
  * Estimates the byte size a box.
  * @returns byte size of the box.
  */
 declare function estimateBoxSize(box: Box<Amount> | BoxCandidate<Amount>, withValue?: Amount): number;
+/**
+ * Deserializes a box embedded in a transaction.
+ *
+ * It efficiently calculates the box ID by accumulating the serialized data during
+ * deserialization and applying blake2b256 hashing, avoiding redundant serialization
+ * operations.
+ *
+ * @param reader - SigmaByteReader containing the serialized box data
+ * @param distinctTokenIds - Array of TokenIDs referenced in the parent transaction
+ * @param transactionId - ID of the transaction containing this box
+ * @param index - Index position of the box in the transaction outputs
+ * @returns A fully deserialized Box with all properties including boxId
+ */
+declare function deserializeEmbeddedBox(reader: SigmaByteReader, distinctTokenIds: string[], transactionId: string, index: number): Box<bigint>;
+declare function deserializeBox(input: ByteInput | SigmaByteReader): BoxCandidate<bigint> | Box<bigint>;
 
-type MinimalUnsignedTransaction = {
-    inputs: UnsignedInput[];
-    dataInputs: DataInput[];
-    outputs: BoxCandidate<Amount>[];
-};
-declare function serializeTransaction(transaction: MinimalUnsignedTransaction | SignedTransaction): SigmaByteWriter;
+type Transaction = UnsignedTransaction | SignedTransaction;
+declare function serializeTransaction(transaction: Transaction): SigmaByteWriter;
+declare function deserializeTransaction<T extends Transaction>(input: ByteInput): T;
 
 declare const dataSerializer: {
     serialize(data: unknown, type: SType, writer: SigmaByteWriter): SigmaByteWriter;
@@ -211,4 +263,4 @@ declare const typeSerializer: {
     deserialize(r: SigmaByteReader): SType;
 };
 
-export { type MinimalUnsignedTransaction, SBigInt, SBigIntType, SBool, SBoolType, SByte, SByteType, SColl, SCollType, SConstant, SGenericType, SGroupElement, SGroupElementType, SInt, SIntType, SLong, SLongType, SMonomorphicType, SPair, SPrimitiveType, SShort, SShortType, SSigmaProp, SSigmaPropType, STupleType, SType, SUnit, SUnitType, SigmaByteReader, SigmaByteWriter, dataSerializer, decode, estimateBoxSize, estimateVLQSize, isColl, isTuple, parse, serializeBox, serializeTransaction, stypeof, typeSerializer };
+export { SBigInt, SBigIntType, SBool, SBoolType, SBox, SBoxType, SByte, SByteType, SColl, SCollType, SConstant, SGenericType, SGroupElement, SGroupElementType, SInt, SIntType, SLong, SLongType, SMonomorphicType, SPair, SPrimitiveType, SShort, SShortType, SSigmaProp, SSigmaPropType, STupleType, SType, SUnit, SUnitType, SigmaByteReader, SigmaByteWriter, dataSerializer, decode, deserializeBox, deserializeEmbeddedBox, deserializeTransaction, estimateBoxSize, estimateVLQSize, isColl, isTuple, parse, serializeBox, serializeTransaction, stypeof, typeSerializer };

package/dist/index.d.ts

@@ -1,20 +1,33 @@
 import { ByteInput as ByteInput$1, blake2b256, Coder } from '@fleet-sdk/crypto';
-import { Box, Amount, BoxCandidate, UnsignedInput, DataInput, SignedTransaction } from '@fleet-sdk/common';
+import { Box, Amount, BoxCandidate, UnsignedTransaction, SignedTransaction } from '@fleet-sdk/common';
 
 declare class SigmaByteReader {
     #private;
     get isEmpty(): boolean;
+    get bytes(): Uint8Array;
+    get cursor(): number;
     constructor(bytes: ByteInput$1);
+    readArray<T>(readFn: (reader: SigmaByteReader, index: number) => T): Array<T>;
     readBool(): boolean;
     readBits(length: number): ArrayLike<boolean>;
     readByte(): number;
     readBytes(length: number): Uint8Array;
-    readVlq(): number;
+    readUInt(): number;
+    readBigUInt(): bigint;
     readI8(): number;
     readI16(): number;
     readI32(): number;
     readI64(): bigint;
     readI256(): bigint;
+    readRemainingBytes(): Uint8Array;
+    /**
+     * Returns bytes without advancing the cursor.
+     */
+    peek(count: number, offset?: number): Uint8Array;
+    /**
+     * Checks if the current position in the byte array starts with the given bytes.
+     */
+    match(bytes: Uint8Array, offset?: number): boolean;
 }
 
 declare class SigmaByteWriter {
@@ -22,8 +35,8 @@ declare class SigmaByteWriter {
     get length(): number;
     constructor(length: number);
     writeBool(value: boolean): SigmaByteWriter;
-    writeVLQ(value: number): SigmaByteWriter;
-    writeBigVLQ(value: bigint): SigmaByteWriter;
+    writeUInt(value: number): SigmaByteWriter;
+    writeBigUInt(value: bigint): SigmaByteWriter;
     writeI16(value: number): SigmaByteWriter;
     writeI32(value: number): SigmaByteWriter;
     writeI64(value: bigint): SigmaByteWriter;
@@ -33,6 +46,16 @@ declare class SigmaByteWriter {
     writeHex(bytesHex: string): SigmaByteWriter;
     writeBits(bits: ArrayLike<boolean>): SigmaByteWriter;
     writeChecksum(length?: number, hashFn?: typeof blake2b256): SigmaByteWriter;
+    /**
+     * Writes a length-delimited array of items to the byte stream using a provided
+     * serializer function.
+     *
+     * @typeParam T - The type of items in the array.
+     * @param items - The array of items to serialize and write.
+     * @param serializer - A function that serializes each item and writes it using the provided SigmaByteWriter.
+     * @returns The current instance of SigmaByteWriter for method chaining.
+     */
+    writeArray<T>(items: T[], serializer: (writer: SigmaByteWriter, item: T) => void): SigmaByteWriter;
     encode<T>(coder: Coder<Uint8Array, T>): T;
     toBytes(): Uint8Array;
 }
@@ -81,6 +104,10 @@ declare class SUnitType extends SMonomorphicType<undefined> {
     get code(): 0x62;
     toString(): string;
 }
+declare class SBoxType extends SMonomorphicType<SConstant<Box<bigint>>> {
+    get code(): 0x63;
+    toString(): string;
+}
 
 type BigIntInput = string | bigint;
 type ByteInput = Uint8Array | string;
@@ -97,8 +124,10 @@ declare const SLong: SProxy<SLongType, BigIntInput, bigint>;
 declare const SBigInt: SProxy<SBigIntType, BigIntInput, bigint>;
 declare const SGroupElement: SProxy<SGroupElementType, ByteInput, Uint8Array<ArrayBufferLike>>;
 declare const SSigmaProp: SProxy<SSigmaPropType, SConstant<Uint8Array<ArrayBufferLike>, SType<unknown, unknown>>, SConstant<Uint8Array<ArrayBufferLike>, SType<unknown, unknown>>>;
-type SUnit = (value?: undefined) => SConstant<undefined, SUnitType>;
+type SUnit = () => SConstant<undefined, SUnitType>;
 declare const SUnit: SUnit;
+type SBox = (value?: Box) => SConstant<Box<bigint>, SBoxType>;
+declare const SBox: SBox;
 type SColl = {
     <D, T extends SByteType>(type: SConstructor<D, T>, elements: ByteInput | D[]): SConstant<Uint8Array, T>;
     <D, T extends SByteType>(type: SConstructor<D, T>, elements: ByteInput[]): SConstant<Uint8Array[], T>;
@@ -155,9 +184,22 @@ declare function isTuple(type: SType): type is STupleType;
 declare class SConstant<D = unknown, T extends SType = SType> {
     #private;
     constructor(type: T, data: D);
-    static from<D, T extends SType = SType>(bytes: ByteInput$1): SConstant<D, T>;
+    static from<D, T extends SType = SType>(bytes: ByteInput$1 | SigmaByteReader): SConstant<D, T>;
     get type(): T;
     get data(): D;
+    /**
+     * Returns the serialized representation of the current instance as a `Uint8Array`.
+     * If the bytes have already been computed and cached, returns the cached value.
+     * Otherwise, serializes the instance and returns the resulting bytes.
+     */
+    get bytes(): Uint8Array;
+    /**
+     * Serializes the current object into a `Uint8Array`.
+     */
+    serialize(): Uint8Array;
+    /**
+     * @deprecated use `serialize` instead
+     */
     toBytes(): Uint8Array;
     toHex(): string;
 }
@@ -185,21 +227,31 @@ declare function parse<T>(constant: ByteInput$1, mode: "strict"): T;
 /** @deprecated use `decode` instead */
 declare function parse<T>(constant: ByteInput$1 | undefined, mode: "safe"): T | undefined;
 
-declare function serializeBox(box: Box<Amount>): SigmaByteWriter;
-declare function serializeBox(box: Box<Amount>, writer: SigmaByteWriter): SigmaByteWriter;
-declare function serializeBox(box: BoxCandidate<Amount>, writer: SigmaByteWriter, distinctTokenIds: string[]): SigmaByteWriter;
+declare function serializeBox(box: Box<Amount> | BoxCandidate<Amount>, writer?: SigmaByteWriter, distinctTokenIds?: string[]): SigmaByteWriter;
 /**
  * Estimates the byte size a box.
  * @returns byte size of the box.
  */
 declare function estimateBoxSize(box: Box<Amount> | BoxCandidate<Amount>, withValue?: Amount): number;
+/**
+ * Deserializes a box embedded in a transaction.
+ *
+ * It efficiently calculates the box ID by accumulating the serialized data during
+ * deserialization and applying blake2b256 hashing, avoiding redundant serialization
+ * operations.
+ *
+ * @param reader - SigmaByteReader containing the serialized box data
+ * @param distinctTokenIds - Array of TokenIDs referenced in the parent transaction
+ * @param transactionId - ID of the transaction containing this box
+ * @param index - Index position of the box in the transaction outputs
+ * @returns A fully deserialized Box with all properties including boxId
+ */
+declare function deserializeEmbeddedBox(reader: SigmaByteReader, distinctTokenIds: string[], transactionId: string, index: number): Box<bigint>;
+declare function deserializeBox(input: ByteInput | SigmaByteReader): BoxCandidate<bigint> | Box<bigint>;
 
-type MinimalUnsignedTransaction = {
-    inputs: UnsignedInput[];
-    dataInputs: DataInput[];
-    outputs: BoxCandidate<Amount>[];
-};
-declare function serializeTransaction(transaction: MinimalUnsignedTransaction | SignedTransaction): SigmaByteWriter;
+type Transaction = UnsignedTransaction | SignedTransaction;
+declare function serializeTransaction(transaction: Transaction): SigmaByteWriter;
+declare function deserializeTransaction<T extends Transaction>(input: ByteInput): T;
 
 declare const dataSerializer: {
     serialize(data: unknown, type: SType, writer: SigmaByteWriter): SigmaByteWriter;
@@ -211,4 +263,4 @@ declare const typeSerializer: {
     deserialize(r: SigmaByteReader): SType;
 };
 
-export { type MinimalUnsignedTransaction, SBigInt, SBigIntType, SBool, SBoolType, SByte, SByteType, SColl, SCollType, SConstant, SGenericType, SGroupElement, SGroupElementType, SInt, SIntType, SLong, SLongType, SMonomorphicType, SPair, SPrimitiveType, SShort, SShortType, SSigmaProp, SSigmaPropType, STupleType, SType, SUnit, SUnitType, SigmaByteReader, SigmaByteWriter, dataSerializer, decode, estimateBoxSize, estimateVLQSize, isColl, isTuple, parse, serializeBox, serializeTransaction, stypeof, typeSerializer };
+export { SBigInt, SBigIntType, SBool, SBoolType, SBox, SBoxType, SByte, SByteType, SColl, SCollType, SConstant, SGenericType, SGroupElement, SGroupElementType, SInt, SIntType, SLong, SLongType, SMonomorphicType, SPair, SPrimitiveType, SShort, SShortType, SSigmaProp, SSigmaPropType, STupleType, SType, SUnit, SUnitType, SigmaByteReader, SigmaByteWriter, dataSerializer, decode, deserializeBox, deserializeEmbeddedBox, deserializeTransaction, estimateBoxSize, estimateVLQSize, isColl, isTuple, parse, serializeBox, serializeTransaction, stypeof, typeSerializer };