changelog for SDK v0.5.5 & CLI v0.1.6 (#50)

* docs for SDK v0.5.5 & CLI v0.1.6

* add details on action max size enforcement

* update changelog for latest changes in CLI v0.1.6

* improve sequencer strategy example

* apply review suggestion

Author: eshaan7

docs/pages/build/changelog.mdx

@@ -1,5 +1,31 @@
 # Changelog [What's new]
 
+## v0.5.5
+
+#### Breaking changes
+
+- The [`getOrderedActions`](/build/framework/sequencer#custom-ordering-strategy) method of a sequencer strategy now accepts a list of actions 
+as a `Readonly<AcknowledgedAction[]>` type and is supposed only to return the ordered list of action hashes as opposed to `Action` objects earlier.
+
+#### Bug Fixes
+
+- Fix BigInt handling for PostgreSQL.
+
+#### Improvements
+
+- Enable [WAL](https://www.sqlite.org/draft/wal.html) for SQLite. This enables better concurrency between readers and writers.
+- Optimized execution time by removing duplicate calculation of state root before and after applying all of the block's actions.
+- Enforce max size on action's payload during submission (~128kb). This limit is also enforced when collecting actions for block building.
+
+#### Other changes
+
+- Bumps dependencies version to address high-security vulnerabilities
+
+## CLI v0.1.6
+
+- Remove the `add hook` command.
+- Perform lint checks in `compile` command before building Wasm. This makes use of [`@stackr/eslint-plugin`](https://github.com/stackrlabs/eslint-stackr), an ESLint plugin with few rules to prevent devs from adding non-deterministic code in transition functions.
+
 ## CLI v0.1.5
 
 - The EIP-712 domain for the app is now injected into the `stf.wasm`.

docs/pages/build/cli/add-bridge.mdx

@@ -10,7 +10,7 @@ USAGE
   $ stackr add [ENTITY] [CONTRACT] [--envFile <value>]
 
 ARGUMENTS
-  ENTITY    (bridge|hook) Entity to add to your App Inbox
+  ENTITY    (bridge) Entity to add to your App Inbox
   CONTRACT  Contract Address of the entity to add to your App Inbox
 
 FLAGS
@@ -19,9 +19,7 @@ FLAGS
 EXAMPLES
   $ stackr add bridge 0x1234567890abcdef1234567890abcdef12345678
 
-  $ stackr add hook 0x1234567890abcdef1234567890abcdef12345678
-
-  $ stackr add hook 0x1234567890abcdef1234567890abcdef12345678 --envFile=<relative path to file>
+  $ stackr add bridge 0x1234567890abcdef1234567890abcdef12345678 --envFile=<relative path to file>
 ```
 
 ## Example

docs/pages/build/cli/add-hook.mdx

@@ -2,6 +2,8 @@
 
 The `compile` command is used to compile your Micro-Rollup's State Machine to portable WebAssembly (Wasm) binary.
 
+Before compiling, it also performs lint checks using the [`@stackr/eslint-plugin`](https://github.com/stackrlabs/eslint-stackr), an ESLint plugin with few rules to prevent devs from adding non-deterministic code in transition functions.
+
 :::info
 Generally, you wouldn't use this command manually since the [`deploy`]((/build/cli/deploy)) command takes care of this step internally.
 :::
@@ -11,10 +13,14 @@ Generally, you wouldn't use this command manually since the [`deploy`]((/build/c
 ```bash
 » stackr compile --help
 USAGE
-  $ stackr compile
+  $ stackr compile [--skipLintChecks]
+
+FLAGS
+  --skipLintChecks  Whether to skip lint checks before compiling (default: false)
 
 EXAMPLES
   $ stackr compile
+  $ stackr compile --skipLintChecks
 ```
 
 ## Example

docs/pages/build/cli/compile.mdx

@@ -87,6 +87,10 @@ These are state transition functions that you will be defining in the `src/stack
 On succesful submission, you will recieve an `Acknowledment` object that acts like a transaction receipt and is also considered a `C0` confirmation.
 This is proof of the action being successfully submitted to the state machine.
 
+:::note
+An action's payload size should not exceed ~128kb. This limit is enforced to keep batch size well within the means of different DA layer's maximum supported blob size. 
+:::
+
 ## EIP-712 Signing
 
 EIP 712 is a standard for signing structured data. It is used to sign actions in this version of Stackr.

docs/pages/build/framework/action/introduction.mdx

@@ -43,38 +43,39 @@ This is done by defining a new class that extends `BaseStrategy` class with the
 :::code-group
 
 ```ts [strategy.ts]
-import { BaseStrategy, Action } from "@stackr/sdk";
+import { AcknowledgedAction, BaseStrategy, Keccak256 } from "@stackr/sdk";
 
 /**
- * RandomStrategy is responsible for ordering actions in a random order.
+ * TimestampOrderStrategy is responsible for ordering actions based on timestamp.
  */
-export class RandomStrategy extends BaseStrategy {
+export class TimestampOrderStrategy extends BaseStrategy {
   /**
-   * Create a new instance of RandomStrategy
+   * Create a new instance of TimestampOrderStrategy
    */
   constructor() {
-    super("RandomOrder");
+    super("TimestampOrder");
   }
 
   /**
-   * Custom ordering logic for actions
-   * returns the actions in a random order
+   * Returns the action hashes in chronological order of timestamp.
    * @param actions - Unordered List of actions
-   * @returns - Ordered list of actions
+   * @returns - Ordered list of action hashes
    */
-  async getOrderedActions(actions: Action[]): Promise<Action[]> {
-    return Promise.resolve(
-      actions.sort(() => {
-        return 0.5 - Math.random();
-      })
+  async getOrderedActions(
+    actions: Readonly<AcknowledgedAction[]>
+  ): Promise<Keccak256[]> {
+    const orderedActions = actions.sort(
+      (a, b) => a.acknowledgement.timestamp - b.acknowledgement.timestamp
     );
+    const orderedActionHashes = orderedActions.map(({ action }) => action.hash);
+    return orderedActionHashes;
   }
 }
 ```
 
 ```ts [rollup.ts]
 // use the custom strategy class in your Micro-Rollup
-rollup.sequencer.setStrategy(new RandomStrategy());
+rollup.sequencer.setStrategy(new TimestampOrderStrategy());
 ```
 
 :::

docs/pages/build/framework/sequencer.mdx

@@ -36,7 +36,7 @@ export default defineConfig({
       link: "https://litepaper.stf.xyz",
     },
     {
-      text: "v0.5.4",
+      text: "v0.5.5",
       items: [
         {
           text: "Changelog",
@@ -372,10 +372,6 @@ export default defineConfig({
             text: "Add Bridge",
             link: "/build/cli/add-bridge",
           },
-          {
-            text: "Add Hook",
-            link: "/build/cli/add-hook",
-          },
           {
             text: "Transfer Ownership",
             link: "/build/cli/transfer-ownership",