{"id":47301305,"url":"https://github.com/OpenZeppelin/compact-tools","last_synced_at":"2026-03-31T07:00:42.370Z","repository":{"id":328143260,"uuid":"1089448515","full_name":"OpenZeppelin/compact-tools","owner":"OpenZeppelin","description":"A monorepo for collecting all the shared Compact tools","archived":false,"fork":false,"pushed_at":"2026-03-05T17:54:26.000Z","size":5728,"stargazers_count":3,"open_issues_count":29,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-05T20:28:43.543Z","etag":null,"topics":["compact","midnightntwrk"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenZeppelin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-04T11:05:43.000Z","updated_at":"2026-03-05T17:55:41.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/OpenZeppelin/compact-tools","commit_stats":null,"previous_names":["openzeppelin/compact-tools"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/OpenZeppelin/compact-tools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fcompact-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fcompact-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fcompact-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fcompact-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenZeppelin","download_url":"https://codeload.github.com/OpenZeppelin/compact-tools/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fcompact-tools/sbom","scorecard":{"id":1240397,"data":{"date":"2025-12-12T19:33:53Z","repo":{"name":"github.com/OpenZeppelin/compact-tools","commit":"ed4131cae0cf170b9a133aac341513dc76b56c8d"},"scorecard":{"version":"v5.3.0","commit":"c22063e786c11f9dd714d777a687ff7c4599b600"},"score":6.3,"checks":[{"name":"Maintained","score":0,"reason":"project was created within the last 90 days. Please review its contents carefully","details":["Warn: Repository was created within the last 90 days."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#packaging"}},{"name":"Code-Review","score":9,"reason":"Found 11/12 approved changesets -- score normalized to 9","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dangerous-workflow"}},{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: detected update tool: Dependabot: .github/dependabot.yml:1"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dependency-update-tool"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/checks.yml:1","Info: topLevel permissions set to 'read-all': .github/workflows/scorecard.yml:18","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":9,"reason":"dependency not pinned by hash detected -- score normalized to 9","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/checks.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/OpenZeppelin/compact-tools/checks.yml/main?enable=pin","Info:   3 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   2 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#license"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#cii-best-practices"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#signed-releases"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-5j98-mcp5-4vw2"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#vulnerabilities"}},{"name":"Branch-Protection","score":5,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Info: 'branch protection settings apply to administrators' is required to merge on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Info: codeowner review is required on branch 'main'","Info: 'last push approval' is required to merge on branch 'main'","Warn: 'up-to-date branches' is disabled on branch 'main'","Info: status check found to merge onto on branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#branch-protection"}},{"name":"Contributors","score":10,"reason":"project has 3 contributing companies or organizations -- score normalized to 10","details":["Info: found contributions from: OpenZeppelin, openzeppelin, redacted-enterprises"],"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#contributors"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 2 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#sast"}},{"name":"CI-Tests","score":7,"reason":"14 out of 19 merged PRs checked by a CI test -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#ci-tests"}}]},"last_synced_at":"2025-12-13T20:20:24.502Z","repository_id":328143260,"created_at":"2025-12-13T20:20:24.503Z","updated_at":"2025-12-13T20:20:24.503Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31224248,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-31T04:08:55.938Z","status":"ssl_error","status_checked_at":"2026-03-31T04:08:47.883Z","response_time":111,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compact","midnightntwrk"],"created_at":"2026-03-17T03:00:22.710Z","updated_at":"2026-03-31T07:00:42.362Z","avatar_url":"https://github.com/OpenZeppelin.png","language":"TypeScript","readme":"[![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)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/OpenZeppelin/compact-tools/badge)](https://api.securityscorecards.dev/projects/github.com/OpenZeppelin/compact-tools)\n\nThis project extends the Midnight Network with additional developer tooling.\n\n# OpenZeppelin Compact Tools\n\nTools for compiling, building, and testing Compact smart contracts. This is a monorepo containing:\n\n- `packages/cli`: CLI utilities to run the Compact compiler and builder\n- `packages/simulator`: TypeScript simulator to run and test Compact contracts locally\n\n## External usage (via git submodule until npm publish)\n\nUntil packages are published to the npm registry, you can consume this repo from another project using a git submodule:\n\n```bash\n# In your project\ngit submodule add https://github.com/OpenZeppelin/compact-tools\ngit submodule update --init --recursive\n\n# Install and build the tools\nyarn --cwd tools/compact-tools install\nyarn --cwd tools/compact-tools build\n\n# Use the simulator as a local dependency\n# package.json\n\"devDependencies\": {\n  \"@openzeppelin/compact-tools-simulator\": \"file:./compact-tools/packages/simulator\"\n}\nyarn install\n\n# Call the CLIs directly or via scripts\nnode compact-tools/packages/cli/dist/runCompiler.js --help\nnode compact-tools/packages/cli/dist/runBuilder.js --help\n```\n\n## Requirements\n\n- Node.js \u003e= 20 (root and `packages/cli`), \u003e= 22 for `packages/simulator`\n- Yarn 4 (Berry)\n- Turbo\n- Optional: Midnight Compact toolchain installed and available in `PATH`\n\nConfirm your Compact toolchain:\n\n```bash\n$ compact compile --version\n\nCompactc version: 0.28.0\n0.28.0\n```\n\n## Getting started\n\nInstall dependencies at the repo root:\n\n```bash\nnvm install\nyarn\n```\n\nBuild everything:\n\n```bash\nyarn build\n```\n\nRun tests (root runs package tests via Turbo):\n\n```bash\nyarn test\n```\n\nFormat and lint (Biome):\n\n```bash\nyarn lint\nyarn lint:fix\n```\n\nClean generated artifacts:\n\n```bash\nyarn clean\n```\n\n## Packages\n\n### `@openzeppelin/compact-tools-cli` ([packages/cli](./packages/cli))\n\nCLI utilities for compiling and building Compact smart contracts.\n\n**Quickstart:**\n\n```bash\n# Compile all .compact files\ncompact-compiler\n\n# Skip ZK proofs for faster development builds\ncompact-compiler --skip-zk\n\n# Compile specific directory\ncompact-compiler --dir security\n\n# Full build (compile + TypeScript + copy artifacts)\ncompact-builder\n```\n\nSee [packages/cli/README.md](./packages/cli/README.md) for full documentation including all options, programmatic API, and examples.\n\n### `@openzeppelin/compact-tools-simulator` ([packages/simulator](./packages/simulator))\n\nTypeScript simulator for testing Compact contracts locally.\n\n**Quickstart:**\n\n```ts\nimport { createSimulator } from '@openzeppelin/compact-tools-simulator';\n\nconst simulator = createSimulator({});\n// Deploy and execute contract circuits, inspect state, etc.\n```\n\nSee package tests in `packages/simulator/src/integration` and `src/unit` for full examples.\n\n## Contributing\n\nBefore opening a PR, please read `CODE_OF_CONDUCT.md`. Use the root scripts to build, test, and format. For targeted work inside a package, run the scripts in that package directory.\n\n## License\n\nMIT\n","funding_links":[],"categories":["Developer Tools"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenZeppelin%2Fcompact-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOpenZeppelin%2Fcompact-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOpenZeppelin%2Fcompact-tools/lists"}