feat(SPV-1535) handle ARC callback (#935)

Co-authored-by: Damian Orzepowski <damian.orzepowski@4chain.studio>

Author: chris-4chain

actions/testabilities/assert_spvwallet_application.go

@@ -21,6 +21,7 @@ type SPVWalletApplicationAssertions interface {
 	Response(response *resty.Response) SPVWalletResponseAssertions
 	User(user fixtures.User) SPVWalletAppUserAssertions
 	ExternalPaymailHost() testpaymail.PaymailExternalAssertions
+	ARC() testengine.ARCAssertions
 }
 
 type SPVWalletResponseAssertions interface {
@@ -80,6 +81,10 @@ func (a *appAssertions) ExternalPaymailHost() testpaymail.PaymailExternalAsserti
 	return a.engineAssertions.ExternalPaymailHost()
 }
 
+func (a *appAssertions) ARC() testengine.ARCAssertions {
+	return a.engineAssertions.ARC()
+}
+
 type responseAssertions struct {
 	t        testing.TB
 	require  *require.Assertions

actions/testabilities/assert_spvwallet_user.go

@@ -31,6 +31,8 @@ type LastOperationAssertions interface {
 	WithCounterparty(counterparty string) LastOperationAssertions
 	WithNoCounterparty() LastOperationAssertions
 	WithTxStatus(txStatus string) LastOperationAssertions
+	WithBlockHeight(blockHeight int64) LastOperationAssertions
+	WithBlockHash(blockHash string) LastOperationAssertions
 }
 
 type userAssertions struct {
@@ -131,3 +133,17 @@ func (l *lastOperationAssertions) WithTxStatus(txStatus string) LastOperationAss
 	l.require.EqualValues(txStatus, l.content.TxStatus)
 	return l
 }
+
+func (l *lastOperationAssertions) WithBlockHeight(blockHeight int64) LastOperationAssertions {
+	l.t.Helper()
+	l.require.NotNil(l.content.BlockHeight)
+	l.require.EqualValues(blockHeight, *l.content.BlockHeight)
+	return l
+}
+
+func (l *lastOperationAssertions) WithBlockHash(blockHash string) LastOperationAssertions {
+	l.t.Helper()
+	l.require.NotNil(l.content.BlockHash)
+	l.require.Equal(blockHash, *l.content.BlockHash)
+	return l
+}

actions/testabilities/fixture_spvwallet_application.go

@@ -42,6 +42,8 @@ type SPVWalletApplicationFixture interface {
 
 	// Tx creates a new mocked transaction builder
 	Tx() txtestability.TransactionSpec
+
+	Config() *config.AppConfig
 }
 
 type BlockHeadersServiceFixture interface {
@@ -167,3 +169,7 @@ func (f *appFixture) Tx() txtestability.TransactionSpec {
 func (f *appFixture) EngineFixture() testengine.EngineFixture {
 	return f.engineFixture
 }
+
+func (f *appFixture) Config() *config.AppConfig {
+	return &f.engineWithConfig.Config
+}

actions/transactions/broadcast_callback.go

@@ -12,17 +12,23 @@ import (
 // broadcastCallback will handle a broadcastCallback call from the broadcast api
 func broadcastCallback(c *gin.Context) {
 	logger := reqctx.Logger(c)
-	var callbackResp *chainmodels.TXInfo
+	config := reqctx.AppConfig(c)
+	var callbackResp chainmodels.TXInfo
 
 	err := c.Bind(&callbackResp)
 	if err != nil {
 		spverrors.ErrorResponse(c, spverrors.ErrCannotBindRequest, logger)
 		return
 	}
 
-	err = reqctx.Engine(c).HandleTxCallback(c.Request.Context(), callbackResp)
+	if config.ExperimentalFeatures.V2 {
+		err = reqctx.Engine(c).TxSyncService().Handle(c, callbackResp)
+	} else {
+		err = reqctx.Engine(c).HandleTxCallback(c, &callbackResp)
+	}
+
 	if err != nil {
-		logger.Err(err).Msgf("failed to update transaction - tx: %v", callbackResp)
+		logger.Err(err).Any("TxInfo", callbackResp).Msgf("failed to update transaction in ARC broadcast callback handler")
 	}
 
 	c.Status(http.StatusOK)

actions/transactions/routes.go

@@ -1,7 +1,8 @@
 package transactions
 
 import (
-	"github.com/bitcoin-sv/spv-wallet/config"
+	"fmt"
+
 	"github.com/bitcoin-sv/spv-wallet/server/handlers"
 )
 
@@ -15,5 +16,16 @@ func RegisterRoutes(handlersManager *handlers.Manager) {
 	group.POST("/drafts", handlers.AsUser(newTransactionDraft))
 	group.POST("", handlers.AsUser(recordTransaction))
 
-	handlersManager.Get(handlers.GroupTransactionCallback).POST(config.BroadcastCallbackRoute, broadcastCallback)
+	registerARCCallback(handlersManager)
+}
+
+func registerARCCallback(handlersManager *handlers.Manager) {
+	config := handlersManager.GetConfig()
+	if config.ARCCallbackEnabled() {
+		callbackURL, err := config.ARC.Callback.ShouldGetURL()
+		if err != nil {
+			panic(fmt.Sprintf(`couldn't get callback URL from configuration: %v`, err.Error()))
+		}
+		handlersManager.Get(handlers.GroupTransactionCallback).POST(callbackURL.Path, broadcastCallback)
+	}
 }

actions/v2/internal/integrationtests/handle_arc_callback_test.go

@@ -0,0 +1,108 @@
+package integrationtests
+
+import (
+	"testing"
+	"time"
+
+	"github.com/bitcoin-sv/go-sdk/chainhash"
+	trx "github.com/bitcoin-sv/go-sdk/transaction"
+	"github.com/bitcoin-sv/spv-wallet/actions/v2/internal/integrationtests/testabilities"
+	chainmodels "github.com/bitcoin-sv/spv-wallet/engine/chain/models"
+	testengine "github.com/bitcoin-sv/spv-wallet/engine/testabilities"
+	"github.com/bitcoin-sv/spv-wallet/engine/v2/transaction/txmodels"
+)
+
+func TestHandlingARCCallback(t *testing.T) {
+	tests := map[string]struct {
+		txInfo         chainmodels.TXInfo
+		expectStatus   txmodels.TxStatus
+		beforeCallback func(t *testing.T, txInfo *chainmodels.TXInfo)
+	}{
+		"On Mined with BUMP": {
+			txInfo: chainmodels.TXInfo{
+				TXStatus:    chainmodels.Mined,
+				BlockHeight: 885803,
+				BlockHash:   "00000000000000000f0905597b6cac80031f0f56834e74dce1a714c682a9ed38",
+				Timestamp:   time.Now().Add(10 * time.Minute),
+			},
+			beforeCallback: calcBump,
+			expectStatus:   txmodels.TxStatusMined,
+		},
+		"On SeenOnNetwork do nothing": {
+			txInfo:       minimalTxInfo(chainmodels.SeenOnNetwork),
+			expectStatus: txmodels.TxStatusBroadcasted,
+		},
+		"On Rejected mark as problematic": {
+			txInfo:       minimalTxInfo(chainmodels.Rejected),
+			expectStatus: txmodels.TxStatusProblematic,
+		},
+	}
+	for name, test := range tests {
+		t.Run(name, func(t *testing.T) {
+			// given:
+			given, when, then := testabilities.New(t)
+			cleanup := given.StartedSPVWalletV2()
+			defer cleanup()
+
+			// when:
+			receiveTxID := when.Alice().ReceivesFromExternal(10)
+
+			// then:
+			then.ARC().Broadcasted().
+				WithTxID(receiveTxID).
+				WithCallbackURL("https://example.com/transaction/broadcast/callback").
+				WithCallbackToken(testengine.CallbackTestToken)
+
+			// and:
+			then.Alice().Operations().Last().
+				WithTxID(receiveTxID).
+				WithTxStatus("BROADCASTED")
+
+			// given:
+			test.txInfo.TxID = receiveTxID
+			if test.beforeCallback != nil {
+				test.beforeCallback(t, &test.txInfo)
+			}
+
+			// when:
+			test.txInfo.TxID = receiveTxID
+			if test.beforeCallback != nil {
+				test.beforeCallback(t, &test.txInfo)
+			}
+			when.ARC().SendsCallback(test.txInfo)
+
+			// then:
+			then.Alice().Operations().Last().
+				WithTxID(receiveTxID).
+				WithTxStatus(string(test.expectStatus))
+
+			if test.expectStatus == txmodels.TxStatusMined {
+				then.Alice().Operations().Last().
+					WithBlockHash(test.txInfo.BlockHash).
+					WithBlockHeight(test.txInfo.BlockHeight)
+			}
+
+			// TODO: Assert for BEEF after Searching Transactions is implemented
+		})
+	}
+}
+
+func minimalTxInfo(txStatus chainmodels.TXStatus) chainmodels.TXInfo {
+	return chainmodels.TXInfo{
+		TXStatus:  txStatus,
+		Timestamp: time.Now().Add(10 * time.Minute),
+	}
+}
+
+func calcBump(t *testing.T, txInfo *chainmodels.TXInfo) {
+	t.Helper()
+
+	txID, _ := chainhash.NewHashFromHex(txInfo.TxID)
+	bump := trx.NewMerklePath(uint32(txInfo.BlockHeight), [][]*trx.PathElement{{
+		&trx.PathElement{
+			Hash:   txID,
+			Offset: 0,
+		},
+	}})
+	txInfo.MerklePath = bump.Hex()
+}

actions/v2/internal/integrationtests/spend_external_funds_internally_test.go

@@ -12,7 +12,7 @@ func TestSpendExternalFundsInternally(t *testing.T) {
 	cleanup := given.StartedSPVWalletV2()
 	defer cleanup()
 
-	// and:
+	// when:
 	receiveTxID := when.Alice().ReceivesFromExternal(10)
 
 	// then:

actions/v2/internal/integrationtests/testabilities/ability_actions.go

@@ -36,6 +36,7 @@ type IntegrationTestAction interface {
 	Alice() ActorsActions
 	Bob() ActorsActions
 	Charlie() ActorsActions
+	ARC() ARCActions
 }
 
 type ActorsActions interface {
@@ -46,6 +47,10 @@ type ActorsActions interface {
 	CreatesOutline() OutlineBuilder
 }
 
+type ARCActions interface {
+	SendsCallback(txInfo chainmodels.TXInfo)
+}
+
 type actions struct {
 	t       testing.TB
 	fixture *fixture
@@ -62,6 +67,13 @@ func (a *actions) Alice() ActorsActions {
 	return a.fixture.alice
 }
 
+func (a *actions) ARC() ARCActions {
+	return &arcActions{
+		t:       a.t,
+		fixture: a.fixture,
+	}
+}
+
 func (a *actions) Bob() ActorsActions {
 	return a.fixture.bob
 }

actions/v2/internal/integrationtests/testabilities/ability_arc_actions.go

@@ -0,0 +1,26 @@
+package testabilities
+
+import (
+	"testing"
+
+	chainmodels "github.com/bitcoin-sv/spv-wallet/engine/chain/models"
+	"github.com/stretchr/testify/require"
+)
+
+type arcActions struct {
+	t       testing.TB
+	fixture *fixture
+}
+
+func (a *arcActions) SendsCallback(txInfo chainmodels.TXInfo) {
+	client := a.fixture.HttpClient().ForAnonymous()
+	token := a.fixture.Config().ARC.Callback.Token
+
+	res, _ := client.R().
+		SetHeader("Content-Type", "application/json").
+		SetBody(txInfo).
+		SetAuthToken(token).
+		Post("/transaction/broadcast/callback")
+
+	require.Equal(a.t, 200, res.StatusCode())
+}

actions/v2/internal/integrationtests/testabilities/assert_actors.go

@@ -4,12 +4,14 @@ import (
 	"testing"
 
 	"github.com/bitcoin-sv/spv-wallet/actions/testabilities"
+	testengine "github.com/bitcoin-sv/spv-wallet/engine/testabilities"
 )
 
 type IntegrationTestAssertion interface {
 	Alice() SpvWalletActorsStateAssertions
 	Bob() SpvWalletActorsStateAssertions
 	Charlie() SpvWalletActorsStateAssertions
+	ARC() testengine.ARCAssertions
 }
 
 // SpvWalletActorsStateAssertions about spv-wallet users