Skip to content

Commit a43fbb7

Browse files
authored
Update Compact Tooling and Tests to 0.26.0, Update CHANGELOG and README (#285)
1 parent 0c3d88d commit a43fbb7

File tree

12 files changed

+85
-80
lines changed

12 files changed

+85
-80
lines changed

.devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FROM mcr.microsoft.com/devcontainers/javascript-node
33

44
# Midnight binaries and tools download URLs
55
# Source: https://docs.midnight.network/relnotes/overview
6-
ARG COMPACT_TOOLCHAIN_VERSION=0.25.0
6+
ARG COMPACT_TOOLCHAIN_VERSION=0.26.0
77
ARG COMPACT_VSCODE_VERSION=0.2.13
88
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"
99

.devcontainer/devcontainer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
"build": {
44
"dockerfile": "Dockerfile"
55
},
6-
"postCreateCommand": "code --install-extension /tmp/compact.vsix && compact update 0.25.0"
7-
}
6+
"postCreateCommand": "code --install-extension /tmp/compact.vsix && compact update 0.26.0"
7+
}

.github/ISSUE_TEMPLATE/01_bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ body:
9393
label: Version
9494
description: What version of Compact are you running?
9595
options:
96-
- 0.25.0 (Default)
96+
- 0.26.0 (Default)
9797
default: 0
9898
validations:
9999
required: true

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- OpenZeppelin Compact Simulator (#247)
13+
1014
### Changed
1115

1216
- Bump compact compiler to v0.25.0 (#233)
1317
- Bump compact compiler to v0.26.0 (#279)
1418
- Upgrade @midnight-ntwrk/compact-runtime ^0.8.1 -> ^0.9.0 (#279)
19+
- Move @openzeppelin-compact/compact to its own package in the package/compact dir (#247)

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Generic badge](https://img.shields.io/badge/Compact%20Compiler-0.25.0-1abc9c.svg)](https://docs.midnight.network/relnotes/compact)
1+
[![Generic badge](https://img.shields.io/badge/Compact%20Compiler-0.26.0-1abc9c.svg)](https://docs.midnight.network/relnotes/compact/minokawa-0-18-26-0)
22
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
33

44
# OpenZeppelin Contracts for Compact
@@ -20,8 +20,8 @@ Follow Midnight's [Compact Developer Tools installation guide](https://docs.midn
2020
```bash
2121
$ compact compile --version
2222

23-
Compactc version: 0.25.0
24-
0.25.0
23+
Compactc version: 0.26.0
24+
0.26.0
2525
```
2626

2727
### Installation

docs/modules/ROOT/pages/index.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Follow Midnight's {compact-dev-tools} installation guide and confirm that `compa
2020
```bash
2121
$ compact compile --version
2222

23-
Compactc version: 0.25.0
24-
0.25.0
23+
Compactc version: 0.26.0
24+
0.26.0
2525
```
2626

2727
=== Installation

packages/compact/src/Builder.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ const execAsync = promisify(exec);
2929
* ```
3030
* ℹ [COMPILE] Found 2 .compact file(s) to compile
3131
* ✔ [COMPILE] [1/2] Compiled AccessControl.compact
32-
* Compactc version: 0.25.0
32+
* Compactc version: 0.26.0
3333
* ✔ [COMPILE] [2/2] Compiled MockAccessControl.compact
34-
* Compactc version: 0.25.0
34+
* Compactc version: 0.26.0
3535
* ✔ [BUILD] [1/3] Compiling TypeScript
3636
* ✔ [BUILD] [2/3] Copying artifacts
3737
* ✔ [BUILD] [3/3] Copying and cleaning .compact files
@@ -41,7 +41,7 @@ const execAsync = promisify(exec);
4141
* ```
4242
* ℹ [COMPILE] Found 2 .compact file(s) to compile
4343
* ✖ [COMPILE] [1/2] Failed AccessControl.compact
44-
* Compactc version: 0.25.0
44+
* Compactc version: 0.26.0
4545
* Error: Expected ';' at line 5 in AccessControl.compact
4646
* ```
4747
*

packages/compact/src/Compiler.ts

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export type ExecFunction = (
3939
* @example
4040
* ```typescript
4141
* const validator = new EnvironmentValidator();
42-
* await validator.validate('0.25.0');
42+
* await validator.validate('0.26.0');
4343
* const version = await validator.getDevToolsVersion();
4444
* ```
4545
*/
@@ -100,7 +100,7 @@ export class EnvironmentValidator {
100100
* @throws {Error} If the CLI is not available or command fails
101101
* @example
102102
* ```typescript
103-
* const toolchainVersion = await validator.getToolchainVersion('0.25.0');
103+
* const toolchainVersion = await validator.getToolchainVersion('0.26.0');
104104
* console.log(`Toolchain: ${toolchainVersion}`);
105105
* ```
106106
*/
@@ -122,7 +122,7 @@ export class EnvironmentValidator {
122122
* @example
123123
* ```typescript
124124
* try {
125-
* await validator.validate('0.25.0');
125+
* await validator.validate('0.26.0');
126126
* console.log('Environment validated successfully');
127127
* } catch (error) {
128128
* if (error instanceof CompactCliNotFoundError) {
@@ -215,7 +215,7 @@ export class FileDiscovery {
215215
* const result = await compiler.compileFile(
216216
* 'contracts/Token.compact',
217217
* '--skip-zk --verbose',
218-
* '0.25.0'
218+
* '0.26.0'
219219
* );
220220
* console.log('Compilation output:', result.stdout);
221221
* ```
@@ -247,7 +247,7 @@ export class CompilerService {
247247
* const result = await compiler.compileFile(
248248
* 'security/AccessControl.compact',
249249
* '--skip-zk',
250-
* '0.25.0'
250+
* '0.26.0'
251251
* );
252252
* console.log('Success:', result.stdout);
253253
* } catch (error) {
@@ -296,7 +296,7 @@ export class CompilerService {
296296
* @class UIService
297297
* @example
298298
* ```typescript
299-
* UIService.displayEnvInfo('compact 0.1.0', 'Compactc 0.25.0', 'security');
299+
* UIService.displayEnvInfo('compact 0.1.0', 'Compactc 0.26.0', 'security');
300300
* UIService.printOutput('Compilation successful', chalk.green);
301301
* ```
302302
*/
@@ -333,9 +333,9 @@ export const UIService = {
333333
* ```typescript
334334
* UIService.displayEnvInfo(
335335
* 'compact 0.1.0',
336-
* 'Compactc version: 0.25.0',
336+
* 'Compactc version: 0.26.0',
337337
* 'security',
338-
* '0.25.0'
338+
* '0.26.0'
339339
* );
340340
* ```
341341
*/
@@ -419,7 +419,7 @@ export const UIService = {
419419
* @example
420420
* ```typescript
421421
* // Basic usage
422-
* const compiler = new CompactCompiler('--skip-zk', 'security', '0.25.0');
422+
* const compiler = new CompactCompiler('--skip-zk', 'security', '0.26.0');
423423
* await compiler.compile();
424424
*
425425
* // Factory method usage
@@ -452,7 +452,7 @@ export class CompactCompiler {
452452
*
453453
* @param flags - Space-separated compiler flags (e.g., '--skip-zk --verbose')
454454
* @param targetDir - Optional subdirectory within src/ to compile (e.g., 'security', 'token')
455-
* @param version - Optional toolchain version to use (e.g., '0.25.0')
455+
* @param version - Optional toolchain version to use (e.g., '0.26.0')
456456
* @param execFn - Optional custom exec function for dependency injection
457457
* @example
458458
* ```typescript
@@ -463,7 +463,7 @@ export class CompactCompiler {
463463
* const compiler = new CompactCompiler('', 'security');
464464
*
465465
* // Compile with specific version
466-
* const compiler = new CompactCompiler('--skip-zk', undefined, '0.25.0');
466+
* const compiler = new CompactCompiler('--skip-zk', undefined, '0.26.0');
467467
*
468468
* // For testing with custom exec function
469469
* const mockExec = vi.fn();
@@ -500,11 +500,11 @@ export class CompactCompiler {
500500
* @throws {Error} If --dir flag is provided without a directory name
501501
* @example
502502
* ```typescript
503-
* // Parse command line: compact-compiler --dir security --skip-zk +0.25.0
503+
* // Parse command line: compact-compiler --dir security --skip-zk +0.26.0
504504
* const compiler = CompactCompiler.fromArgs([
505505
* '--dir', 'security',
506506
* '--skip-zk',
507-
* '+0.25.0'
507+
* '+0.26.0'
508508
* ]);
509509
*
510510
* // With environment variable

packages/compact/src/runBuilder.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { CompactBuilder } from './Builder.js';
1919
* ℹ [COMPILE] COMPACTC_PATH: /path/to/compactc/compactc
2020
* ℹ [COMPILE] Found 1 .compact file(s) to compile
2121
* ✔ [COMPILE] [1/1] Compiled Foo.compact
22-
* Compactc version: 0.25.0
22+
* Compactc version: 0.26.0
2323
* ✔ [BUILD] [1/3] Compiling TypeScript
2424
* ✔ [BUILD] [2/3] Copying artifacts
2525
* ✔ [BUILD] [3/3] Copying and cleaning .compact files

packages/compact/src/runCompiler.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import {
4040
*
4141
* @example Version specification
4242
* ```bash
43-
* npx compact-compiler --dir security --skip-zk +0.25.0
43+
* npx compact-compiler --dir security --skip-zk +0.26.0
4444
* ```
4545
*/
4646
async function runCompiler(): Promise<void> {
@@ -179,7 +179,7 @@ function showUsageHelp(): void {
179179
);
180180
console.log(
181181
chalk.yellow(
182-
' +<version> Use specific toolchain version (e.g., +0.25.0)',
182+
' +<version> Use specific toolchain version (e.g., +0.26.0)',
183183
),
184184
);
185185
console.log(chalk.yellow('\nExamples:'));
@@ -205,7 +205,7 @@ function showUsageHelp(): void {
205205
);
206206
console.log(
207207
chalk.yellow(
208-
' compact-compiler --skip-zk +0.25.0 # Use specific version',
208+
' compact-compiler --skip-zk +0.26.0 # Use specific version',
209209
),
210210
);
211211
console.log(chalk.yellow('\nTurbo integration:'));

0 commit comments

Comments
 (0)