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

Backporting T&C endpoint into phase-2 codebase #229

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
56 changes: 56 additions & 0 deletions internal/shared/api/handlers/handler/terms.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
package handler

import (
"net/http"

"github.com/babylonlabs-io/staking-api-service/internal/shared/types"
"github.com/btcsuite/btcd/chaincfg"
"github.com/babylonlabs-io/staking-api-service/internal/shared/utils"
"encoding/json"
)

type TermsAcceptanceLoggingRequest struct {
Address string `json:"address"`
PublicKey string `json:"public_key"`
}

type TermsAcceptancePublic struct {
Status bool `json:"status"`
}

func (h *Handler) LogTermsAcceptance(request *http.Request) (*Result, *types.Error) {
address, publicKey, err := parseTermsAcceptanceLoggingRequest(request, h.Config.Server.BTCNetParam)
if err != nil {
return nil, err
}

if err := h.Service.AcceptTerms(request.Context(), address, publicKey); err != nil {
return nil, types.NewInternalServiceError(err)
}

return NewResult(TermsAcceptancePublic{Status: true}), nil
}

// parseTermsAcceptanceLoggingRequest parses the terms acceptance request bdoy and returns the address and public key
func parseTermsAcceptanceLoggingRequest(request *http.Request, btcNetParam *chaincfg.Params) (string, string, *types.Error) {
var req TermsAcceptanceLoggingRequest
if err := json.NewDecoder(request.Body).Decode(&req); err != nil {
return "", "", types.NewErrorWithMsg(http.StatusBadRequest, types.BadRequest, "Invalid request payload")
}

// Validate the Bitcoin address
if _, err := utils.CheckBtcAddressType(req.Address, btcNetParam); err != nil {
return "", "", types.NewErrorWithMsg(http.StatusBadRequest, types.BadRequest, "Invalid Bitcoin address")
}

// Validate the public key
if _, err := utils.GetSchnorrPkFromHex(req.PublicKey); err != nil {
return "", "", types.NewErrorWithMsg(http.StatusBadRequest, types.BadRequest, "Invalid public key")
}

if req.Address == "" || req.PublicKey == "" {
return "", "", types.NewErrorWithMsg(http.StatusBadRequest, types.BadRequest, "Address and public key are required")
}

return req.Address, req.PublicKey, nil
}
4 changes: 4 additions & 0 deletions internal/shared/api/routes.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ func (a *Server) SetupRoutes(r *chi.Mux) {
r.Post("/v1/ordinals/verify-utxos", registerHandler(handlers.SharedHandler.VerifyUTXOs))
}

if a.cfg.TermsAcceptanceLogging.Enabled {
r.Post("/log-terms-acceptance", registerHandler(handlers.SharedHandler.LogTermsAcceptance))
}

// V2 API
r.Get("/v2/network-info", registerHandler(handlers.V2Handler.GetNetworkInfo))
r.Get("/v2/finality-providers", registerHandler(handlers.V2Handler.GetFinalityProviders))
Expand Down
17 changes: 9 additions & 8 deletions internal/shared/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ import (
)

type Config struct {
Server *ServerConfig `mapstructure:"server"`
StakingDb *DbConfig `mapstructure:"staking-db"`
IndexerDb *DbConfig `mapstructure:"indexer-db"`
Queue *queue.QueueConfig `mapstructure:"queue"`
Metrics *MetricsConfig `mapstructure:"metrics"`
Assets *AssetsConfig `mapstructure:"assets"`
DelegationTransition *DelegationTransitionConfig `mapstructure:"delegation-transition"`
ExternalAPIs *ExternalAPIsConfig `mapstructure:"external_apis"`
Server *ServerConfig `mapstructure:"server"`
StakingDb *DbConfig `mapstructure:"staking-db"`
IndexerDb *DbConfig `mapstructure:"indexer-db"`
Queue *queue.QueueConfig `mapstructure:"queue"`
Metrics *MetricsConfig `mapstructure:"metrics"`
Assets *AssetsConfig `mapstructure:"assets"`
DelegationTransition *DelegationTransitionConfig `mapstructure:"delegation-transition"`
ExternalAPIs *ExternalAPIsConfig `mapstructure:"external_apis"`
TermsAcceptanceLogging *TermsAcceptanceConfig `mapstructure:"terms_acceptance_logging"`
jrwbabylonlab marked this conversation as resolved.
Show resolved Hide resolved
}

func (cfg *Config) Validate() error {
Expand Down
5 changes: 5 additions & 0 deletions internal/shared/config/terms.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package config

type TermsAcceptanceConfig struct {
Enabled bool `mapstructure:"enabled"`
}
9 changes: 9 additions & 0 deletions internal/shared/db/model/terms.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package dbmodel

import "go.mongodb.org/mongo-driver/bson/primitive"

type TermsAcceptance struct {
Id primitive.ObjectID `bson:"_id,omitempty"`
kirugan marked this conversation as resolved.
Show resolved Hide resolved
Address string `bson:"address"`
PublicKey string `bson:"public_key"`
}
1 change: 1 addition & 0 deletions internal/shared/services/service/interface.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ type SharedServiceProvider interface {
DoHealthCheck(ctx context.Context) error
VerifyUTXOs(ctx context.Context, utxos []types.UTXOIdentifier, address string) ([]*SafeUTXOPublic, *types.Error)
SaveUnprocessableMessages(ctx context.Context, messages string, receipt string) *types.Error
AcceptTerms(ctx context.Context, address, publicKey string) error
}
15 changes: 15 additions & 0 deletions internal/shared/services/service/terms.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package service

import (
"context"
model "github.com/babylonlabs-io/staking-api-service/internal/shared/db/model"
)

func (s *Service) AcceptTerms(ctx context.Context, address, publicKey string) error {
termsAcceptance := &model.TermsAcceptance{
Address: address,
PublicKey: publicKey,
}

return s.DbClients.SaveTermsAcceptance(ctx, termsAcceptance)

Check failure on line 14 in internal/shared/services/service/terms.go

View workflow job for this annotation

GitHub Actions / lint_test / build

s.DbClients.SaveTermsAcceptance undefined (type *dbclients.DbClients has no field or method SaveTermsAcceptance)

Check failure on line 14 in internal/shared/services/service/terms.go

View workflow job for this annotation

GitHub Actions / lint_test / unit-tests

s.DbClients.SaveTermsAcceptance undefined (type *dbclients.DbClients has no field or method SaveTermsAcceptance)
}
Loading