Skip to content
This repository was archived by the owner on Mar 26, 2025. It is now read-only.

Commit 083d598

Browse files
authored
chore(repo): general cleanup (#65)
* chore(repo): general cleanup We don't have the builder here anymore, so we need to remove all these references to it. I'm also taking the chance and updating several things like the rust version used and adding a few make commands. Closes ENG-617 * chore: fix typo * chore: add the swan
1 parent c5e2c9e commit 083d598

File tree

5 files changed

+15
-58
lines changed

5 files changed

+15
-58
lines changed

.github/CODEOWNERS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*: @Evalir @prestwich @dylanlott
2+
abi/: @anna-carroll
3+
.github/: @rswanson

Cargo.toml

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ description = "Types for the zenith smart contracts"
44

55
version = "0.10.1"
66
edition = "2021"
7-
rust-version = "1.81"
7+
rust-version = "1.82"
88
authors = ["Zenith Contributors"]
9-
homepage = "https://github.com/init4tt/zenith"
10-
repository = "https://github.com/init4tt/zenith"
9+
homepage = "https://github.com/init4tech/zenith"
10+
repository = "https://github.com/init4tech/zenith"
1111
license = "AGPL-3.0"
1212

1313
[dependencies]

Makefile

+5-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@ test:
1616

1717
.PHONY: fmt
1818
fmt:
19-
@cargo fmt --all
19+
@cargo +nightly fmt --all
2020

2121
.PHONY: clippy
2222
clippy:
23-
@cargo clippy --all-targets --all-features --workspace -- -D warnings
23+
@cargo clippy --all-targets --all-features -D warnings
24+
25+
tidy:
26+
@cargo clippy --all-targets --all-features -D warnings && cargo +nightly fmt --all

README.md

+3-52
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,11 @@
11
# zenith-rs
22

3-
Rust utilites for working with [Zenith](https://github.com/init4tech/zenith).
3+
Rust types & utilities for working with [Zenith](https://github.com/init4tech/zenith).
44

55
![rust](https://github.com/init4tech/zenith-rs/actions/workflows/rust-ci.yml/badge.svg) ![ecr](https://github.com/init4tech/zenith-rs/actions/workflows/ecr-cd.yml/badge.svg)
66

7-
## Crates
8-
9-
- `zenith-types`: Common types used by other crates.
10-
- `zenith-builder-example`: a block building example that uses the `builder` library.
11-
127
## Development
138

14-
This crate contains an example block builder in the Signet ecosystem.
15-
16-
### Requirements
17-
18-
- Rust 1.79.0
19-
- Cargo [Lambda](https://www.cargo-lambda.info/)
20-
- AWS CLI and credentials
21-
22-
### Environment
23-
24-
The following environment variables are exposed to configure the Builder:
25-
26-
```bash
27-
# Builder Configs
28-
HOST_CHAIN_ID="17000" # Holesky Testnet
29-
RU_CHAIN_ID="17001"
30-
HOST_RPC_URL="http://host.url.here"
31-
ZENITH_ADDRESS="ZENITH_ADDRESS_HERE"
32-
QUINCEY_URL="http://signer.url.here"
33-
BUILDER_PORT="8080"
34-
BUILDER_KEY="YOUR_BUILDER_KEY_HERE"
35-
INCOMING_TRANSACTIONS_BUFFER="10"
36-
BLOCK_CONFIRMATION_BUFFER="10"
37-
BUILDER_REWARDS_ADDRESS="BUILDER_REWARDS_ADDRESS_HERE"
38-
ROLLUP_BLOCK_GAS_LIMIT="30000000"
39-
# Transaction Pool Configs
40-
TX_POOL_URL="http://pool.url.here/" # trailing slash is required
41-
TX_POOL_POLL_INTERVAL="5" # seconds
42-
TX_POOL_CACHE_DURATION="600" # seconds
43-
```
44-
45-
## API
46-
47-
### SignRequest
48-
49-
Sign request example payload:
9+
This project requires Rust 1.82.0 or newer.
5010

51-
```json
52-
{
53-
"hostBlockNumber": "0x0",
54-
"hostChainId": "0x1",
55-
"ruChainId": "0x2",
56-
"gasLimit": "0x5",
57-
"ruRewardAddress": "0x0606060606060606060606060606060606060606",
58-
"contents": "0x0707070707070707070707070707070707070707070707070707070707070707"
59-
}
60-
```
11+
To build the project, run `make build`. To run tests, run `make test`. Before committing code, make sure to run `make tidy`, which will run clippy and format the whole project.

clippy.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
msrv = "1.76"
1+
msrv = "1.82"
22
too-large-for-stack = 128

0 commit comments

Comments
 (0)