Skip to content

Commit

Permalink
docs(constraints-api): fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
thedevbirb committed Nov 7, 2024
1 parent b7b2dae commit c0f520f
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
8 changes: 4 additions & 4 deletions crates/api/src/builder/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ where

/// This endpoint returns a list of signed constraints for a given `slot`.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/relay#constraints>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/relay#constraints>
pub async fn constraints(
Extension(api): Extension<Arc<BuilderApi<A, DB, S, G>>>,
Query(slot): Query<SlotQuery>,
Expand Down Expand Up @@ -230,7 +230,7 @@ where

/// This endpoint returns a stream of signed constraints for a given `slot`.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/relay#constraints-stream>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/relay#constraints-stream>
pub async fn constraints_stream(
Extension(api): Extension<Arc<BuilderApi<A, DB, S, G>>>,
) -> Sse<impl Stream<Item = Result<Event, BuilderApiError>>> {
Expand Down Expand Up @@ -260,7 +260,7 @@ where
/// This endpoint returns the active delegations for the validator scheduled to propose
/// at the provided `slot`. The delegations are returned as a list of BLS pubkeys.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/relay#delegations>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/relay#delegations>
pub async fn delegations(
Extension(api): Extension<Arc<BuilderApi<A, DB, S, G>>>,
Query(slot): Query<SlotQuery>,
Expand Down Expand Up @@ -528,7 +528,7 @@ where
/// 6. Simulates the block to validate the payment.
/// 7. Saves the bid and inclusion proof to the auctioneer.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/relay#blocks_with_proofs>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/relay#blocks_with_proofs>
pub async fn submit_block_with_proofs(
Extension(api): Extension<Arc<BuilderApi<A, DB, S, G>>>,
req: Request<Body>,
Expand Down
6 changes: 3 additions & 3 deletions crates/api/src/constraints/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ where

/// Handles the submission of batch of signed constraints.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/builder#constraints>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/builder#constraints>
pub async fn submit_constraints(
Extension(api): Extension<Arc<ConstraintsApi<A, DB>>>,
req: Request<Body>,
Expand Down Expand Up @@ -195,7 +195,7 @@ where

/// Handles delegating constraint submission rights to another BLS key.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/builder#delegate>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/builder#delegate>
pub async fn delegate(
Extension(api): Extension<Arc<ConstraintsApi<A, DB>>>,
req: Request<Body>,
Expand Down Expand Up @@ -269,7 +269,7 @@ where

/// Handles revoking constraint submission rights from a BLS key.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/builder#revoke>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/builder#revoke>
pub async fn revoke(
Extension(api): Extension<Arc<ConstraintsApi<A, DB>>>,
req: Request<Body>,
Expand Down
2 changes: 1 addition & 1 deletion crates/api/src/proposer/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ where
///
/// The function returns a JSON response containing the best bid and inclusion proofs if found.
///
/// Implements this API: <https://docs.boltprotocol.xyz/api/builder#get_header_with_proofs>
/// Implements this API: <https://docs.boltprotocol.xyz/technical-docs/api/builder#get_header_with_proofs>
pub async fn get_header_with_proofs(
Extension(proposer_api): Extension<Arc<ProposerApi<A, DB, M, G>>>,
headers: HeaderMap,
Expand Down
2 changes: 1 addition & 1 deletion crates/common/src/bid_submission/submission.rs
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ pub struct SignedBidSubmissionDeneb {
pub blobs_bundle: BlobsBundle,
pub signature: BlsSignature,
/// The Merkle proofs of inclusion as needed by the Constraints API.
/// Reference: <https://docs.boltprotocol.xyz/api/builder#get_header_with_proofs>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/builder#get_header_with_proofs>
#[serde(skip_serializing_if = "Option::is_none")]
pub proofs: Option<InclusionProofs>,
}
18 changes: 9 additions & 9 deletions crates/common/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -283,23 +283,23 @@ pub enum Route {
BuilderBidsReceived,
ValidatorRegistration,

// Constraints API: Builder <https://docs.boltprotocol.xyz/api/builder>
/// Reference: <https://docs.boltprotocol.xyz/api/builder#constraints>
// Constraints API: Builder <https://docs.boltprotocol.xyz/technical-docs/api/builder>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/builder#constraints>
SubmitBuilderConstraints,
/// Reference: <https://docs.boltprotocol.xyz/api/builder#delegate>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/builder#delegate>
DelegateSubmissionRights,
/// Reference: <https://docs.boltprotocol.xyz/api/builder#revoke>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/builder#revoke>
RevokeSubmissionRights,
/// Reference: <https://docs.boltprotocol.xyz/api/builder#get_header_with_proofs>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/builder#get_header_with_proofs>
GetHeaderWithProofs,

// Constraints API: Relay <https://docs.boltprotocol.xyz/api/relay>
/// Reference: <https://docs.boltprotocol.xyz/api/relay#constraints>
// Constraints API: Relay <https://docs.boltprotocol.xyz/technical-docs/api/relay>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/relay#constraints>
GetBuilderConstraints,
/// Reference: <https://docs.boltprotocol.xyz/api/relay#constraints_stream>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/relay#constraints_stream>
GetBuilderConstraintsStream,
GetBuilderDelegations,
/// Reference: <https://docs.boltprotocol.xyz/api/relay#blocks_with_proofs>
/// Reference: <https://docs.boltprotocol.xyz/technical-docs/api/relay#blocks_with_proofs>
SubmitBlockWithProofs,
}

Expand Down

0 comments on commit c0f520f

Please sign in to comment.