@fleet-sdk/serializer 0.8.5 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @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

package/dist/index.d.mts

@@ -19,6 +19,7 @@ declare class SigmaByteReader {
     readI32(): number;
     readI64(): bigint;
     readI256(): bigint;
+    readRemainingBytes(): Uint8Array;
     /**
      * Returns bytes without advancing the cursor.
      */
@@ -54,7 +55,7 @@ declare class SigmaByteWriter {
      * @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: (item: T, writer: SigmaByteWriter) => void): SigmaByteWriter;
+    writeArray<T>(items: T[], serializer: (writer: SigmaByteWriter, item: T) => void): SigmaByteWriter;
     encode<T>(coder: Coder<Uint8Array, T>): T;
     toBytes(): Uint8Array;
 }
@@ -186,6 +187,19 @@ declare class SConstant<D = unknown, T extends SType = SType> {
     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;
 }

package/dist/index.d.ts

@@ -19,6 +19,7 @@ declare class SigmaByteReader {
     readI32(): number;
     readI64(): bigint;
     readI256(): bigint;
+    readRemainingBytes(): Uint8Array;
     /**
      * Returns bytes without advancing the cursor.
      */
@@ -54,7 +55,7 @@ declare class SigmaByteWriter {
      * @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: (item: T, writer: SigmaByteWriter) => void): SigmaByteWriter;
+    writeArray<T>(items: T[], serializer: (writer: SigmaByteWriter, item: T) => void): SigmaByteWriter;
     encode<T>(coder: Coder<Uint8Array, T>): T;
     toBytes(): Uint8Array;
 }
@@ -186,6 +187,19 @@ declare class SConstant<D = unknown, T extends SType = SType> {
     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;
 }

package/dist/index.js

@@ -34,6 +34,22 @@ function negateAndMask(value) {
   const mask = (1n << BigInt(len)) - 1n;
   return (~val & mask) + 1n;
 }
+
+// src/coders/numRanges.ts
+var MAX_U8 = 255;
+var MAX_I8 = 127;
+var MIN_I16 = -32768;
+var MAX_I16 = 32767;
+var MIN_I32 = -2147483648;
+var MAX_I32 = 2147483647;
+var MIN_I64 = -BigInt("0x8000000000000000");
+var MAX_I64 = BigInt("0x7fffffffffffffff");
+var MIN_I256 = -BigInt(
+  "0x8000000000000000000000000000000000000000000000000000000000000000"
+);
+var MAX_I256 = BigInt(
+  "0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+);
 function writeVLQ(writer, value) {
   if (value === 0) return writer.write(0);
   if (value < 0) {
@@ -80,7 +96,7 @@ function readBigVLQ(reader) {
   if (reader.isEmpty) return common._0n;
   let value = common._0n;
   let shift = common._0n;
-  let lower7bits = common._0n;
+  let lower7bits;
   do {
     lower7bits = BigInt(reader.readByte());
     value |= (lower7bits & common._127n) << shift;
@@ -129,22 +145,6 @@ var zigZag64 = {
   }
 };
 
-// src/coders/numRanges.ts
-var MAX_U8 = 255;
-var MAX_I8 = 127;
-var MIN_I16 = -32768;
-var MAX_I16 = 32767;
-var MIN_I32 = -2147483648;
-var MAX_I32 = 2147483647;
-var MIN_I64 = -BigInt("0x8000000000000000");
-var MAX_I64 = BigInt("0x7fffffffffffffff");
-var MIN_I256 = -BigInt(
-  "0x8000000000000000000000000000000000000000000000000000000000000000"
-);
-var MAX_I256 = BigInt(
-  "0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
-);
-
 // src/coders/sigmaByteReader.ts
 var SigmaByteReader = class {
   #bytes;
@@ -216,6 +216,9 @@ var SigmaByteReader = class {
     const len = readVLQ(this);
     return hexToBigInt(crypto.hex.encode(this.readBytes(len)));
   }
+  readRemainingBytes() {
+    return this.readBytes(this.#bytes.length - this.#cursor);
+  }
   /**
    * Returns bytes without advancing the cursor.
    */
@@ -321,7 +324,7 @@ var SigmaByteWriter = class {
     this.writeUInt(items.length);
     if (items.length === 0) return this;
     for (const item of items) {
-      serializer(item, this);
+      serializer(this, item);
     }
     return this;
   }
@@ -577,14 +580,8 @@ var SByte = monoProxy(SByteType, descriptors.byte);
 var SBool = monoProxy(SBoolType, descriptors.bool);
 var SShort = monoProxy(SShortType, descriptors.short);
 var SInt = monoProxy(SIntType, descriptors.int);
-var SLong = monoProxy(
-  SLongType,
-  descriptors.long
-);
-var SBigInt = monoProxy(
-  SBigIntType,
-  descriptors.bigInt
-);
+var SLong = monoProxy(SLongType, descriptors.long);
+var SBigInt = monoProxy(SBigIntType, descriptors.bigInt);
 var SGroupElement = monoProxy(
   SGroupElementType,
   descriptors.groupElement
@@ -632,12 +629,12 @@ function writeTokens(writer, tokens, tokenIds) {
   if (tokenIds) {
     writer.writeArray(
       tokens,
-      (token, w) => w.writeUInt(tokenIds.indexOf(token.tokenId)).writeBigUInt(common.ensureBigInt(token.amount))
+      (w, token) => w.writeUInt(tokenIds.indexOf(token.tokenId)).writeBigUInt(common.ensureBigInt(token.amount))
     );
   } else {
     writer.writeArray(
       tokens,
-      (token, w) => w.writeHex(token.tokenId).writeBigUInt(common.ensureBigInt(token.amount))
+      (w, token) => w.writeHex(token.tokenId).writeBigUInt(common.ensureBigInt(token.amount))
     );
   }
 }
@@ -649,7 +646,7 @@ function writeRegisters(writer, registers) {
     if (!value) continue;
     values.push(value);
   }
-  writer.writeArray(values, (value, w) => w.writeHex(value));
+  writer.writeArray(values, (w, value) => w.writeHex(value));
 }
 function estimateBoxSize(box, withValue) {
   if (common.isUndefined(box.creationHeight)) {
@@ -818,9 +815,7 @@ var dataSerializer = {
     }
     if (type.code === descriptors.unit.code) return writer;
     if (type.code === descriptors.box.code) return serializeBox(data, writer);
-    throw Error(
-      `Serialization error: '0x${type.code.toString(16)}' type not implemented.`
-    );
+    throw Error(`Serialization error: '0x${type.code.toString(16)}' type not implemented.`);
   },
   deserialize(type, reader) {
     if (type.embeddable) {
@@ -866,9 +861,7 @@ var dataSerializer = {
           }
         }
         case descriptors.tuple.code: {
-          return type.elementsType.map(
-            (t) => this.deserialize(t, reader)
-          );
+          return type.elementsType.map((t) => this.deserialize(t, reader));
         }
         case descriptors.unit.code:
           return void 0;
@@ -893,9 +886,7 @@ var typeSerializer = {
       } else if (isColl(type.elementsType)) {
         const nestedColl = type.elementsType;
         if (nestedColl.elementsType.embeddable) {
-          writer.write(
-            descriptors.coll.nestedCollTypeCode + nestedColl.elementsType.code
-          );
+          writer.write(descriptors.coll.nestedCollTypeCode + nestedColl.elementsType.code);
         } else {
           writer.write(descriptors.coll.simpleCollTypeCode);
           this.serialize(nestedColl, writer);
@@ -934,10 +925,7 @@ var typeSerializer = {
           break;
         default: {
           const len = type.elementsType.length;
-          common.assert(
-            len >= 2 && len <= 255,
-            "Invalid type: tuples must have between 2 and 255 items."
-          );
+          common.assert(len >= 2 && len <= 255, "Invalid type: tuples must have between 2 and 255 items.");
           writer.write(descriptors.tuple.genericTupleTypeCode);
           writer.writeUInt(len);
         }
@@ -975,12 +963,7 @@ var typeSerializer = {
           return new STupleType(internal);
         }
         case constructorCode.symmetricPair: {
-          const internal = embdCode === 0 ? [
-            this.deserialize(r),
-            this.deserialize(r),
-            this.deserialize(r),
-            this.deserialize(r)
-          ] : [getPrimitiveType(embdCode), getPrimitiveType(embdCode)];
+          const internal = embdCode === 0 ? [this.deserialize(r), this.deserialize(r), this.deserialize(r), this.deserialize(r)] : [getPrimitiveType(embdCode), getPrimitiveType(embdCode)];
           return new STupleType(internal);
         }
       }
@@ -1008,6 +991,7 @@ var MAX_CONSTANT_LENGTH = 4096;
 var SConstant = class _SConstant {
   #type;
   #data;
+  #bytes;
   constructor(type, data) {
     this.#type = type;
     this.#data = type.coerce(data);
@@ -1015,9 +999,14 @@ var SConstant = class _SConstant {
   static from(bytes) {
     const reader = bytes instanceof SigmaByteReader ? bytes : new SigmaByteReader(bytes);
     if (reader.isEmpty) throw new Error("Empty constant bytes.");
+    const start = reader.cursor;
     const type = typeSerializer.deserialize(reader);
     const data = dataSerializer.deserialize(type, reader);
-    return new _SConstant(type, data);
+    return new _SConstant(type, data).#withBytes(reader.bytes.slice(start, reader.cursor));
+  }
+  #withBytes(bytes) {
+    this.#bytes = bytes;
+    return this;
   }
   get type() {
     return this.#type;
@@ -1025,16 +1014,52 @@ var SConstant = class _SConstant {
   get data() {
     return this.#data;
   }
-  toBytes() {
-    const writer = new SigmaByteWriter(MAX_CONSTANT_LENGTH);
+  /**
+   * 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() {
+    if (this.#bytes) return this.#bytes;
+    return this.serialize();
+  }
+  /**
+   * Serializes the current object into a `Uint8Array`.
+   */
+  serialize() {
+    const writer = new SigmaByteWriter(guessConstantBytesSize(this.type, this.data));
     typeSerializer.serialize(this.type, writer);
     dataSerializer.serialize(this.data, this.type, writer);
-    return writer.toBytes();
+    this.#bytes = writer.toBytes();
+    return this.#bytes;
+  }
+  /**
+   * @deprecated use `serialize` instead
+   */
+  toBytes() {
+    return this.serialize();
   }
   toHex() {
-    return crypto.hex.encode(this.toBytes());
+    return crypto.hex.encode(this.serialize());
   }
 };
+function guessConstantBytesSize(type, data) {
+  const dataSize = 1;
+  if (type.code === descriptors.short.code) return dataSize + 8;
+  if (type.code === descriptors.int.code) return dataSize + 16;
+  if (type.code === descriptors.long.code) return dataSize + 32;
+  if (type.code === descriptors.bigInt.code) return dataSize + 64;
+  if (type.code === descriptors.bool.code) return dataSize + 1;
+  if (type.code === descriptors.byte.code) return dataSize + 1;
+  if (type.code === descriptors.unit.code) return dataSize + 0;
+  if (type.code === descriptors.groupElement.code) return dataSize + 33;
+  if (type.code === descriptors.sigmaProp.code) return dataSize + 35;
+  if (isColl(type) && !isColl(type.elementsType) && !isTuple(type.elementsType)) {
+    const len = data.length;
+    return dataSize + estimateVLQSize(len) + guessConstantBytesSize(type.elementsType) * len;
+  }
+  return MAX_CONSTANT_LENGTH;
+}
 function decode(value) {
   if (value === void 0) return;
   try {
@@ -1062,7 +1087,7 @@ function parse(constant, mode = "strict") {
 }
 function serializeTransaction(transaction) {
   const tokenIds = getDistinctTokenIds(transaction.outputs);
-  return new SigmaByteWriter(1e5).writeArray(transaction.inputs, (input, w) => writeInput(w, input)).writeArray(transaction.dataInputs, (dataInput, w) => w.writeHex(dataInput.boxId)).writeArray(tokenIds, (tokenId, w) => w.writeHex(tokenId)).writeArray(transaction.outputs, (output, w) => serializeBox(output, w, tokenIds));
+  return new SigmaByteWriter(1e5).writeArray(transaction.inputs, (w, input) => writeInput(w, input)).writeArray(transaction.dataInputs, (w, dataInput) => w.writeHex(dataInput.boxId)).writeArray(tokenIds, (w, tokenId) => w.writeHex(tokenId)).writeArray(transaction.outputs, (w, output) => serializeBox(output, w, tokenIds));
 }
 function writeInput(writer, input) {
   if (isSignedInput(input)) {
@@ -1079,10 +1104,7 @@ function writeSignedInput(writer, input) {
 function writeUnsignedInput(writer, input) {
   writer.writeHex(input.boxId);
   writeProof(writer, null);
-  writeExtension(
-    writer,
-    isSignedInput(input) ? input.spendingProof?.extension : input.extension
-  );
+  writeExtension(writer, isSignedInput(input) ? input.spendingProof?.extension : input.extension);
 }
 function isSignedInput(input) {
   return input.spendingProof !== void 0;
@@ -1107,10 +1129,7 @@ function writeExtension(writer, extension) {
     if (!value) continue;
     values.push([key, value]);
   }
-  writer.writeArray(
-    values,
-    ([key, value], w) => w.writeUInt(Number(key)).writeHex(value)
-  );
+  writer.writeArray(values, (w, [key, value]) => w.writeUInt(Number(key)).writeHex(value));
 }
 function getDistinctTokenIds(outputs) {
   const tokenIds = /* @__PURE__ */ new Set();
@@ -1143,7 +1162,7 @@ function readInput(reader) {
   return proofBytes ? { boxId, spendingProof: { proofBytes, extension } } : { boxId, extension };
 }
 function computeId(reader, inputs) {
-  const bytes = new SigmaByteWriter(reader.bytes.length).writeArray(inputs, (input, writer) => writeUnsignedInput(writer, input)).writeBytes(reader.bytes.subarray(reader.cursor)).toBytes();
+  const bytes = new SigmaByteWriter(reader.bytes.length).writeArray(inputs, (w, input) => writeUnsignedInput(w, input)).writeBytes(reader.bytes.subarray(reader.cursor)).toBytes();
   return crypto.hex.encode(crypto.blake2b256(bytes));
 }