feat: add RPCs to support new slashing data entities (#33)

Author: seanmcgary

.gitignore

@@ -1,7 +1,8 @@
 .idea
 .DS_Store
-*.sw*
 node_modules
 !gen
 /buf-plugin-openapi/bin
 /openapi-debug.log
+/submodules
+!/submodules/README.md

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "protos/protobuf-libs"]
+	path = protos/protobuf-libs
+	url = https://github.com/Layr-Labs/protobuf-libs.git
+[submodule "submodules/protobuf-libs"]
+	path = submodules/protobuf-libs
+	url = https://github.com/Layr-Labs/protobuf-libs.git

Makefile

@@ -21,8 +21,8 @@ deps/go:
 	npm install
 
 pre-build:
-	cd protocol-apis-annotations && make proto
-	cd buf-plugin-openapi && make install
+	git submodule update --init --recursive
+	cd buf-plugin-openapi && make clean install
 
 .PHONY: proto
 proto: pre-build

buf-plugin-openapi/go.mod

@@ -3,11 +3,11 @@ module github.com/Layr-Labs/buf-plugin-openapi
 go 1.23.6
 
 require (
-	github.com/Layr-Labs/protocol-apis-annotations v0.0.0-00010101000000-000000000000
 	google.golang.org/genproto/googleapis/api v0.0.0-20240123012728-ef4313101c80
 	google.golang.org/protobuf v1.36.5
 )
 
-require google.golang.org/genproto v0.0.0-20240123012728-ef4313101c80 // indirect
-
-replace github.com/Layr-Labs/protocol-apis-annotations => ../protocol-apis-annotations
+require (
+	github.com/Layr-Labs/protobuf-libs v0.0.0-20250305032038-8d1047b56aab // indirect
+	google.golang.org/genproto v0.0.0-20240123012728-ef4313101c80 // indirect
+)

buf-plugin-openapi/go.sum

@@ -1,3 +1,5 @@
+github.com/Layr-Labs/protobuf-libs v0.0.0-20250305032038-8d1047b56aab h1:O3mHv0TxACM+575aVjPRwPOd7Ygf4CAmZmNWs/2zjaA=
+github.com/Layr-Labs/protobuf-libs v0.0.0-20250305032038-8d1047b56aab/go.mod h1:xc4NKuzjHpf6Xr9EnI7r6Uc99B1it1bkzQH6kJvhtW4=
 github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=

buf-plugin-openapi/main.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 	"unicode"
 
-	openapiAnnotations "github.com/Layr-Labs/protocol-apis-annotations/protos/annotations"
+	openapiAnnotations "github.com/Layr-Labs/protobuf-libs/protos/eigenlayer/lib/annotations"
 	"google.golang.org/genproto/googleapis/api/annotations"
 	"google.golang.org/protobuf/compiler/protogen"
 	"google.golang.org/protobuf/proto"
@@ -219,10 +219,10 @@ func main() {
 			// Add tag if not seen before
 			if !seenTags[moduleTag] {
 				seenTags[moduleTag] = true
-				allPathsSpec.Tags = append(allPathsSpec.Tags, Tag{
-					Name:        moduleTag,
-					Description: fmt.Sprintf("Operations from package %s", moduleTag),
-				})
+				// allPathsSpec.Tags = append(allPathsSpec.Tags, Tag{
+				// 	Name:        moduleTag,
+				// 	Description: fmt.Sprintf("Operations from package %s", moduleTag),
+				// })
 			}
 
 			// Process all services in the file
@@ -231,10 +231,10 @@ func main() {
 				serviceTag := fmt.Sprintf("%s/%s", moduleTag, strings.ToLower(service.GoName))
 				if !seenTags[serviceTag] {
 					seenTags[serviceTag] = true
-					allPathsSpec.Tags = append(allPathsSpec.Tags, Tag{
-						Name:        serviceTag,
-						Description: fmt.Sprintf("Operations for service %s", service.GoName),
-					})
+					// allPathsSpec.Tags = append(allPathsSpec.Tags, Tag{
+					// 	Name:        serviceTag,
+					// 	Description: fmt.Sprintf("Operations for service %s", service.GoName),
+					// })
 				}
 
 				for _, method := range service.Methods {
@@ -261,7 +261,7 @@ func main() {
 						Summary:     method.GoName,
 						Description: extractLeadingComments(method),
 						OperationID: fmt.Sprintf("%s_%s", service.GoName, method.GoName),
-						Tags:        []string{moduleTag, serviceTag},
+						Tags:        []string{moduleTag}, // []string{moduleTag, serviceTag},
 						Responses: map[string]Response{
 							"200": {
 								Description: "Successful response",
@@ -281,7 +281,7 @@ func main() {
 						if isPublicVal != nil {
 							isPublic = isPublicVal.(bool)
 							if isPublic {
-								operation.Tags = append(operation.Tags, "public_rpc")
+								//operation.Tags = append(operation.Tags, "public_rpc")
 							}
 						}
 					}
@@ -342,10 +342,10 @@ func main() {
 						}
 						if !seenPublicTags[serviceTag] {
 							seenPublicTags[serviceTag] = true
-							publicPathsSpec.Tags = append(publicPathsSpec.Tags, Tag{
-								Name:        serviceTag,
-								Description: fmt.Sprintf("Operations for service %s", service.GoName),
-							})
+							// publicPathsSpec.Tags = append(publicPathsSpec.Tags, Tag{
+							// 	Name:        serviceTag,
+							// 	Description: fmt.Sprintf("Operations for service %s", service.GoName),
+							// })
 						}
 
 						// Add operation to publicPathsSpec

buf.gen.yaml

@@ -6,8 +6,24 @@ plugins:
   - plugin: go
     out: gen/protos
     opt: paths=source_relative
-
-  # Then generate the OpenAPI spec
+  - plugin: go-grpc
+    out: gen/protos
+    opt: paths=source_relative,require_unimplemented_servers=false
+  - plugin: grpc-gateway
+    out: gen/protos
+    opt: paths=source_relative
+  - plugin: openapiv2
+    out: gen/openapiv2
+    opt: allow_merge=true,merge_file_name=apidocs
+    strategy: all
+    # https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/#merging-output
+  - plugin: grpc-gateway-ts
+    out: gen/api-ts
+  - name: gateway-client
+    path: protoc-gen-grpc-gateway-client
+    out: gen/protos
+    opt:
+      - paths=source_relative
   - plugin: buf-plugin-openapi
     out: gen/openapi
     strategy: all

buf.work.yaml

@@ -1,4 +1,4 @@
 version: v1
 directories:
-  - protocol-apis-annotations/protos
+  - submodules/protobuf-libs/protos
   - protos

gen/api-ts/eigenlayer/sidecar/v1/events/events.pb.ts

@@ -4,7 +4,6 @@
 * This file is a generated Typescript file for GRPC Gateway, DO NOT MODIFY
 */
 
-import * as fm from "../../../../fetch.pb"
 import * as EigenlayerSidecarV1EigenStateEigenState from "../eigenState/eigenState.pb"
 import * as EigenlayerSidecarV1EthereumTypesEthereumTypes from "../ethereumTypes/ethereumTypes.pb"
 
@@ -50,13 +49,4 @@ export type StreamIndexedBlocksResponse = {
   block?: EigenlayerSidecarV1EthereumTypesEthereumTypes.Block
   stateRoot?: EigenlayerSidecarV1EigenStateEigenState.StateRoot
   changes?: EigenlayerSidecarV1EigenStateEigenState.EigenStateChange[]
-}
-
-export class Events {
-  static StreamEigenStateChanges(req: StreamEigenStateChangesRequest, entityNotifier?: fm.NotifyStreamEntityArrival<StreamEigenStateChangesResponse>, initReq?: fm.InitReq): Promise<void> {
-    return fm.fetchStreamingRequest<StreamEigenStateChangesRequest, StreamEigenStateChangesResponse>(`/events/v1/stream-eigen-state-changes`, entityNotifier, {...initReq, method: "POST", body: JSON.stringify(req, fm.replacer)})
-  }
-  static StreamIndexedBlocks(req: StreamIndexedBlocksRequest, entityNotifier?: fm.NotifyStreamEntityArrival<StreamIndexedBlocksResponse>, initReq?: fm.InitReq): Promise<void> {
-    return fm.fetchStreamingRequest<StreamIndexedBlocksRequest, StreamIndexedBlocksResponse>(`/events/v1/stream-indexed-blocks`, entityNotifier, {...initReq, method: "POST", body: JSON.stringify(req, fm.replacer)})
-  }
 }

gen/api-ts/eigenlayer/sidecar/v1/events/rpc.pb.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+// @ts-nocheck
+/*
+* This file is a generated Typescript file for GRPC Gateway, DO NOT MODIFY
+*/
+
+import * as fm from "../../../../fetch.pb"
+import * as EigenlayerSidecarV1EventsEvents from "./events.pb"
+export class Events {
+  static StreamEigenStateChanges(req: EigenlayerSidecarV1EventsEvents.StreamEigenStateChangesRequest, entityNotifier?: fm.NotifyStreamEntityArrival<EigenlayerSidecarV1EventsEvents.StreamEigenStateChangesResponse>, initReq?: fm.InitReq): Promise<void> {
+    return fm.fetchStreamingRequest<EigenlayerSidecarV1EventsEvents.StreamEigenStateChangesRequest, EigenlayerSidecarV1EventsEvents.StreamEigenStateChangesResponse>(`/events/v1/stream-eigen-state-changes`, entityNotifier, {...initReq, method: "POST", body: JSON.stringify(req, fm.replacer)})
+  }
+  static StreamIndexedBlocks(req: EigenlayerSidecarV1EventsEvents.StreamIndexedBlocksRequest, entityNotifier?: fm.NotifyStreamEntityArrival<EigenlayerSidecarV1EventsEvents.StreamIndexedBlocksResponse>, initReq?: fm.InitReq): Promise<void> {
+    return fm.fetchStreamingRequest<EigenlayerSidecarV1EventsEvents.StreamIndexedBlocksRequest, EigenlayerSidecarV1EventsEvents.StreamIndexedBlocksResponse>(`/events/v1/stream-indexed-blocks`, entityNotifier, {...initReq, method: "POST", body: JSON.stringify(req, fm.replacer)})
+  }
+}