@typeberry/convert 0.4.0-fcdfbb1 → 0.4.1-dae2283

package/README.md

@@ -8,6 +8,11 @@ Typeberry is a TypeScript implementation of [JAM protocol](https://graypaper.com
 PRs unless the contributor waives any claims to the prize and copy rights for
 the submitted code. By creating the PR you accept this requirement.**
 
+## Links
+
+- [Documentation](https://fluffylabs.dev/typeberry)
+- [Performance Charts](https://typeberry.fluffylabs.dev)
+
 ## Implementation status
 
 Gray Paper compliance can be controlled via `GP_VERSION` environment variable.

package/index.js

@@ -4254,7 +4254,11 @@ var TestSuite;
 })(TestSuite || (TestSuite = {}));
 const ALL_VERSIONS_IN_ORDER = [GpVersion.V0_6_7, GpVersion.V0_7_0, GpVersion.V0_7_1, GpVersion.V0_7_2];
 const DEFAULT_SUITE = TestSuite.W3F_DAVXY;
-const DEFAULT_VERSION = GpVersion.V0_7_2;
+/**
+ * Current version is set to track the jam-conformance testing.
+ * Since we are currently at 0.7.1 not 0.7.2, we set our default version accordingly.
+ */
+const DEFAULT_VERSION = GpVersion.V0_7_1;
 const env = typeof process === "undefined" ? {} : process.env;
 let CURRENT_VERSION = parseCurrentVersion(env.GP_VERSION) ?? DEFAULT_VERSION;
 let CURRENT_SUITE = parseCurrentSuite(env.TEST_SUITE) ?? DEFAULT_SUITE;
@@ -4313,8 +4317,8 @@ class Compatibility {
     /**
      * Allows selecting different values for different Gray Paper versions from one record.
      *
-     * @param fallback The default value to return if no value is found for the current.
-     * @param record A record mapping versions to values, checking if the version is greater or equal to the current version.
+     * fallback The default value to return if no value is found for the current.
+     * versions A record mapping versions to values, checking if the version is greater or equal to the current version.
      * @returns The value for the current version, or the default value.
      */
     static selectIfGreaterOrEqual({ fallback, versions, }) {
@@ -4477,7 +4481,7 @@ const workspacePathFix = dev_env.NODE_ENV === "development"
 
 ;// CONCATENATED MODULE: ./packages/core/utils/opaque.ts
 /**
- * @fileoverview `Opaque<Type, Token>` constructs a unique type which is a subset of Type with a
+ * `Opaque<Type, Token>` constructs a unique type which is a subset of Type with a
  * specified unique token Token. It means that base type cannot be assigned to unique type by accident.
  * Good examples of opaque types include:
  * - JWTs or other tokens - these are special kinds of string used for authorization purposes.
@@ -4840,7 +4844,7 @@ function isResult(x) {
 var minimist = __nccwpck_require__(595);
 var minimist_default = /*#__PURE__*/__nccwpck_require__.n(minimist);
 ;// CONCATENATED MODULE: ./bin/convert/package.json
-const package_namespaceObject = {"rE":"0.4.0"};
+const package_namespaceObject = {"rE":"0.4.1"};
 ;// CONCATENATED MODULE: ./packages/core/bytes/bitvec.ts
 
 /**
@@ -12689,11 +12693,32 @@ const ENTROPY_ENTRIES = 4;
 
 var state_update_UpdatePreimageKind;
 (function (UpdatePreimageKind) {
-    /** Insert new preimage and optionally update it's lookup history. */
+    /**
+     * Insert new preimage and optionally update it's lookup history.
+     *
+     * Used in: `provide`
+     *
+     * https://graypaper.fluffylabs.dev/#/ab2cdbd/383904383904?v=0.7.2
+     */
     UpdatePreimageKind[UpdatePreimageKind["Provide"] = 0] = "Provide";
-    /** Remove a preimage and it's lookup history. */
+    /**
+     * Remove a preimage and it's lookup history.
+     *
+     * Used in: `forget` and `eject`
+     *
+     * https://graypaper.fluffylabs.dev/#/ab2cdbd/38c701380202?v=0.7.2
+     * https://graypaper.fluffylabs.dev/#/ab2cdbd/379102379302?v=0.7.2
+     */
     UpdatePreimageKind[UpdatePreimageKind["Remove"] = 1] = "Remove";
-    /** update or add lookup history for preimage hash/len to given value. */
+    /**
+     * Update or add lookup history for preimage hash/len to given value.
+     *
+     * Used in: `solicit` and `forget`
+     *
+     * https://graypaper.fluffylabs.dev/#/ab2cdbd/382802382802?v=0.7.2
+     * https://graypaper.fluffylabs.dev/#/ab2cdbd/384002384b02?v=0.7.2
+     * https://graypaper.fluffylabs.dev/#/ab2cdbd/38c60038ea00?v=0.7.2
+     */
     UpdatePreimageKind[UpdatePreimageKind["UpdateOrAdd"] = 2] = "UpdateOrAdd";
 })(state_update_UpdatePreimageKind || (state_update_UpdatePreimageKind = {}));
 /**
@@ -12701,7 +12726,7 @@ var state_update_UpdatePreimageKind;
  *
  * Can be one of the following cases:
  * 1. Provide a new preimage blob and set the lookup history to available at `slot`.
- * 2. Remove (expunge) a preimage and it's lookup history.
+ * 2. Remove (forget) a preimage and it's lookup history.
  * 3. Update `LookupHistory` with given value.
  */
 class UpdatePreimage {
@@ -14584,7 +14609,6 @@ class LeafNode {
     /**
      * Get the byte length of embedded value.
      *
-     * @remark
      * Note in case this node only contains hash this is going to be 0.
      */
     getValueLength() {
@@ -14595,7 +14619,6 @@ class LeafNode {
     /**
      * Returns the embedded value.
      *
-     * @remark
      * Note that this is going to be empty for a regular leaf node (i.e. containing a hash).
      */
     getValue() {
@@ -14605,7 +14628,6 @@ class LeafNode {
     /**
      * Returns contained value hash.
      *
-     * @remark
      * Note that for embedded value this is going to be full 0-padded 32 bytes.
      */
     getValueHash() {
@@ -15801,45 +15823,6 @@ var status_Status;
 
 
 
-;// CONCATENATED MODULE: ./packages/core/pvm-interpreter/gas.ts
-
-
-/** Create a new gas counter instance depending on the gas value. */
-function gas_gasCounter(gas) {
-    return new GasCounterU64(tryAsU64(gas));
-}
-class GasCounterU64 {
-    gas;
-    initialGas;
-    constructor(gas) {
-        this.gas = gas;
-        this.initialGas = tryAsGas(gas);
-    }
-    set(g) {
-        this.gas = tryAsU64(g);
-    }
-    get() {
-        return tryAsGas(this.gas);
-    }
-    sub(g) {
-        const result = this.gas - tryAsU64(g);
-        if (result >= 0n) {
-            this.gas = tryAsU64(result);
-            return false;
-        }
-        this.gas = tryAsU64(0n);
-        return true;
-    }
-    used() {
-        const gasConsumed = tryAsU64(this.initialGas) - this.gas;
-        // In we have less than zero left we assume that all gas has been consumed.
-        if (gasConsumed < 0) {
-            return this.initialGas;
-        }
-        return tryAsGas(gasConsumed);
-    }
-}
-
 ;// CONCATENATED MODULE: ./packages/core/pvm-interpreter/memory/memory-index.ts
 
 
@@ -17574,6 +17557,45 @@ class basic_blocks_BasicBlocks {
 ;// CONCATENATED MODULE: ./packages/core/pvm-interpreter/basic-blocks/index.ts
 
 
+;// CONCATENATED MODULE: ./packages/core/pvm-interpreter/gas.ts
+
+
+/** Create a new gas counter instance depending on the gas value. */
+function gas_gasCounter(gas) {
+    return new GasCounterU64(tryAsU64(gas));
+}
+class GasCounterU64 {
+    gas;
+    initialGas;
+    constructor(gas) {
+        this.gas = gas;
+        this.initialGas = tryAsGas(gas);
+    }
+    set(g) {
+        this.gas = tryAsU64(g);
+    }
+    get() {
+        return tryAsGas(this.gas);
+    }
+    sub(g) {
+        const result = this.gas - tryAsU64(g);
+        if (result >= 0n) {
+            this.gas = tryAsU64(result);
+            return false;
+        }
+        this.gas = tryAsU64(0n);
+        return true;
+    }
+    used() {
+        const gasConsumed = tryAsU64(this.initialGas) - this.gas;
+        // In we have less than zero left we assume that all gas has been consumed.
+        if (gasConsumed < 0) {
+            return this.initialGas;
+        }
+        return tryAsGas(gasConsumed);
+    }
+}
+
 ;// CONCATENATED MODULE: ./packages/core/pvm-interpreter/instruction-gas-map.ts
 
 
@@ -19422,12 +19444,88 @@ class interpreter_Interpreter {
     }
 }
 
+;// CONCATENATED MODULE: ./packages/core/pvm-interpreter/debugger-adapter.ts
+
+
+
+
+
+
+class DebuggerAdapter {
+    pvm;
+    constructor(useSbrkGas = false) {
+        this.pvm = new Interpreter({ useSbrkGas });
+    }
+    resetGeneric(rawProgram, flatRegisters, initialGas) {
+        this.pvm.resetGeneric(rawProgram, 0, tryAsGas(initialGas), new Registers(flatRegisters));
+    }
+    reset(rawProgram, pc, gas, maybeRegisters, maybeMemory) {
+        this.pvm.resetGeneric(rawProgram, pc, tryAsGas(gas), maybeRegisters, maybeMemory);
+    }
+    getPageDump(pageNumber) {
+        const page = this.pvm.getMemoryPage(pageNumber);
+        if (page === null) {
+            // page wasn't allocated so we return an empty page
+            return safeAllocUint8Array(PAGE_SIZE);
+        }
+        if (page.length === PAGE_SIZE) {
+            // page was allocated and has a proper size so we can simply return it
+            return page;
+        }
+        // page was allocated but it is shorter than PAGE_SIZE so we have to extend it
+        const fullPage = safeAllocUint8Array(PAGE_SIZE);
+        fullPage.set(page);
+        return fullPage;
+    }
+    setMemory(address, value) {
+        this.pvm.memory.storeFrom(tryAsMemoryIndex(address), value);
+    }
+    getExitArg() {
+        return this.pvm.getExitParam() ?? 0;
+    }
+    getStatus() {
+        return this.pvm.getStatus();
+    }
+    nextStep() {
+        return this.pvm.nextStep() === Status.OK;
+    }
+    nSteps(steps) {
+        check `${steps >>> 0 > 0} Expected a positive integer got ${steps}`;
+        for (let i = 0; i < steps; i++) {
+            const isOk = this.nextStep();
+            if (!isOk) {
+                return false;
+            }
+        }
+        return true;
+    }
+    getRegisters() {
+        return this.pvm.registers.getAllU64();
+    }
+    setRegisters(registers) {
+        this.pvm.registers.copyFrom(new Registers(registers));
+    }
+    getProgramCounter() {
+        return this.pvm.getPC();
+    }
+    setNextProgramCounter(nextPc) {
+        this.pvm.setNextPC(nextPc);
+    }
+    getGasLeft() {
+        return BigInt(this.pvm.gas.get());
+    }
+    setGasLeft(gas) {
+        this.pvm.gas.set(tryAsGas(gas));
+    }
+}
+
 ;// CONCATENATED MODULE: ./packages/core/pvm-interpreter/index.ts
 
 
 
 
 
+
 ;// CONCATENATED MODULE: ./bin/test-runner/w3f/pvm.ts