muun-recovery/libwallet/fees/fees_test.go

package fees

import (
	"reflect"
	"testing"

	"github.com/btcsuite/btcutil"
)

func TestComputeSwapFees(t *testing.T) {
	testCases := []struct {
		desc              string
		amount            btcutil.Amount
		bestRouteFees     []BestRouteFees
		policies          *FundingOutputPolicies
		takeFeeFromAmount bool
		expected          *SwapFees
	}{
		{
			desc:   "smoke test",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 0,
			},
			takeFeeFromAmount: false,
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        1010,
				ConfirmationsNeeded: 1,
			},
		},
		{
			desc:   "qualifies for 0-conf",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 1000000,
			},
			takeFeeFromAmount: false,
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				ConfirmationsNeeded: 0,
				OutputAmount:        1010,
			},
		},
		{
			desc:   "qualifies for debt lend",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			takeFeeFromAmount: false,
			policies: &FundingOutputPolicies{
				MaximumDebt:       1000000,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 1000000,
			},
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeLend,
				DebtAmount:          1010,
				OutputAmount:        0,
				ConfirmationsNeeded: 0,
			},
		},
		{
			desc:   "debt collect",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			policies: &FundingOutputPolicies{
				MaximumDebt:       100,
				PotentialCollect:  1010,
				MaxAmountFor0Conf: 1000000,
			},
			takeFeeFromAmount: false,
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeCollect,
				DebtAmount:          1010,
				OutputAmount:        2020,
				ConfirmationsNeeded: 0,
			},
		},
		{
			desc:   "dust threshold",
			amount: 50,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			takeFeeFromAmount: false,
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 0,
			},
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       486,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        546,
				ConfirmationsNeeded: 1,
			},
		},
		{
			desc:   "sub-dust lend",
			amount: 50,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			takeFeeFromAmount: false,
			policies: &FundingOutputPolicies{
				MaximumDebt:       1000000,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 1000000,
			},
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       486,
				DebtType:            DebtTypeLend,
				DebtAmount:          60,
				OutputAmount:        0,
				ConfirmationsNeeded: 0,
			},
		},
		{
			desc:   "uses last route if route with enough capacity",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              900,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
				{
					MaxCapacity:              900,
					FeeProportionalMillionth: 1,
					FeeBase:                  20,
				},
			},
			takeFeeFromAmount: false,
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 0,
			},
			expected: &SwapFees{
				RoutingFee:          20,
				OutputPadding:       0,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        1020,
				ConfirmationsNeeded: 1,
			},
		},
		{
			desc:   "smoke test TFFA",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 0,
			},
			takeFeeFromAmount: true,
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        1010,
				ConfirmationsNeeded: 1,
			},
		},
		{
			desc:   "qualifies for 0-conf TFFA",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 0,
			},
			takeFeeFromAmount: true,
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        1010,
				ConfirmationsNeeded: 1,
			},
		},
		{
			desc:   "qualifies for debt lend TFFA",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			takeFeeFromAmount: true,
			policies: &FundingOutputPolicies{
				MaximumDebt:       1000000,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 1000000,
			},
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        1010,
				ConfirmationsNeeded: 0,
			},
		},
		{
			desc:   "debt collect TFFA",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			policies: &FundingOutputPolicies{
				MaximumDebt:       100,
				PotentialCollect:  1010,
				MaxAmountFor0Conf: 1000000,
			},
			takeFeeFromAmount: true,
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       0,
				DebtType:            DebtTypeCollect,
				DebtAmount:          1010,
				OutputAmount:        2020,
				ConfirmationsNeeded: 0,
			},
		},
		{
			desc:   "dust threshold TFFA",
			amount: 50,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              100000,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
			},
			takeFeeFromAmount: true,
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 0,
			},
			expected: &SwapFees{
				RoutingFee:          10,
				OutputPadding:       486,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        546,
				ConfirmationsNeeded: 1,
			},
		},
		{
			desc:   "uses last route if route with enough capacity",
			amount: 1000,
			bestRouteFees: []BestRouteFees{
				{
					MaxCapacity:              900,
					FeeProportionalMillionth: 1,
					FeeBase:                  10,
				},
				{
					MaxCapacity:              900,
					FeeProportionalMillionth: 1,
					FeeBase:                  20,
				},
			},
			takeFeeFromAmount: true,
			policies: &FundingOutputPolicies{
				MaximumDebt:       0,
				PotentialCollect:  0,
				MaxAmountFor0Conf: 0,
			},
			expected: &SwapFees{
				RoutingFee:          20,
				OutputPadding:       0,
				DebtType:            DebtTypeNone,
				DebtAmount:          0,
				OutputAmount:        1020,
				ConfirmationsNeeded: 1,
			},
		},
	}
	for _, tC := range testCases {
		t.Run(tC.desc, func(t *testing.T) {
			fees := ComputeSwapFees(tC.amount, tC.bestRouteFees, tC.policies, tC.takeFeeFromAmount)
			if !reflect.DeepEqual(fees, tC.expected) {
				t.Errorf("fees do not equal expected fees (%+v != %+v)", fees, tC.expected)
			}
		})
	}
}