Implement binary size tracker for OpShin contracts#521
Merged
Conversation
Contributor
Author
|
@nielstron 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: nielstron <20638630+nielstron@users.noreply.github.com>
Co-authored-by: nielstron <20638630+nielstron@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Binary size tracker
Implement binary size tracker for OpShin contracts
Sep 17, 2025
✅ Binary Size Check PassedBinary Size Comparison ReportNo significant binary size changes were detected in this PR. This report compares the binary sizes of compiled contracts against the baseline from the latest release. |
nielstron
approved these changes
Sep 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR implements a comprehensive binary size tracking system to monitor changes in compiled contract sizes across different optimization levels, helping detect regressions that could impact deployment costs and execution limits.
Problem
Occasionally, changes to the OpShin compiler significantly increase binary size, especially under >O2 optimization settings. This can be a huge issue for contract deployment costs and execution limits on Cardano.
Solution
The implementation provides automated tracking of binary sizes for representative contracts:
Key Components
Scripts
scripts/binary_size_tracker.py- Main tracking script that compiles contracts and measures CBOR sizesscripts/check_binary_sizes.py- Developer convenience tool for local testing against latest releasescripts/binary_size_config.yaml- Configuration for tracked contracts and thresholdsCI Integration
.github/workflows/binary-size-tracker.yml- PR workflow that downloads baselines and reports changes.github/workflows/release.yml- Generates and uploads baselines for new releasesTracked Contracts
assert_sum- Simple spending validator (4.6KB)marketplace- Complex contract with data structures (8.9KB)gift- Simple gift contract (1.7KB)dual_use- Multi-purpose contract (0.6KB)Example Output
Usage
Developers can check their changes locally:
The system automatically runs on PRs and comments with size comparison reports, failing CI if changes exceed the significant threshold.
Fixes #520.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.