feat: readme and actions

Author: rswanson

.github/workflows/ecr-cd.yml

@@ -0,0 +1,24 @@
+name: Docker ECR Push
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+
+permissions:
+  packages: write
+  contents: read
+  id-token: write
+
+# simplest example of using the rust-base action
+jobs:
+  docker-ecr-push:
+    uses: init4tech/actions/.github/workflows/ecr-build-and-push.yml@main
+    with:
+      rust-binary-name: zenith-builder-example
+      environment: dev
+    secrets:
+      aws-ecr-repository: ${{ secrets.AWS_ECR_REPOSITORY }}
+      aws-eks-cluster: ${{ secrets.AWS_EKS_CLUSTER }}
+      aws-ecr-deployer-role-arn: ${{ secrets.AWS_ECR_DEPLOYER_ROLE_ARN }}

.github/workflows/rust-ci.yml

@@ -0,0 +1,11 @@
+name: Rust CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+# simplest example of using the rust-base action
+jobs:
+  rust-base:
+    uses: init4tech/actions/.github/workflows/rust-base.yml@main

Dockerfile

@@ -0,0 +1,38 @@
+# syntax=docker/dockerfile:1.7-labs
+### STAGE 0: Create base chef image for building
+### cargo chef is used to speed up the build process by caching dependencies using docker
+FROM --platform=$TARGETPLATFORM lukemathwalker/cargo-chef:latest-rust-latest as chef
+
+RUN cargo install cargo-chef
+
+WORKDIR /app
+
+### Stage 1: cargo chef prepare
+### Creates the recipe.json file which is a manifest of Cargo.toml files and 
+### the relevant Cargo.lock file
+FROM chef as planner
+COPY --exclude=target . .
+RUN cargo chef prepare
+
+### Stage 2: Build the project
+### This stage builds the deps of the project (not the code) using cargo chef cook
+### and then it copies the source code and builds the actual crates
+### this takes advantage of docker layer caching to the max
+FROM chef as builder
+COPY --from=planner /app/recipe.json recipe.json
+RUN apt-get update && apt-get -y upgrade && apt-get install -y gcc libclang-dev pkg-config libssl-dev
+RUN rustup target add x86_64-unknown-linux-gnu 
+RUN rustup toolchain install stable-x86_64-unknown-linux-gnu
+
+RUN cargo chef cook --release --target x86_64-unknown-linux-gnu --recipe-path recipe.json --bin zenith-builder-example 
+COPY --exclude=target . .
+
+RUN cargo build --release --target x86_64-unknown-linux-gnu --bin zenith-builder-example
+
+# Stage 3: Final image for running in the env
+FROM --platform=$TARGETPLATFORM debian:bookworm-slim
+RUN apt-get update && apt-get -y upgrade && apt-get install -y libssl-dev ca-certificates 
+
+COPY --from=builder /app/target/x86_64-unknown-linux-gnu/release/zenith-builder-example /usr/local/bin/zenith-builder-example
+
+ENTRYPOINT [ "/usr/local/bin/zenith-builder-example" ]

README.md

@@ -1 +1,53 @@
-# builder
+# builder
+
+Our sample signet builder implementation.
+
+## Development
+
+This crate contains an example block builder in the Signet ecosystem.
+
+### Requirements
+
+- Rust 1.81.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:
+
+```json
+{
+  "hostBlockNumber": "0x0",
+  "hostChainId": "0x1",
+  "ruChainId": "0x2",
+  "gasLimit": "0x5",
+  "ruRewardAddress": "0x0606060606060606060606060606060606060606",
+  "contents": "0x0707070707070707070707070707070707070707070707070707070707070707"
+}
+```