Bump compact 0.25.0 (#233)

Signed-off-by: Andrew Fleming <[email protected]>
Co-authored-by: 0xisk <[email protected]>

Author: andrew-fleming

.devcontainer/Dockerfile

@@ -3,16 +3,23 @@ FROM mcr.microsoft.com/devcontainers/javascript-node
 
 # Midnight binaries and tools download URLs
 # Source: https://docs.midnight.network/relnotes/overview
-ARG COMPACTC_URL="https://d3fazakqrumx6p.cloudfront.net/artifacts/compiler/compactc_0.24.0/compactc_v0.24.0_x86_64-unknown-linux-musl.zip"
-ARG COMPACT_VSCODE_URL="https://raw.githubusercontent.com/midnight-ntwrk/releases/gh-pages/artifacts/vscode-extension/compact-0.2.13/compact-0.2.13.vsix"
+ARG COMPACT_TOOLCHAIN_VERSION=0.25.0
+ARG COMPACT_VSCODE_VERSION=0.2.13
+ARG COMPACT_VSCODE_URL="https://raw.githubusercontent.com/midnight-ntwrk/releases/gh-pages/artifacts/vscode-extension/compact-${COMPACT_VSCODE_VERSION}/compact-${COMPACT_VSCODE_VERSION}.vsix"
 
-# Download the compact VS Code extension (later installed via devcontainer.json)
-RUN wget -O /tmp/compact.vsix $COMPACT_VSCODE_URL
+# Install required dependencies and clean up
+RUN apt-get update \
+    && apt-get install -y curl unzip wget \
+    && rm -rf /var/lib/apt/lists/*
 
-# Install the Compact compiler (compactc)
-RUN wget -O /tmp/compactc.zip $COMPACTC_URL \
-    && unzip /tmp/compactc.zip -d /tmp/compactc \
-    && sudo mv /tmp/compactc/* /usr/local/bin/
+# Download the Compact VS Code extension (used by devcontainer.json)
+RUN wget -O /tmp/compact.vsix "${COMPACT_VSCODE_URL}"
+
+# Install Compact developer tools CLI
+RUN curl --proto '=https' --tlsv1.2 -LsSf https://github.com/midnightntwrk/compact/releases/download/compact-v0.2.0/compact-installer.sh | sh
+
+# Add Compact CLI to the PATH
+ENV PATH="/root/.compact/bin:$PATH"
 
 # Install turbo for monorepo management
-RUN npm install turbo --global
+RUN npm install --location=global turbo

.devcontainer/devcontainer.json

@@ -3,9 +3,5 @@
   "build": {
     "dockerfile": "Dockerfile"
   },
-  "customizations": {
-    "vscode": {
-      "extensions": ["/tmp/compact.vsix"]
-    }
-  }
+  "postCreateCommand": "code --install-extension /tmp/compact.vsix && compact update 0.25.0"
 }

.github/ISSUE_TEMPLATE/01_bug_report.yml

@@ -93,7 +93,7 @@ body:
       label: Version
       description: What version of Compact are you running?
       options:
-        - 0.24.0 (Default)
+        - 0.25.0 (Default)
       default: 0
     validations:
       required: true

.github/workflows/test.yml

@@ -8,8 +8,8 @@ on:
 
 env:
   TURBO_TELEMETRY_DISABLED: 1
-  COMPILER_VERSION: "0.24.0"
-  LANGUAGE_VERSION: "0.16.0"
+  COMPILER_VERSION: "0.25.0"
+  LANGUAGE_VERSION: "0.17.0"
 
 jobs:
   run-suite:

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+- Bump compact compiler to v0.25.0 (#233)

CONTRIBUTING.md

@@ -144,7 +144,9 @@ Please follow these steps to have your contribution considered by the maintainer
 3. Follow all instructions in [the template](.github/PULL_REQUEST_TEMPLATE.md)
 4. Follow the [engineering guidelines](./GUIDELINES.md).
 5. Follow the [styleguides](#styleguides)
-6. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing. <details><summary>What if the status checks are failing?</summary>
+6. If the PR includes non-trivial changes, additions, or deletions (especially in Compact modules and/or witnesses),
+add an entry to the [CHANGELOG](./CHANGELOG.md).
+7. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing. <details><summary>What if the status checks are failing?</summary>
 If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated.
 A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
 

README.md

@@ -1,4 +1,4 @@
-[![Generic badge](https://img.shields.io/badge/Compact%20Compiler-0.24.0-1abc9c.svg)](https://docs.midnight.network/relnotes/compact)
+[![Generic badge](https://img.shields.io/badge/Compact%20Compiler-0.25.0-1abc9c.svg)](https://docs.midnight.network/relnotes/compact)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
 # OpenZeppelin Contracts for Compact
@@ -20,8 +20,8 @@ Follow Midnight's [Compact Developer Tools installation guide](https://docs.midn
 ```bash
 $ compact compile --version
 
-Compactc version: 0.24.0
-0.24.0
+Compactc version: 0.25.0
+0.25.0
 ```
 
 ### Installation
@@ -59,7 +59,7 @@ Import modules through `node_modules` rather than directly to avoid state confli
 ```typescript
 // MyContract.compact
 
-pragma language_version >= 0.16.0;
+pragma language_version >= 0.17.0;
 
 import CompactStandardLibrary;
 import "./compact-contracts/node_modules/@openzeppelin-compact/contracts/src/access/Ownable"

compact/src/Builder.ts

@@ -29,9 +29,9 @@ const execAsync = promisify(exec);
  * ```
  * ℹ [COMPILE] Found 2 .compact file(s) to compile
  * ✔ [COMPILE] [1/2] Compiled AccessControl.compact
- *     Compactc version: 0.24.0
+ *     Compactc version: 0.25.0
  * ✔ [COMPILE] [2/2] Compiled MockAccessControl.compact
- *     Compactc version: 0.24.0
+ *     Compactc version: 0.25.0
  * ✔ [BUILD] [1/3] Compiling TypeScript
  * ✔ [BUILD] [2/3] Copying artifacts
  * ✔ [BUILD] [3/3] Copying and cleaning .compact files
@@ -41,7 +41,7 @@ const execAsync = promisify(exec);
  * ```
  * ℹ [COMPILE] Found 2 .compact file(s) to compile
  * ✖ [COMPILE] [1/2] Failed AccessControl.compact
- *     Compactc version: 0.24.0
+ *     Compactc version: 0.25.0
  *     Error: Expected ';' at line 5 in AccessControl.compact
  * ```
  *

compact/src/Compiler.ts

@@ -39,7 +39,7 @@ export type ExecFunction = (
  * @example
  * ```typescript
  * const validator = new EnvironmentValidator();
- * await validator.validate('0.24.0');
+ * await validator.validate('0.25.0');
  * const version = await validator.getDevToolsVersion();
  * ```
  */
@@ -100,7 +100,7 @@ export class EnvironmentValidator {
    * @throws {Error} If the CLI is not available or command fails
    * @example
    * ```typescript
-   * const toolchainVersion = await validator.getToolchainVersion('0.24.0');
+   * const toolchainVersion = await validator.getToolchainVersion('0.25.0');
    * console.log(`Toolchain: ${toolchainVersion}`);
    * ```
    */
@@ -122,7 +122,7 @@ export class EnvironmentValidator {
    * @example
    * ```typescript
    * try {
-   *   await validator.validate('0.24.0');
+   *   await validator.validate('0.25.0');
    *   console.log('Environment validated successfully');
    * } catch (error) {
    *   if (error instanceof CompactCliNotFoundError) {
@@ -215,7 +215,7 @@ export class FileDiscovery {
  * const result = await compiler.compileFile(
  *   'contracts/Token.compact',
  *   '--skip-zk --verbose',
- *   '0.24.0'
+ *   '0.25.0'
  * );
  * console.log('Compilation output:', result.stdout);
  * ```
@@ -247,7 +247,7 @@ export class CompilerService {
    *   const result = await compiler.compileFile(
    *     'security/AccessControl.compact',
    *     '--skip-zk',
-   *     '0.24.0'
+   *     '0.25.0'
    *   );
    *   console.log('Success:', result.stdout);
    * } catch (error) {
@@ -296,7 +296,7 @@ export class CompilerService {
  * @class UIService
  * @example
  * ```typescript
- * UIService.displayEnvInfo('compact 0.1.0', 'Compactc 0.24.0', 'security');
+ * UIService.displayEnvInfo('compact 0.1.0', 'Compactc 0.25.0', 'security');
  * UIService.printOutput('Compilation successful', chalk.green);
  * ```
  */
@@ -333,9 +333,9 @@ export const UIService = {
    * ```typescript
    * UIService.displayEnvInfo(
    *   'compact 0.1.0',
-   *   'Compactc version: 0.24.0',
+   *   'Compactc version: 0.25.0',
    *   'security',
-   *   '0.24.0'
+   *   '0.25.0'
    * );
    * ```
    */
@@ -419,7 +419,7 @@ export const UIService = {
  * @example
  * ```typescript
  * // Basic usage
- * const compiler = new CompactCompiler('--skip-zk', 'security', '0.24.0');
+ * const compiler = new CompactCompiler('--skip-zk', 'security', '0.25.0');
  * await compiler.compile();
  *
  * // Factory method usage
@@ -452,7 +452,7 @@ export class CompactCompiler {
    *
    * @param flags - Space-separated compiler flags (e.g., '--skip-zk --verbose')
    * @param targetDir - Optional subdirectory within src/ to compile (e.g., 'security', 'token')
-   * @param version - Optional toolchain version to use (e.g., '0.24.0')
+   * @param version - Optional toolchain version to use (e.g., '0.25.0')
    * @param execFn - Optional custom exec function for dependency injection
    * @example
    * ```typescript
@@ -463,7 +463,7 @@ export class CompactCompiler {
    * const compiler = new CompactCompiler('', 'security');
    *
    * // Compile with specific version
-   * const compiler = new CompactCompiler('--skip-zk', undefined, '0.24.0');
+   * const compiler = new CompactCompiler('--skip-zk', undefined, '0.25.0');
    *
    * // For testing with custom exec function
    * const mockExec = vi.fn();
@@ -500,11 +500,11 @@ export class CompactCompiler {
    * @throws {Error} If --dir flag is provided without a directory name
    * @example
    * ```typescript
-   * // Parse command line: compact-compiler --dir security --skip-zk +0.24.0
+   * // Parse command line: compact-compiler --dir security --skip-zk +0.25.0
    * const compiler = CompactCompiler.fromArgs([
    *   '--dir', 'security',
    *   '--skip-zk',
-   *   '+0.24.0'
+   *   '+0.25.0'
    * ]);
    *
    * // With environment variable

compact/src/runBuilder.ts

@@ -19,7 +19,7 @@ import { CompactBuilder } from './Builder.js';
  * ℹ [COMPILE] COMPACTC_PATH: /path/to/compactc/compactc
  * ℹ [COMPILE] Found 1 .compact file(s) to compile
  * ✔ [COMPILE] [1/1] Compiled Foo.compact
- *     Compactc version: 0.24.0
+ *     Compactc version: 0.25.0
  * ✔ [BUILD] [1/3] Compiling TypeScript
  * ✔ [BUILD] [2/3] Copying artifacts
  * ✔ [BUILD] [3/3] Copying and cleaning .compact files