@typeberry/jam 0.4.0-fcdfbb1 → 0.4.1-9e565b9

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/bootstrap-generator.mjs

@@ -2878,7 +2878,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;
@@ -2937,8 +2941,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, }) {
@@ -3101,7 +3105,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.
@@ -10200,11 +10204,32 @@ const ENTROPY_ENTRIES = 4;
 
 var 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";
 })(UpdatePreimageKind || (UpdatePreimageKind = {}));
 /**
@@ -10212,7 +10237,7 @@ var 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 state_update_UpdatePreimage {