Merge pull request #179 from fleet-sdk/arobsn/i176

Add `SBox` constant serialization

Author: arobsn

.changeset/smooth-planets-yawn.md

@@ -0,0 +1,5 @@
+---
+"@fleet-sdk/serializer": patch
+---
+
+Add `SBox` constant serialization and deserialization.

packages/serializer/src/_test-vectors/constantVectors.ts

@@ -12,6 +12,7 @@ import {
   SShort
 } from "../types";
 import { type SConstructor, STuple } from "../types/constructors";
+import { validBoxes } from "_test-vectors";
 
 const u8a = (input: number[]) => Uint8Array.from(input);
 
@@ -585,3 +586,18 @@ export const tupleTestVectors: GenericTypeTestVector[] = [
     hex: "3c0c3c0e0e3c0c3c0e580c3c0e58060a6261636b67726f756e6404626c75650570756e6b730361706505626561726409626967206265617264056d6f757468066d6f6465737407676c617373657302767203746f700a7065616b207370696b650000"
   }
 ];
+
+export const sBoxVectors = [
+  {
+    value: validBoxes[0],
+    hex: "63c0843d0008cd038d39af8c37583609ff51c6a577efe60684119da2fbd0d75f9c72372886a58a63cdee330150fdc80e168c153e472bd7e3dd18a4a0b9e90c550206fdbdb789ee8afdd3b1a90100ae11d207f0989945f63909d2f703b2640acf4f654a8fdadd23570a640f9d12ee00"
+  },
+  {
+    value: validBoxes[1],
+    hex: "63caf0ca330008cd038d39af8c37583609ff51c6a577efe60684119da2fbd0d75f9c72372886a58a639fbf3318de5ee573c6a492c129d51119649bfeaedfc9afa6f54af576e62e1f7f3bbd42078e87f9f1051fd6e032e8476c4aa54c18c1a308dce83940e8f4a28f576440513ed7326ad4898a993d03faf2cb329f2e90d6d23b58d91bbb6c046aa143261cc21f52fbe2824bfcbf043274251ce2cb4eb2024a1a155e19ad1d1f58ff8b9e6eb034a3bb1fd58802757d2380a0b787e905003bd19d0187117f130b62e1bcab0939929ff5c7709f843c5c4dd158949285d00136aba4b4a97b65be491cf9f5ca57b5408b0da8d0194f30ec8330d1e8946161c103c5d6629329285b14ed3eac1dba0e07dbd1e61ee332c2039a7a9c04e8be0cb74eb6f6b1c7ae03a3b3fa62124ef52209a46121e3f93ca98d7fc24198009e90fde8205ef9d3fc330100bd762484086cf560d3127eb53f0769d76244d9737636b2699d55c56cd470bfa589015a34d53ca483924b9a6aa0c771f11888881b516a8d1a9cdc535d063fe26d065e21d601123e8838b95cdaebe24e594276b2a89cd38e98add98405bb5327520ecf6cacf2cb07bf59773def7e08375a553be4cbd862de85f66e6dd3dccb8f87f53158f9255bf59582a6efc79e84911102f31739e2e4937bb9afb552943753d1e3e9cdd1a5e5661949cb0cef93f907eade9e0d30974274078845f263b4f21787e33cc99e9ec19a17ad85a5bc6da2cca91c5a2ec7c98b8c850b0cd8c9f416e5b1ca9f986a7f10a84191dfb85941619e49e53c0dc30ebf83324bfc1c1c51c3a53abfe87e6db9a03c649e8360f255ffc4bd34303d30fc7db23ae551db9c04fbbaac7337d051c10fc3da0ccb864f4d32d40027551e1c3ea3ce361f39b91e40c10fef802b475c06189fdbf844153cdc1d449a5ba87cce13d11bb47b5a539f27f12bfdecfad1f82a472c3d4ecaa08fb7392ff041ee2e6af75f4a558810a74b28600549d5392810e880ade204bf2afb01fde7e373e22f24032434a7b883913bd87a23b62ee8b43eba53c9f6c201bf337a2ce726259ad31e043c5b3d432e31b403fc6686691171e0e0a319b9ae7a0100b1e236b60b95c2c6f8007a9d89bc460fc9e78f98b09faec9449007b40bccf3888124d71693c49a84fbbecd4908c94813b46514b18b67a99952dc1e6e4791556de413db0eee105e8290b090a773b7c56756507d45a76743d73bce54e8a915e95d9eb97360b681e596010089b758cfed2b9eac6721fb4576d8ba016202fdd939f32425aa7e2aefcbdde32e01"
+  },
+  {
+    value: validBoxes[2],
+    hex: "63c0843d0008cd02200a1c1b8fa17ec82de54bcaef96f23d7b34196c0410f6f578abdbf163b14b258abd33010cd8c9f416e5b1ca9f986a7f10a84191dfb85941619e49e53c0dc30ebf83324b0100b66aab1e43874ad8c5583f685a7d6d947238c373f615aee1d04ee604ba2c934000"
+  }
+];

packages/serializer/src/serializers/dataSerializer.ts

@@ -1,8 +1,9 @@
-import { assert } from "@fleet-sdk/common";
+import { assert, type Box } from "@fleet-sdk/common";
 import type { SigmaByteReader, SigmaByteWriter } from "../coders";
 import type { SConstant } from "../sigmaConstant";
 import { isColl, isTuple, type SCollType, type STupleType, type SType } from "../types";
 import { descriptors } from "../types/descriptors";
+import { deserializeBox, serializeBox } from "./boxSerializer";
 
 const GROUP_ELEMENT_LENGTH = 33;
 const PROVE_DLOG_OP = 0xcd;
@@ -80,6 +81,7 @@ export const dataSerializer = {
     }
 
     if (type.code === descriptors.unit.code) return writer;
+    if (type.code === descriptors.box.code) return serializeBox(data as Box, writer);
 
     throw Error(
       `Serialization error: '0x${type.code.toString(16)}' type not implemented.`
@@ -139,6 +141,8 @@ export const dataSerializer = {
         }
         case descriptors.unit.code:
           return undefined;
+        case descriptors.box.code:
+          return deserializeBox(reader);
       }
     }
 

packages/serializer/src/serializers/typeSerializer.ts

@@ -14,6 +14,8 @@ export const typeSerializer = {
       writer.write(type.code);
     } else if (type.code === descriptors.unit.code) {
       writer.write(type.code);
+    } else if (type.code === descriptors.box.code) {
+      writer.write(type.code);
     } else if (isColl(type)) {
       if (type.elementsType.embeddable) {
         writer.write(descriptors.coll.simpleCollTypeCode + type.elementsType.code);
@@ -149,9 +151,10 @@ export const typeSerializer = {
 
         return new STupleType(wrapped);
       }
-      case descriptors.unit.code: {
+      case descriptors.unit.code:
         return descriptors.unit;
-      }
+      case descriptors.box.code:
+        return descriptors.box;
     }
 
     throw new Error("Not implemented.");

packages/serializer/src/sigmaConstant.spec.ts

@@ -1,5 +1,5 @@
-import { ensureBigInt } from "@fleet-sdk/common";
-import { hex, randomBytes } from "@fleet-sdk/crypto";
+import { type Box, ensureBigInt } from "@fleet-sdk/common";
+import { hex } from "@fleet-sdk/crypto";
 import { describe, expect, it, test } from "vitest";
 import {
   bigintVectors,
@@ -9,14 +9,15 @@ import {
   groupElementVectors,
   intVectors,
   longVectors,
+  sBoxVectors,
   shortVectors,
   sigmaPropVectors,
   tupleTestVectors
 } from "./_test-vectors/constantVectors";
 import { SigmaByteWriter } from "./coders";
 import { dataSerializer } from "./serializers";
 import { decode, parse, SConstant, stypeof } from "./sigmaConstant";
-import type { SGroupElementType } from "./types";
+import type { SGroupElementType, SPrimitiveType } from "./types";
 import {
   SBigInt,
   SBool,
@@ -30,7 +31,7 @@ import {
   STupleType,
   SUnit
 } from "./types/";
-import { STuple } from "./types/constructors";
+import { SBox, STuple } from "./types/constructors";
 import { Value$ } from "sigmastate-js/main";
 import fc from "fast-check";
 import {
@@ -45,6 +46,7 @@ import {
   MIN_I64,
   MIN_I8
 } from "./coders/numRanges";
+import { SPair } from "../dist";
 
 describe("Primitive types serialization and parsing", () => {
   it.each(boolVectors)("Should road-trip SBool($value)", (tv) => {
@@ -277,6 +279,25 @@ describe("Not implemented types", () => {
   });
 });
 
+describe("SBox serialization", () => {
+  test.each(sBoxVectors)("SBox serialization bytes", (tv) => {
+    const sconst = SBox(tv.value);
+    expect(sconst.toHex()).to.be.equal(tv.hex);
+    expect(sconst.type.toString()).to.be.equal("SBox");
+  });
+
+  test.each(sBoxVectors)("SBox roundtrip", (tv) => {
+    expect(SBox(SConstant.from<Box>(tv.hex).data).toHex()).to.be.equal(tv.hex);
+  });
+
+  it("Should not embed SBox", () => {
+    // @ts-expect-error SBox is not compatible with SColl
+    expect(() => SColl(SBox, [sBoxVectors[0].value])).toThrow();
+    // @ts-expect-error SBox is not compatible with SPair
+    expect(() => SPair(SBox(sBoxVectors[0].value), SBox(sBoxVectors[1]))).toThrow();
+  });
+});
+
 describe("Tuple serialization", () => {
   it.each(tupleTestVectors)("Should road-trip $name", (tv) => {
     expect(tv.sconst.toHex()).to.be.equal(tv.hex);

packages/serializer/src/sigmaConstant.ts

@@ -1,4 +1,3 @@
-import { assert, isUndefined } from "@fleet-sdk/common";
 import { type ByteInput, hex } from "@fleet-sdk/crypto";
 import { SigmaByteReader, SigmaByteWriter } from "./coders";
 import { dataSerializer } from "./serializers/dataSerializer";

packages/serializer/src/types/constructors.spec.ts

@@ -51,13 +51,9 @@ describe("Constructor proxies", () => {
 
 describe("SPair constructor", () => {
   it("Should throw if params contains different types", () => {
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    expect(() => SPair(SBool(true) as any, SBool() as any)).to.throw(
-      "Invalid tuple declaration."
-    );
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    expect(() => SPair(SBool() as any, SBool(true)) as any).to.throw(
-      "Invalid tuple declaration."
-    );
+    // @ts-expect-error invalid pair construction
+    expect(() => SPair(SBool(true), SBool())).to.throw("Invalid tuple declaration.");
+    // @ts-expect-error invalid pair construction
+    expect(() => SPair(SBool(), SBool(true))).to.throw("Invalid tuple declaration.");
   });
 });

packages/serializer/src/types/constructors.ts

@@ -1,9 +1,9 @@
-import { isEmpty } from "@fleet-sdk/common";
+import { type Box, isEmpty } from "@fleet-sdk/common";
 import { SConstant } from "../sigmaConstant";
 import type { SType } from "./base";
 import { descriptors } from "./descriptors";
 import { SCollType, STupleType } from "./generics";
-import { SUnitType } from "./monomorphics";
+import { SBoxType, SUnitType } from "./monomorphics";
 import {
   SBigIntType,
   SBoolType,
@@ -108,8 +108,11 @@ export const SSigmaProp = monoProxy<SSigmaPropType, SConstant<Uint8Array>>(
   descriptors.sigmaProp
 );
 
-type SUnit = (value?: undefined) => SConstant<undefined, SUnitType>;
-export const SUnit: SUnit = monoProxy(SUnitType, undefined, true);
+type SUnit = () => SConstant<undefined, SUnitType>;
+export const SUnit = monoProxy(SUnitType, undefined, true) as unknown as SUnit;
+
+type SBox = (value?: Box) => SConstant<Box<bigint>, SBoxType>;
+export const SBox = monoProxy(SBoxType, undefined, true) as unknown as SBox;
 
 type SColl = {
   <D, T extends SByteType>(

packages/serializer/src/types/descriptors.ts

@@ -1,6 +1,6 @@
 import type { SType } from "./base";
 import type { SCollType, STupleType } from "./generics";
-import { SUnitType } from "./monomorphics";
+import { SBoxType, SUnitType } from "./monomorphics";
 import {
   SBigIntType,
   SBoolType,
@@ -61,6 +61,7 @@ export const descriptors = {
   groupElement: new SGroupElementType(),
   sigmaProp: new SSigmaPropType(),
   unit: new SUnitType(),
+  box: new SBoxType(),
   coll: collDescriptor,
   tuple: tupleDescriptor
 } satisfies { [key: string]: Descriptor };

packages/serializer/src/types/index.ts

@@ -14,5 +14,6 @@ export {
   SSigmaProp,
   SUnit,
   SColl,
-  SPair
+  SPair,
+  SBox
 } from "./constructors";