Skip to content

zkparty/kzg-ceremony-sequencer

 
 

Repository files navigation

KZG Ceremony Rest API

lines of code dependency status codecov CI

This implements KZG Ceremony Specification.

The latest build is available as a container on ghcr.io/ethereum/kzg-ceremony-sequencer:

docker run ghcr.io/ethereum/kzg-ceremony-sequencer:latest

Setup

Generate keypair for signing

openssl genpkey -algorithm RSA -pkeyopt rsa_keygen_bits:3072 -out private.key
openssl rsa -in private.key -pubout -out publickey.pem

Build, lint, test, run

cargo fmt && cargo clippy --all-targets --all-features && cargo build --all-targets --all-features && cargo test --all-targets --all-features && cargo run -- -vvv

Database

  1. Run cargo install sqlx-cli
  2. Set DATABASE_URL=sqlite:/path/to/sequencer.db
  3. Run sqlx database create
  4. Migrations will be run automatically on server startup

Requirements

  • OAuth Client App : Currently we require users to sign in with either Ethereum or Github, which requires an OAuth client application that the user gives read access to their profile to.

  • Keypair generation algorithm : The sequencer signs JWTs that can be verified by external parties. Openssl is recommended.

Live URL

  • kzg-ceremony-poc.fly.dev
  • You can use the endpoint /hello_world to check that the server is running

Registering for Sign-in-with-Ethereum

See the documentation here.

To register, use the REST API:

curl -X POST https://oidc.signinwithethereum.org/register \
   -H 'Content-Type: application/json' \
   -d '{"redirect_uris": ["http://127.0.0.1:3000/auth/callback/eth"]}'
{
  "client_id": "9b49de48-d198-47e7-afff-7ee26cbcbc95",
  "client_secret": "...",
  "registration_access_token": "....",
  "registration_client_uri": "https://oidc.signinwithethereum.org/client/9b49de48-d198-47e7-afff-7ee26cbcbc95",
  "redirect_uris": [
    "http://127.0.0.1:3000/auth/callback/eth"
  ]
}
fly secrets set ETH_RPC_URL="..."
fly secrets set ETH_CLIENT_ID="..."
fly secrets set ETH_CLIENT_SECRET="..."
fly secrets set GH_CLIENT_ID="..."
fly secrets set GH_CLIENT_SECRET="..."
fly volumes create kzg_ceremony_sequencer_dev_data --size 5

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 99.1%
  • Dockerfile 0.9%