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

feat: added OpenAPI docs #36

Merged
merged 2 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
218 changes: 217 additions & 1 deletion registry/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions registry/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ tracing-subscriber = { version = "0.3.19", features = ["env-filter", "fmt"] }

# web
reqwest = { version = "0.12", features = ["json", "stream"] }
tower-http = { version = "0.6.2", features = ["cors", "trace", "timeout"] }
axum = "0.8.1"

# db
Expand All @@ -42,6 +43,11 @@ beacon-api-client = { git = "https://github.com/ralexstokes/ethereum-consensus",
bls = { git = "https://github.com/sigp/lighthouse", tag = "v6.0.1", features = ["supranational"] }
sha2 = { version = "0.10", features = ["asm"] }

# docs
utoipa-axum = "0.2.0"
utoipa = { version = "5.3.1", features = ["axum_extras"] }
utoipa-swagger-ui = { version = "9.0.0", features = ["axum"] }

# types
url = { version = "2.5.4", features = ["serde"] }
serde = { version = "1.0", features = ["derive"] }
Expand Down
9 changes: 2 additions & 7 deletions registry/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,5 @@ db_url = "postgres://boltadmin:$PASSWORD@remotebeast:5412/bolt_registry"
# Beacon node connection
beacon_url = "http://remotebeast:44400"

# Data sources
# These data sources take precedence over the registry. Their values are canonical.
#
# Lido CCCP through the keysAPI:
[sources.lido]
type = "kapi"
base_url = "http://34.88.187.80:30303/v1/preconfs/lido-bolt/validators"
# Lido keys API
keys_api_url = "http://34.88.187.80:30303/v1/preconfs/lido-bolt/validators"
8 changes: 8 additions & 0 deletions registry/justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
default:
@just --list --unsorted

# Run the development server locally
dev loglevel='debug':
@echo "Starting bolt-registry in development mode with loglevel: {{loglevel}}"
RUST_LOG=bolt_registry={{loglevel}} cargo watch -x run

Loading
Loading