feat(SPV-1337): paymail capabilities test

actions/paymailserver/incoming_paymail_tx_test.go

@@ -0,0 +1,229 @@
+package paymailserver_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/bitcoin-sv/go-sdk/script"
+	"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"
+	"github.com/bitcoin-sv/spv-wallet/engine/tester/fixtures"
+	"github.com/stretchr/testify/require"
+)
+
+func TestIncomingPaymailRawTX(t *testing.T) {
+	givenForAllTests := testabilities.Given(t)
+	cleanup := givenForAllTests.StartedSPVWalletWithConfiguration(
+		testengine.WithDomainValidationDisabled(),
+	)
+	defer cleanup()
+
+	var testState struct {
+		reference     string
+		lockingScript *script.Script
+	}
+
+	// given:
+	given, then := testabilities.NewOf(givenForAllTests, t)
+	client := given.HttpClient().ForAnonymous()
+
+	// and:
+	address := fixtures.Sender.Paymails[0]
+	satoshis := uint64(1000)
+	note := "test note"
+
+	t.Run("step 1 - call p2p-payment-destination", func(t *testing.T) {
+		// given:
+		requestBody := map[string]any{
+			"satoshis": satoshis,
+		}
+
+		// when:
+		res, _ := client.R().
+			SetHeader("Content-Type", "application/json").
+			SetBody(requestBody).
+			Post(
+				fmt.Sprintf(
+					"https://example.com/v1/bsvalias/p2p-payment-destination/%s",
+					address,
+				),
+			)
+
+		// then:
+		then.Response(res).IsOK().WithJSONMatching(`{
+			"outputs": [
+			  {
+			    "address": "{{ matchAddress }}",
+			    "satoshis": {{ .satoshis }},
+			    "script": "{{ matchHex }}"
+			  }
+			],
+			"reference": "{{ matchHexWithLength 32 }}"
+		}`, map[string]any{
+			"satoshis": satoshis,
+		})
+
+		// update:
+		getter := then.Response(res).JSONValue()
+		testState.reference = getter.GetString("reference")
+
+		// and:
+		lockingScript, err := script.NewFromHex(getter.GetString("outputs[0]/script"))
+		require.NoError(t, err)
+		testState.lockingScript = lockingScript
+	})
+
+	t.Run("step 2 - call receive-transaction capability", func(t *testing.T) {
+		// given:
+		txSpec := fixtures.GivenTX(t).
+			WithInput(satoshis+1).
+			WithOutputScript(satoshis, testState.lockingScript)
+
+		// and:
+		requestBody := map[string]any{
+			"hex":       txSpec.RawTX(),
+			"reference": testState.reference,
+			"metadata": map[string]any{
+				"note": note,
+			},
+		}
+
+		// and:
+		given.ARC().WillRespondForBroadcast(200, &chainmodels.TXInfo{
+			TxID:     txSpec.ID(),
+			TXStatus: chainmodels.SeenOnNetwork,
+		})
+
+		// when:
+		res, _ := client.R().
+			SetHeader("Content-Type", "application/json").
+			SetBody(requestBody).
+			Post(
+				fmt.Sprintf(
+					"https://example.com/v1/bsvalias/receive-transaction/%s",
+					address,
+				),
+			)
+
+		// then:
+		then.Response(res).IsOK().WithJSONMatching(`{
+			"txid": "{{ .txid }}",
+			"note": "{{ .note }}"
+		}`, map[string]any{
+			"txid": txSpec.ID(),
+			"note": note,
+		})
+	})
+}
+
+func TestIncomingPaymailBeef(t *testing.T) {
+	givenForAllTests := testabilities.Given(t)
+	cleanup := givenForAllTests.StartedSPVWalletWithConfiguration(
+		testengine.WithDomainValidationDisabled(),
+	)
+	defer cleanup()
+
+	var testState struct {
+		reference     string
+		lockingScript *script.Script
+		txID          string
+	}
+
+	// given:
+	given, then := testabilities.NewOf(givenForAllTests, t)
+	client := given.HttpClient().ForAnonymous()
+
+	// and:
+	address := fixtures.Sender.Paymails[0]
+	satoshis := uint64(1000)
+	note := "test note"
+
+	t.Run("step 1 - call p2p-payment-destination", func(t *testing.T) {
+		// given:
+		requestBody := map[string]any{
+			"satoshis": satoshis,
+		}
+
+		// when:
+		res, _ := client.R().
+			SetHeader("Content-Type", "application/json").
+			SetBody(requestBody).
+			Post(
+				fmt.Sprintf(
+					"https://example.com/v1/bsvalias/p2p-payment-destination/%s",
+					address,
+				),
+			)
+
+		// then:
+		then.Response(res).IsOK().WithJSONMatching(`{
+			"outputs": [
+			  {
+			    "address": "{{ matchAddress }}",
+			    "satoshis": {{ .satoshis }},
+			    "script": "{{ matchHex }}"
+			  }
+			],
+			"reference": "{{ matchHexWithLength 32 }}"
+		}`, map[string]any{
+			"satoshis": satoshis,
+		})
+
+		// update:
+		getter := then.Response(res).JSONValue()
+		testState.reference = getter.GetString("reference")
+
+		// and:
+		lockingScript, err := script.NewFromHex(getter.GetString("outputs[0]/script"))
+		require.NoError(t, err)
+		testState.lockingScript = lockingScript
+	})
+
+	t.Run("step 2 - call beef capability", func(t *testing.T) {
+		// given:
+		txSpec := fixtures.GivenTX(t).
+			WithInput(satoshis+1).
+			WithOutputScript(satoshis, testState.lockingScript)
+
+		// and:
+		requestBody := map[string]any{
+			"beef":      txSpec.BEEF(),
+			"reference": testState.reference,
+			"metadata": map[string]any{
+				"note": note,
+			},
+		}
+
+		// and:
+		given.ARC().WillRespondForBroadcast(200, &chainmodels.TXInfo{
+			TxID:     txSpec.ID(),
+			TXStatus: chainmodels.SeenOnNetwork,
+		})
+
+		// and;
+		given.BHS().WillRespondForMerkleRootsVerify(200, &chainmodels.MerkleRootsConfirmations{
+			ConfirmationState: chainmodels.MRConfirmed,
+		})
+
+		// when:
+		res, _ := client.R().
+			SetHeader("Content-Type", "application/json").
+			SetBody(requestBody).
+			Post(
+				fmt.Sprintf(
+					"https://example.com/v1/bsvalias/beef/%s",
+					address,
+				),
+			)
+
+		// then:
+		then.Response(res).IsOK().WithJSONMatching(`{
+			"txid": "{{ .txid }}",
+			"note": "{{ .note }}"
+		}`, map[string]any{
+			"txid": txSpec.ID(),
+			"note": note,
+		})
+	})
+}

actions/paymailserver/register.go

@@ -0,0 +1,11 @@
+package paymailserver
+
+import (
+	"github.com/bitcoin-sv/go-paymail/server"
+	"github.com/gin-gonic/gin"
+)
+
+// Register registers the paymail server.
+func Register(configuration *server.Configuration, ginEngine *gin.Engine) {
+	configuration.RegisterRoutes(ginEngine)
+}