Bump to compact 0.28.0 (#62)

Co-authored-by: 0xisk <0xisk@proton.me>
Co-authored-by: ⟣ €₥ℵ∪ℓ ⟢ <34749913+emnul@users.noreply.github.com>

Author: 3 people

.github/actions/setup/action.yml

@@ -43,4 +43,4 @@ runs:
       if: ${{ inputs.skip-compact != 'true' }}
       uses: midnightntwrk/setup-compact-action@4130145456ad3f45934788dd4a65647eb283e658 # loose commit/not released
       with:
-        compact-version: "0.26.0"
+        compact-version: "0.28.0"

README.md

@@ -46,8 +46,8 @@ Confirm your Compact toolchain:
 ```bash
 $ compact compile --version
 
-Compactc version: 0.26.0
-0.26.0
+Compactc version: 0.28.0
+0.28.0
 ```
 
 ## Getting started

package.json

@@ -15,12 +15,9 @@
     "types": "turbo run types",
     "clean": "turbo run clean"
   },
-  "dependencies": {
-    "@midnight-ntwrk/compact-runtime": "^0.9.0"
-  },
   "devDependencies": {
     "@biomejs/biome": "2.3.8",
-    "@midnight-ntwrk/ledger": "^4.0.0",
+    "@midnight-ntwrk/ledger-v7": "^7.0.0",
     "@midnight-ntwrk/zswap": "^4.0.0",
     "@types/node": "24.10.1",
     "ts-node": "^10.9.2",

packages/cli/README.md

@@ -23,7 +23,7 @@ Verify your Compact installation:
 
 ```bash
 $ compact compile --version
-Compactc version: 0.26.0
+Compactc version: 0.28.0
 ```
 
 ## Binaries
@@ -52,7 +52,7 @@ compact-compiler [options]
 | `--out <directory>` | Output directory for compiled artifacts | `artifacts` |
 | `--hierarchical` | Preserve source directory structure in output | `false` |
 | `--skip-zk` | Skip zero-knowledge proof generation | `false` |
-| `+<version>` | Use specific toolchain version (e.g., `+0.26.0`) | (default) |
+| `+<version>` | Use specific toolchain version (e.g., `+0.28.0`) | (default) |
 
 ### Environment Variables
 
@@ -102,7 +102,7 @@ compact-compiler --dir security
 compact-compiler --skip-zk
 
 # Use specific toolchain version
-compact-compiler +0.26.0
+compact-compiler +0.28.0
 
 # Custom source and output directories
 compact-compiler --src contracts --out build
@@ -155,7 +155,7 @@ import { CompactCompiler } from '@openzeppelin/compact-tools-cli';
 const compiler = new CompactCompiler({
   flags: '--skip-zk',
   targetDir: 'security',
-  version: '0.26.0',
+  version: '0.28.0',
   hierarchical: true,
   srcDir: 'src',
   outDir: 'artifacts',
@@ -167,7 +167,7 @@ await compiler.compile();
 const compiler = CompactCompiler.fromArgs([
   '--dir', 'security',
   '--skip-zk',
-  '+0.26.0'
+  '+0.28.0'
 ]);
 
 await compiler.compile();
@@ -196,7 +196,7 @@ class CompactBuilder {
 interface CompilerOptions {
   flags?: string;           // Compiler flags (e.g., '--skip-zk --verbose')
   targetDir?: string;       // Subdirectory within srcDir to compile
-  version?: string;         // Toolchain version (e.g., '0.26.0')
+  version?: string;         // Toolchain version (e.g., '0.28.0')
   hierarchical?: boolean;   // Preserve directory structure in output
   srcDir?: string;          // Source directory (default: 'src')
   outDir?: string;          // Output directory (default: 'artifacts')
@@ -233,15 +233,15 @@ yarn clean
 
 ## Output Example
 
-```
+```bash
 ℹ [COMPILE] Compact compiler started
-ℹ [COMPILE] Compact developer tools: compact 0.1.0
-ℹ [COMPILE] Compact toolchain: Compactc version: 0.26.0
+ℹ [COMPILE] Compact developer tools: compact 0.2.0
+ℹ [COMPILE] Compact toolchain: Compactc version: 0.28.0
 ℹ [COMPILE] Found 2 .compact file(s) to compile
 ✔ [COMPILE] [1/2] Compiled AccessControl.compact
-    Compactc version: 0.26.0
+    Compactc version: 0.28.0
 ✔ [COMPILE] [2/2] Compiled Token.compact
-    Compactc version: 0.26.0
+    Compactc version: 0.28.0
 ```
 
 ## License

packages/simulator/README.md

@@ -15,7 +15,7 @@ allowing you to simulate contract behavior locally without blockchain deployment
 
 ```typescript
 import { createSimulator } from '@openzeppelin-compact/contracts-simulator';
-import { Contract, ledger } from './artifacts/MyContract/contract/index.cjs';
+import { Contract, ledger } from './artifacts/MyContract/contract/index.js';
 
 // 1. Define your contract arguments type
 type MyContractArgs = readonly [owner: Uint8Array, value: bigint];
@@ -46,7 +46,7 @@ The base simulator acts as a configuration class that the actual simulator will
 
 ```typescript
 import { createSimulator } from '@openzeppelin-compact/contracts-simulator';
-import { Contract as MyContract, ledger } from './artifacts/MyContract/contract/index.cjs';
+import { Contract as MyContract, ledger } from './artifacts/MyContract/contract/index.js';
 import { MyContractWitnesses, MyContractPrivateState } from './MyContractWitnesses.js';
 
 // Define contract constructor arguments as a tuple type

packages/simulator/package.json

@@ -30,7 +30,7 @@
     "clean": "git clean -fXd"
   },
   "devDependencies": {
-    "@midnight-ntwrk/ledger": "^4.0.0",
+    "@midnight-ntwrk/ledger-v7": "^7.0.0",
     "@midnight-ntwrk/zswap": "^4.0.0",
     "@tsconfig/node24": "^24.0.3",
     "@types/node": "24.10.1",
@@ -39,6 +39,6 @@
     "vitest": "^4.0.15"
   },
   "dependencies": {
-    "@midnight-ntwrk/compact-runtime": "^0.9.0"
+    "@midnight-ntwrk/compact-runtime": "0.14.0"
   }
 }

packages/simulator/src/core/AbstractSimulator.ts

@@ -1,7 +1,7 @@
 import type {
   CircuitContext,
   CoinPublicKey,
-  ContractState,
+  StateValue,
 } from '@midnight-ntwrk/compact-runtime';
 import type {
   ContextlessCircuits,
@@ -79,12 +79,12 @@ export abstract class AbstractSimulator<P, L>
   }
 
   /**
-   * Retrieves the original contract state from the circuit context.
+   * Retrieves the current contract state data.
    *
-   * @returns The current contract state from the blockchain
+   * @returns The current state value containing the ledger data
    */
-  public getContractState(): ContractState {
-    return this.circuitContext.originalState;
+  public getContractState(): StateValue {
+    return this.circuitContext.currentQueryContext.state.state;
   }
 
   /**

packages/simulator/src/core/CircuitContextManager.ts

@@ -4,7 +4,8 @@ import {
   type ConstructorContext,
   type ContractAddress,
   type ContractState,
-  constructorContext,
+  CostModel,
+  createConstructorContext,
   type EncodedZswapLocalState,
   QueryContext,
 } from '@midnight-ntwrk/compact-runtime';
@@ -44,22 +45,22 @@ export class CircuitContextManager<P> {
     contractAddress: ContractAddress,
     ...contractArgs: any[]
   ) {
-    const initCtx = constructorContext(privateState, coinPK);
+    const initCtx = createConstructorContext(privateState, coinPK);
 
     const {
       currentPrivateState,
       currentContractState,
       currentZswapLocalState,
     } = contract.initialState(initCtx, ...contractArgs);
 
+    // Extract ChargedState from the compiler-generated ContractState
+    const chargedState = currentContractState.data;
+
     this.context = {
       currentPrivateState,
       currentZswapLocalState,
-      originalState: currentContractState,
-      transactionContext: new QueryContext(
-        currentContractState.data,
-        contractAddress,
-      ),
+      currentQueryContext: new QueryContext(chargedState, contractAddress),
+      costModel: CostModel.initialCostModel(),
     };
   }
 

packages/simulator/src/core/ContractSimulator.ts

@@ -35,12 +35,16 @@ export abstract class ContractSimulator<P, L> extends AbstractSimulator<P, L> {
    */
   public getCallerContext(): CircuitContext<P> {
     const activeCaller = this.callerOverride || this.persistentCallerOverride;
+    const baseCtx = this.circuitContext;
 
     return {
-      ...this.circuitContext,
+      currentPrivateState: baseCtx.currentPrivateState,
+      currentQueryContext: baseCtx.currentQueryContext,
       currentZswapLocalState: activeCaller
         ? emptyZswapLocalState(activeCaller)
-        : this.circuitContext.currentZswapLocalState,
+        : baseCtx.currentZswapLocalState,
+      costModel: baseCtx.costModel,
+      gasLimit: baseCtx.gasLimit,
     };
   }
 

packages/simulator/src/factory/createSimulator.ts

@@ -1,5 +1,5 @@
 import type { WitnessContext } from '@midnight-ntwrk/compact-runtime';
-import { sampleContractAddress } from '@midnight-ntwrk/zswap';
+import { dummyContractAddress } from '@midnight-ntwrk/compact-runtime';
 import { CircuitContextManager } from '../core/CircuitContextManager.js';
 import { ContractSimulator } from '../core/ContractSimulator.js';
 import type { IMinimalContract } from '../types/Contract.js';
@@ -49,7 +49,7 @@ export function createSimulator<
         privateState = config.defaultPrivateState(),
         witnesses = config.witnessesFactory(),
         coinPK = '0'.repeat(64),
-        contractAddress = sampleContractAddress(),
+        contractAddress = dummyContractAddress(),
       } = options;
 
       this._witnesses = witnesses;
@@ -65,7 +65,7 @@ export function createSimulator<
         ...processedArgs,
       );
 
-      this.contractAddress = this.circuitContext.transactionContext.address;
+      this.contractAddress = this.circuitContext.currentQueryContext.address;
     }
 
     public _pureCircuitProxy?: ContextlessCircuits<
@@ -143,7 +143,7 @@ export function createSimulator<
      */
     getPublicState(): L {
       return config.ledgerExtractor(
-        this.circuitContext.transactionContext.state,
+        this.circuitContext.currentQueryContext.state.state,
       );
     }
 
@@ -191,7 +191,7 @@ export function createSimulator<
       return {
         ledger: this.getPublicState(),
         privateState: circuitCtx.currentPrivateState,
-        contractAddress: circuitCtx.transactionContext.address,
+        contractAddress: circuitCtx.currentQueryContext.address,
       };
     }
   };