Skip to content

Commit

Permalink
chore(repo): general cleanup (#65)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
Evalir authored Nov 25, 2024
1 parent c5e2c9e commit 083d598
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 58 deletions.
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*: @Evalir @prestwich @dylanlott
abi/: @anna-carroll
.github/: @rswanson
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ description = "Types for the zenith smart contracts"

version = "0.10.1"
edition = "2021"
rust-version = "1.81"
rust-version = "1.82"
authors = ["Zenith Contributors"]
homepage = "https://github.com/init4tt/zenith"
repository = "https://github.com/init4tt/zenith"
homepage = "https://github.com/init4tech/zenith"
repository = "https://github.com/init4tech/zenith"
license = "AGPL-3.0"

[dependencies]
Expand Down
7 changes: 5 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ test:

.PHONY: fmt
fmt:
@cargo fmt --all
@cargo +nightly fmt --all

.PHONY: clippy
clippy:
@cargo clippy --all-targets --all-features --workspace -- -D warnings
@cargo clippy --all-targets --all-features -D warnings

tidy:
@cargo clippy --all-targets --all-features -D warnings && cargo +nightly fmt --all
55 changes: 3 additions & 52 deletions README.md
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 & utilities 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.
2 changes: 1 addition & 1 deletion clippy.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
msrv = "1.76"
msrv = "1.82"
too-large-for-stack = 128

0 comments on commit 083d598

Please sign in to comment.