feat(SPV-809): mysql & mongo removal

README.md

@@ -345,7 +345,6 @@ Ports which are used:
 - 5432 - PostgreSQL DB
 - 6379 - Redis
 - 8080 - Block Headers Service
-- 27017 - MongoDB
 - 80 - in case of exposing on the paymail domain and its subdomains
 - 443 - in case of exposing on the paymail domain and its subdomains
 <br/>

config.example.yaml

@@ -28,20 +28,10 @@ db:
   datastore:
     # enable datastore debug mode
     debug: false
-    # datastore engine - sqlite/postgresql/mysql/mongodb (experimental)
+    # datastore engine - sqlite/postgresql
     engine: sqlite
     # prefix for all tables
     table_prefix: xapi
-  mongodb:
-    database_name: xapi
-    debug: false
-    max_connection_idle_time: 0s
-    max_connection_time: 0s
-    max_idle_connections: 0
-    max_open_connections: 0
-    table_prefix: ""
-    transactions: false
-    uri: mongodb://localhost:27017/xapi
   sql:
     debug: false
     driver: postgresql

config/config.go

@@ -123,9 +123,7 @@ type RedisConfig struct {
 type DbConfig struct {
 	// Datastore general config.
 	Datastore *DatastoreConfig `json:"datastore" mapstructure:"datastore"`
-	// Mongo is a config for MongoDb. Works only if datastore engine is set to mongodb.
-	Mongo *datastore.MongoDBConfig `json:"mongodb" mapstructure:"mongodb"`
-	// SQL is a config for PostgreSQL or MySQL. Works only if datastore engine is set to postgresql or mysql.
+	// SQL is a config for PostgreSQL. Works only if datastore engine is set to postgresql.
 	SQL *datastore.SQLConfig `json:"sql" mapstructure:"sql"`
 	// SQLite is a config for SQLite. Works only if datastore engine is set to sqlite.
 	SQLite *datastore.SQLiteConfig `json:"sqlite" mapstructure:"sqlite"`
@@ -135,7 +133,7 @@ type DbConfig struct {
 type DatastoreConfig struct {
 	// TablePrefix is the prefix for all table names in the database.
 	TablePrefix string `json:"table_prefix" mapstructure:"table_prefix"`
-	// Engine is the database to be used, mysql, sqlite, postgresql.
+	// Engine is the database to be used, sqlite, postgresql.
 	Engine datastore.Engine `json:"engine" mapstructure:"engine"`
 	// Debug is a flag that decides whether additional output (such as sql statements) should be produced from datastore.
 	Debug bool `json:"debug" mapstructure:"debug"`

config/config_test.go

@@ -143,60 +143,4 @@ func TestAppConfig_Validate(t *testing.T) {
 		err := app.Validate()
 		assert.Error(t, err)
 	})
-
-	t.Run("datastore - invalid sql config", func(t *testing.T) {
-		app, _ := baseTestConfig(t)
-		app.Db.Datastore.Engine = datastore.MySQL
-		app.Db.SQL = nil
-		err := app.Validate()
-		assert.Error(t, err)
-	})
-
-	t.Run("datastore - invalid sql user", func(t *testing.T) {
-		app, _ := baseTestConfig(t)
-		app.Db.Datastore.Engine = datastore.MySQL
-		app.Db.SQL.User = ""
-		err := app.Validate()
-		assert.Error(t, err)
-	})
-
-	t.Run("datastore - invalid sql name", func(t *testing.T) {
-		app, _ := baseTestConfig(t)
-		app.Db.Datastore.Engine = datastore.MySQL
-		app.Db.SQL.Name = ""
-		err := app.Validate()
-		assert.Error(t, err)
-	})
-
-	t.Run("datastore - invalid sql host", func(t *testing.T) {
-		app, _ := baseTestConfig(t)
-		app.Db.Datastore.Engine = datastore.MySQL
-		app.Db.SQL.Host = ""
-		err := app.Validate()
-		assert.Error(t, err)
-	})
-
-	t.Run("datastore - invalid mongo config", func(t *testing.T) {
-		app, _ := baseTestConfig(t)
-		app.Db.Datastore.Engine = datastore.MongoDB
-		app.Db.Mongo = nil
-		err := app.Validate()
-		assert.Error(t, err)
-	})
-
-	t.Run("datastore - invalid mongo uri", func(t *testing.T) {
-		app, _ := baseTestConfig(t)
-		app.Db.Datastore.Engine = datastore.MongoDB
-		app.Db.Mongo.URI = ""
-		err := app.Validate()
-		assert.Error(t, err)
-	})
-
-	t.Run("datastore - invalid mongo database name", func(t *testing.T) {
-		app, _ := baseTestConfig(t)
-		app.Db.Datastore.Engine = datastore.MongoDB
-		app.Db.Mongo.DatabaseName = ""
-		err := app.Validate()
-		assert.Error(t, err)
-	})
 }

config/defaults.go

@@ -75,25 +75,18 @@ func getDbDefaults() *DbConfig {
 			Engine:      "sqlite",
 			TablePrefix: "xapi",
 		},
-		Mongo: &datastore.MongoDBConfig{
-			DatabaseName:       "xapi",
-			ExistingConnection: nil,
-			Transactions:       false,
-			URI:                "mongodb://localhost:27017/xapi",
-		},
 		SQL: &datastore.SQLConfig{
-			Driver:                    "postgresql",
-			ExistingConnection:        nil,
-			Host:                      "localhost",
-			Name:                      "xapi",
-			Password:                  "",
-			Port:                      "5432",
-			Replica:                   false,
-			SkipInitializeWithVersion: true,
-			TimeZone:                  "UTC",
-			TxTimeout:                 10 * time.Second,
-			User:                      "postgres",
-			SslMode:                   "disable",
+			Driver:             "postgresql",
+			ExistingConnection: nil,
+			Host:               "localhost",
+			Name:               "xapi",
+			Password:           "",
+			Port:               "5432",
+			Replica:            false,
+			TimeZone:           "UTC",
+			TxTimeout:          10 * time.Second,
+			User:               "postgres",
+			SslMode:            "disable",
 		},
 		SQLite: &datastore.SQLiteConfig{
 			DatabasePath:       "./spv-wallet.db",

config/services.go

@@ -323,7 +323,7 @@ func loadDatastore(options []engine.ClientOps, appConfig *AppConfig, testMode bo
 			DatabasePath: appConfig.Db.SQLite.DatabasePath, // "" for in memory
 			Shared:       appConfig.Db.SQLite.Shared,
 		}))
-	} else if appConfig.Db.Datastore.Engine == datastore.MySQL || appConfig.Db.Datastore.Engine == datastore.PostgreSQL {
+	} else if appConfig.Db.Datastore.Engine == datastore.PostgreSQL {
 		tablePrefix := appConfig.Db.Datastore.TablePrefix
 		if len(appConfig.Db.SQL.TablePrefix) > 0 {
 			tablePrefix = appConfig.Db.SQL.TablePrefix
@@ -349,16 +349,6 @@ func loadDatastore(options []engine.ClientOps, appConfig *AppConfig, testMode bo
 			SslMode:   appConfig.Db.SQL.SslMode,
 		}))
 
-	} else if appConfig.Db.Datastore.Engine == datastore.MongoDB {
-
-		debug := appConfig.Db.Datastore.Debug
-		tablePrefix := appConfig.Db.Datastore.TablePrefix
-		if len(appConfig.Db.Mongo.TablePrefix) > 0 {
-			tablePrefix = appConfig.Db.Mongo.TablePrefix
-		}
-		appConfig.Db.Mongo.Debug = debug
-		appConfig.Db.Mongo.TablePrefix = tablePrefix
-		options = append(options, engine.WithMongoDB(appConfig.Db.Mongo))
 	} else {
 		return nil, errors.New("unsupported datastore engine: " + appConfig.Db.Datastore.Engine.String())
 	}

config/validate_datastore.go

@@ -16,7 +16,7 @@ func (d *DbConfig) Validate() error {
 		if d.SQLite == nil {
 			return errors.New("missing sqlite config")
 		}
-	} else if d.Datastore.Engine == datastore.MySQL || d.Datastore.Engine == datastore.PostgreSQL {
+	} else if d.Datastore.Engine == datastore.PostgreSQL {
 		if d.SQL == nil {
 			return errors.New("missing sql config")
 		} else if len(d.SQL.Host) == 0 {
@@ -26,14 +26,7 @@ func (d *DbConfig) Validate() error {
 		} else if len(d.SQL.Name) == 0 {
 			return errors.New("missing sql db name")
 		}
-	} else if d.Datastore.Engine == datastore.MongoDB {
-		if d.Mongo == nil {
-			return errors.New("missing mongo config")
-		} else if len(d.Mongo.URI) == 0 {
-			return errors.New("missing mongo uri")
-		} else if len(d.Mongo.DatabaseName) == 0 {
-			return errors.New("missing mongo database name")
-		}
 	}
+
 	return nil
 }

config/validate_datastore_test.go

@@ -14,7 +14,6 @@ func TestDatastoreConfig_Validate(t *testing.T) {
 	t.Run("valid datastore config", func(t *testing.T) {
 		d := DbConfig{
 			Datastore: &DatastoreConfig{Engine: datastore.SQLite},
-			Mongo:     &datastore.MongoDBConfig{},
 			SQL:       &datastore.SQLConfig{},
 			SQLite:    &datastore.SQLiteConfig{},
 		}
@@ -27,7 +26,6 @@ func TestDatastoreConfig_Validate(t *testing.T) {
 	t.Run("empty datastore", func(t *testing.T) {
 		d := DbConfig{
 			Datastore: &DatastoreConfig{Engine: datastore.Empty},
-			Mongo:     &datastore.MongoDBConfig{},
 			SQL:       &datastore.SQLConfig{},
 			SQLite:    &datastore.SQLiteConfig{},
 		}
@@ -40,7 +38,6 @@ func TestDatastoreConfig_Validate(t *testing.T) {
 	t.Run("invalid datastore engine", func(t *testing.T) {
 		d := DbConfig{
 			Datastore: &DatastoreConfig{Engine: ""},
-			Mongo:     &datastore.MongoDBConfig{},
 			SQL:       &datastore.SQLConfig{},
 			SQLite:    &datastore.SQLiteConfig{},
 		}

docker-compose.yml

@@ -118,23 +118,6 @@ services:
       timeout: 5s
       retries: 3
 
-  wallet-mongodb:
-    image: mongo
-    environment:
-      MONGO_INITDB_ROOT_USERNAME: mongo
-      MONGO_INITDB_ROOT_PASSWORD: mongo
-      MONGO_INITDB_DATABASE: xapi
-    ports:
-      - '27017:27017'
-    volumes:
-      - wallet-mongodb-data:/data/db
-    healthcheck:
-      test: echo 'db.runCommand("ping").ok' | mongosh mongodb:27017/test --quiet
-      interval: 10s
-      timeout: 10s
-      retries: 5
-      start_period: 40s
-
   wallet-gateway:
     image: traefik:v2.11
     container_name: traefik
@@ -165,8 +148,6 @@ volumes:
     driver: local
   wallet-redis-data:
     driver: local
-  wallet-mongodb-data:
-    driver: local
   block-headers-service-data:
     driver: local
   wallet-gateway-data:

engine/README.md

@@ -21,22 +21,22 @@
 
 ## Table of Contents
 
--   [SPV Wallet Engine](#spv-wallet-engine)
-    -   [Table of Contents](#table-of-contents)
-    -   [About](#about)
-        -   [DISCLAIMER](#disclaimer)
-        -   [SPV Wallet Engine: Out-of-the-box Features:](#spv-wallet-engine-out-of-the-box-features)
-        -   [**Project Assumptions: MVP**](#project-assumptions-mvp)
-    -   [Installation](#installation)
-    -   [Documentation](#documentation)
-        -   [Built-in Features](#built-in-features)
-    -   [Usage](#usage)
-        -   [Examples \& Tests](#examples--tests)
-        -   [Benchmarks](#benchmarks)
-    -   [Code Standards](#code-standards)
-    -   [Usage](#usage-1)
-    -   [Contributing](#contributing)
-    -   [License](#license)
+- [SPV Wallet Engine](#spv-wallet-engine)
+  - [Table of Contents](#table-of-contents)
+  - [About](#about)
+      - [DISCLAIMER](#disclaimer)
+      - [SPV Wallet Engine: Out-of-the-box Features:](#spv-wallet-engine-out-of-the-box-features)
+      - [**Project Assumptions: MVP**](#project-assumptions-mvp)
+  - [Installation](#installation)
+  - [Documentation](#documentation)
+      - [Built-in Features](#built-in-features)
+  - [Usage](#usage)
+    - [Examples \& Tests](#examples--tests)
+    - [Benchmarks](#benchmarks)
+  - [Code Standards](#code-standards)
+  - [Usage](#usage-1)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 <br/>
 
@@ -61,7 +61,7 @@
 #### SPV Wallet Engine: Out-of-the-box Features:
 
 -   xPub & UTXO State Management (state, balance, utxos, destinations)
--   Bring your own Database ([PostgreSQL](https://www.postgresql.org/), [SQLite](https://www.sqlite.org), [MySQL](https://www.mysql.com/), [Mongo](https://www.mongodb.com/) or [interface](./datastore/interface.go) your own)
+-   Bring your own Database ([PostgreSQL](https://www.postgresql.org/), [SQLite](https://www.sqlite.org), or [interface](./datastore/interface.go) your own)
 -   Caching ([FreeCache](https://github.com/github.com/coocood/freecache), [Redis](https://redis.io/) or [interface](https://github.com/mrz1836/go-cachestore/blob/master/interface.go) your own)
 -   Task Management ([TaskQ](https://github.com/vmihailenco/taskq) or [interface](taskmanager/interface.go) your own)
 -   Transaction Syncing (queue, broadcast, push to mempool or on-chain, or [interface](chainstate/interface.go) your own)

engine/client.go

@@ -30,7 +30,7 @@ type (
 		cacheStore    *cacheStoreOptions    // Configuration options for Cachestore (ristretto, redis, etc.)
 		cluster       *clusterOptions       // Configuration options for the cluster coordinator
 		chainstate    *chainstateOptions    // Configuration options for Chainstate (broadcast, sync, etc.)
-		dataStore     *dataStoreOptions     // Configuration options for the DataStore (MySQL, etc.)
+		dataStore     *dataStoreOptions     // Configuration options for the DataStore (PostgreSQL, etc.)
 		debug         bool                  // If the client is in debug mode
 		encryptionKey string                // Encryption key for encrypting sensitive information (IE: paymail xPub) (hex encoded key)
 		httpClient    HTTPInterface         // HTTP interface to use