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

Prysm v4 - mark old endpoints for deprecation #11997

Merged
merged 26 commits into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ea973a5
updating some protos
james-prysm Feb 15, 2023
6dc38a5
updating proto endpoints
james-prysm Feb 15, 2023
f366937
updating generated code
james-prysm Feb 15, 2023
678645f
fixing linting
james-prysm Feb 15, 2023
51728ee
updating protos
james-prysm Feb 21, 2023
e4890f5
updating based on feedback. also removing unused storage protos
james-prysm Feb 21, 2023
3f836b0
Merge branch 'develop' into deprecate-old-endpoints
james-prysm Feb 21, 2023
c1d98ae
adding in deprecation notice on the server functions
james-prysm Feb 21, 2023
fb35cce
Merge branch 'develop' into deprecate-old-endpoints
james-prysm Feb 21, 2023
2ff4025
Update proto/prysm/v1alpha1/beacon_chain.proto
james-prysm Feb 22, 2023
8b5f53e
Update proto/prysm/v1alpha1/beacon_chain.proto
james-prysm Feb 22, 2023
95d7782
Update proto/prysm/v1alpha1/health.proto
james-prysm Feb 22, 2023
ded5cfb
Update proto/prysm/v1alpha1/validator.proto
james-prysm Feb 22, 2023
746ef7d
Update proto/prysm/v1alpha1/debug.proto
james-prysm Feb 22, 2023
59f2649
Update proto/eth/v1/beacon_chain.proto
james-prysm Feb 22, 2023
d87088b
Update proto/prysm/v1alpha1/health.proto
james-prysm Feb 22, 2023
f37acdc
Update proto/eth/service/beacon_chain_service.proto
james-prysm Feb 22, 2023
3d51b52
Update proto/eth/service/beacon_chain_service.proto
james-prysm Feb 22, 2023
ed96394
Update proto/eth/service/beacon_chain_service.proto
james-prysm Feb 22, 2023
4ea0747
addressing feedback
james-prysm Feb 22, 2023
9a6cd03
rewording comment
james-prysm Feb 22, 2023
c64beee
Merge branch 'develop' into deprecate-old-endpoints
james-prysm Feb 22, 2023
0478945
updating comments
james-prysm Feb 22, 2023
9a40687
Merge branch 'develop' into deprecate-old-endpoints
james-prysm Feb 23, 2023
ed50d99
Merge refs/heads/develop into deprecate-old-endpoints
prylabs-bulldozer[bot] Feb 23, 2023
479b9d7
Merge refs/heads/develop into deprecate-old-endpoints
prylabs-bulldozer[bot] Feb 23, 2023
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
703 changes: 358 additions & 345 deletions proto/eth/service/beacon_chain_service.pb.go

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion proto/eth/service/beacon_chain_service.pb.gw.go

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

7 changes: 7 additions & 0 deletions proto/eth/service/beacon_chain_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ service BeaconChain {

// GetWeakSubjectivity is a new proposed endpoint to retrieve the details necessary to download
// the ssz data needed to start a beacon node - checkpoint(epoch + block_root) and state_root
// DEPRECATED: GetWeakSubjectivity endpoint will no longer be supported
rpc GetWeakSubjectivity(google.protobuf.Empty) returns (v1.WeakSubjectivityResponse) {
option deprecated = true;
option (google.api.http) = { get: "/internal/eth/v1/beacon/weak_subjectivity" };
}

Expand Down Expand Up @@ -186,6 +188,7 @@ service BeaconChain {
//
// Spec: https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.3.0#/Beacon/publishBlock
rpc SubmitBlockSSZ(v2.SSZContainer) returns (google.protobuf.Empty) {
option deprecated = true;
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
option (google.api.http) = {
post: "/internal/eth/v1/beacon/blocks/ssz"
body: "*"
Expand Down Expand Up @@ -240,7 +243,9 @@ service BeaconChain {
// GetBlock retrieves block details for given block id.
//
// Spec: https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.3.0#/Beacon/getBlock
// DEPRECATED: GetBlock is deprecated in favor of GetBlockV2
rpc GetBlock(v1.BlockRequest) returns (v1.BlockResponse) {
option deprecated = true;
option (google.api.http) = {
get: "/internal/eth/v1/beacon/blocks/{block_id}"
};
Expand All @@ -249,7 +254,9 @@ service BeaconChain {
// GetBlockSSZ returns the SSZ-serialized version of block details for given block id.
//
// Spec: https://ethereum.github.io/beacon-APIs/?urls.primaryName=v2.3.0#/Beacon/getBlock
// DEPRECATED: GetBlockSSZ is deprecated in favor of GetBlockV2SSZ
rpc GetBlockSSZ(v1.BlockRequest) returns (v1.BlockSSZResponse) {
option deprecated = true;
option (google.api.http) = {
get: "/internal/eth/v1/beacon/blocks/{block_id}/ssz"
};
Expand Down
2 changes: 1 addition & 1 deletion proto/eth/service/beacon_debug_service.pb.gw.go

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

250 changes: 126 additions & 124 deletions proto/eth/v1/beacon_chain.pb.go

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions proto/eth/v1/beacon_chain.proto
Original file line number Diff line number Diff line change
Expand Up @@ -293,11 +293,15 @@ message DepositContract {
string address = 2;
}

// DEPRECATED: GetWeakSubjectivity endpoint will no longer be supported
message WeakSubjectivityResponse {
option deprecated = true;
WeakSubjectivityData data = 1;
}

// DEPRECATED: GetWeakSubjectivity endpoint will no longer be supported
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
message WeakSubjectivityData {
option deprecated = true;
ethereum.eth.v1.Checkpoint ws_checkpoint = 1;
bytes state_root = 2;
}
Expand Down
1,681 changes: 849 additions & 832 deletions proto/prysm/v1alpha1/beacon_chain.pb.go

Large diffs are not rendered by default.

13 changes: 12 additions & 1 deletion proto/prysm/v1alpha1/beacon_chain.proto
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ option php_namespace = "Ethereum\\Eth\\v1alpha1";
//
// The beacon chain API can be used to access data relevant to the Ethereum Beacon Chain.
service BeaconChain {
// TODO(preston): Batch requests?

// Retrieve attestations by block root, slot, or epoch.
//
Expand Down Expand Up @@ -62,15 +61,19 @@ service BeaconChain {

// Server-side stream of attestations as they are received by
// the beacon chain node.
// DEPRECATED: This endpoint is superseded by the /eth/v1/events Beacon API endpoint, there is an internal GRPC endpoint /internal/eth/v1/events
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
rpc StreamAttestations(google.protobuf.Empty) returns (stream Attestation) {
option deprecated = true;
option (google.api.http) = {
get: "/eth/v1alpha1/beacon/attestations/stream"
};
}

// Server-side stream of indexed attestations as they are received by
// the beacon chain node.
// DEPRECATED: This endpoint is superseded by the /eth/v1/events Beacon API endpoint, there is an internal GRPC endpoint /internal/eth/v1/events
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
rpc StreamIndexedAttestations(google.protobuf.Empty) returns (stream IndexedAttestation) {
option deprecated = true;
option (google.api.http) = {
get: "/eth/v1alpha1/beacon/attestations/indexed/stream"
};
Expand Down Expand Up @@ -106,7 +109,9 @@ service BeaconChain {

// Server-side stream of all signed blocks as they are received by
// the beacon chain node.
// DEPRECATED: This endpoint is superseded by the /eth/v1/events Beacon API endpoint, there is an internal GRPC endpoint /internal/eth/v1/events
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
rpc StreamBlocks(StreamBlocksRequest) returns (stream SignedBeaconBlock) {
option deprecated = true;
option (google.api.http) = {
get: "/eth/v1alpha1/beacon/blocks/stream"
};
Expand All @@ -117,7 +122,9 @@ service BeaconChain {
//
// This includes the head block slot and root as well as information about
// the most recent finalized and justified slots.
// DEPRECATED: This endpoint is superseded by the /eth/v1/events Beacon API endpoint, there is an internal GRPC endpoint /internal/eth/v1/events
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
rpc StreamChainHead(google.protobuf.Empty) returns (stream ChainHead) {
option deprecated = true;
option (google.api.http) = {
get: "/eth/v1alpha1/beacon/chainhead/stream"
};
Expand Down Expand Up @@ -232,7 +239,9 @@ service BeaconChain {
}

// Server-side stream of validator information at each epoch.
// DEPRECATED: This endpoint is superseded by the /eth/v1/events Beacon API endpoint, there is an internal GRPC endpoint /internal/eth/v1/events
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
rpc StreamValidatorsInfo(stream ValidatorChangeSet) returns (stream ValidatorInfo) {
option deprecated = true;
option (google.api.http) = {
get: "/eth/v1alpha1/beacon/validators/info/stream"
};
Expand Down Expand Up @@ -271,7 +280,9 @@ enum SetAction {
}

// ValidatorChangeSet updates the server's list of keys on which to operate.
// DEPRECATED: This message's endpoint is superseded by the /eth/v1/events Beacon API endpoint, there is an internal GRPC endpoint /internal/eth/v1/events
james-prysm marked this conversation as resolved.
Show resolved Hide resolved
message ValidatorChangeSet {
option deprecated = true;
// Action (add/remove/set).
SetAction action = 1;

Expand Down
36 changes: 20 additions & 16 deletions proto/prysm/v1alpha1/debug.pb.go

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

2 changes: 2 additions & 0 deletions proto/prysm/v1alpha1/debug.proto
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ service Debug {
};
}
// Returns the inclusion slot of a given attester id and slot.
// DEPRECATED: This endpoint doesn't appear to be used and have been marked for deprecation.
rpc GetInclusionSlot(InclusionSlotRequest) returns (InclusionSlotResponse) {
option deprecated = true;
option (google.api.http) = {
get: "/eth/v1alpha1/debug/inclusion"
};
Expand Down
Loading