Skip to content

Commit 2b820d7

Browse files
jshufrojshufro
committed
Merge remote-tracking branch 'treegen/jms/monorepo' into jms/monorepo-add-treegen-no-changes
2 parents fc403d8 + 226d22a commit 2b820d7

12 files changed

Lines changed: 2202 additions & 0 deletions

File tree

‎treegen/.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.json
2+
treegen
3+
Releases/

‎treegen/Dockerfile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
FROM debian:bullseye-slim
2+
3+
ARG TARGETARCH
4+
COPY ./Releases/treegen-linux-${TARGETARCH} /treegen

‎treegen/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎treegen/README.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Rocket Pool Rewards Tree Generation Tool
2+
3+
This is a standalone tool for creating the rewards tree and minipool attestation files for rewards intervals on the Rocket Pool network.
4+
It can recreate trees for past rewards intervals, or it can "simulate" the tree for the current interval ending at the latest finalized block (for testing purposes).
5+
It uses the same codebase as the Smartnode, so you can be assured that `treegen` will generate the same trees as the Smartnode stack.
6+
7+
8+
## Running Treegen
9+
10+
There are currently three ways to run `treegen`:
11+
12+
1. Run the precompiled binaries locally (Linux only, using `glibc`)
13+
2. Run the Docker image (Linux, Windows, and macOS)
14+
3. Build from source and run locally
15+
16+
17+
### Running the Binary Locally
18+
19+
Run the binary as follows:
20+
21+
```
22+
$ ./treegen-linux-amd64 [options]
23+
```
24+
25+
Options:
26+
27+
```
28+
--bn-endpoint value, -b value The URL of the Beacon Node's REST API. Note that for past interval generation, this must have Archive capability (ability to replay arbitrary historical states). (default: "http://localhost:5052")
29+
--ec-endpoint value, -e value The URL of the Execution Client's JSON-RPC API. Note that for past interval generation, this must be an Archive EC. (default: "http://localhost:8545")
30+
--interval value, -i value The rewards interval to generate the artifacts for. A value of -1 indicates that you want to do a "dry run" of generating the tree for the current (active) interval, using the current latest finalized block as the interval end. (default: -1)
31+
--output-dir value, -o value Optional output directory to save generated files (default is the current working directory).
32+
--pretty-print, -p Toggle for saving the files in pretty-print format so they're human readable. (default: true)
33+
--ruleset value, -r value The ruleset to use during generation. If not included, treegen will use the default ruleset for the network based on the rewards interval at the chosen block. Default of 0 will use whatever the ruleset specified by the network based on which block is being targeted. (default: 0)
34+
--network-info, -n If provided, this will simply print out info about the network being used, the current rewards interval, and the current ruleset. (default: false)
35+
--approximate-only, -a Approximates the rETH stakers' share of the Smoothing Pool at the current block instead of generating the entire rewards tree. Ignores -i. (default: false)
36+
--use-rolling-records, -rr Enable the rolling record capability of the Smartnode tree generator. Use this to store and load record caches instead of recalculating attestation performance each time you run treegen. (default: false)
37+
```
38+
39+
40+
### Running via the Docker Image
41+
42+
`treegen` is also available in a Docker image for users not on Linux systems, or on systems incompatible with the precompiled binaries.
43+
To run it, use the following command:
44+
45+
```
46+
$ ./treegen.sh -e <EC endpoint> -b <BN endpoint> [options]
47+
```
48+
49+
Options:
50+
51+
```
52+
--bn-endpoint value, -b value The URL of the Beacon Node's REST API. Note that for past interval generation, this must have Archive capability (ability to replay arbitrary historical states). (default: "http://localhost:5052")
53+
--ec-endpoint value, -e value The URL of the Execution Client's JSON-RPC API. Note that for past interval generation, this must be an Archive EC. (default: "http://localhost:8545")
54+
--interval value, -i value The rewards interval to generate the artifacts for. A value of -1 indicates that you want to do a "dry run" of generating the tree for the current (active) interval, using the current latest finalized block as the interval end. (default: -1)
55+
--pretty-print, -p Toggle for saving the files in pretty-print format so they're human readable. (default: true)
56+
--ruleset value, -r value The ruleset to use during generation. If not included, treegen will use the default ruleset for the network based on the rewards interval at the chosen block. Default of 0 will use whatever the ruleset specified by the network based on which block is being targeted. (default: 0)
57+
--network-info, -n If provided, this will simply print out info about the network being used, the current rewards interval, and the current ruleset. (default: false)
58+
--approximate-only, -a Approximates the rETH stakers' share of the Smoothing Pool at the current block instead of generating the entire rewards tree. Ignores -i. (default: false)
59+
--use-rolling-records, -rr Enable the rolling record capability of the Smartnode tree generator. Use this to store and load record caches instead of recalculating attestation performance each time you run treegen. (default: false)
60+
```
61+
62+
NOTE: Do *not* use the `-o` flag if you are using this script, as it is already built into the script.
63+
Output files will be stored in the `out` directory.
64+
65+
66+
## Building
67+
68+
To build the binary locally, simply enter this folder and run `go build`.
69+
You will need to have Go v1.19 or higher set up already.

‎treegen/build-release.sh‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
#!/bin/bash
2+
3+
# Builds the binaries
4+
build_binary() {
5+
echo -n "Building binaries... "
6+
docker run --rm -v $PWD:/treegen rocketpool/smartnode-builder:latest /treegen/build_binaries.sh
7+
echo "done!"
8+
}
9+
10+
# Build the images
11+
build_docker() {
12+
echo -n "Building Docker images... "
13+
docker buildx build --platform=linux/amd64 -t rocketpool/treegen:$VERSION-amd64 --load .
14+
docker buildx build --platform=linux/arm64 -t rocketpool/treegen:$VERSION-arm64 --load .
15+
docker push rocketpool/treegen:$VERSION-amd64
16+
docker push rocketpool/treegen:$VERSION-arm64
17+
echo "done!"
18+
}
19+
20+
# Build the manifest
21+
build_manifest() {
22+
echo -n "Building Docker manifest... "
23+
rm -f ~/.docker/manifests/docker.io_rocketpool_treegen-$VERSION
24+
rm -f ~/.docker/manifests/docker.io_rocketpool_treegen-latest
25+
docker manifest create rocketpool/treegen:$VERSION --amend rocketpool/treegen:$VERSION-amd64 --amend rocketpool/treegen:$VERSION-arm64
26+
docker manifest create rocketpool/treegen:latest --amend rocketpool/treegen:$VERSION-amd64 --amend rocketpool/treegen:$VERSION-arm64
27+
echo "done!"
28+
echo -n "Pushing to Docker Hub... "
29+
docker manifest push --purge rocketpool/treegen:$VERSION
30+
docker manifest push --purge rocketpool/treegen:latest
31+
echo "done!"
32+
}
33+
34+
# Print usage
35+
usage() {
36+
echo "Usage: build-release.sh [options] -v <version number>"
37+
echo "This script builds treegen's artifacts."
38+
echo "Options:"
39+
echo $'\t-a\tBuild all of the artifacts.'
40+
echo $'\t-b\tBuild the native binaries for most Linux distributions'
41+
echo $'\t-d\tBuild the Alpine-based Docker containers'
42+
echo $'\t-m\tBuild the Docker manifest'
43+
exit 0
44+
}
45+
46+
# =================
47+
# === Main Body ===
48+
# =================
49+
50+
# Get the version
51+
while getopts "abdmv:" FLAG; do
52+
case "$FLAG" in
53+
a) BINARIES=true DOCKER=true MANIFEST=true ;;
54+
b) BINARIES=true ;;
55+
d) DOCKER=true ;;
56+
m) MANIFEST=true ;;
57+
v) VERSION="$OPTARG" ;;
58+
*) usage ;;
59+
esac
60+
done
61+
if [ -z "$VERSION" ]; then
62+
usage
63+
fi
64+
65+
# Build the artifacts
66+
if [ "$BINARIES" = true ]; then
67+
build_binary
68+
fi
69+
if [ "$DOCKER" = true ]; then
70+
build_docker
71+
fi
72+
if [ "$MANIFEST" = true ]; then
73+
build_manifest
74+
fi

‎treegen/build_binaries.sh‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#!/bin/bash
2+
3+
cd /treegen
4+
5+
export CGO_ENABLED=1
6+
7+
# Build x64 version
8+
CGO_CFLAGS="-O -D__BLST_PORTABLE__" GOARCH=amd64 GOOS=linux go build -o Releases/treegen-linux-amd64 -buildvcs=false
9+
10+
# Build the arm64 version
11+
CC=aarch64-linux-gnu-gcc CXX=aarch64-linux-gnu-cpp CGO_CFLAGS="-O -D__BLST_PORTABLE__" GOARCH=arm64 GOOS=linux go build -o Releases/treegen-linux-arm64 -buildvcs=false

0 commit comments

Comments
 (0)