Support tips in intents and chats (#103)

* Pull in latest protos

* Support tip flag in intent data model

* Support localization for new tip verbs

* Support new Tips chat

* Add basic happy path tip intent integration

* Add basic edge case tests for tipping in SubmitIntent

* Pull in latest protos

* SubmitIntent now enforces Twitter tip address DNS

* Include platform and username in memo for tip payment transaction

* Move tip memo utility to transaction package

* Update intent postgres store with additional tip metadata

Author: jeffyanta

pkg/code/chat/chat.go

@@ -7,6 +7,7 @@ const (
 	CodeTeamName         = "Code Team"
 	KinPurchasesName     = "Kin Purchases"
 	PaymentsName         = "Payments" // Renamed to Web Payments on client
+	TipsName             = "Tips"
 
 	// Test chats used for unit/integration testing only
 	TestCantMuteName        = "TestCantMute"
@@ -39,6 +40,11 @@ var (
 			CanMute:              true,
 			CanUnsubscribe:       false,
 		},
+		TipsName: {
+			TitleLocalizationKey: localization.ChatTitleTips,
+			CanMute:              true,
+			CanUnsubscribe:       false,
+		},
 
 		TestCantMuteName: {
 			TitleLocalizationKey: "n/a",

pkg/code/chat/message_cash_transactions.go

@@ -20,8 +20,6 @@ import (
 // don't belong in the Cash Transactions chat will be ignored.
 //
 // Note: Tests covered in SubmitIntent history tests
-//
-// todo: How are we handling relationship account flows?
 func SendCashTransactionsExchangeMessage(ctx context.Context, data code_data.Provider, intentRecord *intent.Record) error {
 	messageId := intentRecord.IntentId
 
@@ -36,6 +34,9 @@ func SendCashTransactionsExchangeMessage(ctx context.Context, data code_data.Pro
 		if intentRecord.SendPrivatePaymentMetadata.IsMicroPayment {
 			// Micro payment messages exist in merchant domain-specific chats
 			return nil
+		} else if intentRecord.SendPrivatePaymentMetadata.IsTip {
+			// Tip messages exist in a tip-specific chat
+			return nil
 		} else if intentRecord.SendPrivatePaymentMetadata.IsWithdrawal {
 			if intentRecord.InitiatorOwnerAccount == intentRecord.SendPrivatePaymentMetadata.DestinationOwnerAccount {
 				// This is a top up for a public withdawal

pkg/code/chat/message_merchant.go

@@ -17,12 +17,6 @@ import (
 	"github.com/code-payments/code-server/pkg/code/data/intent"
 )
 
-type MessageWithOwner struct {
-	Owner   *common.Account
-	Title   string
-	Message *chatpb.ChatMessage
-}
-
 // SendMerchantExchangeMessage sends a message to the merchant's chat with
 // exchange data content related to the submitted intent. Intents that
 // don't belong in the merchant chat will be ignored. The set of chat messages

pkg/code/chat/message_tips.go

@@ -0,0 +1,93 @@
+package chat
+
+import (
+	"context"
+
+	"github.com/pkg/errors"
+
+	chatpb "github.com/code-payments/code-protobuf-api/generated/go/chat/v1"
+
+	"github.com/code-payments/code-server/pkg/code/common"
+	code_data "github.com/code-payments/code-server/pkg/code/data"
+	"github.com/code-payments/code-server/pkg/code/data/chat"
+	"github.com/code-payments/code-server/pkg/code/data/intent"
+)
+
+// SendTipsExchangeMessage sends a message to the Tips chat with exchange data
+// content related to the submitted intent. Intents that don't belong in the
+// Tips chat will be ignored.
+//
+// Note: Tests covered in SubmitIntent history tests
+func SendTipsExchangeMessage(ctx context.Context, data code_data.Provider, intentRecord *intent.Record) ([]*MessageWithOwner, error) {
+	messageId := intentRecord.IntentId
+
+	exchangeData, ok := getExchangeDataFromIntent(intentRecord)
+	if !ok {
+		return nil, nil
+	}
+
+	verbByMessageReceiver := make(map[string]chatpb.ExchangeDataContent_Verb)
+	switch intentRecord.IntentType {
+	case intent.SendPrivatePayment:
+		if !intentRecord.SendPrivatePaymentMetadata.IsTip {
+			// Not a tip
+			return nil, nil
+		}
+
+		verbByMessageReceiver[intentRecord.InitiatorOwnerAccount] = chatpb.ExchangeDataContent_SENT_TIP
+		if len(intentRecord.SendPrivatePaymentMetadata.DestinationOwnerAccount) > 0 {
+			verbByMessageReceiver[intentRecord.SendPrivatePaymentMetadata.DestinationOwnerAccount] = chatpb.ExchangeDataContent_RECEIVED_TIP
+		}
+	default:
+		return nil, nil
+	}
+
+	var messagesToPush []*MessageWithOwner
+	for account, verb := range verbByMessageReceiver {
+		receiver, err := common.NewAccountFromPublicKeyString(account)
+		if err != nil {
+			return nil, err
+		}
+
+		content := []*chatpb.Content{
+			{
+				Type: &chatpb.Content_ExchangeData{
+					ExchangeData: &chatpb.ExchangeDataContent{
+						Verb: verb,
+						ExchangeData: &chatpb.ExchangeDataContent_Exact{
+							Exact: exchangeData,
+						},
+					},
+				},
+			},
+		}
+		protoMessage, err := newProtoChatMessage(messageId, content, intentRecord.CreatedAt)
+		if err != nil {
+			return nil, errors.Wrap(err, "error creating proto chat message")
+		}
+
+		canPush, err := SendChatMessage(
+			ctx,
+			data,
+			TipsName,
+			chat.ChatTypeInternal,
+			true,
+			receiver,
+			protoMessage,
+			verb != chatpb.ExchangeDataContent_RECEIVED_TIP,
+		)
+		if err != nil && err != chat.ErrMessageAlreadyExists {
+			return nil, errors.Wrap(err, "error persisting chat message")
+		}
+
+		if canPush {
+			messagesToPush = append(messagesToPush, &MessageWithOwner{
+				Owner:   receiver,
+				Title:   TipsName,
+				Message: protoMessage,
+			})
+		}
+	}
+
+	return messagesToPush, nil
+}

pkg/code/chat/util.go

@@ -11,6 +11,7 @@ import (
 	chatpb "github.com/code-payments/code-protobuf-api/generated/go/chat/v1"
 	transactionpb "github.com/code-payments/code-protobuf-api/generated/go/transaction/v2"
 
+	"github.com/code-payments/code-server/pkg/code/common"
 	code_data "github.com/code-payments/code-server/pkg/code/data"
 	"github.com/code-payments/code-server/pkg/code/data/account"
 	"github.com/code-payments/code-server/pkg/code/data/action"
@@ -19,6 +20,12 @@ import (
 	"github.com/code-payments/code-server/pkg/kin"
 )
 
+type MessageWithOwner struct {
+	Owner   *common.Account
+	Title   string
+	Message *chatpb.ChatMessage
+}
+
 func newProtoChatMessage(
 	messageId string,
 	content []*chatpb.Content,

pkg/code/data/intent/intent.go

@@ -4,6 +4,8 @@ import (
 	"errors"
 	"time"
 
+	transactionpb "github.com/code-payments/code-protobuf-api/generated/go/transaction/v2"
+
 	"github.com/code-payments/code-server/pkg/currency"
 	"github.com/code-payments/code-server/pkg/phone"
 )
@@ -106,6 +108,15 @@ type SendPrivatePaymentMetadata struct {
 	IsWithdrawal   bool
 	IsRemoteSend   bool
 	IsMicroPayment bool
+	IsTip          bool
+
+	// Set when IsTip = true
+	TipMetadata *TipMetadata
+}
+
+type TipMetadata struct {
+	Platform transactionpb.TippedUser_Platform
+	Username string
 }
 
 type ReceivePaymentsPrivatelyMetadata struct {
@@ -545,6 +556,14 @@ func (m *OpenAccountsMetadata) Validate() error {
 }
 
 func (m *SendPrivatePaymentMetadata) Clone() SendPrivatePaymentMetadata {
+	var tipMetadata *TipMetadata
+	if m.TipMetadata != nil {
+		tipMetadata = &TipMetadata{
+			Platform: m.TipMetadata.Platform,
+			Username: m.TipMetadata.Username,
+		}
+	}
+
 	return SendPrivatePaymentMetadata{
 		DestinationOwnerAccount: m.DestinationOwnerAccount,
 		DestinationTokenAccount: m.DestinationTokenAccount,
@@ -554,13 +573,25 @@ func (m *SendPrivatePaymentMetadata) Clone() SendPrivatePaymentMetadata {
 		ExchangeRate:     m.ExchangeRate,
 		NativeAmount:     m.NativeAmount,
 		UsdMarketValue:   m.UsdMarketValue,
-		IsWithdrawal:     m.IsWithdrawal,
-		IsRemoteSend:     m.IsRemoteSend,
-		IsMicroPayment:   m.IsMicroPayment,
+
+		IsWithdrawal:   m.IsWithdrawal,
+		IsRemoteSend:   m.IsRemoteSend,
+		IsMicroPayment: m.IsMicroPayment,
+		IsTip:          m.IsTip,
+
+		TipMetadata: tipMetadata,
 	}
 }
 
 func (m *SendPrivatePaymentMetadata) CopyTo(dst *SendPrivatePaymentMetadata) {
+	var tipMetadata *TipMetadata
+	if m.TipMetadata != nil {
+		tipMetadata = &TipMetadata{
+			Platform: m.TipMetadata.Platform,
+			Username: m.TipMetadata.Username,
+		}
+	}
+
 	dst.DestinationOwnerAccount = m.DestinationOwnerAccount
 	dst.DestinationTokenAccount = m.DestinationTokenAccount
 	dst.Quantity = m.Quantity
@@ -569,9 +600,13 @@ func (m *SendPrivatePaymentMetadata) CopyTo(dst *SendPrivatePaymentMetadata) {
 	dst.ExchangeRate = m.ExchangeRate
 	dst.NativeAmount = m.NativeAmount
 	dst.UsdMarketValue = m.UsdMarketValue
+
 	dst.IsWithdrawal = m.IsWithdrawal
 	dst.IsRemoteSend = m.IsRemoteSend
 	dst.IsMicroPayment = m.IsMicroPayment
+	dst.IsTip = m.IsTip
+
+	dst.TipMetadata = tipMetadata
 }
 
 func (m *SendPrivatePaymentMetadata) Validate() error {
@@ -599,6 +634,22 @@ func (m *SendPrivatePaymentMetadata) Validate() error {
 		return errors.New("usd market value cannot be zero")
 	}
 
+	if m.IsTip {
+		if m.TipMetadata == nil {
+			return errors.New("tip metadata required for tips")
+		}
+
+		if m.TipMetadata.Platform == transactionpb.TippedUser_UNKNOWN {
+			return errors.New("tip platform is required")
+		}
+
+		if len(m.TipMetadata.Username) == 0 {
+			return errors.New("tip username is required")
+		}
+	} else if m.TipMetadata != nil {
+		return errors.New("tip metadata can only be set for tips")
+	}
+
 	return nil
 }