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

Add streaming endpoints to executiondata api #1275

Merged
merged 7 commits into from
Apr 7, 2023

Conversation

peterargue
Copy link
Contributor

Closes: #???

Description


For contributor use:

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@peterargue peterargue force-pushed the petera/add-streaming-exec-data-proto branch from 10cdee2 to 4ecca7d Compare March 10, 2023 00:44
@@ -6,6 +6,9 @@ option go_package = "github.com/onflow/flow/protobuf/go/flow/access";
option java_package = "org.onflow.protobuf.access";

import "flow/entities/block_execution_data.proto";
import "flow/entities/block_header.proto";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unused?

@@ -25,4 +34,34 @@ message GetExecutionDataByBlockIDRequest {

message GetExecutionDataByBlockIDResponse {
entities.BlockExecutionData block_execution_data = 1;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file would need way more comments since it would likely be documentation entry point.
A good example of the documentation is google public apis: https://github.com/googleapis/googleapis/blob/master/google/spanner/v1/spanner.proto

Comment on lines 40 to 41
bytes start_block_id = 1;
uint64 start_block_height = 2;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may want to describe precedence of arguments and the behaviour when both of them are zero

Comment on lines 63 to 66
message EventFilter {
repeated string event_type = 1;
repeated string address = 2;
repeated string contract = 3;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For people with a lack of context you may give a couple of examples of filters to highlight that they are OR'ed.

Copy link
Contributor

@koko1123 koko1123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all the documentation!

@peterargue peterargue merged commit 727d541 into master Apr 7, 2023
@peterargue peterargue deleted the petera/add-streaming-exec-data-proto branch April 7, 2023 00:50
bors bot added a commit to onflow/flow-go that referenced this pull request Apr 10, 2023
3723: [Access] Add streaming API for BlockExecutionData r=peterargue a=peterargue

Implement streaming gRPC APIs for `BlockExecutionData` and events.

Protobuf: onflow/flow#1275
FLIP: onflow/flips#73

Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com>
peterargue added a commit to onflow/flow-go that referenced this pull request Apr 11, 2023
3723: [Access] Add streaming API for BlockExecutionData r=peterargue a=peterargue

Implement streaming gRPC APIs for `BlockExecutionData` and events.

Protobuf: onflow/flow#1275
FLIP: onflow/flips#73

Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com>
peterargue added a commit to peterargue/flow-go that referenced this pull request Apr 13, 2023
3723: [Access] Add streaming API for BlockExecutionData r=peterargue a=peterargue

Implement streaming gRPC APIs for `BlockExecutionData` and events.

Protobuf: onflow/flow#1275
FLIP: onflow/flips#73

Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com>
peterargue added a commit to onflow/flow-go that referenced this pull request May 18, 2023
3723: [Access] Add streaming API for BlockExecutionData r=peterargue a=peterargue

Implement streaming gRPC APIs for `BlockExecutionData` and events.

Protobuf: onflow/flow#1275
FLIP: onflow/flips#73

Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com>
peterargue added a commit to onflow/flow-go that referenced this pull request May 19, 2023
3723: [Access] Add streaming API for BlockExecutionData r=peterargue a=peterargue

Implement streaming gRPC APIs for `BlockExecutionData` and events.

Protobuf: onflow/flow#1275
FLIP: onflow/flips#73

Co-authored-by: Peter Argue <89119817+peterargue@users.noreply.github.com>
@treethought treethought mentioned this pull request Jul 22, 2023
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants