Merge pull request 'sms-upsell-api' (#10) from sms-api into master

Reviewed-on: #10

config/config.go

@@ -16,12 +16,15 @@ const (
 	voucherTransfersPathPrefix = "/api/v1/transfers/last10"
 	voucherDataPathPrefix      = "/api/v1/token"
 	AliasPrefix                = "api/v1/alias"
+	SendSMSPrefix              = "api/v1/external/upsell"
+	AliasEnsPrefix             = "/api/v1/bypass"
 )
 
 var (
 	custodialURLBase string
 	dataURLBase      string
 	BearerToken      string
+	aliasEnsURLBase  string
 )
 
 var (
@@ -34,6 +37,8 @@ var (
 	VoucherTransfersURL string
 	VoucherDataURL      string
 	CheckAliasURL       string
+	SendSMSURL          string
+	AliasEnsURL         string
 )
 
 func setBase() error {
@@ -41,6 +46,7 @@ func setBase() error {
 
 	custodialURLBase = env.GetEnv("CUSTODIAL_URL_BASE", "http://localhost:5003")
 	dataURLBase = env.GetEnv("DATA_URL_BASE", "http://localhost:5006")
+	aliasEnsURLBase = env.GetEnv("ALIAS_ENS_BASE", "http://localhost:5015")
 	BearerToken = env.GetEnv("BEARER_TOKEN", "")
 
 	_, err = url.Parse(custodialURLBase)
@@ -69,5 +75,7 @@ func LoadConfig() error {
 	VoucherTransfersURL, _ = url.JoinPath(dataURLBase, voucherTransfersPathPrefix)
 	VoucherDataURL, _ = url.JoinPath(dataURLBase, voucherDataPathPrefix)
 	CheckAliasURL, _ = url.JoinPath(dataURLBase, AliasPrefix)
+	SendSMSURL, _ = url.JoinPath(dataURLBase, SendSMSPrefix)
+	AliasEnsURL, _ = url.JoinPath(aliasEnsURLBase, AliasEnsPrefix)
 	return nil
 }

dev/api.go

@@ -202,10 +202,13 @@ func (das *DevAccountService) loadItem(ctx context.Context, k []byte, v []byte)
 	}
 	if ss[0] == "account" {
 		err = das.loadAccount(ctx, ss[1], v)
+		logg.ErrorCtxf(ctx, "loading saved account failed", "error_load_account", err)
 	} else if ss[0] == "tx" {
 		err = das.loadTx(ctx, ss[1], v)
+		logg.ErrorCtxf(ctx, "loading transactions failed", "error_load_txs", err)
 	} else if ss[0] == "alias" {
 		err = das.loadAlias(ctx, ss[1], k)
+		logg.ErrorCtxf(ctx, "loading aliases failed", "error_load_aliases", err)
 	} else {
 		logg.ErrorCtxf(ctx, "unknown double underscore key", "key", ss[0])
 	}
@@ -574,10 +577,12 @@ func (das *DevAccountService) TokenTransfer(ctx context.Context, amount, from, t
 func (das *DevAccountService) CheckAliasAddress(ctx context.Context, alias string) (*models.AliasAddress, error) {
 	addr, ok := das.accountsAlias[alias]
 	if !ok {
+		logg.ErrorCtxf(ctx, "alias check failed", "alias", alias)
 		return nil, fmt.Errorf("alias %s not found", alias)
 	}
 	acc, ok := das.accounts[addr]
 	if !ok {
+		logg.ErrorCtxf(ctx, "failed to resolve alias", "alias", alias)
 		return nil, fmt.Errorf("alias %s found but does not resolve", alias)
 	}
 	return &models.AliasAddress{
@@ -600,6 +605,7 @@ func (das *DevAccountService) RequestAlias(ctx context.Context, publicKey string
 	var alias string
 	uid, err := uuid.NewV4()
 	if !aliasRegex.MatchString(hint) {
+		logg.ErrorCtxf(ctx, "alias hint does not match", "key", publicKey, "hint", hint)
 		return nil, fmt.Errorf("alias hint does not match: %s", publicKey)
 	}
 	acc, ok := das.accounts[publicKey]
@@ -611,6 +617,7 @@ func (das *DevAccountService) RequestAlias(ctx context.Context, publicKey string
 		}
 		err = das.saveAccount(ctx, acc)
 		if err != nil {
+			logg.ErrorCtxf(ctx, "account save failed with", "account", acc, "account_save_error", err)
 			return nil, err
 		}
 		das.accounts[publicKey] = acc
@@ -618,6 +625,7 @@ func (das *DevAccountService) RequestAlias(ctx context.Context, publicKey string
 	alias = hint
 	isPhone, err := das.applyPhoneAlias(ctx, publicKey, alias)
 	if err != nil {
+		logg.ErrorCtxf(ctx, "failed to apply phone alias", "public key", publicKey, "alias", alias, "error", err)
 		return nil, fmt.Errorf("phone parser error: %v", err)
 	}
 	if !isPhone {
@@ -636,6 +644,7 @@ func (das *DevAccountService) RequestAlias(ctx context.Context, publicKey string
 		das.accountsAlias[alias] = publicKey
 		err := das.saveAlias(ctx, map[string]string{alias: publicKey})
 		if err != nil {
+			logg.ErrorCtxf(ctx, "account save error", "public key", publicKey, "alias", alias, "alias_save_error", err)
 			return nil, fmt.Errorf("Failed to save the account alias with error:  %s", err.Error())
 		}
 	}
@@ -644,3 +653,10 @@ func (das *DevAccountService) RequestAlias(ctx context.Context, publicKey string
 		Alias: alias,
 	}, nil
 }
+
+func (das *DevAccountService) SendUpsellSMS(ctx context.Context, inviterPhone, inviteePhone string) (*models.SendSMSResponse, error) {
+	logg.DebugCtxf(ctx, "sent an SMS", "inviterPhone", inviterPhone, "inviteePhone", inviteePhone)
+	return &models.SendSMSResponse{
+		Invitee: inviteePhone,
+	}, nil
+}

models/alias_response.go

@@ -7,3 +7,13 @@ type RequestAliasResult struct {
 type AliasAddress struct {
 	Address string
 }
+
+type AliasEnsResult struct {
+	Address    string `json:"address"`
+	AutoChoose bool   `json:"autoChoose"`
+	Name       string `json:"name"`
+}
+
+type AliasEnsAddressResult struct {
+	Address string `json:"address"`
+}

models/send_sms_response.go

@@ -0,0 +1,5 @@
+package models
+
+type SendSMSResponse struct {
+	Invitee string `json:"invitee"`
+}

remote/account_service.go

@@ -17,4 +17,5 @@ type AccountService interface {
 	TokenTransfer(ctx context.Context, amount, from, to, tokenAddress string) (*models.TokenTransferResponse, error)
 	CheckAliasAddress(ctx context.Context, alias string) (*models.AliasAddress, error)
 	RequestAlias(ctx context.Context, hint string, publicKey string) (*models.RequestAliasResult, error)
+	SendUpsellSMS(ctx context.Context, inviterPhone, inviteePhone string) (*models.SendSMSResponse, error)
 }

remote/http/service.go

@@ -11,7 +11,9 @@ import (
 	"net/http"
 	"net/url"
 	"regexp"
+	"strings"
 
+	"git.defalsify.org/vise.git/logging"
 	"git.grassecon.net/grassrootseconomics/sarafu-api/config"
 	"git.grassecon.net/grassrootseconomics/sarafu-api/dev"
 	"git.grassecon.net/grassrootseconomics/sarafu-api/models"
@@ -22,6 +24,7 @@ import (
 
 var (
 	aliasRegex = regexp.MustCompile("^\\+?[a-zA-Z0-9\\-_]+$")
+	logg       = logging.NewVanilla().WithDomain("sarafu-api.devapi")
 )
 
 type HTTPAccountService struct {
@@ -59,6 +62,10 @@ func (as *HTTPAccountService) TrackAccountStatus(ctx context.Context, publicKey
 	return &r, nil
 }
 
+func (as *HTTPAccountService) ToFqdn(alias string) string {
+	return alias + ".sarafu.eth"
+}
+
 // CheckBalance retrieves the balance for a given public key from the custodial balance API endpoint.
 // Parameters:
 //   - publicKey: The public key associated with the account whose balance needs to be checked.
@@ -216,8 +223,10 @@ func (as *HTTPAccountService) CheckAliasAddress(ctx context.Context, alias strin
 	if as.SS == nil {
 		return nil, fmt.Errorf("The storage service cannot be nil")
 	}
+	logg.InfoCtxf(ctx, "resolving alias before formatting", "alias", alias)
 	svc := dev.NewDevAccountService(ctx, as.SS)
 	if as.UseApi {
+		logg.InfoCtxf(ctx, "resolving alias to address", "alias", alias)
 		return resolveAliasAddress(ctx, alias)
 	} else {
 		return svc.CheckAliasAddress(ctx, alias)
@@ -225,27 +234,114 @@ func (as *HTTPAccountService) CheckAliasAddress(ctx context.Context, alias strin
 }
 
 func resolveAliasAddress(ctx context.Context, alias string) (*models.AliasAddress, error) {
-	var r models.AliasAddress
+	var (
+		aliasEnsResult models.AliasEnsAddressResult
+	)
 
-	ep, err := url.JoinPath(config.CheckAliasURL, alias)
+	ep, err := url.JoinPath(config.AliasEnsURL, "/resolve")
 	if err != nil {
 		return nil, err
 	}
-	req, err := http.NewRequest("GET", ep, nil)
+
+	u, err := url.Parse(ep)
 	if err != nil {
 		return nil, err
 	}
-	_, err = doRequest(ctx, req, &r)
+
-	return &r, err
+	query := u.Query()
+	query.Set("name", alias)
+	u.RawQuery = query.Encode()
+
+	req, err := http.NewRequest("GET", u.String(), nil)
+	if err != nil {
+		return nil, err
+	}
+	_, err = doRequest(ctx, req, &aliasEnsResult)
+	if err != nil {
+		return nil, err
+	}
+	return &models.AliasAddress{Address: aliasEnsResult.Address}, err
 }
 
-// TODO: Use actual custodial api to request available alias
 func (as *HTTPAccountService) RequestAlias(ctx context.Context, publicKey string, hint string) (*models.RequestAliasResult, error) {
 	if as.SS == nil {
 		return nil, fmt.Errorf("The storage service cannot be nil")
 	}
-	svc := dev.NewDevAccountService(ctx, as.SS)
+	if as.UseApi {
-	return svc.RequestAlias(ctx, publicKey, hint)
+		if !strings.Contains(hint, ".") {
+			hint = as.ToFqdn(hint)
+		}
+		enr, err := requestEnsAlias(ctx, publicKey, hint)
+		if err != nil {
+			return nil, err
+		}
+		return &models.RequestAliasResult{Alias: enr.Name}, nil
+	} else {
+		svc := dev.NewDevAccountService(ctx, as.SS)
+		return svc.RequestAlias(ctx, publicKey, hint)
+	}
+}
+
+func requestEnsAlias(ctx context.Context, publicKey string, hint string) (*models.AliasEnsResult, error) {
+	var r models.AliasEnsResult
+
+	ep, err := url.JoinPath(config.AliasEnsURL, "/register")
+	if err != nil {
+		return nil, err
+	}
+	logg.InfoCtxf(ctx, "requesting alias", "endpoint", ep, "hint", hint)
+	//Payload with the address and hint to derive an ENS name
+	payload := map[string]string{
+		"address": publicKey,
+		"hint":    hint,
+	}
+	payloadBytes, err := json.Marshal(payload)
+	if err != nil {
+		return nil, err
+	}
+	req, err := http.NewRequest("POST", ep, bytes.NewBuffer(payloadBytes))
+	if err != nil {
+		return nil, err
+	}
+	// Log the request body
+	logg.InfoCtxf(ctx, "request body", "payload", string(payloadBytes))
+	_, err = doRequest(ctx, req, &r)
+	if err != nil {
+		return nil, err
+	}
+	logg.InfoCtxf(ctx, "alias successfully assigned", "alias", r.Name)
+	return &r, nil
+}
+
+// SendSMS calls the API to send out an SMS.
+// Parameters:
+//   - inviterPhone: The user initiating the SMS.
+//   - inviteePhone: The number being invited to Sarafu.
+func (as *HTTPAccountService) SendUpsellSMS(ctx context.Context, inviterPhone, inviteePhone string) (*models.SendSMSResponse, error) {
+	var r models.SendSMSResponse
+
+	// Create request payload
+	payload := map[string]string{
+		"inviterPhone": inviterPhone,
+		"inviteePhone": inviteePhone,
+	}
+
+	payloadBytes, err := json.Marshal(payload)
+	if err != nil {
+		return nil, err
+	}
+
+	// Create a new request
+	req, err := http.NewRequest("POST", config.SendSMSURL, bytes.NewBuffer(payloadBytes))
+	if err != nil {
+		return nil, err
+	}
+	_, err = doRequest(ctx, req, &r)
+	if err != nil {
+		return nil, err
+	}
+
+	return &r, nil
 }
 
 // TODO: remove eth-custodial api dependency

testutil/mocks/api_mock.go

@@ -61,3 +61,7 @@ func (m MockApi) RequestAlias(ctx context.Context, publicKey string, hint string
 func (m MockApi) TokenTransfer(ctx context.Context, amount, from, to, tokenAddress string) (*models.TokenTransferResponse, error) {
 	return nil, nil
 }
+
+func (m MockApi) SendUpsellSMS(ctx context.Context, inviterPhone, inviteePhone string) (*models.SendSMSResponse, error) {
+	return nil, nil
+}

testutil/mocks/service_mock.go

@@ -53,7 +53,12 @@ func (m *MockAccountService) CheckAliasAddress(ctx context.Context, alias string
 	return args.Get(0).(*models.AliasAddress), args.Error(1)
 }
 
-func (m MockAccountService) RequestAlias(ctx context.Context, publicKey string, hint string) (*models.RequestAliasResult, error) {
+func (m *MockAccountService) RequestAlias(ctx context.Context, publicKey string, hint string) (*models.RequestAliasResult, error) {
 	args := m.Called(publicKey, hint)
 	return args.Get(0).(*models.RequestAliasResult), args.Error(1)
 }
+
+func (m *MockAccountService) SendUpsellSMS(ctx context.Context, inviterPhone, inviteePhone string) (*models.SendSMSResponse, error) {
+	args := m.Called(inviterPhone, inviteePhone)
+	return args.Get(0).(*models.SendSMSResponse), args.Error(1)
+}

testutil/testservice/account_service.go

@@ -64,3 +64,7 @@ func (m TestAccountService) CheckAliasAddress(ctx context.Context, alias string)
 func (m TestAccountService) RequestAlias(ctx context.Context, publicKey string, hint string) (*models.RequestAliasResult, error) {
 	return &models.RequestAliasResult{}, nil
 }
+
+func (m TestAccountService) SendUpsellSMS(ctx context.Context, inviterPhone, inviteePhone string) (*models.SendSMSResponse, error) {
+	return &models.SendSMSResponse{}, nil
+}