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.

Sign up for GitHub

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

[DataApi] Add Service Availability Handler #276

Merged
merged 26 commits into from
Mar 8, 2024
Merged

[DataApi] Add Service Availability Handler #276

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
dfc6c78
Add EigenDA Service Availability Handler
Feb 23, 2024
c84bf80
Update Swagger
Feb 23, 2024
7a53df6
Fix documentation
Feb 23, 2024
dde6875
move test
Feb 23, 2024
799e3ed
Fix Linter error
Feb 23, 2024
6370c6a
Fix PR comments
Feb 26, 2024
0784249
Add Query Parameter for Service Availability
Feb 26, 2024
2227421
Fix merge conflict
Feb 26, 2024
9ee6796
Fix Query Parameter
Feb 26, 2024
11d3bc1
Update Http Code when server is not serving
Feb 26, 2024
d408dc8
Fix PR comment
Feb 26, 2024
89d77a7
Fix PR comment
Feb 27, 2024
b052622
fix comment
Feb 27, 2024
8c7382c
Merge branch 'master' into dataapi-services-availability
Feb 27, 2024
266e754
Add Multiple Requests Test
Feb 29, 2024
edfea10
fix linter error
Feb 29, 2024
5a6a6e5
Fix PR comment
Mar 5, 2024
25bd920
Merge branch 'master' into dataapi-services-availability
Mar 5, 2024
d3e1eae
Merge branch 'master' into dataapi-services-availability
Mar 5, 2024
430cf8c
changes
Mar 7, 2024
23d521a
Add Mock for HealthCheck
Mar 7, 2024
1e5e64a
Handle nil connections
Mar 7, 2024
d5a3da9
Fix Linter error
Mar 7, 2024
b72347f
update variable names
Mar 7, 2024
c3e7efb
remove unused variables
Mar 7, 2024
2888bad
Fix pr comment
Mar 8, 2024
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
7 changes: 6 additions & 1 deletion disperser/cmd/dataapi/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ type Config struct {

BLSOperatorStateRetrieverAddr string
EigenDAServiceManagerAddr string

DisperserHostname string
ChurnerHostname string
}

func NewConfig(ctx *cli.Context) Config {
Expand All @@ -54,8 +57,10 @@ func NewConfig(ctx *cli.Context) Config {
AllowOrigins: ctx.GlobalStringSlice(flags.AllowOriginsFlag.Name),
MetricsConfig: dataapi.MetricsConfig{
HTTPPort: ctx.GlobalString(flags.MetricsHTTPPort.Name),
EnableMetrics: ctx.GlobalBool(flags.EnableMetrics.Name),
EnableMetrics: ctx.GlobalBool(flags.EnableMetricsFlag.Name),
},
DisperserHostname: ctx.GlobalString(flags.DisperserHostnameFlag.Name),
ChurnerHostname: ctx.GlobalString(flags.ChurnerHostnameFlag.Name),
}
return config
}
22 changes: 20 additions & 2 deletions disperser/cmd/dataapi/flags/flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,28 @@ var (
EnvVar: common.PrefixEnvVar(envVarPrefix, "ALLOW_ORIGINS"),
Required: true,
}
EnableMetrics = cli.BoolFlag{
EnableMetricsFlag = cli.BoolFlag{
Name: common.PrefixFlag(FlagPrefix, "enable-metrics"),
Usage: "start metrics server",
Required: true,
EnvVar: common.PrefixEnvVar(envVarPrefix, "ENABLE_METRICS"),
}
// EigenDA Disperser and Churner Hostnames to check Server Availability
// ex:
// disperser-goerli.eigenda.eigenops.xyz,
// churner-goerli.eigenda.eigenops.xyz
DisperserHostnameFlag = cli.StringFlag{
Name: common.PrefixFlag(FlagPrefix, "eigenda-disperser-hostname"),
Usage: "HostName of EigenDA Disperser",
Required: true,
EnvVar: common.PrefixEnvVar(envVarPrefix, "EIGENDA_DISPERSER_HOSTNAME"),
}
ChurnerHostnameFlag = cli.StringFlag{
Name: common.PrefixFlag(FlagPrefix, "eigenda-churner-hostname"),
Usage: "HostName of EigenDA Churner",
Required: true,
EnvVar: common.PrefixEnvVar(envVarPrefix, "EIGENDA_CHURNER_HOSTNAME"),
}
/* Optional Flags*/
MetricsHTTPPort = cli.StringFlag{
Name: common.PrefixFlag(FlagPrefix, "metrics-http-port"),
Expand All @@ -125,7 +141,9 @@ var requiredFlags = []cli.Flag{
PrometheusServerSecretFlag,
PrometheusMetricsClusterLabelFlag,
AllowOriginsFlag,
EnableMetrics,
EnableMetricsFlag,
DisperserHostnameFlag,
ChurnerHostnameFlag,
}

var optionalFlags = []cli.Flag{
Expand Down
8 changes: 5 additions & 3 deletions disperser/cmd/dataapi/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,11 @@ func RunDataApi(ctx *cli.Context) error {
metrics = dataapi.NewMetrics(blobMetadataStore, config.MetricsConfig.HTTPPort, logger)
server = dataapi.NewServer(
dataapi.Config{
ServerMode: config.ServerMode,
SocketAddr: config.SocketAddr,
AllowOrigins: config.AllowOrigins,
ServerMode: config.ServerMode,
SocketAddr: config.SocketAddr,
AllowOrigins: config.AllowOrigins,
DisperserHostname: config.DisperserHostname,
ChurnerHostname: config.ChurnerHostname,
},
sharedStorage,
promClient,
Expand Down
8 changes: 5 additions & 3 deletions disperser/dataapi/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
package dataapi

type Config struct {
SocketAddr string
ServerMode string
AllowOrigins []string
SocketAddr string
ServerMode string
AllowOrigins []string
DisperserHostname string
ChurnerHostname string
}
142 changes: 117 additions & 25 deletions disperser/dataapi/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,43 @@ const docTemplate = `{
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/eigenda-services/service-availability": {
"get": {
"produces": [
"application/json"
],
"tags": [
"ServiceAvailability"
],
"summary": "Get status of public EigenDA services.",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/dataapi.ServiceAvailabilityResponse"
}
},
"400": {
"description": "error: Bad request",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"404": {
"description": "error: Not found",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
}
},
"500": {
"description": "error: Server error",
"schema": {
"$ref": "#/definitions/dataapi.ErrorResponse"
}
}
}
}
},
"/feed/blobs": {
"get": {
"produces": [
Expand Down Expand Up @@ -349,31 +386,6 @@ const docTemplate = `{
}
},
"definitions": {
"encoding.BlobCommitments": {
"type": "object",
"properties": {
"commitment": {
"$ref": "#/definitions/core.Commitment"
},
"length": {
"type": "integer"
},
"length_proof": {
"$ref": "#/definitions/core.Commitment"
}
}
},
"core.Commitment": {
"type": "object",
"properties": {
"x": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"core.SecurityParam": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -564,6 +576,31 @@ const docTemplate = `{
}
}
},
"dataapi.ServiceAvailability": {
"type": "object",
"properties": {
"service_name": {
"type": "string"
},
"service_status": {
"type": "string"
}
}
},
"dataapi.ServiceAvailabilityResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/dataapi.ServiceAvailability"
}
},
"meta": {
"$ref": "#/definitions/dataapi.Meta"
}
}
},
"dataapi.Throughput": {
"type": "object",
"properties": {
Expand All @@ -575,6 +612,50 @@ const docTemplate = `{
}
}
},
"encoding.BlobCommitments": {
"type": "object",
"properties": {
"commitment": {
"$ref": "#/definitions/encoding.G1Commitment"
},
"length": {
"type": "integer"
},
"length_commitment": {
"$ref": "#/definitions/encoding.G2Commitment"
},
"length_proof": {
"$ref": "#/definitions/encoding.LengthProof"
}
}
},
"encoding.G1Commitment": {
"type": "object",
"properties": {
"x": {
"type": "array",
"items": {
"type": "integer"
}
}
}
},
"encoding.G2Commitment": {
"type": "object",
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
"encoding.LengthProof": {
"type": "object",
"properties": {
"x": {
"$ref": "#/definitions/github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2"
}
}
},
"github_com_Layr-Labs_eigenda_disperser.BlobStatus": {
"type": "integer",
"enum": [
Expand All @@ -591,6 +672,17 @@ const docTemplate = `{
"Finalized",
"InsufficientSignatures"
]
},
"github_com_consensys_gnark-crypto_ecc_bn254_internal_fptower.E2": {
"type": "object",
"properties": {
"a0": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}`
Expand Down
Loading
Loading