Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minaminao/huff-rs
A low-level assembly language for the Ethereum Virtual Machine built in blazing-fast pure rust.
https://github.com/minaminao/huff-rs
Last synced: 23 days ago
JSON representation
A low-level assembly language for the Ethereum Virtual Machine built in blazing-fast pure rust.
- Host: GitHub
- URL: https://github.com/minaminao/huff-rs
- Owner: minaminao
- License: apache-2.0
- Created: 2024-09-09T23:47:12.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T05:12:48.000Z (3 months ago)
- Last Synced: 2024-09-17T08:01:38.788Z (3 months ago)
- Language: Rust
- Size: 3.92 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# huff-rs • [](https://github.com/minaminao/huff-rs/actions/workflows/ci.yaml) [](https://opensource.org/licenses/Apache-2.0)
This is a fork of [huff-language/huff-rs](https://github.com/huff-language/huff-rs).
`huff-rs` is a [Huff](https://github.com/huff-language) compiler built in Rust.
## What is a Huff?
Huff is a low-level programming language designed for developing highly optimized smart contracts that run on the Ethereum Virtual Machine (EVM). Huff does not hide the inner workings of the EVM. Instead, Huff exposes its programming stack to the developer for manual manipulation.
Rather than having functions, Huff has macros - individual blocks of bytecode that can be rigorously tested and evaluated using the Huff runtime testing suite.
[Huff](https://github.com/AztecProtocol/huff) was originally developed by the Aztec Protocol team to write [Weierstrudel](https://github.com/aztecprotocol/weierstrudel). Weierstrudel is an on-chain elliptical curve arithmetic library that requires incredibly optimized code that neither [Solidity](https://docs.soliditylang.org/en/v0.8.14/) nor [Yul](https://docs.soliditylang.org/en/v0.8.9/yul.html) could provide.
While EVM experts can use Huff to write highly-efficient smart contracts for use in production, it can also serve as a way for beginners to learn more about the EVM.
To dive deeper into [Huff](https://github.com/huff-language), visit the [Official Huff Docs](https://huff.sh)(also available on [github](https://github.com/huff-language/huff-docs)).
## Installation
Install from source by running:
```bash
git clone https://raw.githubusercontent.com/minaminao/huff-rs
cd huff-rs
cargo install --path ./huff_cli --bins --locked --force
```
OR
```bash
cargo install --git https://raw.githubusercontent.com/minaminao/huff-rs --locked huff_cli
```
To make sure you are running the version, you can run `huffc --version` and it should respond with `huff_cli `.
```bash
$ huffc --version
huff_cli 0.3.2
```
## Architecture
## Modules
- [huff_core](./huff_core): The core module to huff-rs. Resolves source file paths, executes compilation, and exports artifacts.
- [huff_cli](./huff_cli): The command line interface for the Huff compiler.
- [huff_js](./huff_js): A wasm compatible interface to the Huff compiler for JavaScript bindings.
- [huff_lexer](./huff_lexer): Takes in the source of a `.huff` file and generates a vector of `Token`s.
- [huff_parser](./huff_parser): Crafts a `Contract` AST from the vector of `Token`s generated by [huff_lexer](./huff_lexer).
- [huff_codegen](./huff_codegen): EVM Bytecode generation module that accepts an AST generated by [huff_parser](./huff_parser).
- [huff_utils](./huff_utils): Various utilities and types used by all modules.
- [huffup](./huffup): Update or revert to a specific huff-rs branch with ease. (Forked from [foundry](https://github.com/foundry-rs/foundry))
## Contributing
All contributions are welcome! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/minaminao/huff-rs/issues/new); it's that easy!
To run examples, make sure you update git submodules to pull down the [huff-examples](./huff-examples/) submodule by running `git submodule update`.
To pass github actions, please run:
```bash
cargo check --all
cargo test --all --all-features
cargo +nightly fmt -- --check
cargo +nightly clippy --all --all-features -- -D warnings
```
In order to fix any formatting issues, run:
```bash
cargo +nightly fmt --all
```
**Recommended PR Template**
Here is an example PR template - not strictly required, but will greatly improve the speed at which your PR is reviewed & merged!
```md
## Overview
## Checklist
- [x]
- [x]
- [ ]
```
When the PR checklist isn't complete, it is **highly** recommended to make it a draft PR. NOTE: if your PR is not complete, it will likely be changed to a draft by one of the repository admins.
For breaking changes: make sure to edit the [excalidraw asset](https://excalidraw.com/#json=9YvTZp-rY9NOQnX9TC8Dz,sVM8vpgvQqGiXNXrBNshTg) and export the file to [./assets/huffc.excalidraw](./assets/huffc.excalidraw) along with an image to [./assets/huffc.png](./assets/huffc.png).
## Safety
> **Warning**
>
> This is **experimental software** and is provided on an "as is" and "as available" basis.
> Expect rapid iteration and **use at your own risk**.
>
> This code is **not designed for safety**.
>
> - There are untested invariants in the code that may break.
> - **You can easily shoot yourself in the foot if you're not careful.**
> - You should thoroughly read the documentation and examples.
>
> We **do not give any warranties** and **will not be liable for any loss** incurred through any use of this codebase.
## Acknowledgements
The original [Huff Language](https://github.com/huff-language) compiler: [`huff-language/huff-rs`](https://github.com/huff-language/huff-rs).
[Foundry](https://github.com/foundry-rs/foundry), for the many scripts, documentation, devops, and code on which [huff-rs](https://github.com/huff-language/huff-rs) is based on.
All [huff-rs](https://github.com/huff-language/huff-rs) contributors, users, advocates, and enthusiasts!