psq/declar

Minimize Clarity contracts

A simple minimizer for Clarity

Declar, somehting to make your Clarity contracts less clear, but smaller, so it will cost less to deploy. Consider not using to make your deployed contracts less nebulous, or publish the non minimized version. Many people will forever thank you!

Rules

This is work in progress, as it currently implements removing comments and compressing spaces however the basis to do smarter things is already there as the full syntactic tree is available and will make implementing the rest fairly straightforward.

It can already shave 40% from the swapr contract, which is the biggest Clarity contract I had available

• remove comments
• remove unnecessary blank space
• do not rename define-public and define-read-only function names
• rename constants
• rename parameters
• rename variable names in let
• rename define-data-var variable names
• remove unused constants
• remove unused define-private methods
• do not rename all strings and numbers
• do not rename principals
• do not rename tuple keys as they might be returned (unless can figure out this is the case)
• include a way to add the url of the non minimized contract (using an url shortener too?)

How to run declar

You just need to pass the contract path, and the path for outputing the minimized contract

For example:

node declar.js contracts/my-token.clar contracts/my-token-min.clar

Other plans

• make it a webapp where you can paste your clarity contract
• add options to control how aggressive the minization shoul be, i.e. just spaces and comments, rename internal names, rename variables, ...
• tests will be included

Bonuses included

The Clarity parser, implemented in plain javascript, should be usable as a standalone module. npm version should be available soon. For now, you can require using the github url using

npm i github:psq/declar

Report issues

If you try it and the minized contract does not work or does not look correct, submit a PR, or create an issue. Thanks!