You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 20, 2024. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+21-24
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@
4
4
5
5
> `huff-rs` is a [Huff](https://github.com/huff-language) compiler built in rust.
6
6
7
-
8
7
## What is a Huff?
9
8
10
9
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.
@@ -17,7 +16,6 @@ While EVM experts can use Huff to write highly-efficient smart contracts for use
17
16
18
17
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)).
19
18
20
-
21
19
## Installation
22
20
23
21
_Something not working? Send a message in [discord](https://discord.huff.sh)._
@@ -33,14 +31,16 @@ To avoid redirecting the script directly into bash, download and run the [huffup
33
31
To install the Huff compiler, simply run `huffup`.
34
32
35
33
If you have the old [huffc (TypeScript version)](https://github.com/huff-language/huffc) npm package installed globally, you can remove it with:
34
+
36
35
```bash
37
36
sudo yarn global remove huffc
38
37
```
39
38
40
-
To make sure you are running the rust version, you can run `huffc --version` and it should respond with `huff_cli <version>`. If it responds with `2.0.0` that means you are running the Typescript version.
39
+
To make sure you are running the rust version, you can run `huffc --version` and it should respond with `huff_cli <version>`. If it responds with `2.0.0` that means you are running the Typescript version.
_Note: Compilation benchmarks were performed on [huff-examples erc20](https://github.com/huff-language/huff-examples/tree/main/erc20/contracts/ERC20.huff)._
73
72
74
-
75
73
## Architecture
76
74
77
75
78
76
79
-
80
77
## Modules
81
-
*[huff_core](./huff_core): The core module to huff-rs. Resolves source file paths, executes compilation, and exports artifacts.
82
-
*[huff_cli](./huff_cli): The command line interface for the Huff compiler.
83
-
*[huff_js](./huff_js): A wasm compatible interface to the Huff compiler for JavaScript bindings.
84
-
*[huff_lexer](./huff_lexer): Takes in the source of a `.huff` file and generates a vector of `Token`s.
85
-
*[huff_parser](./huff_parser): Crafts a `Contract` AST from the vector of `Token`s generated by [huff_lexer](./huff_lexer).
86
-
*[huff_codegen](./huff_codegen): EVM Bytecode generation module that accepts an AST generated by [huff_parser](./huff_parser).
87
-
*[huff_utils](./huff_utils): Various utilities and types used by all modules.
88
-
*[huffup](./huffup): Update or revert to a specific huff-rs branch with ease. (Forked from [foundry](https://github.com/foundry-rs/foundry))
89
78
79
+
-[huff_core](./huff_core): The core module to huff-rs. Resolves source file paths, executes compilation, and exports artifacts.
80
+
-[huff_cli](./huff_cli): The command line interface for the Huff compiler.
81
+
-[huff_js](./huff_js): A wasm compatible interface to the Huff compiler for JavaScript bindings.
82
+
-[huff_lexer](./huff_lexer): Takes in the source of a `.huff` file and generates a vector of `Token`s.
83
+
-[huff_parser](./huff_parser): Crafts a `Contract` AST from the vector of `Token`s generated by [huff_lexer](./huff_lexer).
84
+
-[huff_codegen](./huff_codegen): EVM Bytecode generation module that accepts an AST generated by [huff_parser](./huff_parser).
85
+
-[huff_utils](./huff_utils): Various utilities and types used by all modules.
86
+
-[huffup](./huffup): Update or revert to a specific huff-rs branch with ease. (Forked from [foundry](https://github.com/foundry-rs/foundry))
90
87
91
88
## Contributing
92
89
93
90
All contributions are welcome! We want to make contributing to this project as easy and transparent as possible, whether it's:
94
-
- Reporting a bug
95
-
- Discussing the current state of the code
96
-
- Submitting a fix
97
-
- Proposing new features
98
-
- Becoming a maintainer
91
+
92
+
- Reporting a bug
93
+
- Discussing the current state of the code
94
+
- Submitting a fix
95
+
- Proposing new features
96
+
- Becoming a maintainer
99
97
100
98
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/huff-language/huff-rs/issues/new); it's that easy!
101
99
@@ -141,7 +139,6 @@ When the PR checklist isn't complete, it is **highly** recommended to make it a
141
139
142
140
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).
143
141
144
-
145
142
## Safety
146
143
147
144
> **Warning**
@@ -150,13 +147,13 @@ For breaking changes: make sure to edit the [excalidraw asset](https://excalidra
150
147
> Expect rapid iteration and **use at your own risk**.
151
148
>
152
149
> This code is **not designed for safety**.
150
+
>
153
151
> - There are untested invariants in the code that may break.
154
152
> -**You can easily shoot yourself in the foot if you're not careful.**
155
153
> - You should thoroughly read the documentation and examples.
156
154
>
157
155
> We **do not give any warranties** and **will not be liable for any loss** incurred through any use of this codebase.
158
156
159
-
160
157
## Acknowledgements
161
158
162
159
The original [Huff Language](https://github.com/huff-language) compiler: [`huffc`](https://github.com/huff-language/huffc).
Copy file name to clipboardexpand all lines: huff_cli/README.md
+68-22
Original file line number
Diff line number
Diff line change
@@ -5,43 +5,87 @@ The `huffc` CLI is written using [clap's](https://docs.rs/clap) [derive feature]
5
5
## huffc
6
6
7
7
```
8
-
huffc 0.3.1
8
+
huffc 0.3.2
9
9
Huff Language Compiler built in Pure Rust.
10
10
11
11
USAGE:
12
-
huffc [OPTIONS] [--] [PATH]
12
+
huffc [OPTIONS] [PATH] [SUBCOMMAND]
13
13
14
14
ARGS:
15
15
<PATH> The contract(s) to compile
16
16
17
17
OPTIONS:
18
-
-a, --artifacts Whether to generate artifacts or not
19
-
-b, --bytecode Generate and log bytecode
20
-
-d, --output-directory <OUTPUTDIR> The output directory [default: ./artifacts]
21
-
-g, --interface Generate solidity interface for a Huff artifact
22
-
-h, --help Print help information
23
-
-i, --inputs <INPUTS>... The input constructor arguments
24
-
-n, --interactive Interactively input the constructor args
25
-
-o, --output <OUTPUT> The output file path
26
-
-p, --print Prints out to the terminal
27
-
-r, --bin-runtime Generate and log runtime bytecode
28
-
-s, --source-path <SOURCE> The contracts source path [default: ./contracts]
29
-
-v, --verbose Verbose output
30
-
-V, --version Print version information
31
-
-z, --optimize Optimize compilation [WIP]
18
+
-a, --artifacts
19
+
Whether to generate artifacts or not
20
+
21
+
-b, --bytecode
22
+
Generate and log bytecode
23
+
24
+
-c, --constants <CONSTANTS>...
25
+
Override / set constants for the compilation environment
26
+
27
+
-d, --output-directory <OUTPUTDIR>
28
+
The output directory [default: ./artifacts]
29
+
30
+
-e, --evm-version <EVM_VERSION>
31
+
Set the EVM version
32
+
33
+
-g, --interface [<INTERFACE>...]
34
+
Generate solidity interface for a Huff artifact
35
+
36
+
-h, --help
37
+
Print help information
38
+
39
+
-i, --inputs <INPUTS>...
40
+
The input constructor arguments
41
+
42
+
-l, --label-indices
43
+
Prints out the jump label PC indices for the specified contract
44
+
45
+
-m, --alt-main <ALTERNATIVE_MAIN>
46
+
Compile a specific macro
47
+
48
+
-n, --interactive
49
+
Interactively input the constructor args
50
+
51
+
-o, --output <OUTPUT>
52
+
The output file path
53
+
54
+
-p, --print
55
+
Prints out to the terminal
56
+
57
+
-r, --bin-runtime
58
+
Generate and log runtime bytecode
59
+
60
+
-s, --source-path <SOURCE>
61
+
The contracts source path [default: ./contracts]
62
+
63
+
-t, --alt-constructor <ALTERNATIVE_CONSTRUCTOR>
64
+
Compile a specific constructor macro
65
+
66
+
-v, --verbose
67
+
Verbose output
68
+
69
+
-V, --version
70
+
Print version information
71
+
72
+
-z, --optimize
73
+
Optimize compilation [WIP]
74
+
32
75
```
33
76
34
77
_NOTE: To generate the above output, run: `huffc --help`_
35
78
36
-
37
79
## Usage
38
80
39
81
To run `huffc` from the command line, you can simply run:
82
+
40
83
```bash
41
84
huffc --help
42
85
```
43
86
44
87
By default, huffc will attempt to compile all contracts in the `contracts` directory. If there is no `contracts` directory present, the following will spit out an error like so:
**NOTE**: The following will _not_ compile since multiple artifacts cannot be output to the same artifact json file.
137
+
93
138
```bash
94
139
huffc -o ./artifact.json ./contracts/
95
140
```
96
141
97
-
98
142
#### Entering Constructor Arguments
99
143
100
144
`huffc` supports passing in constructor arguments to the contract. This is done by passing in the `--interactive` (shorthand: `-n`) flag or passing the `--inputs` (shorthand: `-i`) flag.
101
145
102
-
and passing in the arguments as a comma separated list.
146
+
and passing in the arguments as a comma separated list.
103
147
104
148
For example, to compile a contract (let's call it `example.huff`) with the following constructor definition:
0 commit comments