feat(BUX-641) Shared- & Public- config

docs/docs.go

@@ -15,6 +15,25 @@ const docTemplate = `{
     "host": "{{.Host}}",
     "basePath": "{{.BasePath}}",
     "paths": {
+        "/api/v1/config": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "sharedconfig"
+                ],
+                "summary": "Get config returns config fields exposed to clients",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/config.PublicConfig"
+                        }
+                    }
+                }
+            }
+        },
         "/api/v1/sign-in": {
             "post": {
                 "consumes": [
@@ -244,6 +263,20 @@ const docTemplate = `{
                 }
             }
         },
+        "config.PublicConfig": {
+            "type": "object",
+            "properties": {
+                "experimental_features": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "boolean"
+                    }
+                },
+                "paymail_domain": {
+                    "type": "string"
+                }
+            }
+        },
         "spvwallet.FullTransaction": {
             "type": "object",
             "properties": {

docs/swagger.json

@@ -7,6 +7,25 @@
         "version": "1.0"
     },
     "paths": {
+        "/api/v1/config": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "sharedconfig"
+                ],
+                "summary": "Get config returns config fields exposed to clients",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/config.PublicConfig"
+                        }
+                    }
+                }
+            }
+        },
         "/api/v1/sign-in": {
             "post": {
                 "consumes": [
@@ -236,6 +255,20 @@
                 }
             }
         },
+        "config.PublicConfig": {
+            "type": "object",
+            "properties": {
+                "experimental_features": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "boolean"
+                    }
+                },
+                "paymail_domain": {
+                    "type": "string"
+                }
+            }
+        },
         "spvwallet.FullTransaction": {
             "type": "object",
             "properties": {

docs/swagger.yaml

@@ -13,6 +13,15 @@ definitions:
       password:
         type: string
     type: object
+  config.PublicConfig:
+    properties:
+      experimental_features:
+        additionalProperties:
+          type: boolean
+        type: object
+      paymail_domain:
+        type: string
+    type: object
   spvwallet.FullTransaction:
     properties:
       blockHash:
@@ -110,6 +119,18 @@ info:
   title: SPV Wallet WEB Backend
   version: "1.0"
 paths:
+  /api/v1/config:
+    get:
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/config.PublicConfig'
+      summary: Get config returns config fields exposed to clients
+      tags:
+      - sharedconfig
   /api/v1/sign-in:
     post:
       consumes:

domain/config/config_service.go

@@ -0,0 +1,77 @@
+package config
+
+import (
+	"slices"
+	"sync"
+
+	backendconfig "github.com/bitcoin-sv/spv-wallet-web-backend/config"
+	"github.com/bitcoin-sv/spv-wallet-web-backend/domain/users"
+	"github.com/bitcoin-sv/spv-wallet/models"
+	"github.com/rs/zerolog"
+	"github.com/spf13/viper"
+)
+
+// ConfigService is a service for fetching and caching SharedConfig from the spv-wallet and providing PublicConfig.
+type ConfigService struct {
+	adminWalletClient users.AdminWalletClient
+	log               *zerolog.Logger
+
+	sharedConfig *models.SharedConfig
+	publicConfig *PublicConfig
+	mutex        sync.Mutex
+}
+
+// NewConfigService creates a new ConfigService.
+func NewConfigService(adminWalletClient users.AdminWalletClient, log *zerolog.Logger) *ConfigService {
+	return &ConfigService{
+		adminWalletClient: adminWalletClient,
+		log:               log,
+		sharedConfig:      nil,
+		publicConfig:      nil,
+	}
+}
+
+// GetSharedConfig returns shared config.
+// If shared config is not cached, it will be fetched from the spv-wallet.
+// SharedConfig should not be exposed to the public - use PublicConfig instead.
+func (s *ConfigService) GetSharedConfig() *models.SharedConfig {
+	if s.sharedConfig != nil {
+		return s.sharedConfig
+	}
+
+	s.mutex.Lock()
+	defer s.mutex.Unlock()
+	model, err := s.adminWalletClient.GetSharedConfig()
+	if err != nil {
+		s.log.Error().Err(err).Msg("Failed to get shared config")
+		return nil
+	}
+	s.sharedConfig = model
+	return s.sharedConfig
+}
+
+// GetPublicConfig returns public config.
+func (s *ConfigService) GetPublicConfig() *PublicConfig {
+	if s.publicConfig != nil {
+		return s.publicConfig
+	}
+	shared := s.GetSharedConfig()
+	if shared == nil {
+		return nil
+	}
+
+	s.publicConfig = s.makePublicConfig(shared)
+	return s.publicConfig
+}
+
+func (s *ConfigService) makePublicConfig(shared *models.SharedConfig) *PublicConfig {
+	configuredPaymailDomain := viper.GetString(backendconfig.EnvPaymailDomain)
+	if !slices.Contains(shared.PaymilDomains, configuredPaymailDomain) {
+		s.log.Warn().Str("configuredPaymailDomain", configuredPaymailDomain).Msg("Configured paymail domain is not in the list of paymail domains from SPV Wallet")
+	}
+
+	return &PublicConfig{
+		PaymilDomain:         configuredPaymailDomain,
+		ExperimentalFeatures: shared.ExperimentalFeatures,
+	}
+}

domain/config/public_config.go

@@ -0,0 +1,7 @@
+package config
+
+// PublicConfig represents a config that is exposed to the public.
+type PublicConfig struct {
+	PaymilDomain         string          `json:"paymail_domain"`
+	ExperimentalFeatures map[string]bool `json:"experimental_features"`
+}

domain/services.go

@@ -2,6 +2,7 @@ package domain
 
 import (
 	db_users "github.com/bitcoin-sv/spv-wallet-web-backend/data/users"
+	"github.com/bitcoin-sv/spv-wallet-web-backend/domain/config"
 	"github.com/bitcoin-sv/spv-wallet-web-backend/domain/transactions"
 	"github.com/bitcoin-sv/spv-wallet-web-backend/domain/users"
 	"github.com/bitcoin-sv/spv-wallet-web-backend/transports/spvwallet"
@@ -14,6 +15,7 @@ type Services struct {
 	UsersService        *users.UserService
 	TransactionsService *transactions.TransactionService
 	WalletClientFactory users.WalletClientFactory
+	ConfigService       *config.ConfigService
 }
 
 // NewServices creates services instance.
@@ -31,5 +33,6 @@ func NewServices(usersRepo *db_users.UsersRepository, log *zerolog.Logger) (*Ser
 		UsersService:        uService,
 		TransactionsService: transactions.NewTransactionService(adminWalletClient, walletClientFactory, log),
 		WalletClientFactory: walletClientFactory,
+		ConfigService:       config.NewConfigService(adminWalletClient, log),
 	}, nil
 }

domain/users/interfaces.go

@@ -75,6 +75,7 @@ type (
 	AdminWalletClient interface {
 		RegisterXpub(xpriv *bip32.ExtendedKey) (string, error)
 		RegisterPaymail(alias, xpub string) (string, error)
+		GetSharedConfig() (*models.SharedConfig, error)
 	}
 
 	// WalletClientFactory defines methods to create user and admin clients.

go.mod

@@ -4,58 +4,70 @@ go 1.21.5
 
 require (
 	github.com/avast/retry-go/v4 v4.5.1
-	github.com/bitcoin-sv/spv-wallet-go-client v0.6.0
-	github.com/bitcoin-sv/spv-wallet/models v0.15.0
-	github.com/brianvoe/gofakeit/v6 v6.26.3
-	github.com/centrifugal/centrifuge v0.30.6
+	github.com/bitcoin-sv/spv-wallet-go-client v0.6.1-0.20240312095707-fece60668ec2
+	github.com/bitcoin-sv/spv-wallet/models v0.20.0
+	github.com/brianvoe/gofakeit/v6 v6.28.0
+	github.com/centrifugal/centrifuge v0.31.0
 	github.com/gin-contrib/sessions v0.0.5
 	github.com/golang/mock v1.6.0
 	github.com/libsv/go-bk v0.1.6
-	github.com/rs/zerolog v1.31.0
+	github.com/rs/zerolog v1.32.0
 	github.com/spf13/viper v1.18.2
-	github.com/stretchr/testify v1.8.4
+	github.com/stretchr/testify v1.9.0
 	github.com/swaggo/files v1.0.1
 	github.com/swaggo/gin-swagger v1.6.0
-	github.com/swaggo/swag v1.16.2
+	github.com/swaggo/swag v1.16.3
 	github.com/xdg-go/pbkdf2 v1.0.0
 	go.elastic.co/ecszerolog v0.2.0
 )
 
 require (
 	github.com/FZambia/eagle v0.1.0 // indirect
 	github.com/KyleBanks/depth v1.2.1 // indirect
+	github.com/aead/siphash v1.0.1 // indirect
 	github.com/antonlindstrom/pgstore v0.0.0-20220421113606-e3a6e3fed12a // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/bitcoinschema/go-bitcoin/v2 v2.0.5 // indirect
 	github.com/bitcoinsv/bsvd v0.0.0-20190609155523-4c29707f7173 // indirect
-	github.com/bytedance/sonic v1.10.2 // indirect
-	github.com/centrifugal/protocol v0.11.0 // indirect
+	github.com/bitcoinsv/bsvlog v0.0.0-20181216181007-cb81b076bf2e // indirect
+	github.com/bitcoinsv/bsvutil v0.0.0-20181216182056-1d77cf353ea9 // indirect
+	github.com/btcsuite/go-socks v0.0.0-20170105172521-4720035b7bfd // indirect
+	github.com/btcsuite/goleveldb v1.0.0 // indirect
+	github.com/btcsuite/snappy-go v1.0.0 // indirect
+	github.com/btcsuite/websocket v0.0.0-20150119174127-31079b680792 // indirect
+	github.com/btcsuite/winsvc v1.0.0 // indirect
+	github.com/bytedance/sonic v1.11.2 // indirect
+	github.com/centrifugal/protocol v0.12.0 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect
 	github.com/chenzhuoyu/iasm v0.9.1 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
-	github.com/go-openapi/jsonpointer v0.20.2 // indirect
-	github.com/go-openapi/jsonreference v0.20.4 // indirect
-	github.com/go-openapi/spec v0.20.13 // indirect
-	github.com/go-openapi/swag v0.22.7 // indirect
+	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/jsonreference v0.21.0 // indirect
+	github.com/go-openapi/spec v0.21.0 // indirect
+	github.com/go-openapi/swag v0.23.0 // indirect
 	github.com/go-playground/locales v0.14.1 // indirect
 	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-playground/validator/v10 v10.16.0 // indirect
+	github.com/go-playground/validator/v10 v10.19.0 // indirect
 	github.com/goccy/go-json v0.10.2 // indirect
-	github.com/google/uuid v1.5.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/gorilla/context v1.1.2 // indirect
 	github.com/gorilla/securecookie v1.1.2 // indirect
 	github.com/gorilla/sessions v1.2.2 // indirect
 	github.com/gorilla/websocket v1.5.1 // indirect
 	github.com/hashicorp/errwrap v1.1.0 // indirect
 	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/igm/sockjs-go/v3 v3.0.3 // indirect
+	github.com/jessevdk/go-flags v1.5.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
+	github.com/jrick/logrotate v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/klauspost/cpuid/v2 v2.2.6 // indirect
-	github.com/leodido/go-urn v1.2.4 // indirect
+	github.com/kkdai/bstream v1.0.0 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.7 // indirect
+	github.com/knz/go-libedit v1.10.1 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
 	github.com/libsv/go-bt/v2 v2.2.5 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
@@ -64,12 +76,12 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
-	github.com/prometheus/client_golang v1.18.0 // indirect
-	github.com/prometheus/client_model v0.5.0 // indirect
-	github.com/prometheus/common v0.45.0 // indirect
-	github.com/prometheus/procfs v0.12.0 // indirect
+	github.com/prometheus/client_golang v1.19.0 // indirect
+	github.com/prometheus/client_model v0.6.0 // indirect
+	github.com/prometheus/common v0.50.0 // indirect
+	github.com/prometheus/procfs v0.13.0 // indirect
 	github.com/quasoft/memstore v0.0.0-20191010062613-2bce066d2b0b // indirect
-	github.com/redis/rueidis v1.0.25 // indirect
+	github.com/redis/rueidis v1.0.31 // indirect
 	github.com/sagikazarmark/locafero v0.4.0 // indirect
 	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
 	github.com/segmentio/asm v1.2.0 // indirect
@@ -80,13 +92,13 @@ require (
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	go.uber.org/atomic v1.11.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	golang.org/x/arch v0.6.0 // indirect
-	golang.org/x/crypto v0.19.0 // indirect
-	golang.org/x/exp v0.0.0-20231226003508-02704c960a9b // indirect
-	golang.org/x/net v0.19.0 // indirect
-	golang.org/x/sync v0.5.0 // indirect
-	golang.org/x/tools v0.16.1 // indirect
-	google.golang.org/protobuf v1.32.0 // indirect
+	golang.org/x/arch v0.7.0 // indirect
+	golang.org/x/crypto v0.21.0 // indirect
+	golang.org/x/exp v0.0.0-20240222234643-814bf88cf225 // indirect
+	golang.org/x/net v0.22.0 // indirect
+	golang.org/x/sync v0.6.0 // indirect
+	golang.org/x/tools v0.19.0 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
 )
 
 require (
@@ -103,7 +115,7 @@ require (
 	github.com/spf13/cast v1.6.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/subosito/gotenv v1.6.0 // indirect
-	golang.org/x/sys v0.17.0 // indirect
+	golang.org/x/sys v0.18.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect