feat(api): constraints getter functions #4

namn-grg · 2024-09-20T13:05:37Z

This PR adds the following -

Implements the constraint getter fns in builder api
Changes the cache storage from ConstraintWithProofData to SignedConstraintWithProofData
Add checks during submit constraints
Add tests for constraints-api and getter fns

…straints

thedevbirb

Great job! Some minor comments

thedevbirb · 2024-09-23T07:29:45Z

crates/api/src/constraints/api.rs

+// TODO: Move this to appropriate place
+#[derive(Clone)]
+pub struct ConstraintsHandle {
+    pub(crate) constraints_tx: mpsc::Sender<ConstraintsMessage>, 
+}


Where would you like to put this?

On second thought I think this might be right place itself. lmk if any suggestions

thedevbirb · 2024-09-23T07:38:21Z

crates/api/src/relay_data/api.rs

+        // TODO: Return err if the slot is outside expiry bounds i.e. before an epoch
+        // For this we need a beacon state tracker
+        let slot = params as u64;


It makes sense to return an error in such case. Anyway, I'd consider to make the slot parameter optional (and reflect it in the docs), and when it is not sent we should consider the current slot (from the beacon state) the default one. It is most likely the most requested slot.

thedevbirb · 2024-09-23T07:39:18Z

crates/api/src/relay_data/api.rs

+    /// Implements this API: <https://chainbound.github.io/bolt-docs/api/relay#constraints-stream>
+    pub async fn constraints_stream(
+        Extension(data_api): Extension<Arc<DataApi<A, DB>>>,
+    ) -> Sse<impl Stream<Item = Result<Event, DataApiError>>> {
+        let constraints_rx = data_api.constraints_rx.read().await;

-    // pub async fn blocks_with_proofs() {
-    //     unimplemented!()
-    // }
+        let filtered = constraints_rx.map(|constraint| match serde_json::to_string(&constraint) {
+            Ok(json) => Ok(Event::default().data(json).event("constraint").retry(Duration::from_millis(50))),
+            Err(err) => {
+                warn!(error=%err, "Failed to serialize constraint");
+                Err(DataApiError::InternalServerError)
+            }
+        });
+
+        Sse::new(filtered).keep_alive(KeepAlive::default())
+    }


This is great and very short, however I have never implemented SSE in Rust. I have two questions:

can you please add some unit tests for this?

what did you use as a reference for this implementation?

Yes will add unit tests for this.

Referred this -
https://github.com/chainbound/dato/blob/1f6999dd01bf34698c926fde84373527c589b03e/src/client/api.rs#L138

merklefruit · 2024-09-23T07:49:27Z

crates/api/src/relay_data/api.rs

+    /// Implements this API: <https://chainbound.github.io/bolt-docs/api/relay#constraints-stream>
+    pub async fn constraints_stream(
+        Extension(data_api): Extension<Arc<DataApi<A, DB>>>,
+    ) -> Sse<impl Stream<Item = Result<Event, DataApiError>>> {
+        let constraints_rx = data_api.constraints_rx.read().await;

-    // pub async fn blocks_with_proofs() {
-    //     unimplemented!()
-    // }
+        let filtered = constraints_rx.map(|constraint| match serde_json::to_string(&constraint) {
+            Ok(json) => Ok(Event::default().data(json).event("constraint").retry(Duration::from_millis(50))),
+            Err(err) => {
+                warn!(error=%err, "Failed to serialize constraint");
+                Err(DataApiError::InternalServerError)
+            }
+        });
+
+        Sse::new(filtered).keep_alive(KeepAlive::default())
+    }
 }


How does this SSE stay open? I don't fully understand how long we are keeping the read() lock for when opening a stream. What happens if we want to write in the constraints while also streaming contents to clients?

Thanks for pointing out, resolved

namn-grg · 2024-09-23T11:24:45Z

Testing WIP

merklefruit · 2024-09-23T13:26:32Z

crates/api/src/relay_data/api.rs

 }

 impl<A: Auctioneer + 'static, DB: DatabaseService + 'static> DataApi<A, DB> {
    pub fn new(validator_preferences: Arc<ValidatorPreferences>, auctioneer:Arc<A>, db: Arc<DB>) -> (Self, ConstraintsHandle) {
-        let (constraints_tx, constraints_rx) = mpsc::channel(100); // Should we have buffer?
+        let (constraints_tx, constraints_rx ) = broadcast::channel(100); // Should we have buffer?


to address the comment, I would leave the channel to something like 128 constraint messages - it's not likely to ever get filled anyway

merklefruit · 2024-09-23T13:27:02Z

crates/api/src/relay_data/api.rs

+        let constraints_rx = data_api.constraints_rx.resubscribe();
+        let stream = BroadcastStream::new(constraints_rx);


crates/api/src/constraints/api.rs

…straints

notion-workspace · 2024-09-24T18:39:36Z

PBS Stack Update

feat(builder-api): delegations getter fn

merklefruit

Great job! Few nits

merklefruit · 2024-09-27T14:26:49Z

crates/api/src/builder/api.rs

+        let slot = slot.slot;
+        let head_slot = api.curr_slot_info.read().await.0;
+
+        if slot > head_slot || slot < head_slot - 32 {


shouldn't this be if slot < head_slot || slot > head_slot + 32 ?

Presumably we want to fetch the constraints for a future slot.

merklefruit · 2024-09-27T14:30:08Z

crates/api/src/builder/api.rs

+        let duty_bytes = api.proposer_duties_response.read().await.clone();
+        let proposer_duties: Vec<BuilderGetValidatorsResponse> = serde_json::from_slice(&duty_bytes.unwrap()).unwrap();


suggestion

let Some(duty_bytes) = api.proposer_duties_response.read().await else { return Err(...) } let Ok(proposer_duties) = serde_json::from_slice::<Vec<BuilderGetValidatorsResponse>>(duty_bytes) else { return Err(...) }

merklefruit · 2024-09-27T14:33:45Z

crates/api/src/builder/api.rs

+            Err(err) => {
+                match err {
+                    DatabaseError::ValidatorDelegationNotFound => {
+                        warn!("No delegations found for validator");


Suggested change

warn!("No delegations found for validator");

debug!("No delegations found for validator");

merklefruit · 2024-09-27T14:35:50Z

crates/api/src/builder/api.rs

        let mut tx_clone = payload.transactions().clone();
        let root = tx_clone.hash_tree_root().expect("failed to hash tree root");
        let root = root.to_vec().as_slice().try_into().expect("failed to convert to hash32");

        let proofs = payload.proofs().expect("proofs not found");
-        match verify_multiproofs(constraints, proofs, root) {
+        let constraints: Vec<ConstraintsWithProofData> = constraints.iter().map(|c| ConstraintsWithProofData {


should be able to avoid clone() inside by using into_iter()

If I use into_iter() and remove clone it still gives move occurs, copy trait not implemented

merklefruit · 2024-09-27T14:36:44Z

crates/api/src/builder/api.rs

        let mut tx_clone = payload.transactions().clone();
        let root = tx_clone.hash_tree_root().expect("failed to hash tree root");
        let root = root.to_vec().as_slice().try_into().expect("failed to convert to hash32");


Great workaround of the types :)

merklefruit · 2024-09-27T14:37:52Z

crates/api/src/builder/tests.rs

+
+    #[tokio::test]
+    #[serial]
+    async fn test_constraints_stream_ok() {


merklefruit · 2024-09-27T14:48:38Z

crates/api/src/constraints/api.rs

            ) {
                return Err(ConstraintsApiError::InvalidSignature);
            };

            // Once we support sending messages signed with correct validator pubkey on the sidecar, 
            // return error if invalid

-            let message = signed_constraints.message.clone();
+            let message = constraint.message.clone();


can probably do this and use slot below to avoid clone

Suggested change

let message = constraint.message.clone();

let slot = constraint.message.slot;

man I seriously need to start avoiding clone haha. I remember this was needed before but after making some changes to the verification part, I forgot to remove this clone.

merklefruit

lgtm, let's move on to testing on devnet

fix: return signed delegations

coderabbitai · 2024-10-02T10:00:10Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

namn-grg added 2 commits September 20, 2024 17:54

chore: add constraint handler

867a79a

Merge branch 'naman/feat/constraints-api-new' into naman/feat/get-con…

82106bd

…straints

namn-grg changed the title ~~feat(api): getter functions for constraints~~ feat(api): constraints getter functions Sep 20, 2024

feat: add constraints getter fn

4ddfa4e

namn-grg marked this pull request as ready for review September 23, 2024 07:01

thedevbirb reviewed Sep 23, 2024

View reviewed changes

merklefruit reviewed Sep 23, 2024

View reviewed changes

namn-grg added 2 commits September 23, 2024 14:15

chore: mpsc > broadcast

0fa9570

chore(data-api): state tracker

2ceb5f3

chore(data-api): undo optional slot number

35a643c

merklefruit reviewed Sep 23, 2024

View reviewed changes

namn-grg added 2 commits September 23, 2024 20:14

chore(constraints-api): store signed constraints in cache

aba52d7

chore(constraints-api): add check for max length

bbf5668

merklefruit reviewed Sep 23, 2024

View reviewed changes

crates/api/src/constraints/api.rs Outdated Show resolved Hide resolved

namn-grg added 4 commits September 24, 2024 10:15

Merge branch 'naman/feat/constraints-api-new' into naman/feat/get-con…

8dc7652

…straints

chore: constraint stream test wip

0becf35

feat(builder-api): constraints getter fn

0c08ab2

test(builder-api): constraints stream

3860774

feat: improvements and testing done

367a84a

namn-grg requested review from merklefruit and thedevbirb September 25, 2024 14:14

namn-grg and others added 6 commits September 26, 2024 14:33

test(constraint-api): add conflict test

d435e2f

feat(builder-api): delegations getter fn

4fd9fc3

test: delegations getter fn

3f115ab

misc: add comments

07f4c1f

fix: empty vec response

0e695e5

Merge pull request #5 from chainbound/naman/feat/get-delegations

e67a8f9

feat(builder-api): delegations getter fn

merklefruit requested changes Sep 27, 2024

View reviewed changes

namn-grg added 3 commits September 29, 2024 14:32

misc: address review

c06381a

fix: return signed delegations

7f9ba84

fix: docs link

e62763a

merklefruit approved these changes Oct 2, 2024

View reviewed changes

namn-grg added 2 commits October 2, 2024 15:28

misc: address review

657be93

Merge pull request #6 from chainbound/naman/fix/delegations

a2aa9c3

fix: return signed delegations

namn-grg merged commit 5b45570 into naman/feat/constraints-api-new Oct 3, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): constraints getter functions #4

feat(api): constraints getter functions #4

namn-grg commented Sep 20, 2024 •

edited

Loading

thedevbirb left a comment

thedevbirb Sep 23, 2024

namn-grg Sep 23, 2024

thedevbirb Sep 23, 2024

namn-grg Sep 23, 2024

thedevbirb Sep 23, 2024

namn-grg Sep 23, 2024

merklefruit Sep 23, 2024 •

edited

Loading

namn-grg Sep 23, 2024

namn-grg commented Sep 23, 2024

merklefruit Sep 23, 2024

merklefruit Sep 23, 2024

notion-workspace bot commented Sep 24, 2024

merklefruit left a comment

merklefruit Sep 27, 2024

namn-grg Sep 29, 2024

merklefruit Sep 27, 2024

namn-grg Sep 29, 2024

merklefruit Sep 27, 2024

merklefruit Sep 27, 2024

namn-grg Sep 29, 2024

merklefruit Sep 27, 2024

merklefruit Sep 27, 2024

merklefruit Sep 27, 2024

namn-grg Sep 29, 2024

namn-grg Sep 29, 2024

merklefruit left a comment

coderabbitai bot commented Oct 2, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

		let constraints_rx = data_api.constraints_rx.resubscribe();
		let stream = BroadcastStream::new(constraints_rx);

		let duty_bytes = api.proposer_duties_response.read().await.clone();
		let proposer_duties: Vec<BuilderGetValidatorsResponse> = serde_json::from_slice(&duty_bytes.unwrap()).unwrap();

	warn!("No delegations found for validator");
	debug!("No delegations found for validator");

	let message = constraint.message.clone();
	let slot = constraint.message.slot;

feat(api): constraints getter functions #4

feat(api): constraints getter functions #4

Conversation

namn-grg commented Sep 20, 2024 • edited Loading

thedevbirb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

merklefruit Sep 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

namn-grg commented Sep 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

notion-workspace bot commented Sep 24, 2024

merklefruit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

merklefruit left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Oct 2, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

namn-grg commented Sep 20, 2024 •

edited

Loading

merklefruit Sep 23, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)