feat(SPV-1059) fee and change

.golangci-lint.yml

@@ -96,12 +96,17 @@ issues:
     # Exclude some linters from running on tests files.
     - path: _test\.go
       linters:
-        - gocyclo
         - errcheck
         - gosec
         - wrapcheck
         - bodyclose
 
+    - path: /testabilities/
+      linters:
+        - gosec
+        - wrapcheck
+        - bodyclose
+
     - path: tester/
       linters:
         - gocyclo

actions/paymailserver/incoming_paymail_tx_test.go

@@ -6,6 +6,7 @@ import (
 	"time"
 
 	"github.com/bitcoin-sv/go-sdk/script"
+	trx "github.com/bitcoin-sv/go-sdk/transaction"
 	"github.com/bitcoin-sv/spv-wallet/actions/testabilities"
 	chainmodels "github.com/bitcoin-sv/spv-wallet/engine/chain/models"
 	testengine "github.com/bitcoin-sv/spv-wallet/engine/testabilities"
@@ -354,9 +355,11 @@ func TestIncomingPaymailBeef(t *testing.T) {
 			Post("/api/v2/transactions/outlines")
 
 		//  then:
-		thenResponse := testabilities.NewTransactionsEndpointAssertions(t, given).Response(res)
-		thenResponse.IsOK()
-		thenResponse.ContainsValidBEEFHexInField("hex")
+		then.Response(res).IsOK()
+
+		// and:
+		_, err := trx.NewTransactionFromBEEFHex(then.Response(res).JSONValue().GetString("hex"))
+		require.NoError(t, err)
 	})
 }
 

actions/testabilities/assert_spvwallet_application.go

@@ -8,6 +8,7 @@ import (
 	"testing"
 
 	"github.com/bitcoin-sv/spv-wallet/actions/testabilities/apierror"
+	testpaymail "github.com/bitcoin-sv/spv-wallet/engine/paymail/testabilities"
 	testengine "github.com/bitcoin-sv/spv-wallet/engine/testabilities"
 	"github.com/bitcoin-sv/spv-wallet/engine/tester/fixtures"
 	"github.com/bitcoin-sv/spv-wallet/engine/tester/jsonrequire"
@@ -19,7 +20,7 @@ import (
 type SPVWalletApplicationAssertions interface {
 	Response(response *resty.Response) SPVWalletResponseAssertions
 	User(user fixtures.User) SPVWalletAppUserAssertions
-	ExternalPaymailHost() testengine.PaymailExternalAssertions
+	ExternalPaymailHost() testpaymail.PaymailExternalAssertions
 }
 
 type SPVWalletResponseAssertions interface {
@@ -73,7 +74,7 @@ func (a *appAssertions) User(user fixtures.User) SPVWalletAppUserAssertions {
 	}
 }
 
-func (a *appAssertions) ExternalPaymailHost() testengine.PaymailExternalAssertions {
+func (a *appAssertions) ExternalPaymailHost() testpaymail.PaymailExternalAssertions {
 	return a.engineAssertions.ExternalPaymailHost()
 }
 

actions/v2/transactions/internal/mapping/outline_tx.go

@@ -80,6 +80,14 @@ func outlineOutputEntryToResponse(index int, value *transaction.OutputAnnotation
 func outlineOutputToResponse(from *transaction.OutputAnnotation) api.ModelsOutputAnnotation {
 	return api.ModelsOutputAnnotation{
 		Bucket: api.ModelsOutputAnnotationBucket(from.Bucket),
+		CustomInstructions: lo.IfF(
+			from.CustomInstructions != nil,
+			func() *api.ModelsSPVWalletCustomInstructions {
+				return lo.ToPtr(
+					lo.Map(*from.CustomInstructions, lox.MappingFn(customInstructionsToResponse)),
+				)
+			},
+		).Else(nil),
 		Paymail: lo.IfF(
 			from.Paymail != nil,
 			func() *api.ModelsPaymailAnnotationDetails {

actions/v2/transactions/internal/testabilities/ability_transactions_endpoint.go

@@ -2,12 +2,10 @@ package testabilities
 
 import (
 	"testing"
-
-	"github.com/bitcoin-sv/spv-wallet/actions/testabilities"
 )
 
-func New(t testing.TB) (given TransactionsEndpointFixture, then testabilities.TransactionsEndpointAssertions) {
+func New(t testing.TB) (given TransactionsEndpointFixture, then TransactionsEndpointAssertions) {
 	given = Given(t)
-	then = testabilities.NewTransactionsEndpointAssertions(t, given)
+	then = Then(t, given)
 	return
 }

actions/v2/transactions/internal/testabilities/assert_transaction_details.go

@@ -0,0 +1,53 @@
+package testabilities
+
+import (
+	"testing"
+
+	sdk "github.com/bitcoin-sv/go-sdk/transaction"
+	"github.com/bitcoin-sv/spv-wallet/engine/tester/fixtures"
+	"github.com/bitcoin-sv/spv-wallet/engine/v2/transaction"
+	"github.com/bitcoin-sv/spv-wallet/models/bsv"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+type TransactionDetailsAssertions interface {
+	WithOutputValues(values ...bsv.Satoshis) TransactionDetailsAssertions
+	OutputUnlockableBy(vout int, user fixtures.User) TransactionDetailsAssertions
+}
+
+type transactionAssertions struct {
+	t           testing.TB
+	tx          *sdk.Transaction
+	require     *require.Assertions
+	assert      *assert.Assertions
+	annotations transaction.Annotations
+}
+
+func (a *transactionAssertions) WithOutputValues(values ...bsv.Satoshis) TransactionDetailsAssertions {
+	a.t.Helper()
+	a.require.Lenf(a.tx.Outputs, len(values), "Tx has less outputs then expected values")
+	for i, v := range values {
+		a.assert.Equal(v, bsv.Satoshis(a.tx.Outputs[i].Satoshis), "output value mismatch")
+	}
+	return a
+}
+
+func (a *transactionAssertions) OutputUnlockableBy(vout int, user fixtures.User) TransactionDetailsAssertions {
+	a.t.Helper()
+	a.assert.Less(vout, len(a.tx.Outputs), "there is no vout to unlock in transaction outputs")
+
+	outputAnnotation, ok := a.annotations.Outputs[vout]
+	if !ok {
+		a.t.Fatalf("output %d has no required annotation", vout)
+	}
+	a.require.NotNil(outputAnnotation.CustomInstructions, "output %d has no custom instructions", vout)
+
+	fixtures.GivenTX(a.t).
+		WithSender(user).
+		WithInputFromUTXO(a.tx, uint32(vout), *outputAnnotation.CustomInstructions...).
+		WithOPReturn("dummy data").
+		TX() // during TX call, the transaction is signed. Should fail if the UTXO cannot be unlocked by the user.
+
+	return a
+}

actions/v2/transactions/internal/testabilities/assert_transactions_endpoint.go

@@ -0,0 +1,74 @@
+package testabilities
+
+import (
+	"testing"
+
+	sdk "github.com/bitcoin-sv/go-sdk/transaction"
+	"github.com/bitcoin-sv/spv-wallet/actions/testabilities"
+	"github.com/go-resty/resty/v2"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+type TransactionsEndpointAssertions interface {
+	Response(response *resty.Response) TransactionsResponseAssertions
+}
+
+type TransactionsResponseAssertions interface {
+	testabilities.SPVWalletResponseAssertions
+	ContainsValidTransaction(format string) TransactionDetailsAssertions
+}
+
+func Then(t testing.TB, app testabilities.SPVWalletApplicationFixture) TransactionsEndpointAssertions {
+	return &transactionEndpointAssertions{
+		t:                     t,
+		applicationAssertions: testabilities.Then(t, app),
+	}
+}
+
+type transactionEndpointAssertions struct {
+	t                     testing.TB
+	applicationAssertions testabilities.SPVWalletApplicationAssertions
+}
+
+func (a *transactionEndpointAssertions) Response(response *resty.Response) TransactionsResponseAssertions {
+	return &transactionResponseAssertions{
+		t:                           a.t,
+		require:                     require.New(a.t),
+		assert:                      assert.New(a.t),
+		response:                    response,
+		SPVWalletResponseAssertions: a.applicationAssertions.Response(response),
+	}
+}
+
+type transactionResponseAssertions struct {
+	testabilities.SPVWalletResponseAssertions
+	t        testing.TB
+	response *resty.Response
+	require  *require.Assertions
+	assert   *assert.Assertions
+}
+
+func (a *transactionResponseAssertions) ContainsValidTransaction(format string) TransactionDetailsAssertions {
+	a.t.Helper()
+	txHex := a.SPVWalletResponseAssertions.JSONValue().GetString("hex")
+	var tx *sdk.Transaction
+	var err error
+	switch format {
+	case "BEEF":
+		tx, err = sdk.NewTransactionFromBEEFHex(txHex)
+	case "RAW":
+		tx, err = sdk.NewTransactionFromHex(txHex)
+	default:
+		a.t.Fatalf("unsupported format: %s", format)
+	}
+
+	a.require.NoError(err, "hex is not valid tx in format %s", format)
+	a.assert.NotZero(tx.Version, "tx version is 0 which is not acceptable by nodes")
+	return &transactionAssertions{
+		t:       a.t,
+		require: a.require,
+		assert:  a.assert,
+		tx:      tx,
+	}
+}

actions/v2/transactions/internal/testabilities/fixture_transactions_endpoints.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/bitcoin-sv/spv-wallet/actions/testabilities"
 	"github.com/bitcoin-sv/spv-wallet/engine/tester/fixtures"
+	"github.com/bitcoin-sv/spv-wallet/engine/tester/paymailmock"
 )
 
 // ExpectedCustomInstructions represents json array with custom instructions of UTXO created with Faucet().TopUp() method
@@ -18,7 +19,7 @@ const ExpectedCustomInstructions = `[
 
 type TransactionsEndpointFixture interface {
 	testabilities.SPVWalletApplicationFixture
-	OutlineResponseContext(additionalParams map[string]any) map[string]any
+	OutlineResponseContext(format string, additionalParams map[string]any) map[string]any
 }
 
 func Given(t testing.TB) TransactionsEndpointFixture {
@@ -31,11 +32,14 @@ type fixture struct {
 	testabilities.SPVWalletApplicationFixture
 }
 
-func (f *fixture) OutlineResponseContext(paramsOverride map[string]any) map[string]any {
-	params := make(map[string]any)
-	params["ReceiverPaymail"] = fixtures.RecipientExternal.DefaultPaymail()
-	params["SenderPaymail"] = fixtures.Sender.DefaultPaymail()
-	params["CustomInstructions"] = ExpectedCustomInstructions
+func (f *fixture) OutlineResponseContext(format string, paramsOverride map[string]any) map[string]any {
+	params := map[string]any{
+		"Format":             format,
+		"ReceiverPaymail":    fixtures.RecipientExternal.DefaultPaymail(),
+		"SenderPaymail":      fixtures.Sender.DefaultPaymail(),
+		"CustomInstructions": ExpectedCustomInstructions,
+		"Reference":          paymailmock.MockedReferenceID,
+	}
 
 	maps.Copy(params, paramsOverride)