loopdb: modify liquidity to use asset ids

Author: sputn1ck

liquidity/autoloop_testcontext_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop"
 	"github.com/lightninglabs/loop/loopdb"
+	"github.com/lightninglabs/loop/loopdb/sqlc"
 	"github.com/lightninglabs/loop/swap"
 	"github.com/lightninglabs/loop/test"
 	"github.com/lightningnetwork/lnd/clock"
@@ -188,10 +189,14 @@ func newAutoloopTestCtx(t *testing.T, parameters Parameters,
 		MinimumConfirmations: loop.DefaultSweepConfTarget,
 		Lnd:                  &testCtx.lnd.LndServices,
 		Clock:                testCtx.testClock,
-		PutLiquidityParams: func(_ context.Context, _ []byte) error {
+		PutLiquidityParams: func(_ context.Context, _ string,
+			_ []byte) error {
+
 			return nil
 		},
-		FetchLiquidityParams: func(context.Context) ([]byte, error) {
+		FetchLiquidityParams: func(context.Context) (
+			[]sqlc.LiquidityParam, error) {
+
 			return nil, nil
 		},
 	}

liquidity/liquidity.go

@@ -46,6 +46,7 @@ import (
 	"github.com/lightninglabs/loop"
 	"github.com/lightninglabs/loop/labels"
 	"github.com/lightninglabs/loop/loopdb"
+	"github.com/lightninglabs/loop/loopdb/sqlc"
 	clientrpc "github.com/lightninglabs/loop/looprpc"
 	"github.com/lightninglabs/loop/swap"
 	"github.com/lightningnetwork/lnd/clock"
@@ -110,6 +111,9 @@ const (
 	// defaultHtlcConfTarget is the default confirmation target we use for
 	// loop in swap htlcs, set to the same default at the client.
 	defaultHtlcConfTarget = loop.DefaultHtlcConfTarget
+
+	// defaultBtcAssetId is the default asset ID for BTC.
+	defaultBtcAssetId = "btc"
 )
 
 var (
@@ -229,13 +233,15 @@ type Config struct {
 	//
 	// NOTE: the params are encoded using `proto.Marshal` over an RPC
 	// request.
-	PutLiquidityParams func(ctx context.Context, params []byte) error
+	PutLiquidityParams func(ctx context.Context, assetId string,
+		params []byte) error
 
 	// FetchLiquidityParams reads the serialized `Parameters` from db.
 	//
 	// NOTE: the params are decoded using `proto.Unmarshal` over a
 	// serialized RPC request.
-	FetchLiquidityParams func(ctx context.Context) ([]byte, error)
+	FetchLiquidityParams func(ctx context.Context) ([]sqlc.LiquidityParam,
+		error)
 }
 
 // Manager contains a set of desired liquidity rules for our channel
@@ -392,7 +398,8 @@ func (m *Manager) saveParams(ctx context.Context, req proto.Message) error {
 	}
 
 	// Save the params on disk.
-	if err := m.cfg.PutLiquidityParams(ctx, paramsBytes); err != nil {
+	err = m.cfg.PutLiquidityParams(ctx, defaultBtcAssetId, paramsBytes)
+	if err != nil {
 		return fmt.Errorf("failed to save params: %v", err)
 	}
 
@@ -404,19 +411,22 @@ func (m *Manager) saveParams(ctx context.Context, req proto.Message) error {
 func (m *Manager) loadParams(ctx context.Context) (
 	*clientrpc.LiquidityParameters, error) {
 
-	paramsBytes, err := m.cfg.FetchLiquidityParams(ctx)
+	params, err := m.cfg.FetchLiquidityParams(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("failed to read params: %v", err)
 	}
 
 	// Return early if there's nothing saved.
-	if paramsBytes == nil {
+	if params == nil {
 		return nil, nil
 	}
 
 	// Unmarshal the params.
 	req := &clientrpc.LiquidityParameters{}
-	err = proto.Unmarshal(paramsBytes, req)
+	if len(params) != 1 {
+		return nil, fmt.Errorf("expected 1 param, got %v", len(params))
+	}
+	err = proto.Unmarshal(params[0].Params, req)
 	if err != nil {
 		return nil, fmt.Errorf("failed to unmarshal params: %v", err)
 	}

liquidity/liquidity_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/lightninglabs/loop"
 	"github.com/lightninglabs/loop/labels"
 	"github.com/lightninglabs/loop/loopdb"
+	"github.com/lightninglabs/loop/loopdb/sqlc"
 	clientrpc "github.com/lightninglabs/loop/looprpc"
 	"github.com/lightninglabs/loop/swap"
 	"github.com/lightninglabs/loop/test"
@@ -268,10 +269,12 @@ func TestPersistParams(t *testing.T) {
 
 	ctxb := context.Background()
 
-	var paramsBytes []byte
+	var paramsBytes []sqlc.LiquidityParam
 
 	// Mock the read method to return empty data.
-	manager.cfg.FetchLiquidityParams = func(context.Context) ([]byte, error) {
+	manager.cfg.FetchLiquidityParams = func(context.Context) (
+		[]sqlc.LiquidityParam, error) {
+
 		return paramsBytes, nil
 	}
 
@@ -282,9 +285,14 @@ func TestPersistParams(t *testing.T) {
 
 	// Mock the write method to return no error.
 	manager.cfg.PutLiquidityParams = func(ctx context.Context,
-		data []byte) error {
+		assetId string, data []byte) error {
 
-		paramsBytes = data
+		paramsBytes = []sqlc.LiquidityParam{
+			{
+				AssetID: defaultBtcAssetId,
+				Params:  data,
+			},
+		}
 		return nil
 	}
 

loopdb/interface.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"time"
 
+	"github.com/lightninglabs/loop/loopdb/sqlc"
 	"github.com/lightningnetwork/lnd/lntypes"
 )
 
@@ -61,14 +62,15 @@ type SwapStore interface {
 	//
 	// NOTE: it's the caller's responsibility to encode the param. Atm,
 	// it's encoding using the proto package's `Marshal` method.
-	PutLiquidityParams(ctx context.Context, params []byte) error
+	PutLiquidityParams(ctx context.Context, assetId string,
+		params []byte) error
 
 	// FetchLiquidityParams reads the serialized `manager.Parameters` bytes
 	// from the bucket.
 	//
 	// NOTE: it's the caller's responsibility to decode the param. Atm,
 	// it's decoding using the proto package's `Unmarshal` method.
-	FetchLiquidityParams(ctx context.Context) ([]byte, error)
+	FetchLiquidityParams(ctx context.Context) ([]sqlc.LiquidityParam, error)
 
 	// BatchUpdateLoopOutSwapCosts updates the swap costs for a batch of
 	// loop out swaps.

loopdb/migrate.go

@@ -184,7 +184,7 @@ func (m *MigratorManager) migrateLiquidityParams(ctx context.Context) error {
 	}
 
 	// Put the liquidity parameters in the toStore.
-	err = m.toStore.PutLiquidityParams(ctx, params)
+	err = m.toStore.PutLiquidityParams(ctx, "btc", params[0].Params)
 	if err != nil {
 		return err
 	}
@@ -295,11 +295,14 @@ func (m *MigratorManager) checkLiquidityParams(ctx context.Context) error {
 		return err
 	}
 
-	// Check that the liquidity parameters are the same.
-	if !bytes.Equal(fromParams, toParams) {
-		return NewMigrationError(
-			fmt.Errorf("from: %v, to: %v", fromParams, toParams),
-		)
+	for i, fromParam := range fromParams {
+		// Check that the liquidity parameters are the same.
+		if !bytes.Equal(fromParam.Params, toParams[i].Params) {
+			return NewMigrationError(
+				fmt.Errorf("from: %v, to: %v", fromParams,
+					toParams),
+			)
+		}
 	}
 
 	return nil

loopdb/sql_store.go

@@ -342,10 +342,15 @@ func (db *BaseDB) UpdateLoopIn(ctx context.Context, hash lntypes.Hash,
 //
 // NOTE: it's the caller's responsibility to encode the param. Atm,
 // it's encoding using the proto package's `Marshal` method.
-func (db *BaseDB) PutLiquidityParams(ctx context.Context,
+func (db *BaseDB) PutLiquidityParams(ctx context.Context, assetId string,
 	params []byte) error {
 
-	err := db.Queries.UpsertLiquidityParams(ctx, params)
+	err := db.Queries.UpsertLiquidityParams(
+		ctx, sqlc.UpsertLiquidityParamsParams{
+			AssetID: assetId,
+			Params:  params,
+		},
+	)
 	if err != nil {
 		return err
 	}
@@ -358,10 +363,10 @@ func (db *BaseDB) PutLiquidityParams(ctx context.Context,
 //
 // NOTE: it's the caller's responsibility to decode the param. Atm,
 // it's decoding using the proto package's `Unmarshal` method.
-func (db *BaseDB) FetchLiquidityParams(ctx context.Context) ([]byte,
-	error) {
+func (db *BaseDB) FetchLiquidityParams(ctx context.Context) (
+	[]sqlc.LiquidityParam, error) {
 
-	var params []byte
+	var params []sqlc.LiquidityParam
 	params, err := db.Queries.FetchLiquidityParams(ctx)
 	if errors.Is(err, sql.ErrNoRows) {
 		return params, nil

loopdb/sql_test.go

@@ -317,16 +317,17 @@ func TestSqliteLiquidityParams(t *testing.T) {
 	require.Empty(t, params, "expect empty bytes")
 	require.Nil(t, params, "expected nil byte array")
 
-	params = []byte("test")
+	insrtParams := []byte("test")
 
 	// Test we can save the params.
-	err = store.PutLiquidityParams(ctxb, params)
+	err = store.PutLiquidityParams(ctxb, "test", insrtParams)
 	require.NoError(t, err, "failed to put params")
 
 	// Now fetch the db again should return the above saved bytes.
 	paramsRead, err := store.FetchLiquidityParams(ctxb)
 	require.NoError(t, err, "failed to fetch params")
-	require.Equal(t, params, paramsRead, "unexpected return value")
+	require.Equal(t, insrtParams, paramsRead[0].Params,
+		"unexpected return value")
 }
 
 // TestSqliteTypeConversion is a small test that checks that we can safely

loopdb/sqlc/liquidity_params.sql.go

@@ -0,0 +1 @@
+ALTER TABLE liquidity_params DROP COLUMN asset_id;

loopdb/sqlc/migrations/000013_liquidity_assets.down.sql

@@ -0,0 +1,15 @@
+-- Create a new table with the desired schema
+CREATE TABLE new_liquidity_params (
+    asset_id TEXT NOT NULL PRIMARY KEY,
+    params BLOB
+);
+
+-- Copy data from the old table to the new table
+INSERT INTO new_liquidity_params (asset_id, params)
+SELECT 'BTC', params FROM liquidity_params;
+
+-- Drop the old table
+DROP TABLE liquidity_params;
+
+-- Rename the new table to the old table name
+ALTER TABLE new_liquidity_params RENAME TO liquidity_params;