Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(repo): general cleanup #65

Merged
merged 3 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*: @Evalir @prestwich @dylanlott
abi/: @anna-carroll
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🦀


.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 && @crago +nightly fmt --all
Evalir marked this conversation as resolved.
Show resolved Hide resolved
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 & utilites for working with [Zenith](https://github.com/init4tech/zenith).
Evalir marked this conversation as resolved.
Show resolved Hide resolved

![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.