@proto-kit/module 0.1.1-develop.154 → 0.1.1-develop.160

package/dist/method/MethodParameterDecoder.d.ts

@@ -6,9 +6,11 @@ export interface Fieldable {
 export interface FromFieldClass {
     new: (...args: any[]) => any;
     fromFields: (fields: Field[]) => Fieldable;
+    name: string;
     prototype: {
-        _fields: any[];
+        _fields?: any[];
     };
+    sizeInFields?: () => number;
 }
 export declare class MethodParameterDecoder {
     private readonly types;

package/dist/method/MethodParameterDecoder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MethodParameterDecoder.d.ts","sourceRoot":"","sources":["../../src/method/MethodParameterDecoder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEzD,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,KAAK,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;IAC7B,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,SAAS,CAAC;IAE3C,SAAS,EAAE;QACT,OAAO,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAOD,qBAAa,sBAAsB;IAWb,OAAO,CAAC,QAAQ,CAAC,KAAK;WAV5B,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,MAAM;IAU3E,OAAO;IAEA,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,EAAE;IAc/C,IAAW,SAAS,IAAI,MAAM,CAI7B;CACF"}
+{"version":3,"file":"MethodParameterDecoder.d.ts","sourceRoot":"","sources":["../../src/method/MethodParameterDecoder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEzD,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,KAAK,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;IAC7B,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,SAAS,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE;QACT,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;KACjB,CAAC;IACF,YAAY,CAAC,EAAE,MAAM,MAAM,CAAC;CAC7B;AAYD,qBAAa,sBAAsB;IAWb,OAAO,CAAC,QAAQ,CAAC,KAAK;WAV5B,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,MAAM;IAU3E,OAAO;IAEA,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,EAAE;IAiB/C,IAAW,SAAS,IAAI,MAAM,CAM7B;CACF"}

package/dist/method/MethodParameterDecoder.js

@@ -1,5 +1,6 @@
 const errors = {
     fieldLengthNotMatching: (expected, actual) => new Error(`Expected ${expected} field elements, got ${actual}`),
+    typeNotCompatible: (name) => new Error(`Cannot decode type ${name}, it has to be either a Struct, CircuitValue or built-in snarkyjs type`),
 };
 export class MethodParameterDecoder {
     static fromMethod(target, methodName) {
@@ -15,8 +16,10 @@ export class MethodParameterDecoder {
         }
         let stack = fields.slice();
         return this.types.map((type) => {
-            // eslint-disable-next-line no-underscore-dangle
-            const numberFieldsNeeded = type.prototype._fields.length;
+            const numberFieldsNeeded = type.prototype._fields?.length ?? type.sizeInFields?.() ?? -1;
+            if (numberFieldsNeeded === -1) {
+                throw errors.typeNotCompatible(type.name);
+            }
             const structFields = stack.slice(0, numberFieldsNeeded);
             stack = stack.slice(numberFieldsNeeded);
             return type.fromFields(structFields);
@@ -24,7 +27,7 @@ export class MethodParameterDecoder {
     }
     get fieldSize() {
         return this.types
-            .map((type) => type.prototype._fields.length)
+            .map((type) => type.prototype._fields?.length ?? type.sizeInFields?.() ?? 0)
             .reduce((a, b) => a + b);
     }
 }

package/dist/method/assert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/method/assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,UAAU,CAAC;AAK1C;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,QAQvD"}
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/method/assert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,UAAU,CAAC;AAM1C;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,QAYvD"}

package/dist/method/assert.js

@@ -1,6 +1,7 @@
 import { Bool, Provable } from "snarkyjs";
 import { container } from "tsyringe";
 import { RuntimeMethodExecutionContext } from "./RuntimeMethodExecutionContext";
+import { log } from "@proto-kit/common";
 /**
  * Maintains an execution status of the current runtime module method,
  * while prioritizing one-time failures. The assertion won't change the
@@ -14,6 +15,9 @@ export function assert(condition, message) {
     const executionContext = container.resolve(RuntimeMethodExecutionContext);
     const previousStatus = executionContext.current().result.status;
     const status = Provable.if(previousStatus, Bool, condition, previousStatus);
+    if (!status.toBoolean()) {
+        log.debug("Assertion failed: ", message);
+    }
     // const status = previousStatus.and(condition);
     executionContext.setStatus(status);
     executionContext.setStatusMessage(message);

package/package.json

@@ -2,7 +2,7 @@
   "name": "@proto-kit/module",
   "license": "MIT",
   "private": false,
-  "version": "0.1.1-develop.154+8ce23c3",
+  "version": "0.1.1-develop.160+5120680",
   "type": "module",
   "scripts": {
     "build": "tsc -p tsconfig.json",
@@ -17,8 +17,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@proto-kit/common": "0.1.1-develop.154+8ce23c3",
-    "@proto-kit/protocol": "0.1.1-develop.154+8ce23c3",
+    "@proto-kit/common": "0.1.1-develop.160+5120680",
+    "@proto-kit/protocol": "0.1.1-develop.160+5120680",
     "lodash": "^4.17.21",
     "loglevel": "^1.8.1",
     "reflect-metadata": "^0.1.13",
@@ -32,5 +32,5 @@
     "snarkyjs": "0.11.0",
     "tsyringe": "^4.7.0"
   },
-  "gitHead": "8ce23c33e6e251febc9ff6a77e2afa19d41a6ee9"
+  "gitHead": "51206808f0eba77c4ad8c1af476a6dbdd478d2a3"
 }

package/src/method/MethodParameterDecoder.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-underscore-dangle */
 import { Field } from "snarkyjs";
 
 import { RuntimeModule } from "../runtime/RuntimeModule";
@@ -9,15 +10,22 @@ export interface Fieldable {
 export interface FromFieldClass {
   new: (...args: any[]) => any;
   fromFields: (fields: Field[]) => Fieldable;
+  name: string;
   // Maybe this is wrong IDK
   prototype: {
-    _fields: any[];
+    _fields?: any[];
   };
+  sizeInFields?: () => number;
 }
 
 const errors = {
   fieldLengthNotMatching: (expected: number, actual: number) =>
     new Error(`Expected ${expected} field elements, got ${actual}`),
+
+  typeNotCompatible: (name: string) =>
+    new Error(
+      `Cannot decode type ${name}, it has to be either a Struct, CircuitValue or built-in snarkyjs type`
+    ),
 };
 
 export class MethodParameterDecoder {
@@ -39,8 +47,11 @@ export class MethodParameterDecoder {
     }
     let stack = fields.slice();
     return this.types.map((type) => {
-      // eslint-disable-next-line no-underscore-dangle
-      const numberFieldsNeeded = type.prototype._fields.length;
+      const numberFieldsNeeded =
+        type.prototype._fields?.length ?? type.sizeInFields?.() ?? -1;
+      if (numberFieldsNeeded === -1) {
+        throw errors.typeNotCompatible(type.name);
+      }
       const structFields = stack.slice(0, numberFieldsNeeded);
       stack = stack.slice(numberFieldsNeeded);
       return type.fromFields(structFields);
@@ -49,7 +60,9 @@ export class MethodParameterDecoder {
 
   public get fieldSize(): number {
     return this.types
-      .map((type) => type.prototype._fields.length)
+      .map(
+        (type) => type.prototype._fields?.length ?? type.sizeInFields?.() ?? 0
+      )
       .reduce((a, b) => a + b);
   }
 }

package/src/method/assert.ts

@@ -2,6 +2,7 @@ import { Bool, Provable } from "snarkyjs";
 import { container } from "tsyringe";
 
 import { RuntimeMethodExecutionContext } from "./RuntimeMethodExecutionContext";
+import { log } from "@proto-kit/common";
 
 /**
  * Maintains an execution status of the current runtime module method,
@@ -17,6 +18,10 @@ export function assert(condition: Bool, message?: string) {
   const previousStatus = executionContext.current().result.status;
   const status = Provable.if(previousStatus, Bool, condition, previousStatus);
 
+  if (!status.toBoolean()) {
+    log.debug("Assertion failed: ", message);
+  }
+
   // const status = previousStatus.and(condition);
   executionContext.setStatus(status);
   executionContext.setStatusMessage(message);