feat: auto-swaps (#1266)

Also fixes #1303

## TODOs

- [x] Do final testing with LDK/LND on mainnet
- [x] Improve fee display on the frontend, currently looks scary
- [x] ~Shift Swaps from settings~ (Agreeed to do in follow-up)
- [x] ~Add option to do one-time swaps~ (Agreeed to do in follow-up)

### Minor
- [x] `LDK_NETWORK` config var should now be `NETWORK`
- [x] ~Use LNClient method to publish transactions~ (Agreeed to do in
follow-up)

### Testing
- [ ] Phoenix
- [ ] Cashu
- [x] Wails

Author: im-adithya

.env.example

@@ -35,4 +35,8 @@ FRONTEND_URL=http://localhost:5173
 #LND_ADDRESS=127.0.0.1:10001
 #LND_MACAROON_FILE=/home/YOUR_USERNAME/.polar/networks/1/volumes/lnd/alice/data/chain/bitcoin/regtest/admin.macaroon
 
-#LDK_VSS_URL="http://localhost:8090/vss"
+#LDK_VSS_URL="http://localhost:8090/vss"
+
+# Boltz API
+#BOLTZ_API=https://api.testnet.boltz.exchange
+#NETWORK=testnet

README.md

@@ -159,12 +159,14 @@ For more information refer to:
 The following configuration options can be set as environment variables or in a .env file
 
 - `RELAY`: default: "wss://relay.getalby.com/v1"
-- `JWT_SECRET`: a randomly generated secret string. (only needed in http mode)
-- `DATABASE_URI`: a sqlite filename or postgres URL. Default is SQLite DB `nwc.db` without a path, which will be put in the user home directory: $XDG_DATA_HOME/albyhub/nwc.db
-- `PORT`: the port on which the app should listen on (default: 8080)
-- `WORK_DIR`: directory to store NWC data files. Default: $XDG_DATA_HOME/albyhub
-- `LOG_LEVEL`: log level for the application. Higher is more verbose. Default: 4 (info)
-- `AUTO_UNLOCK_PASSWORD`: provide unlock password to auto-unlock Alby Hub on startup (e.g. after a machine restart). Unlock password still be required to access the interface.
+- `JWT_SECRET`: A randomly generated secret string. (only needed in http mode)
+- `DATABASE_URI`: A sqlite filename or postgres URL. Default is SQLite DB `nwc.db` without a path, which will be put in the user home directory: $XDG_DATA_HOME/albyhub/nwc.db
+- `PORT`: The port on which the app should listen on (default: 8080)
+- `WORK_DIR`: Directory to store NWC data files. Default: $XDG_DATA_HOME/albyhub
+- `LOG_LEVEL`: Log level for the application. Higher is more verbose. Default: 4 (info)
+- `AUTO_UNLOCK_PASSWORD`: Provide unlock password to auto-unlock Alby Hub on startup (e.g. after a machine restart). Unlock password still be required to access the interface.
+- `BOLTZ_API`: The api which provides auto swaps functionality. Default: "https://api.boltz.exchange"
+- `NETWORK`: On-chain network used for auto swaps. Should match the backend network. Default: "bitcoin"
 
 ### Migrating the database (Sqlite <-> Postgres)
 
@@ -204,14 +206,14 @@ _To configure via env, the following parameters must be provided:_
 ##### Mutinynet
 
 - `MEMPOOL_API=https://mutinynet.com/api`
-- `LDK_NETWORK=signet`
+- `NETWORK=signet`
 - `LDK_ESPLORA_SERVER=https://mutinynet.com/api`
 - `LDK_GOSSIP_SOURCE=https://rgs.mutinynet.com/snapshot`
 
 ##### Testnet (Not recommended - try Mutinynet)
 
 - `MEMPOOL_API=https://mempool.space/testnet/api`
-- `LDK_NETWORK=testnet`
+- `NETWORK=testnet`
 - `LDK_ESPLORA_SERVER=https://mempool.space/testnet/api`
 - `LDK_GOSSIP_SOURCE=https://rapidsync.lightningdevkit.org/testnet/snapshot`
 

api/api.go

@@ -10,6 +10,7 @@ import (
 	"net/http"
 	"net/url"
 	"slices"
+	"strconv"
 	"strings"
 	"sync"
 	"time"
@@ -543,6 +544,83 @@ func (api *api) GetNodeConnectionInfo(ctx context.Context) (*lnclient.NodeConnec
 	return api.svc.GetLNClient().GetNodeConnectionInfo(ctx)
 }
 
+func (api *api) GetAutoSwapsConfig() (*GetAutoSwapsConfigResponse, error) {
+	swapBalanceThresholdStr, _ := api.cfg.Get(config.AutoSwapBalanceThresholdKey, "")
+	swapAmountStr, _ := api.cfg.Get(config.AutoSwapAmountKey, "")
+	swapDestination, _ := api.cfg.Get(config.AutoSwapDestinationKey, "")
+
+	enabled := swapBalanceThresholdStr != "" &&
+		swapAmountStr != "" &&
+		swapDestination != ""
+	var swapBalanceThreshold, swapAmount uint64
+	if enabled {
+		var err error
+		if swapBalanceThreshold, err = strconv.ParseUint(swapBalanceThresholdStr, 10, 64); err != nil {
+			return nil, fmt.Errorf("invalid autoswap balance threshold: %w", err)
+		}
+		if swapAmount, err = strconv.ParseUint(swapAmountStr, 10, 64); err != nil {
+			return nil, fmt.Errorf("invalid autoswap amount: %w", err)
+		}
+	}
+
+	swapFees, err := api.svc.GetSwapsService().CalculateFee()
+	if err != nil {
+		logger.Logger.WithError(err).Error("failed to calculate fee info")
+		return nil, err
+	}
+
+	return &GetAutoSwapsConfigResponse{
+		Enabled:          enabled,
+		BalanceThreshold: swapBalanceThreshold,
+		SwapAmount:       swapAmount,
+		Destination:      swapDestination,
+		AlbyServiceFee:   swapFees.AlbyServiceFee,
+		BoltzServiceFee:  swapFees.BoltzServiceFee,
+		BoltzNetworkFee:  swapFees.BoltzNetworkFee,
+	}, nil
+}
+
+func (api *api) EnableAutoSwaps(ctx context.Context, enableAutoSwapsRequest *EnableAutoSwapsRequest) error {
+	err := api.cfg.SetUpdate(config.AutoSwapBalanceThresholdKey, strconv.FormatUint(enableAutoSwapsRequest.BalanceThreshold, 10), "")
+	if err != nil {
+		logger.Logger.WithError(err).Error("Failed to save autoswap balance threshold to config")
+		return err
+	}
+
+	err = api.cfg.SetUpdate(config.AutoSwapAmountKey, strconv.FormatUint(enableAutoSwapsRequest.SwapAmount, 10), "")
+	if err != nil {
+		logger.Logger.WithError(err).Error("Failed to save autoswap amount to config")
+		return err
+	}
+
+	err = api.cfg.SetUpdate(config.AutoSwapDestinationKey, enableAutoSwapsRequest.Destination, "")
+	if err != nil {
+		logger.Logger.WithError(err).Error("Failed to save autoswap destination to config")
+		return err
+	}
+
+	return api.svc.StartAutoSwaps()
+}
+
+func (api *api) DisableAutoSwaps() error {
+	if err := api.cfg.SetUpdate(config.AutoSwapBalanceThresholdKey, "", ""); err != nil {
+		logger.Logger.WithError(err).Error("Failed to remove autoswap balance threshold")
+		return err
+	}
+	if err := api.cfg.SetUpdate(config.AutoSwapAmountKey, "", ""); err != nil {
+		logger.Logger.WithError(err).Error("Failed to remove autoswap amount")
+		return err
+	}
+	if err := api.cfg.SetUpdate(config.AutoSwapDestinationKey, "", ""); err != nil {
+		logger.Logger.WithError(err).Error("Failed to remove autoswap destination")
+		return err
+	}
+
+	api.svc.GetSwapsService().StopAutoSwaps()
+
+	return nil
+}
+
 func (api *api) GetNodeStatus(ctx context.Context) (*lnclient.NodeStatus, error) {
 	if api.svc.GetLNClient() == nil {
 		return nil, errors.New("LNClient not started")

api/models.go

@@ -59,6 +59,9 @@ type API interface {
 	GetWalletCapabilities(ctx context.Context) (*WalletCapabilitiesResponse, error)
 	Health(ctx context.Context) (*HealthResponse, error)
 	SetCurrency(currency string) error
+	GetAutoSwapsConfig() (*GetAutoSwapsConfigResponse, error)
+	DisableAutoSwaps() error
+	EnableAutoSwaps(ctx context.Context, autoSwapsRequest *EnableAutoSwapsRequest) error
 	GetCustomNodeCommands() (*CustomNodeCommandsResponse, error)
 	ExecuteCustomNodeCommand(ctx context.Context, command string) (interface{}, error)
 }
@@ -114,6 +117,22 @@ type CreateAppRequest struct {
 	UnlockPassword string   `json:"unlockPassword"`
 }
 
+type EnableAutoSwapsRequest struct {
+	BalanceThreshold uint64 `json:"balanceThreshold"`
+	SwapAmount       uint64 `json:"swapAmount"`
+	Destination      string `json:"destination"`
+}
+
+type GetAutoSwapsConfigResponse struct {
+	Enabled          bool    `json:"enabled"`
+	BalanceThreshold uint64  `json:"balanceThreshold"`
+	SwapAmount       uint64  `json:"swapAmount"`
+	Destination      string  `json:"destination"`
+	AlbyServiceFee   float64 `json:"albyServiceFee"`
+	BoltzServiceFee  float64 `json:"boltzServiceFee"`
+	BoltzNetworkFee  uint64  `json:"boltzNetworkFee"`
+}
+
 type StartRequest struct {
 	UnlockPassword string `json:"unlockPassword"`
 }

api/transactions.go

@@ -65,7 +65,7 @@ func (api *api) SendPayment(ctx context.Context, invoice string, amountMsat *uin
 	if api.svc.GetLNClient() == nil {
 		return nil, errors.New("LNClient not started")
 	}
-	transaction, err := api.svc.GetTransactionsService().SendPaymentSync(ctx, invoice, amountMsat, nil, api.svc.GetLNClient(), nil, nil)
+	transaction, err := api.svc.GetTransactionsService().SendPaymentSync(ctx, invoice, amountMsat, nil, api.svc.GetLNClient(), nil, nil, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -142,7 +142,7 @@ func (api *api) TopupIsolatedApp(ctx context.Context, userApp *db.App, amountMsa
 		return err
 	}
 
-	_, err = api.svc.GetTransactionsService().SendPaymentSync(ctx, transaction.PaymentRequest, nil, nil, api.svc.GetLNClient(), nil, nil)
+	_, err = api.svc.GetTransactionsService().SendPaymentSync(ctx, transaction.PaymentRequest, nil, nil, api.svc.GetLNClient(), nil, nil, nil)
 	return err
 }
 

config/config.go

@@ -146,6 +146,20 @@ func (cfg *config) GetRelayUrl() string {
 	return relayUrl
 }
 
+func (cfg *config) GetNetwork() string {
+	env := cfg.GetEnv()
+
+	if env.Network != "" {
+		return env.Network
+	}
+
+	if env.LDKNetwork != "" {
+		return env.LDKNetwork
+	}
+
+	return "bitcoin"
+}
+
 func (cfg *config) Get(key string, encryptionKey string) (string, error) {
 	return cfg.get(key, encryptionKey, cfg.db)
 }

config/models.go

@@ -8,7 +8,10 @@ const (
 )
 
 const (
-	OnchainAddressKey = "OnchainAddress"
+	OnchainAddressKey           = "OnchainAddress"
+	AutoSwapBalanceThresholdKey = "AutoSwapBalanceThreshold"
+	AutoSwapAmountKey           = "AutoSwapAmount"
+	AutoSwapDestinationKey      = "AutoSwapDestination"
 )
 
 type AppConfig struct {
@@ -23,7 +26,8 @@ type AppConfig struct {
 	JWTSecret                string `envconfig:"JWT_SECRET"`
 	LogLevel                 string `envconfig:"LOG_LEVEL" default:"4"`
 	LogToFile                bool   `envconfig:"LOG_TO_FILE" default:"true"`
-	LDKNetwork               string `envconfig:"LDK_NETWORK" default:"bitcoin"`
+	Network                  string `envconfig:"NETWORK"`
+	LDKNetwork               string `envconfig:"LDK_NETWORK"`
 	LDKEsploraServer         string `envconfig:"LDK_ESPLORA_SERVER" default:"https://electrs.getalbypro.com"` // TODO: remove LDK prefix
 	LDKGossipSource          string `envconfig:"LDK_GOSSIP_SOURCE"`
 	LDKLogLevel              string `envconfig:"LDK_LOG_LEVEL" default:"3"`
@@ -44,6 +48,7 @@ type AppConfig struct {
 	EnableAdvancedSetup      bool   `envconfig:"ENABLE_ADVANCED_SETUP" default:"true"`
 	AutoUnlockPassword       string `envconfig:"AUTO_UNLOCK_PASSWORD"`
 	LogDBQueries             bool   `envconfig:"LOG_DB_QUERIES" default:"false"`
+	BoltzApi                 string `envconfig:"BOLTZ_API" default:"https://api.boltz.exchange"`
 }
 
 func (c *AppConfig) IsDefaultClientId() bool {
@@ -56,6 +61,7 @@ type Config interface {
 	SetUpdate(key string, value string, encryptionKey string) error
 	GetJWTSecret() string
 	GetRelayUrl() string
+	GetNetwork() string
 	GetEnv() *AppConfig
 	CheckUnlockPassword(password string) bool
 	ChangeUnlockPassword(currentUnlockPassword string, newUnlockPassword string) error

constants/constants.go

@@ -47,6 +47,8 @@ const (
 // accounting for encryption and other metadata in the response, this is set to 4096 characters
 const INVOICE_METADATA_MAX_LENGTH = 4096
 
+const SEND_PAYMENT_TIMEOUT = 50
+
 // errors used by NIP-47 and the transaction service
 const (
 	ERROR_INTERNAL               = "INTERNAL"

frontend/src/components/layouts/SettingsLayout.tsx

@@ -104,6 +104,7 @@ export default function SettingsLayout() {
         <aside className="flex flex-col justify-between lg:w-1/5">
           <nav className="flex flex-wrap lg:flex-col lg:space-y-1">
             <MenuItem to="/settings">General</MenuItem>
+            <MenuItem to="/settings/swaps">Swaps</MenuItem>
             {info?.autoUnlockPasswordSupported && (
               <MenuItem to="/settings/auto-unlock">Auto Unlock</MenuItem>
             )}

frontend/src/components/ui/radio-group.tsx

@@ -32,7 +32,7 @@ const RadioGroupItem = React.forwardRef<
       {...props}
     >
       <RadioGroupPrimitive.Indicator className="flex items-center justify-center">
-        <CheckIcon className="h-3.5 w-3.5 fill-primary" />
+        <CheckIcon className="h-3.5 w-3.5" />
       </RadioGroupPrimitive.Indicator>
     </RadioGroupPrimitive.Item>
   );