SDP-1116 Support External_ID DRAFT PR (See TODO). reece

cmd/serve.go

@@ -268,6 +268,14 @@ func (c *ServeCommand) Command(serverService ServerServiceInterface, monitorServ
 			FlagDefault: horizonclient.DefaultTestNetClient.HorizonURL,
 			Required:    true,
 		},
+		{
+			Name:        "use-external-id",
+			Usage:       "Enable or disable the use of external ID in wallet deep links",
+			OptType:     types.Bool, 
+			ConfigKey:   &serveOpts.UseExternalID, // Ensure ServeOptions has a UseExternalID field of type bool
+			FlagDefault: false, // Default value set to false. Do Not embed external_id in wallet deep links
+			Required:    false, 
+		},
 	}
 
 	messengerOptions := message.MessengerOptions{}

internal/data/assets.go

@@ -286,6 +286,7 @@ func (a *AssetModel) GetAssetsPerReceiverWallet(ctx context.Context, receiverWal
 			r.id AS "receiver_wallet.receiver.id",
 			r.phone_number AS "receiver_wallet.receiver.phone_number",
 			r.email AS "receiver_wallet.receiver.email",
+			r.external_id AS "receiver_wallet.receiver.external_id",
 			a.id AS "asset.id",
 			a.code AS "asset.code",
 			a.issuer AS "asset.issuer",

internal/data/assets_test.go

@@ -639,6 +639,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverX.ID,
 					Email:       receiverX.Email,
 					PhoneNumber: receiverX.PhoneNumber,
+					ExternalID: receiverX.ExternalID,
 				},
 				ReceiverWalletStats: ReceiverWalletStats{
 					TotalInvitationSMSResentAttempts: 2,
@@ -656,6 +657,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverX.ID,
 					Email:       receiverX.Email,
 					PhoneNumber: receiverX.PhoneNumber,
+					ExternalID: receiverX.ExternalID,
 				},
 				InvitationSentAt: &invitationSentAt,
 			},
@@ -670,6 +672,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverX.ID,
 					Email:       receiverX.Email,
 					PhoneNumber: receiverX.PhoneNumber,
+					ExternalID: receiverX.ExternalID,
 				},
 			},
 			WalletID:                walletB.ID,
@@ -683,6 +686,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverX.ID,
 					Email:       receiverX.Email,
 					PhoneNumber: receiverX.PhoneNumber,
+					ExternalID: receiverX.ExternalID,
 				},
 			},
 			WalletID:                walletB.ID,
@@ -696,6 +700,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverY.ID,
 					Email:       receiverY.Email,
 					PhoneNumber: receiverY.PhoneNumber,
+					ExternalID: receiverY.ExternalID,
 				},
 			},
 			WalletID:                walletA.ID,
@@ -709,6 +714,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverY.ID,
 					Email:       receiverY.Email,
 					PhoneNumber: receiverY.PhoneNumber,
+					ExternalID: receiverY.ExternalID,
 				},
 			},
 			WalletID:                walletA.ID,
@@ -722,6 +728,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverY.ID,
 					Email:       receiverY.Email,
 					PhoneNumber: receiverY.PhoneNumber,
+					ExternalID: receiverY.ExternalID,
 				},
 			},
 			WalletID:                walletB.ID,
@@ -735,6 +742,7 @@ func Test_GetAssetsPerReceiverWallet(t *testing.T) {
 					ID:          receiverY.ID,
 					Email:       receiverY.Email,
 					PhoneNumber: receiverY.PhoneNumber,
+					ExternalID: receiverY.ExternalID,
 				},
 			},
 			WalletID:                walletB.ID,

internal/data/receivers.go

@@ -31,6 +31,7 @@ type ReceiverRegistrationRequest struct {
 	VerificationValue string            `json:"verification"`
 	VerificationType  VerificationField `json:"verification_type"`
 	ReCAPTCHAToken    string            `json:"recaptcha_token"`
+	ExternalID        string            `json:"external_id"`
 }
 
 type ReceiverStats struct {

internal/data/receivers_wallet.go

@@ -232,6 +232,7 @@ func (rw *ReceiverWalletModel) GetAllPendingRegistration(ctx context.Context) ([
 			r.id AS "receiver.id",
 			r.phone_number AS "receiver.phone_number",
 			r.email AS "receiver.email",
+			r.external_id AS "receiver.external_id",
 			w.id AS "wallet.id",
 			w.name AS "wallet.name"
 		FROM

internal/data/receivers_wallet_test.go

@@ -839,6 +839,7 @@ func Test_ReceiverWallet_GetAllPendingRegistration(t *testing.T) {
 					ID:          receiver.ID,
 					PhoneNumber: receiver.PhoneNumber,
 					Email:       receiver.Email,
+					ExternalID: receiver.ExternalID,
 				},
 				Wallet: Wallet{
 					ID:   wallet3.ID,
@@ -851,6 +852,7 @@ func Test_ReceiverWallet_GetAllPendingRegistration(t *testing.T) {
 					ID:          receiver.ID,
 					PhoneNumber: receiver.PhoneNumber,
 					Email:       receiver.Email,
+					ExternalID: receiver.ExternalID,
 				},
 				Wallet: Wallet{
 					ID:   wallet4.ID,

internal/scheduler/jobs/send_receiver_wallets_sms_invitation_job.go

@@ -25,6 +25,7 @@ type SendReceiverWalletsSMSInvitationJobOptions struct {
 	MaxInvitationSMSResendAttempts int64
 	Sep10SigningPrivateKey         string
 	CrashTrackerClient             crashtracker.CrashTrackerClient
+	UseExternalID				   bool
 }
 
 var _ Job = (*SendReceiverWalletsSMSInvitationJob)(nil)
@@ -58,6 +59,7 @@ func NewSendReceiverWalletsSMSInvitationJob(options SendReceiverWalletsSMSInvita
 		options.Sep10SigningPrivateKey,
 		options.MaxInvitationSMSResendAttempts,
 		options.CrashTrackerClient,
+		options.UseExternalID,
 	)
 	if err != nil {
 		log.Fatalf("error instantiating service: %s", err.Error())

internal/scheduler/jobs/send_receiver_wallets_sms_invitation_job_test.go

@@ -137,6 +137,7 @@ func Test_SendReceiverWalletsSMSInvitationJob_Execute(t *testing.T) {
 			stellarSecretKey,
 			maxInvitationSMSResendAttempts,
 			crashTrackerClientMock,
+			true,
 		)
 		require.NoError(t, err)
 
@@ -200,6 +201,7 @@ func Test_SendReceiverWalletsSMSInvitationJob_Execute(t *testing.T) {
 			OrganizationName:         "MyCustomAid",
 			AssetCode:                asset1.Code,
 			AssetIssuer:              asset1.Issuer,
+			ExternalID:		   		  receiver1.ExternalID,
 		}
 		deepLink1, err := walletDeepLink1.GetSignedRegistrationLink(stellarSecretKey)
 		require.NoError(t, err)
@@ -211,6 +213,7 @@ func Test_SendReceiverWalletsSMSInvitationJob_Execute(t *testing.T) {
 			OrganizationName:         "MyCustomAid",
 			AssetCode:                asset2.Code,
 			AssetIssuer:              asset2.Issuer,
+			ExternalID:		   		  receiver2.ExternalID,
 		}
 		deepLink2, err := walletDeepLink2.GetSignedRegistrationLink(stellarSecretKey)
 		require.NoError(t, err)

internal/serve/httphandler/verifiy_receiver_registration_handler.go

@@ -108,6 +108,12 @@ func (v VerifyReceiverRegistrationHandler) processReceiverVerificationPII(
 	now := time.Now()
 	truncatedPhoneNumber := utils.TruncateString(receiver.PhoneNumber, 3)
 
+	// Use the external_id associated with the receiver if it exists
+	if receiver.ExternalID != "" {
+		// Logic to handle the verification associated with the external_id
+		// This may include comparing the hashed phone number with the one associated with external_id
+	}
+
 	// STEP 1: find the receiverVerification entry that matches the pair [receiverID, verificationType]
 	receiverVerifications, err := v.Models.ReceiverVerification.GetByReceiverIDsAndVerificationField(ctx, dbTx, []string{receiver.ID}, receiverRegistrationRequest.VerificationType)
 	if err != nil {

internal/serve/httphandler/verifiy_receiver_registration_handler_test.go

@@ -120,6 +120,28 @@ func Test_VerifyReceiverRegistrationHandler_validate(t *testing.T) {
 				ReCAPTCHAToken:    "token",
 			},
 		},
+		{
+			name: "🎉 successfully parses the body with external_id if the SEP24 token, recaptcha token and request body are all valid",
+			contextSep24Claims: sep24JWTClaims,
+			requestBody: `{
+				"phone_number": "+380445555555",
+				"otp": "123456",
+				"verification": "1990-01-01",
+				"verification_type": "date_of_birth",
+				"external_id": "user-external-id",
+				"reCAPTCHA_token": "token"
+			}`,
+			isRecaptchaValidFnResponse: []interface{}{true, nil},
+			wantSep24Claims:            sep24JWTClaims,
+			wantResult: data.ReceiverRegistrationRequest{
+				PhoneNumber:       "+380445555555",
+				OTP:               "123456",
+				VerificationValue: "1990-01-01",
+				VerificationType:  data.VerificationFieldDateOfBirth,
+				ExternalID:        "user-external-id",
+				ReCAPTCHAToken:    "token",
+			},
+		},
 	}
 
 	models, err := data.NewModels(dbConnectionPool)

internal/serve/serve.go

 }.VerifyReceiverRegistration) 
 r.With(sep24HeaderTokenAuthenticationMiddleware).Post("/verification", httphandler.VerifyReceiverRegistrationHandler{ 
 	AnchorPlatformAPIService: o.AnchorPlatformAPIService, 
 	Models:                   o.Models, 
 	ReCAPTCHAValidator:       reCAPTCHAValidator, 
 	NetworkPassphrase:        o.NetworkPassphrase, 
 	EventProducer:            o.EventProducer, 
 }.VerifyReceiverRegistration) 
@@ -85,6 +85,7 @@ type ServeOptions struct {
 	DisableMFA                      bool
 	DisableReCAPTCHA                bool
 	PasswordValidator               *authUtils.PasswordValidator
+	UseExternalID					bool
 }
 
 // SetupDependencies uses the serve options to setup the dependencies for the server.

internal/services/send_receiver_wallets_invite_service.go

@@ -26,6 +26,7 @@ type SendReceiverWalletInviteService struct {
 	maxInvitationSMSResendAttempts int64
 	sep10SigningPrivateKey         string
 	crashTrackerClient             crashtracker.CrashTrackerClient
+	UseExternalID				   bool
 }
 
 func (s SendReceiverWalletInviteService) validate() error {
@@ -106,6 +107,11 @@ func (s SendReceiverWalletInviteService) SendInvite(ctx context.Context) error {
 			AssetIssuer:              rwa.Asset.Issuer,
 		}
 
+		// Only set ExternalID if UseExternalID config is true
+		if s.UseExternalID {
+			wdl.ExternalID = rwa.ReceiverWallet.Receiver.ExternalID
+		}
+
 		registrationLink, err := wdl.GetSignedRegistrationLink(s.sep10SigningPrivateKey)
 		if err != nil {
 			log.Ctx(ctx).Errorf(
@@ -245,14 +251,15 @@ func (s SendReceiverWalletInviteService) shouldSendInvitationSMS(ctx context.Con
 	return true
 }
 
-func NewSendReceiverWalletInviteService(models *data.Models, messengerClient message.MessengerClient, anchorPlatformBaseSepURL, sep10SigningPrivateKey string, maxInvitationSMSResendAttempts int64, crashTrackerClient crashtracker.CrashTrackerClient) (*SendReceiverWalletInviteService, error) {
+func NewSendReceiverWalletInviteService(models *data.Models, messengerClient message.MessengerClient, anchorPlatformBaseSepURL, sep10SigningPrivateKey string, maxInvitationSMSResendAttempts int64, crashTrackerClient crashtracker.CrashTrackerClient, UseExternalID bool) (*SendReceiverWalletInviteService, error) {
 	s := &SendReceiverWalletInviteService{
 		messengerClient:                messengerClient,
 		models:                         models,
 		anchorPlatformBaseSepURL:       anchorPlatformBaseSepURL,
 		maxInvitationSMSResendAttempts: maxInvitationSMSResendAttempts,
 		sep10SigningPrivateKey:         sep10SigningPrivateKey,
 		crashTrackerClient:             crashTrackerClient,
+		UseExternalID:				   UseExternalID,
 	}
 
 	if err := s.validate(); err != nil {
@@ -275,6 +282,8 @@ type WalletDeepLink struct {
 	AssetCode string
 	// AssetIssuer is the issuer of the Stellar asset that the receiver will be able to receive.
 	AssetIssuer string
+	// ExternalID is an optional parameter that can be used to include an external ID in the registration link.
+	ExternalID string // The external ID you want to include in the registration link
 }
 
 func (wdl WalletDeepLink) isNativeAsset() bool {
@@ -380,6 +389,7 @@ func (wdl WalletDeepLink) validate() error {
 // GetUnsignedRegistrationLink creates a deep link for the wallet registration using the format below:
 // <deep_link></route>?<domain>&<name>&<asset>.
 func (wdl WalletDeepLink) GetUnsignedRegistrationLink() (string, error) {
+
 	if err := wdl.validate(); err != nil {
 		return "", fmt.Errorf("validating WalletDeepLink: %w", err)
 	}
@@ -403,6 +413,9 @@ func (wdl WalletDeepLink) GetUnsignedRegistrationLink() (string, error) {
 	q.Add("domain", tomlFileDomain)
 	q.Add("name", wdl.OrganizationName)
 	q.Add("asset", wdl.assetName())
+	if wdl.ExternalID != "" {
+		q.Add("external_id", wdl.ExternalID)
+	}
 
 	u.RawQuery = q.Encode()