Merge pull request #37 from YASSERRMD/phase_4

phase 4: health enrichment, make help & golangci-lint config

Author: YASSERRMD

.golangci.yml

@@ -0,0 +1,38 @@
+run:
+  timeout: 5m
+  modules-download-mode: readonly
+
+linters:
+  enable:
+    - errcheck
+    - govet
+    - staticcheck
+    - gosimple
+    - ineffassign
+    - unused
+    - gofmt
+    - misspell
+    - unconvert
+    - bodyclose
+
+linters-settings:
+  errcheck:
+    check-type-assertions: true
+    check-blank: false
+  govet:
+    enable-all: false
+  gofmt:
+    simplify: true
+
+issues:
+  exclude-rules:
+    # Test files may use unsafe assertions and blank identifiers freely.
+    - path: "_test\\.go"
+      linters:
+        - errcheck
+    # Generated or legacy files.
+    - path: "internal/merkle/"
+      linters:
+        - unused
+  max-issues-per-linter: 50
+  max-same-issues: 10

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build test lint docker-build docker-up clean build-tokenizer
+.PHONY: build test lint docker-build docker-up clean build-tokenizer help
 
 BINARY_DIR := bin
 SIQLAH_BIN := $(BINARY_DIR)/siqlah
@@ -16,34 +16,40 @@ VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null || echo dev)
 COMMIT  ?= $(shell git rev-parse --short HEAD 2>/dev/null || echo unknown)
 LDFLAGS := -ldflags "-X main.version=$(VERSION) -X main.commitSHA=$(COMMIT)"
 
-build: $(BINARY_DIR)
+build: $(BINARY_DIR) ## Build all Go binaries into bin/
 	$(GO) build $(LDFLAGS) -o $(SIQLAH_BIN) ./cmd/siqlah
 	$(GO) build -o $(WITNESS_BIN) ./cmd/witness
 	$(GO) build -o $(VERIFIER_BIN) ./cmd/verifier
 
 $(BINARY_DIR):
 	mkdir -p $(BINARY_DIR)
 
-build-tokenizer:
+build-tokenizer: ## Build the Rust tokenizer static library
 	cd $(TOKENIZER_DIR) && $(CARGO) build --release
 
-test:
+test: ## Run the full Go test suite
 	$(GO) test ./...
 
-lint:
+lint: ## Run go vet and golangci-lint (if installed)
 	$(GO) vet ./...
 	@which golangci-lint > /dev/null 2>&1 && golangci-lint run ./... || echo "golangci-lint not installed, skipping"
 
-docker-build:
+docker-build: ## Build the siqlah Docker image
 	$(DOCKER) build -f deployments/Dockerfile -t siqlah:latest .
 
-docker-up:
+docker-up: ## Start siqlah + witness containers via docker compose
 	$(DOCKER_COMPOSE) -f deployments/docker-compose.yml up -d
 
-clean:
+clean: ## Remove build artifacts (bin/ and Rust target/)
 	rm -rf $(BINARY_DIR)
 	cd $(TOKENIZER_DIR) && $(CARGO) clean
 
-# build-legacy: build with SQLite-only mode (no Tessera)
-build-legacy:
+build-legacy: ## Build with SQLite-only mode (no Tessera)
 	go build -tags sqlite_legacy -o bin/ ./cmd/...
+
+help: ## Show this help message
+	@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | \
+		awk 'BEGIN {FS = ":.*##"}; {printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2}'
+	@echo ""
+	@echo "Targets without descriptions:"
+	@grep -E '^[a-zA-Z_-]+:' $(MAKEFILE_LIST) | grep -v '##' | awk -F: '{print "  " $$1}'

cmd/siqlah/main.go

@@ -142,6 +142,7 @@ func main() {
 	}
 	reg := provider.NewRegistry()
 	srv := api.NewWithOptions(st, cpBuilder, operatorPub, operatorPriv, reg, version, *inferenceRegion)
+	srv.WithBackendInfo(*logBackend, *signingBackend)
 	if *x402Recipient != "" {
 		srv.WithX402Recipient(*x402Recipient)
 	}

internal/api/health.go

@@ -2,12 +2,16 @@ package api
 
 import (
 	"net/http"
+	"time"
 )
 
 // HealthResponse is returned by GET /v1/health.
 type HealthResponse struct {
-	Status  string `json:"status"`
-	Version string `json:"version"`
+	Status     string `json:"status"`
+	Version    string `json:"version"`
+	LogBackend string `json:"log_backend,omitempty"`
+	SignerType  string `json:"signer_type,omitempty"`
+	Timestamp  string `json:"timestamp"`
 }
 
 // StatsResponse is returned by GET /v1/stats.
@@ -19,18 +23,20 @@ type StatsResponse struct {
 }
 
 func (s *Server) handleHealth(w http.ResponseWriter, r *http.Request) {
+	resp := HealthResponse{
+		Version:    s.version,
+		LogBackend: s.logBackend,
+		SignerType:  s.signerType,
+		Timestamp:  time.Now().UTC().Format(time.RFC3339),
+	}
 	// Probe DB connectivity via Stats (lightweight query).
 	if _, err := s.store.Stats(); err != nil {
-		writeJSON(w, http.StatusServiceUnavailable, HealthResponse{
-			Status:  "degraded",
-			Version: s.version,
-		})
+		resp.Status = "degraded"
+		writeJSON(w, http.StatusServiceUnavailable, resp)
 		return
 	}
-	writeJSON(w, http.StatusOK, HealthResponse{
-		Status:  "ok",
-		Version: s.version,
-	})
+	resp.Status = "ok"
+	writeJSON(w, http.StatusOK, resp)
 }
 
 func (s *Server) handleStats(w http.ResponseWriter, r *http.Request) {

internal/api/server.go

@@ -31,6 +31,8 @@ type Server struct {
 	registry        providerRegistry
 	version         string
 	logOrigin       string
+	logBackend      string
+	signerType      string
 	x402Bridge      *x402.Bridge
 	x402Recipient   string
 	modelReg        *model.Registry
@@ -114,6 +116,13 @@ func (s *Server) WithX402Recipient(addr string) *Server {
 	return s
 }
 
+// WithBackendInfo sets the log backend and signer type strings surfaced by GET /v1/health.
+func (s *Server) WithBackendInfo(logBackend, signerType string) *Server {
+	s.logBackend = logBackend
+	s.signerType = signerType
+	return s
+}
+
 // Routes returns a ServeMux with all API routes registered.
 func (s *Server) Routes() *http.ServeMux {
 	mux := http.NewServeMux()