-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Showing
4 changed files
with
13 additions
and
57 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
*: @Evalir @prestwich @dylanlott | ||
abi/: @anna-carroll |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,60 +1,11 @@ | ||
# zenith-rs | ||
|
||
Rust utilites for working with [Zenith](https://github.com/init4tech/zenith). | ||
Rust types & utilites for working with [Zenith](https://github.com/init4tech/zenith). | ||
|
||
![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) | ||
|
||
## Crates | ||
|
||
- `zenith-types`: Common types used by other crates. | ||
- `zenith-builder-example`: a block building example that uses the `builder` library. | ||
|
||
## Development | ||
|
||
This crate contains an example block builder in the Signet ecosystem. | ||
|
||
### Requirements | ||
|
||
- Rust 1.79.0 | ||
- Cargo [Lambda](https://www.cargo-lambda.info/) | ||
- AWS CLI and credentials | ||
|
||
### Environment | ||
|
||
The following environment variables are exposed to configure the Builder: | ||
|
||
```bash | ||
# Builder Configs | ||
HOST_CHAIN_ID="17000" # Holesky Testnet | ||
RU_CHAIN_ID="17001" | ||
HOST_RPC_URL="http://host.url.here" | ||
ZENITH_ADDRESS="ZENITH_ADDRESS_HERE" | ||
QUINCEY_URL="http://signer.url.here" | ||
BUILDER_PORT="8080" | ||
BUILDER_KEY="YOUR_BUILDER_KEY_HERE" | ||
INCOMING_TRANSACTIONS_BUFFER="10" | ||
BLOCK_CONFIRMATION_BUFFER="10" | ||
BUILDER_REWARDS_ADDRESS="BUILDER_REWARDS_ADDRESS_HERE" | ||
ROLLUP_BLOCK_GAS_LIMIT="30000000" | ||
# Transaction Pool Configs | ||
TX_POOL_URL="http://pool.url.here/" # trailing slash is required | ||
TX_POOL_POLL_INTERVAL="5" # seconds | ||
TX_POOL_CACHE_DURATION="600" # seconds | ||
``` | ||
|
||
## API | ||
|
||
### SignRequest | ||
|
||
Sign request example payload: | ||
This project requires Rust 1.82.0 or newer. | ||
|
||
```json | ||
{ | ||
"hostBlockNumber": "0x0", | ||
"hostChainId": "0x1", | ||
"ruChainId": "0x2", | ||
"gasLimit": "0x5", | ||
"ruRewardAddress": "0x0606060606060606060606060606060606060606", | ||
"contents": "0x0707070707070707070707070707070707070707070707070707070707070707" | ||
} | ||
``` | ||
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. |