Feat: event api disable via event registry address

.env.example

@@ -22,4 +22,4 @@ LOG_LEVEL=
 METRICS_ENABLED=true
 METRICS_HOST="[::]"
 METRICS_PORT=4000
-SHUTTER_EVENT_REGISTRY_CONTRACT_ADDRESS=
+SHUTTER_EVENT_REGISTRY_CONTRACT_ADDRESS= # Event API is auto-disabled when this is empty

common/config.go

@@ -9,10 +9,11 @@ import (
 )
 
 type Config struct {
-	KeyperHTTPURL *url.URL
-	SigningKey    *ecdsa.PrivateKey
-	PublicKey     *ecdsa.PublicKey
-	P2P           *p2p.Config
+	KeyperHTTPURL   *url.URL
+	SigningKey      *ecdsa.PrivateKey
+	PublicKey       *ecdsa.PublicKey
+	P2P             *p2p.Config
+	DisableEventAPI bool // true when SHUTTER_EVENT_REGISTRY_CONTRACT_ADDRESS is not configured; if true, event API endpoints are not registered
 }
 
 func NewConfig(keyperHTTPUrl string, signingKey *ecdsa.PrivateKey, p2pConfig *p2p.Config) (*Config, error) {

docs/docs.go

@@ -288,8 +288,8 @@ const docTemplate = `{
                     },
                     {
                         "type": "string",
-                        "description": "Identity prefix associated with the event identity registration.",
-                        "name": "identityPrefix",
+                        "description": "Identity associated with the event identity registration.",
+                        "name": "identity",
                         "in": "query",
                         "required": true
                     }

docs/swagger.json

@@ -279,8 +279,8 @@
                     },
                     {
                         "type": "string",
-                        "description": "Identity prefix associated with the event identity registration.",
-                        "name": "identityPrefix",
+                        "description": "Identity associated with the event identity registration.",
+                        "name": "identity",
                         "in": "query",
                         "required": true
                     }

docs/swagger.yaml

@@ -327,9 +327,9 @@ paths:
         name: eon
         required: true
         type: integer
-      - description: Identity prefix associated with the event identity registration.
+      - description: Identity associated with the event identity registration.
         in: query
-        name: identityPrefix
+        name: identity
         required: true
         type: string
       produces:

internal/middleware/event_api_guard.go

@@ -0,0 +1,28 @@
+package middleware
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	"github.com/shutter-network/shutter-api/common"
+	sherror "github.com/shutter-network/shutter-api/internal/error"
+)
+
+// EventAPIGuard returns 501 Not Implemented when DisableEventAPI is true
+// (i.e., when SHUTTER_EVENT_REGISTRY_CONTRACT_ADDRESS is not configured).
+// When enabled, requests proceed to the event handlers.
+func EventAPIGuard(config *common.Config) gin.HandlerFunc {
+	return func(ctx *gin.Context) {
+		if config.DisableEventAPI {
+			err := sherror.NewHttpError(
+				"Service is unavailable.",
+				"Service is unavailable.",
+				http.StatusNotImplemented,
+			)
+			ctx.Error(err)
+			ctx.Abort()
+			return
+		}
+		ctx.Next()
+	}
+}

internal/router/router.go

@@ -44,6 +44,7 @@ func NewRouter(
 		}
 
 		eventGroup := api.Group("/event")
+		eventGroup.Use(middleware.EventAPIGuard(config))
 		{
 			eventGroup.POST("/compile_trigger_definition", cryptoService.CompileEventTriggerDefinition)
 			eventGroup.POST("/register_identity", cryptoService.RegisterEventIdentity)

main.go

@@ -187,6 +187,11 @@ func main() {
 		log.Err(err).Msg("unable to parse keyper http url")
 		return
 	}
+	// Disable event API if event registry contract address is not configured
+	config.DisableEventAPI = shutterEventRegistryContractAddressStringified == ""
+	if config.DisableEventAPI {
+		log.Info().Msg("Event API disabled: SHUTTER_EVENT_REGISTRY_CONTRACT_ADDRESS not configured")
+	}
 	app := router.NewRouter(ctx, db, contract, client, config)
 	watcher := watcher.NewWatcher(config, db)
 	group, deferFn := service.RunBackground(ctx, watcher)

tests/integration/init_test.go

@@ -80,6 +80,7 @@ func (s *TestShutterService) SetupSuite() {
 
 	s.config, err = common.NewConfig(keyperHTTPUrl, signingKey, &p2pConfig)
 	s.Require().NoError(err)
+	s.config.DisableEventAPI = false
 
 	rpc_url := os.Getenv("RPC_URL")
 	s.ethClient, err = ethclient.Dial(rpc_url)