Support custom push payload with initial currency info navigation (#13)

* Support custom push payload with initial currency info navigation

* Run proto validation on custom push payload

Author: jeffyanta

geyser/integration.go

@@ -37,5 +37,6 @@ func (i *Integration) OnDepositReceived(ctx context.Context, owner, mint *ocp_co
 	if ocp_common.IsCoreMint(mint) {
 		return push.SendUsdfDepositedPush(ctx, i.pusher, userID, usdMarketValue)
 	}
-	return push.SendFlipcashCurrencyDepositedPush(ctx, i.pusher, userID, currencyName, usdMarketValue)
+	protoMint := &commonpb.PublicKey{Value: mint.PublicKey().ToBytes()}
+	return push.SendFlipcashCurrencyDepositedPush(ctx, i.pusher, userID, protoMint, currencyName, usdMarketValue)
 }

go.mod

@@ -5,9 +5,9 @@ go 1.25.0
 require (
 	firebase.google.com/go/v4 v4.18.0
 	github.com/ReneKroon/ttlcache v1.7.0
-	github.com/code-payments/flipcash2-protobuf-api v0.2.0
-	github.com/code-payments/ocp-protobuf-api v0.10.0
-	github.com/code-payments/ocp-server v0.24.0
+	github.com/code-payments/flipcash2-protobuf-api v0.3.0
+	github.com/code-payments/ocp-protobuf-api v0.11.0
+	github.com/code-payments/ocp-server v0.26.0
 	github.com/devsisters/go-applereceipt v0.0.0-20240805020915-fa22a0160fc2
 	github.com/georgysavva/scany/v2 v2.1.4
 	github.com/google/uuid v1.6.0

go.sum

@@ -40,12 +40,12 @@ github.com/cockroachdb/cockroach-go/v2 v2.2.0 h1:/5znzg5n373N/3ESjHF5SMLxiW4RKB0
 github.com/cockroachdb/cockroach-go/v2 v2.2.0/go.mod h1:u3MiKYGupPPjkn3ozknpMUpxPaNLTFWAya419/zv6eI=
 github.com/code-payments/code-vm-indexer v1.2.0 h1:rSHpBMiT9BKgmKcXg/VIoi/h0t7jNxGx07Qz59m+6Q0=
 github.com/code-payments/code-vm-indexer v1.2.0/go.mod h1:vn91YN2qNqb+gGJeZe2+l+TNxVmEEiRHXXnIn2Y40h8=
-github.com/code-payments/flipcash2-protobuf-api v0.2.0 h1:5uL9g0D+WyoCP95rg37CJOPA+a8sPOQrKWrfEEIDM+U=
-github.com/code-payments/flipcash2-protobuf-api v0.2.0/go.mod h1:s/1pOsb4FTRD+LcvRKGjfmm6ygRS/m1ep34EIW0fuDs=
-github.com/code-payments/ocp-protobuf-api v0.10.0 h1:l9Yh3eXdhvgBQS/evg1HYMERXlr7ymASHekAhW/RUmA=
-github.com/code-payments/ocp-protobuf-api v0.10.0/go.mod h1:tw6BooY5a8l6CtSZnKOruyKII0W04n89pcM4BizrgG8=
-github.com/code-payments/ocp-server v0.24.0 h1:QF7K3Nbrapl2tXx4EgL3xPWpxqCM+gCNiP2+RralSBM=
-github.com/code-payments/ocp-server v0.24.0/go.mod h1:+E1VncCtaZGgvM9wKu+qe/AA+gpcbbpu0BXw76vcD4k=
+github.com/code-payments/flipcash2-protobuf-api v0.3.0 h1:gz+InymDZKp3n7HyOQCidd80ZmZj784pIPdHaebDs18=
+github.com/code-payments/flipcash2-protobuf-api v0.3.0/go.mod h1:s/1pOsb4FTRD+LcvRKGjfmm6ygRS/m1ep34EIW0fuDs=
+github.com/code-payments/ocp-protobuf-api v0.11.0 h1:Zq0H3tg+bjTuXF9T6kRXEX8sGXu1NQ0szvUD1MdVs4Q=
+github.com/code-payments/ocp-protobuf-api v0.11.0/go.mod h1:tw6BooY5a8l6CtSZnKOruyKII0W04n89pcM4BizrgG8=
+github.com/code-payments/ocp-server v0.26.0 h1:0KicwwrwFac+j04mtEngDwGqK8OOEfP7BIko2PWgBb0=
+github.com/code-payments/ocp-server v0.26.0/go.mod h1:TZFN0NlGW/q0ipQGYJl1ZMy9pcpG1kNwRwt2GBz6E5E=
 github.com/containerd/continuity v0.4.3 h1:6HVkalIp+2u1ZLH1J/pYX2oBVXlJZvh1X1A7bEZ9Su8=
 github.com/containerd/continuity v0.4.3/go.mod h1:F6PTNCKepoxEaXLQp3wDAjygEnImnZ/7o4JzpodfroQ=
 github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=

push/pusher.go

@@ -2,20 +2,25 @@ package push
 
 import (
 	"context"
+	"encoding/base64"
+	"fmt"
 
 	"firebase.google.com/go/v4/messaging"
 	"go.uber.org/zap"
+	"google.golang.org/protobuf/proto"
 
 	commonpb "github.com/code-payments/flipcash2-protobuf-api/generated/go/common/v1"
+	pushpb "github.com/code-payments/flipcash2-protobuf-api/generated/go/push/v1"
+	"github.com/mr-tron/base58"
 )
 
 type Pusher interface {
-	SendBasicPushes(ctx context.Context, title, body string, users ...*commonpb.UserId) error
+	SendPushes(ctx context.Context, title, body string, customPayload *pushpb.Payload, users ...*commonpb.UserId) error
 }
 
 type NoOpPusher struct{}
 
-func (n *NoOpPusher) SendBasicPushes(_ context.Context, _, _ string, _ ...*commonpb.UserId) error {
+func (n *NoOpPusher) SendPushes(_ context.Context, _, _ string, _ *pushpb.Payload, _ ...*commonpb.UserId) error {
 	return nil
 }
 
@@ -41,8 +46,7 @@ func NewFCMPusher(log *zap.Logger, tokens TokenStore, client FCMClient) *FCMPush
 	}
 }
 
-// todo: Some duplicated code, but the existing push per message flow is likely going away anyways. We'll refactor when we get to that.
-func (p *FCMPusher) SendBasicPushes(ctx context.Context, title, body string, users ...*commonpb.UserId) error {
+func (p *FCMPusher) SendPushes(ctx context.Context, title, body string, customPayload *pushpb.Payload, users ...*commonpb.UserId) error {
 	if len(users) == 0 {
 		return nil
 	}
@@ -64,12 +68,43 @@ func (p *FCMPusher) SendBasicPushes(ctx context.Context, title, body string, use
 
 	tokens := extractTokens(pushTokens)
 
+	if customPayload == nil {
+		customPayload = &pushpb.Payload{}
+	}
+
+	err = customPayload.Validate()
+	if err != nil {
+		return err
+	}
+
+	marshalledCustomPayload, err := proto.Marshal(customPayload)
+	if err != nil {
+		return err
+	}
+	encodedCustomPayload := base64.StdEncoding.EncodeToString(marshalledCustomPayload)
+
+	customData := map[string]string{
+		"flipcash_payload": encodedCustomPayload,
+	}
+	if customPayload.Navigation != nil {
+		var targetUrl string
+		switch typed := customPayload.Navigation.Type.(type) {
+		case *pushpb.Navigation_CurrencyInfo:
+			targetUrl = fmt.Sprintf("https://app.flipcash.com/token/%s", base58.Encode(typed.CurrencyInfo.Value))
+		}
+		if len(targetUrl) > 0 {
+			customData["target_url"] = targetUrl
+		}
+	}
+
 	message := &messaging.MulticastMessage{
 		Tokens: tokens,
 		Notification: &messaging.Notification{
 			Title: title,
 			Body:  body,
 		},
+
+		Data: customData,
 	}
 
 	response, err := p.client.SendEachForMulticast(ctx, message)

push/pushes.go

@@ -8,9 +8,11 @@ import (
 	"golang.org/x/text/message"
 
 	commonpb "github.com/code-payments/flipcash2-protobuf-api/generated/go/common/v1"
+	pushpb "github.com/code-payments/flipcash2-protobuf-api/generated/go/push/v1"
 
 	"github.com/code-payments/flipcash2-server/localization"
 	ocp_currency "github.com/code-payments/ocp-server/currency"
+	ocp_common "github.com/code-payments/ocp-server/ocp/common"
 )
 
 var (
@@ -24,34 +26,62 @@ func SendUsdfDepositedPush(ctx context.Context, pusher Pusher, user *commonpb.Us
 		"$%.2f was added to your USD Reserves",
 		usdMarketValue,
 	)
-	return pusher.SendBasicPushes(ctx, title, body, user)
+	customPayload := &pushpb.Payload{
+		Navigation: &pushpb.Navigation{
+			Type: &pushpb.Navigation_CurrencyInfo{
+				CurrencyInfo: &commonpb.PublicKey{Value: ocp_common.CoreMintAccount.PublicKey().ToBytes()},
+			},
+		},
+	}
+	return pusher.SendPushes(ctx, title, body, customPayload, user)
 }
 
-func SendFlipcashCurrencyDepositedPush(ctx context.Context, pusher Pusher, user *commonpb.UserId, currencyName string, usdMarketValue float64) error {
+func SendFlipcashCurrencyDepositedPush(ctx context.Context, pusher Pusher, user *commonpb.UserId, mint *commonpb.PublicKey, currencyName string, usdMarketValue float64) error {
 	title := fmt.Sprintf("%s Now Available", currencyName)
 	body := amountPrinter.Sprintf(
 		"$%.2f of %s was added to your Flipcash wallet",
 		usdMarketValue,
 		currencyName,
 	)
-	return pusher.SendBasicPushes(ctx, title, body, user)
+	customPayload := &pushpb.Payload{
+		Navigation: &pushpb.Navigation{
+			Type: &pushpb.Navigation_CurrencyInfo{
+				CurrencyInfo: mint,
+			},
+		},
+	}
+	return pusher.SendPushes(ctx, title, body, customPayload, user)
 }
 
-func SendFlipcashCurrencyBoughtPush(ctx context.Context, pusher Pusher, user *commonpb.UserId, currencyName string, region ocp_currency.Code, nativeAmount float64) error {
+func SendFlipcashCurrencyBoughtPush(ctx context.Context, pusher Pusher, user *commonpb.UserId, mint *commonpb.PublicKey, currencyName string, region ocp_currency.Code, nativeAmount float64) error {
 	title := fmt.Sprintf("%s Successfully Purchased", currencyName)
 	body := amountPrinter.Sprintf(
 		"%s of %s was added to your Flipcash wallet",
 		localization.FormatFiat(defaultLocale, region, nativeAmount),
 		currencyName,
 	)
-	return pusher.SendBasicPushes(ctx, title, body, user)
+	customPayload := &pushpb.Payload{
+		Navigation: &pushpb.Navigation{
+			Type: &pushpb.Navigation_CurrencyInfo{
+				CurrencyInfo: mint,
+			},
+		},
+	}
+	return pusher.SendPushes(ctx, title, body, customPayload, user)
 }
 
-func SendFlipcashCurrencySoldPush(ctx context.Context, pusher Pusher, user *commonpb.UserId, currencyName string, region ocp_currency.Code, nativeAmount float64) error {
+func SendFlipcashCurrencySoldPush(ctx context.Context, pusher Pusher, user *commonpb.UserId, mint *commonpb.PublicKey, currencyName string, region ocp_currency.Code, nativeAmount float64) error {
 	title := fmt.Sprintf("%s Successfully Sold", currencyName)
 	body := amountPrinter.Sprintf(
 		"%s was added to your USD Reserves",
 		localization.FormatFiat(defaultLocale, region, nativeAmount),
 	)
-	return pusher.SendBasicPushes(ctx, title, body, user)
+	customPayload := &pushpb.Payload{
+		Navigation: &pushpb.Navigation{
+			Type: &pushpb.Navigation_CurrencyInfo{
+				CurrencyInfo: mint,
+			},
+		},
+	}
+	return pusher.SendPushes(ctx, title, body, customPayload, user)
 }

push/tests/pusher.go

@@ -2,12 +2,14 @@ package tests
 
 import (
 	"context"
+	"encoding/base64"
 	"fmt"
 	"testing"
 
 	"firebase.google.com/go/v4/messaging"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap"
+	"google.golang.org/protobuf/proto"
 
 	commonpb "github.com/code-payments/flipcash2-protobuf-api/generated/go/common/v1"
 	pushpb "github.com/code-payments/flipcash2-protobuf-api/generated/go/push/v1"
@@ -58,7 +60,19 @@ func testFCMPusher_SendBasicPushes(t *testing.T, store push.TokenStore) {
 
 	targetUsers := users[:3]
 
-	require.NoError(t, pusher.SendBasicPushes(ctx, "title", "body", targetUsers...))
+	customPayload := &pushpb.Payload{
+		Navigation: &pushpb.Navigation{
+			Type: &pushpb.Navigation_CurrencyInfo{
+				CurrencyInfo: &commonpb.PublicKey{Value: make([]byte, 32)},
+			},
+		},
+	}
+
+	marshalledCustomPayload, err := proto.Marshal(customPayload)
+	require.NoError(t, err)
+	expectedEncodedCustomPayload := base64.StdEncoding.EncodeToString(marshalledCustomPayload)
+
+	require.NoError(t, pusher.SendPushes(ctx, "title", "body", customPayload, targetUsers...))
 
 	require.NotNil(t, fcmClient.sentMessage)
 
@@ -71,5 +85,7 @@ func testFCMPusher_SendBasicPushes(t *testing.T, store push.TokenStore) {
 		"token2_1", "token2_2",
 	}
 	require.ElementsMatch(t, expectedTokens, fcmClient.sentMessage.Tokens)
-	require.Empty(t, fcmClient.sentMessage.Data)
+	require.Len(t, fcmClient.sentMessage.Data, 2)
+	require.Equal(t, expectedEncodedCustomPayload, fcmClient.sentMessage.Data["flipcash_payload"])
+	require.Equal(t, "https://app.flipcash.com/token/11111111111111111111111111111111", fcmClient.sentMessage.Data["target_url"])
 }

swap/integration.go

@@ -24,14 +24,15 @@ func NewIntegration(accounts account.Store, pusher push.Pusher) ocp_swap.Integra
 	}
 }
 
-func (i *Integration) OnSwapFinalized(ctx context.Context, owner *ocp_common.Account, isBuy bool, currencyName string, region ocp_currency.Code, amountReceived float64) error {
+func (i *Integration) OnSwapFinalized(ctx context.Context, owner *ocp_common.Account, isBuy bool, mint *ocp_common.Account, currencyName string, region ocp_currency.Code, amountReceived float64) error {
 	userID, err := i.accounts.GetUserId(ctx, &commonpb.PublicKey{Value: owner.PublicKey().ToBytes()})
 	if err != nil {
 		return err
 	}
 
+	protoMint := &commonpb.PublicKey{Value: mint.PublicKey().ToBytes()}
 	if isBuy {
-		return push.SendFlipcashCurrencyBoughtPush(ctx, i.pusher, userID, currencyName, region, amountReceived)
+		return push.SendFlipcashCurrencyBoughtPush(ctx, i.pusher, userID, protoMint, currencyName, region, amountReceived)
 	}
-	return push.SendFlipcashCurrencySoldPush(ctx, i.pusher, userID, currencyName, region, amountReceived)
+	return push.SendFlipcashCurrencySoldPush(ctx, i.pusher, userID, protoMint, currencyName, region, amountReceived)
 }