Merge branch 'master' into lash/dump-format

Reviewed-on: #251
Reviewed-by: lash <accounts-grassrootseconomics@holbrook.no>

.dockerignore

@@ -1,5 +1,6 @@
 /**
 !/cmd/africastalking
+!/cmd/ssh
 !/common
 !/config
 !/initializers

Dockerfile

@@ -19,6 +19,7 @@ WORKDIR /build
 RUN echo "Building on $BUILDPLATFORM, building for $TARGETPLATFORM"
 RUN go mod download
 RUN go build -tags logtrace -o ussd-africastalking -ldflags="-X main.build=${BUILD} -s -w" cmd/africastalking/main.go
+RUN go build -tags logtrace -o ussd-ssh -ldflags="-X main.build=${BUILD} -s -w" cmd/ssh/main.go
 
 FROM debian:bookworm-slim
 
@@ -30,6 +31,7 @@ RUN apt-get clean && rm -rf /var/lib/apt/lists/*
 WORKDIR /service
 
 COPY --from=build /build/ussd-africastalking .
+COPY --from=build /build/ussd-ssh .
 COPY --from=build /build/LICENSE .
 COPY --from=build /build/README.md .
 COPY --from=build /build/services ./services
@@ -37,5 +39,6 @@ COPY --from=build /build/.env.example .
 RUN mv .env.example .env
 
 EXPOSE 7123
+EXPOSE 7122
 
 CMD ["./ussd-africastalking"]

cmd/africastalking/main.go

@@ -1,110 +1,39 @@
 package main
 
 import (
-	"bytes"
 	"context"
-	"encoding/json"
 	"flag"
 	"fmt"
-	"io"
-	"log"
 	"net/http"
 	"os"
 	"os/signal"
 	"path"
 	"strconv"
-	"strings"
 	"syscall"
 
 	"git.defalsify.org/vise.git/engine"
 	"git.defalsify.org/vise.git/logging"
 	"git.defalsify.org/vise.git/resource"
 
-	"git.grassecon.net/urdt/ussd/common"
 	"git.grassecon.net/urdt/ussd/config"
 	"git.grassecon.net/urdt/ussd/initializers"
 	"git.grassecon.net/urdt/ussd/internal/handlers"
-	httpserver "git.grassecon.net/urdt/ussd/internal/http"
+	"git.grassecon.net/urdt/ussd/internal/http/at"
+	httpserver "git.grassecon.net/urdt/ussd/internal/http/at"
 	"git.grassecon.net/urdt/ussd/internal/storage"
 	"git.grassecon.net/urdt/ussd/remote"
 )
 
 var (
-	logg      = logging.NewVanilla()
+	logg          = logging.NewVanilla().WithDomain("AfricasTalking").WithContextKey("at-session-id")
-	scriptDir = path.Join("services", "registration")
+	scriptDir     = path.Join("services", "registration")
-
+	build         = "dev"
-	build = "dev"
+	menuSeparator = ": "
 )
 
 func init() {
 	initializers.LoadEnvVariables()
 }
-
-type atRequestParser struct{}
-
-func (arp *atRequestParser) GetSessionId(rq any) (string, error) {
-	rqv, ok := rq.(*http.Request)
-	if !ok {
-		log.Printf("got an invalid request:", rq)
-		return "", handlers.ErrInvalidRequest
-	}
-
-	// Capture body (if any) for logging
-	body, err := io.ReadAll(rqv.Body)
-	if err != nil {
-		log.Printf("failed to read request body:", err)
-		return "", fmt.Errorf("failed to read request body: %v", err)
-	}
-	// Reset the body for further reading
-	rqv.Body = io.NopCloser(bytes.NewReader(body))
-
-	// Log the body as JSON
-	bodyLog := map[string]string{"body": string(body)}
-	logBytes, err := json.Marshal(bodyLog)
-	if err != nil {
-		log.Printf("failed to marshal request body:", err)
-	} else {
-		log.Printf("Received request:", string(logBytes))
-	}
-
-	if err := rqv.ParseForm(); err != nil {
-		log.Printf("failed to parse form data: %v", err)
-		return "", fmt.Errorf("failed to parse form data: %v", err)
-	}
-
-	phoneNumber := rqv.FormValue("phoneNumber")
-	if phoneNumber == "" {
-		return "", fmt.Errorf("no phone number found")
-	}
-
-	formattedNumber, err := common.FormatPhoneNumber(phoneNumber)
-	if err != nil {
-		fmt.Printf("Error: %v\n", err)
-		return "", fmt.Errorf("failed to format number")
-	}
-
-	return formattedNumber, nil
-}
-
-func (arp *atRequestParser) GetInput(rq any) ([]byte, error) {
-	rqv, ok := rq.(*http.Request)
-	if !ok {
-		return nil, handlers.ErrInvalidRequest
-	}
-	if err := rqv.ParseForm(); err != nil {
-		return nil, fmt.Errorf("failed to parse form data: %v", err)
-	}
-
-	text := rqv.FormValue("text")
-
-	parts := strings.Split(text, "*")
-	if len(parts) == 0 {
-		return nil, fmt.Errorf("no input found")
-	}
-
-	return []byte(parts[len(parts)-1]), nil
-}
-
 func main() {
 	config.LoadConfig()
 
@@ -131,9 +60,10 @@ func main() {
 	pfp := path.Join(scriptDir, "pp.csv")
 
 	cfg := engine.Config{
-		Root:       "root",
+		Root:          "root",
-		OutputSize: uint32(size),
+		OutputSize:    uint32(size),
-		FlagCount:  uint32(128),
+		FlagCount:     uint32(128),
+		MenuSeparator: menuSeparator,
 	}
 
 	if engineDebug {
@@ -191,7 +121,7 @@ func main() {
 	}
 	defer stateStore.Close()
 
-	rp := &atRequestParser{}
+	rp := &at.ATRequestParser{}
 	bsh := handlers.NewBaseSessionHandler(cfg, rs, stateStore, userdataStore, rp, hl)
 	sh := httpserver.NewATSessionHandler(bsh)
 

cmd/async/main.go

@@ -21,8 +21,9 @@ import (
 )
 
 var (
-	logg      = logging.NewVanilla()
+	logg          = logging.NewVanilla()
-	scriptDir = path.Join("services", "registration")
+	scriptDir     = path.Join("services", "registration")
+	menuSeparator = ": "
 )
 
 func init() {
@@ -34,7 +35,7 @@ type asyncRequestParser struct {
 	input     []byte
 }
 
-func (p *asyncRequestParser) GetSessionId(r any) (string, error) {
+func (p *asyncRequestParser) GetSessionId(ctx context.Context, r any) (string, error) {
 	return p.sessionId, nil
 }
 
@@ -70,9 +71,10 @@ func main() {
 	pfp := path.Join(scriptDir, "pp.csv")
 
 	cfg := engine.Config{
-		Root:       "root",
+		Root:          "root",
-		OutputSize: uint32(size),
+		OutputSize:    uint32(size),
-		FlagCount:  uint32(128),
+		FlagCount:     uint32(128),
+		MenuSeparator: menuSeparator,
 	}
 
 	if engineDebug {

cmd/http/main.go

@@ -26,6 +26,7 @@ import (
 var (
 	logg      = logging.NewVanilla()
 	scriptDir = path.Join("services", "registration")
+	menuSeparator = ": "
 )
 
 func init() {
@@ -58,9 +59,10 @@ func main() {
 	pfp := path.Join(scriptDir, "pp.csv")
 
 	cfg := engine.Config{
-		Root:       "root",
+		Root:          "root",
-		OutputSize: uint32(size),
+		OutputSize:    uint32(size),
-		FlagCount:  uint32(128),
+		FlagCount:     uint32(128),
+		MenuSeparator: menuSeparator,
 	}
 
 	if engineDebug {

cmd/main.go

@@ -18,8 +18,9 @@ import (
 )
 
 var (
-	logg      = logging.NewVanilla()
+	logg          = logging.NewVanilla()
-	scriptDir = path.Join("services", "registration")
+	scriptDir     = path.Join("services", "registration")
+	menuSeparator = ": "
 )
 
 func init() {
@@ -49,10 +50,11 @@ func main() {
 	pfp := path.Join(scriptDir, "pp.csv")
 
 	cfg := engine.Config{
-		Root:       "root",
+		Root:          "root",
-		SessionId:  sessionId,
+		SessionId:     sessionId,
-		OutputSize: uint32(size),
+		OutputSize:    uint32(size),
-		FlagCount:  uint32(128),
+		FlagCount:     uint32(128),
+		MenuSeparator: menuSeparator,
 	}
 
 	resourceDir := scriptDir

cmd/ssh/README.md

@@ -0,0 +1,34 @@
+# URDT-USSD SSH server
+
+An SSH server entry point for the vise engine.
+
+
+## Adding public keys for access
+
+Map your (client) public key to a session identifier (e.g. phone number)
+
+```
+go run -v -tags logtrace ./cmd/ssh/sshkey/main.go -i <session_id> [--dbdir <dbpath>] <client_publickey_filepath>
+```
+
+
+## Create a private key for the server
+
+```
+ssh-keygen -N "" -f <server_privatekey_filepath>
+```
+
+
+## Run the server
+
+
+```
+go run -v -tags logtrace ./cmd/ssh/main.go -h <host> -p <port> [--dbdir <dbpath>] <server_privatekey_filepath>
+```
+
+
+## Connect to the server
+
+```
+ssh [-v] -T -p <port> -i <client_publickey_filepath> <host>
+```

cmd/ssh/main.go

@@ -0,0 +1,117 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"os"
+	"os/signal"
+	"path"
+	"sync"
+	"syscall"
+
+	"git.defalsify.org/vise.git/db"
+	"git.defalsify.org/vise.git/engine"
+	"git.defalsify.org/vise.git/logging"
+
+	"git.grassecon.net/urdt/ussd/internal/ssh"
+)
+
+var (
+	wg        sync.WaitGroup
+	keyStore  db.Db
+	logg      = logging.NewVanilla()
+	scriptDir = path.Join("services", "registration")
+
+	build = "dev"
+)
+
+func main() {
+	var dbDir string
+	var resourceDir string
+	var size uint
+	var engineDebug bool
+	var stateDebug bool
+	var host string
+	var port uint
+	flag.StringVar(&dbDir, "dbdir", ".state", "database dir to read from")
+	flag.StringVar(&resourceDir, "resourcedir", path.Join("services", "registration"), "resource dir")
+	flag.BoolVar(&engineDebug, "engine-debug", false, "use engine debug output")
+	flag.BoolVar(&stateDebug, "state-debug", false, "use engine debug output")
+	flag.UintVar(&size, "s", 160, "max size of output")
+	flag.StringVar(&host, "h", "127.0.0.1", "http host")
+	flag.UintVar(&port, "p", 7122, "http port")
+	flag.Parse()
+
+	sshKeyFile := flag.Arg(0)
+	_, err := os.Stat(sshKeyFile)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "cannot open ssh server private key file: %v\n", err)
+		os.Exit(1)
+	}
+
+	ctx := context.Background()
+	logg.WarnCtxf(ctx, "!!!!! WARNING WARNING WARNING")
+	logg.WarnCtxf(ctx, "!!!!! =======================")
+	logg.WarnCtxf(ctx, "!!!!! This is not a production ready server!")
+	logg.WarnCtxf(ctx, "!!!!! Do not expose to internet and only use with tunnel!")
+	logg.WarnCtxf(ctx, "!!!!! (See ssh -L <...>)")
+
+	logg.Infof("start command", "dbdir", dbDir, "resourcedir", resourceDir, "outputsize", size, "keyfile", sshKeyFile, "host", host, "port", port)
+
+	pfp := path.Join(scriptDir, "pp.csv")
+
+	cfg := engine.Config{
+		Root:       "root",
+		OutputSize: uint32(size),
+		FlagCount:  uint32(16),
+	}
+	if stateDebug {
+		cfg.StateDebug = true
+	}
+	if engineDebug {
+		cfg.EngineDebug = true
+	}
+
+	authKeyStore, err := ssh.NewSshKeyStore(ctx, dbDir)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "keystore file open error: %v", err)
+		os.Exit(1)
+	}
+	defer func() {
+		logg.TraceCtxf(ctx, "shutdown auth key store reached")
+		err = authKeyStore.Close()
+		if err != nil {
+			logg.ErrorCtxf(ctx, "keystore close error", "err", err)
+		}
+	}()
+
+	cint := make(chan os.Signal)
+	cterm := make(chan os.Signal)
+	signal.Notify(cint, os.Interrupt, syscall.SIGINT)
+	signal.Notify(cterm, os.Interrupt, syscall.SIGTERM)
+
+	runner := &ssh.SshRunner{
+		Cfg:         cfg,
+		Debug:       engineDebug,
+		FlagFile:    pfp,
+		DbDir:       dbDir,
+		ResourceDir: resourceDir,
+		SrvKeyFile:  sshKeyFile,
+		Host:        host,
+		Port:        port,
+	}
+	go func() {
+		select {
+		case _ = <-cint:
+		case _ = <-cterm:
+		}
+		logg.TraceCtxf(ctx, "shutdown runner reached")
+		err := runner.Stop()
+		if err != nil {
+			logg.ErrorCtxf(ctx, "runner stop error", "err", err)
+		}
+
+	}()
+	runner.Run(ctx, authKeyStore)
+}

cmd/ssh/sshkey/main.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"os"
+
+	"git.grassecon.net/urdt/ussd/internal/ssh"
+)
+
+func main() {
+	var dbDir string
+	var sessionId string
+	flag.StringVar(&dbDir, "dbdir", ".state", "database dir to read from")
+	flag.StringVar(&sessionId, "i", "", "session id")
+	flag.Parse()
+
+	if sessionId == "" {
+		fmt.Fprintf(os.Stderr, "empty session id\n")
+		os.Exit(1)
+	}
+
+	ctx := context.Background()
+
+	sshKeyFile := flag.Arg(0)
+	if sshKeyFile == "" {
+		fmt.Fprintf(os.Stderr, "missing key file argument\n")
+		os.Exit(1)
+	}
+
+	store, err := ssh.NewSshKeyStore(ctx, dbDir)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%v\n", err)
+		os.Exit(1)
+	}
+	defer store.Close()
+
+	err = store.AddFromFile(ctx, sshKeyFile, sessionId)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "%v\n", err)
+		os.Exit(1)
+	}
+}

common/db.go

@@ -7,32 +7,84 @@ import (
 	"git.defalsify.org/vise.git/logging"
 )
 
+// DataType is a subprefix value used in association with vise/db.DATATYPE_USERDATA. 
+//
+// All keys are used only within the context of a single account. Unless otherwise specified, the user context is the session id.
+//
+// * The first byte is vise/db.DATATYPE_USERDATA
+// * The last 2 bytes are the DataTyp value, big-endian.
+// * The intermediate bytes are the id of the user context.
+//
+// All values are strings
 type DataTyp uint16
 
 const (
-	DATA_ACCOUNT DataTyp = iota
+	// API Tracking id to follow status of account creation
-	DATA_ACCOUNT_CREATED
+	DATA_TRACKING_ID = iota
-	DATA_TRACKING_ID
+	// EVM address returned from API on account creation
 	DATA_PUBLIC_KEY
-	DATA_CUSTODIAL_ID
+	// Currently active PIN used to authenticate ussd state change requests
 	DATA_ACCOUNT_PIN
-	DATA_ACCOUNT_STATUS
+	// The first name of the user
 	DATA_FIRST_NAME
+	// The last name of the user
 	DATA_FAMILY_NAME
+	// The year-of-birth of the user
 	DATA_YOB
+	// The location of the user
 	DATA_LOCATION
+	// The gender of the user
 	DATA_GENDER
+	// The offerings description of the user
 	DATA_OFFERINGS
+	// The ethereum address of the recipient of an ongoing send request
 	DATA_RECIPIENT
+	// The voucher value amount of an ongoing send request
 	DATA_AMOUNT
+	// A general swap field for temporary values
 	DATA_TEMPORARY_VALUE
+	// Currently active voucher symbol of user
 	DATA_ACTIVE_SYM
+	// Voucher balance of user's currently active voucher
 	DATA_ACTIVE_BAL
+	// String boolean indicating whether use of PIN is blocked
 	DATA_BLOCKED_NUMBER
+	// Reverse mapping of a user's evm address to a session id.
 	DATA_PUBLIC_KEY_REVERSE
+	// Decimal count of the currently active voucher
 	DATA_ACTIVE_DECIMAL
+	// EVM address of the currently active voucher
 	DATA_ACTIVE_ADDRESS
-	DATA_TRANSACTIONS
+)
+
+const (
+	// List of valid voucher symbols in the user context.
+	DATA_VOUCHER_SYMBOLS DataTyp = 256 + iota
+	// List of voucher balances for vouchers valid in the user context.
+	DATA_VOUCHER_BALANCES
+	// List of voucher decimal counts for vouchers valid in the user context.
+	DATA_VOUCHER_DECIMALS
+	// List of voucher EVM addresses for vouchers valid in the user context.
+	DATA_VOUCHER_ADDRESSES
+	// List of senders for valid transactions in the user context.
+)
+
+const (
+	DATA_TX_SENDERS = 512 + iota
+	// List of recipients for valid transactions in the user context.
+	DATA_TX_RECIPIENTS
+	// List of voucher values for valid transactions in the user context.
+	DATA_TX_VALUES
+	// List of voucher EVM addresses for valid transactions in the user context.
+	DATA_TX_ADDRESSES
+	// List of valid transaction hashes in the user context.
+	DATA_TX_HASHES
+	// List of transaction dates for valid transactions in the user context.
+	DATA_TX_DATES
+	// List of voucher symbols for valid transactions in the user context.
+	DATA_TX_SYMBOLS
+	// List of voucher decimal counts for valid transactions in the user context.
+	DATA_TX_DECIMALS
 )
 
 var (
@@ -69,3 +121,10 @@ func StringToDataTyp(str string) (DataTyp, error) {
 		return 0, errors.New("invalid DataTyp string")
 	}
 }
+
+// ToBytes converts DataTyp or int to a byte slice
+func ToBytes[T ~uint16 | int](value T) []byte {
+	bytes := make([]byte, 2)
+	binary.BigEndian.PutUint16(bytes, uint16(value))
+	return bytes
+}

common/pin.go

@@ -0,0 +1,33 @@
+package common
+
+import (
+	"regexp"
+
+	"golang.org/x/crypto/bcrypt"
+)
+
+// Define the regex pattern as a constant
+const (
+	pinPattern = `^\d{4}$`
+)
+
+// checks whether the given input is a 4 digit number
+func IsValidPIN(pin string) bool {
+	match, _ := regexp.MatchString(pinPattern, pin)
+	return match
+}
+
+// HashPIN uses bcrypt with 8 salt rounds to hash the PIN
+func HashPIN(pin string) (string, error) {
+	hash, err := bcrypt.GenerateFromPassword([]byte(pin), 8)
+	if err != nil {
+		return "", err
+	}
+	return string(hash), nil
+}
+
+// VerifyPIN compareS the hashed PIN with the plaintext PIN
+func VerifyPIN(hashedPIN, pin string) bool {
+	err := bcrypt.CompareHashAndPassword([]byte(hashedPIN), []byte(pin))
+	return err == nil
+}

common/pin_test.go

@@ -0,0 +1,173 @@
+package common
+
+import (
+	"testing"
+
+	"golang.org/x/crypto/bcrypt"
+)
+
+func TestIsValidPIN(t *testing.T) {
+	tests := []struct {
+		name     string
+		pin      string
+		expected bool
+	}{
+		{
+			name:     "Valid PIN with 4 digits",
+			pin:      "1234",
+			expected: true,
+		},
+		{
+			name:     "Valid PIN with leading zeros",
+			pin:      "0001",
+			expected: true,
+		},
+		{
+			name:     "Invalid PIN with less than 4 digits",
+			pin:      "123",
+			expected: false,
+		},
+		{
+			name:     "Invalid PIN with more than 4 digits",
+			pin:      "12345",
+			expected: false,
+		},
+		{
+			name:     "Invalid PIN with letters",
+			pin:      "abcd",
+			expected: false,
+		},
+		{
+			name:     "Invalid PIN with special characters",
+			pin:      "12@#",
+			expected: false,
+		},
+		{
+			name:     "Empty PIN",
+			pin:      "",
+			expected: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			actual := IsValidPIN(tt.pin)
+			if actual != tt.expected {
+				t.Errorf("IsValidPIN(%q) = %v; expected %v", tt.pin, actual, tt.expected)
+			}
+		})
+	}
+}
+
+func TestHashPIN(t *testing.T) {
+	tests := []struct {
+		name string
+		pin  string
+	}{
+		{
+			name: "Valid PIN with 4 digits",
+			pin:  "1234",
+		},
+		{
+			name: "Valid PIN with leading zeros",
+			pin:  "0001",
+		},
+		{
+			name: "Empty PIN",
+			pin:  "",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			hashedPIN, err := HashPIN(tt.pin)
+			if err != nil {
+				t.Errorf("HashPIN(%q) returned an error: %v", tt.pin, err)
+				return
+			}
+
+			if hashedPIN == "" {
+				t.Errorf("HashPIN(%q) returned an empty hash", tt.pin)
+			}
+
+			// Ensure the hash can be verified with bcrypt
+			err = bcrypt.CompareHashAndPassword([]byte(hashedPIN), []byte(tt.pin))
+			if tt.pin != "" && err != nil {
+				t.Errorf("HashPIN(%q) produced a hash that does not match: %v", tt.pin, err)
+			}
+		})
+	}
+}
+
+func TestVerifyMigratedHashPin(t *testing.T) {
+	tests := []struct {
+		pin  string
+		hash string
+	}{
+		{
+			pin:  "1234",
+			hash: "$2b$08$dTvIGxCCysJtdvrSnaLStuylPoOS/ZLYYkxvTeR5QmTFY3TSvPQC6",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.pin, func(t *testing.T) {
+			ok := VerifyPIN(tt.hash, tt.pin)
+			if !ok {
+				t.Errorf("VerifyPIN could not verify migrated PIN: %v", tt.pin)
+			}
+		})
+	}
+}
+
+func TestVerifyPIN(t *testing.T) {
+	tests := []struct {
+		name       string
+		pin        string
+		hashedPIN  string
+		shouldPass bool
+	}{
+		{
+			name:       "Valid PIN verification",
+			pin:        "1234",
+			hashedPIN:  hashPINHelper("1234"),
+			shouldPass: true,
+		},
+		{
+			name:       "Invalid PIN verification with incorrect PIN",
+			pin:        "5678",
+			hashedPIN:  hashPINHelper("1234"),
+			shouldPass: false,
+		},
+		{
+			name:       "Invalid PIN verification with empty PIN",
+			pin:        "",
+			hashedPIN:  hashPINHelper("1234"),
+			shouldPass: false,
+		},
+		{
+			name:       "Invalid PIN verification with invalid hash",
+			pin:        "1234",
+			hashedPIN:  "invalidhash",
+			shouldPass: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := VerifyPIN(tt.hashedPIN, tt.pin)
+			if result != tt.shouldPass {
+				t.Errorf("VerifyPIN(%q, %q) = %v; expected %v", tt.hashedPIN, tt.pin, result, tt.shouldPass)
+			}
+		})
+	}
+}
+
+// Helper function to hash a PIN for testing purposes
+func hashPINHelper(pin string) string {
+	hashedPIN, err := HashPIN(pin)
+	if err != nil {
+		panic("Failed to hash PIN for test setup: " + err.Error())
+	}
+	return hashedPIN
+}

common/storage.go

@@ -8,14 +8,15 @@ import (
 	"git.defalsify.org/vise.git/resource"
 	"git.defalsify.org/vise.git/persist"
 	"git.grassecon.net/urdt/ussd/internal/storage"
+	dbstorage "git.grassecon.net/urdt/ussd/internal/storage/db"
 )
 
 func StoreToDb(store *UserDataStore) db.Db {
 	return store.Db
 }
 
-func StoreToPrefixDb(store *UserDataStore, pfx []byte) storage.PrefixDb {
+func StoreToPrefixDb(store *UserDataStore, pfx []byte) dbstorage.PrefixDb {
-	return storage.NewSubPrefixDb(store.Db, pfx)	
+	return dbstorage.NewSubPrefixDb(store.Db, pfx)	
 }
 
 type StorageServices interface {

common/transfer_statements.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 	"time"
 
-	"git.grassecon.net/urdt/ussd/internal/storage"
+	dbstorage "git.grassecon.net/urdt/ussd/internal/storage/db"
 	dataserviceapi "github.com/grassrootseconomics/ussd-data-service/pkg/api"
 )
 
@@ -56,26 +56,26 @@ func ProcessTransfers(transfers []dataserviceapi.Last10TxResponse) TransferMetad
 
 // GetTransferData retrieves and matches transfer data
 // returns a formatted string of the full transaction/statement
-func GetTransferData(ctx context.Context, db storage.PrefixDb, publicKey string, index int) (string, error) {
+func GetTransferData(ctx context.Context, db dbstorage.PrefixDb, publicKey string, index int) (string, error) {
-	keys := []string{"txfrom", "txto", "txval", "txaddr", "txhash", "txdate", "txsym"}
+	keys := []DataTyp{DATA_TX_SENDERS, DATA_TX_RECIPIENTS, DATA_TX_VALUES, DATA_TX_ADDRESSES, DATA_TX_HASHES, DATA_TX_DATES, DATA_TX_SYMBOLS}
-	data := make(map[string]string)
+	data := make(map[DataTyp]string)
 
 	for _, key := range keys {
-		value, err := db.Get(ctx, []byte(key))
+		value, err := db.Get(ctx, ToBytes(key))
 		if err != nil {
-			return "", fmt.Errorf("failed to get %s: %v", key, err)
+			return "", fmt.Errorf("failed to get %s: %v", ToBytes(key), err)
 		}
 		data[key] = string(value)
 	}
 
 	// Split the data
-	senders := strings.Split(string(data["txfrom"]), "\n")
+	senders := strings.Split(string(data[DATA_TX_SENDERS]), "\n")
-	recipients := strings.Split(string(data["txto"]), "\n")
+	recipients := strings.Split(string(data[DATA_TX_RECIPIENTS]), "\n")
-	values := strings.Split(string(data["txval"]), "\n")
+	values := strings.Split(string(data[DATA_TX_VALUES]), "\n")
-	addresses := strings.Split(string(data["txaddr"]), "\n")
+	addresses := strings.Split(string(data[DATA_TX_ADDRESSES]), "\n")
-	hashes := strings.Split(string(data["txhash"]), "\n")
+	hashes := strings.Split(string(data[DATA_TX_HASHES]), "\n")
-	dates := strings.Split(string(data["txdate"]), "\n")
+	dates := strings.Split(string(data[DATA_TX_DATES]), "\n")
-	syms := strings.Split(string(data["txsym"]), "\n")
+	syms := strings.Split(string(data[DATA_TX_SYMBOLS]), "\n")
 
 	// Check if index is within range
 	if index < 1 || index > len(senders) {
@@ -84,18 +84,18 @@ func GetTransferData(ctx context.Context, db storage.PrefixDb, publicKey string,
 
 	// Adjust for 0-based indexing
 	i := index - 1
-	transactionType := "received"
+	transactionType := "Received"
-	party := fmt.Sprintf("from: %s", strings.TrimSpace(senders[i]))
+	party := fmt.Sprintf("From: %s", strings.TrimSpace(senders[i]))
 	if strings.TrimSpace(senders[i]) == publicKey {
-		transactionType = "sent"
+		transactionType = "Sent"
-		party = fmt.Sprintf("to: %s", strings.TrimSpace(recipients[i]))
+		party = fmt.Sprintf("To: %s", strings.TrimSpace(recipients[i]))
 	}
 
 	formattedDate := formatDate(strings.TrimSpace(dates[i]))
 
 	// Build the full transaction detail
 	detail := fmt.Sprintf(
-		"%s %s %s\n%s\ncontract address: %s\ntxhash: %s\ndate: %s",
+		"%s %s %s\n%s\nContract address: %s\nTxhash: %s\nDate: %s",
 		transactionType,
 		strings.TrimSpace(values[i]),
 		strings.TrimSpace(syms[i]),

common/user_store.go

@@ -20,7 +20,7 @@ type UserDataStore struct {
 func (store *UserDataStore) ReadEntry(ctx context.Context, sessionId string, typ DataTyp) ([]byte, error) {
 	store.SetPrefix(db.DATATYPE_USERDATA)
 	store.SetSession(sessionId)
-	k := PackKey(typ, []byte(sessionId))
+	k := ToBytes(typ)
 	return store.Get(ctx, k)
 }
 
@@ -29,6 +29,6 @@ func (store *UserDataStore) ReadEntry(ctx context.Context, sessionId string, typ
 func (store *UserDataStore) WriteEntry(ctx context.Context, sessionId string, typ DataTyp, value []byte) error {
 	store.SetPrefix(db.DATATYPE_USERDATA)
 	store.SetSession(sessionId)
-	k := PackKey(typ, []byte(sessionId))
+	k := ToBytes(typ)
 	return store.Put(ctx, k, value)
 }

common/vouchers.go

@@ -6,7 +6,7 @@ import (
 	"math/big"
 	"strings"
 
-	"git.grassecon.net/urdt/ussd/internal/storage"
+	dbstorage "git.grassecon.net/urdt/ussd/internal/storage/db"
 	dataserviceapi "github.com/grassrootseconomics/ussd-data-service/pkg/api"
 )
 
@@ -63,23 +63,24 @@ func ScaleDownBalance(balance, decimals string) string {
 }
 
 // GetVoucherData retrieves and matches voucher data
-func GetVoucherData(ctx context.Context, db storage.PrefixDb, input string) (*dataserviceapi.TokenHoldings, error) {
+func GetVoucherData(ctx context.Context, db dbstorage.PrefixDb, input string) (*dataserviceapi.TokenHoldings, error) {
-	keys := []string{"sym", "bal", "deci", "addr"}
+	keys := []DataTyp{DATA_VOUCHER_SYMBOLS, DATA_VOUCHER_BALANCES, DATA_VOUCHER_DECIMALS, DATA_VOUCHER_ADDRESSES}
-	data := make(map[string]string)
+	data := make(map[DataTyp]string)
 
 	for _, key := range keys {
-		value, err := db.Get(ctx, []byte(key))
+		value, err := db.Get(ctx, ToBytes(key))
 		if err != nil {
-			return nil, fmt.Errorf("failed to get %s: %v", key, err)
+			return nil, fmt.Errorf("failed to get %s: %v", ToBytes(key), err)
 		}
 		data[key] = string(value)
 	}
 
 	symbol, balance, decimal, address := MatchVoucher(input,
-		data["sym"],
+		data[DATA_VOUCHER_SYMBOLS],
-		data["bal"],
+		data[DATA_VOUCHER_BALANCES],
-		data["deci"],
+		data[DATA_VOUCHER_DECIMALS],
-		data["addr"])
+		data[DATA_VOUCHER_ADDRESSES],
+	)
 
 	if symbol == "" {
 		return nil, nil
@@ -151,7 +152,7 @@ func GetTemporaryVoucherData(ctx context.Context, store DataStore, sessionId str
 	return data, nil
 }
 
-// UpdateVoucherData sets the active voucher data in the DataStore.
+// UpdateVoucherData updates the active voucher data in the DataStore.
 func UpdateVoucherData(ctx context.Context, store DataStore, sessionId string, data *dataserviceapi.TokenHoldings) error {
 	logg.TraceCtxf(ctx, "dtal", "data", data)
 	// Active voucher data entries

common/vouchers_test.go

@@ -8,8 +8,9 @@ import (
 	"github.com/alecthomas/assert/v2"
 	"github.com/stretchr/testify/require"
 
-	"git.grassecon.net/urdt/ussd/internal/storage"
+	visedb "git.defalsify.org/vise.git/db"
 	memdb "git.defalsify.org/vise.git/db/mem"
+	dbstorage "git.grassecon.net/urdt/ussd/internal/storage/db"
 	dataserviceapi "github.com/grassrootseconomics/ussd-data-service/pkg/api"
 )
 
@@ -83,19 +84,21 @@ func TestGetVoucherData(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	spdb := storage.NewSubPrefixDb(db, []byte("vouchers"))
+
+	prefix := ToBytes(visedb.DATATYPE_USERDATA)
+	spdb := dbstorage.NewSubPrefixDb(db, prefix)
 
 	// Test voucher data
-	mockData := map[string][]byte{
+	mockData := map[DataTyp][]byte{
-		"sym":  []byte("1:SRF\n2:MILO"),
+		DATA_VOUCHER_SYMBOLS:   []byte("1:SRF\n2:MILO"),
-		"bal":  []byte("1:100\n2:200"),
+		DATA_VOUCHER_BALANCES:  []byte("1:100\n2:200"),
-		"deci": []byte("1:6\n2:4"),
+		DATA_VOUCHER_DECIMALS:  []byte("1:6\n2:4"),
-		"addr": []byte("1:0xd4c288865Ce\n2:0x41c188d63Qa"),
+		DATA_VOUCHER_ADDRESSES: []byte("1:0xd4c288865Ce\n2:0x41c188d63Qa"),
 	}
 
 	// Put the data
 	for key, value := range mockData {
-		err = spdb.Put(ctx, []byte(key), []byte(value))
+		err = spdb.Put(ctx, []byte(ToBytes(key)), []byte(value))
 		if err != nil {
 			t.Fatal(err)
 		}

debug/cap.go

@@ -0,0 +1,5 @@
+package debug
+
+var (
+	DebugCap uint32
+)

debug/db.go

@@ -0,0 +1,84 @@
+package debug
+
+import (
+	"fmt"
+	"encoding/binary"
+
+	"git.grassecon.net/urdt/ussd/common"
+	"git.defalsify.org/vise.git/db"
+)
+
+var (
+	dbTypStr map[common.DataTyp]string = make(map[common.DataTyp]string)
+)
+
+type KeyInfo struct {
+	SessionId string
+	Typ uint8
+	SubTyp common.DataTyp
+	Label string
+	Description string
+}
+
+func (k KeyInfo) String() string {
+	v := uint16(k.SubTyp)
+	s := subTypToString(k.SubTyp)
+	if s == "" {
+		v = uint16(k.Typ)
+		s = typToString(k.Typ)
+	}
+	return fmt.Sprintf("Session Id: %s\nTyp: %s (%d)\n", k.SessionId, s, v)
+}
+
+func ToKeyInfo(k []byte, sessionId string) (KeyInfo, error) {
+	o := KeyInfo{}
+	b := []byte(sessionId)
+
+	if len(k) <= len(b) {
+		return o, fmt.Errorf("storage key missing")
+	}
+
+	o.SessionId = sessionId
+
+	o.Typ = uint8(k[0])
+	k = k[1:]
+	o.SessionId = string(k[:len(b)])
+	k = k[len(b):]
+
+	if o.Typ == db.DATATYPE_USERDATA {
+		if len(k) == 0 {
+			return o, fmt.Errorf("missing subtype key")
+		}
+		v := binary.BigEndian.Uint16(k[:2])
+		o.SubTyp = common.DataTyp(v)
+		o.Label = subTypToString(o.SubTyp)
+		k = k[2:]
+	} else {
+		o.Label = typToString(o.Typ)
+	}
+
+	if len(k) != 0 {
+		return o, fmt.Errorf("excess key information")
+	}
+
+	return o, nil
+}
+
+func FromKey(k []byte) (KeyInfo, error) {
+	o := KeyInfo{}
+
+	if len(k) < 4 {
+		return o, fmt.Errorf("insufficient key length")
+	}
+
+	sessionIdBytes := k[1:len(k)-2]
+	return ToKeyInfo(k, string(sessionIdBytes))
+}
+
+func subTypToString(v common.DataTyp) string {
+	return dbTypStr[v + db.DATATYPE_USERDATA + 1]
+}
+
+func typToString(v uint8) string {
+	return dbTypStr[common.DataTyp(uint16(v))]
+}

debug/db_debug.go

@@ -0,0 +1,44 @@
+// +build debugdb
+
+package debug
+
+import (
+	"git.defalsify.org/vise.git/db"
+
+	"git.grassecon.net/urdt/ussd/common"
+)
+
+func init() {
+	DebugCap |= 1
+	dbTypStr[db.DATATYPE_STATE] = "internal state"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TRACKING_ID] = "tracking id"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_PUBLIC_KEY] = "public key"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_ACCOUNT_PIN] = "account pin"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_FIRST_NAME] = "first name"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_FAMILY_NAME] = "family name"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_YOB] = "year of birth"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_LOCATION] = "location"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_GENDER] = "gender"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_OFFERINGS] = "offerings"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_RECIPIENT] = "recipient"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_AMOUNT] = "amount"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TEMPORARY_VALUE] = "temporary value"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_ACTIVE_SYM] = "active sym"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_ACTIVE_BAL] = "active bal"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_BLOCKED_NUMBER] = "blocked number"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_PUBLIC_KEY_REVERSE] = "public_key_reverse"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_ACTIVE_DECIMAL] = "active decimal"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_ACTIVE_ADDRESS] = "active address"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_VOUCHER_SYMBOLS] = "voucher symbols"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_VOUCHER_BALANCES] = "voucher balances"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_VOUCHER_DECIMALS] = "voucher decimals"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_VOUCHER_ADDRESSES] = "voucher addresses"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_SENDERS] = "tx senders"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_RECIPIENTS] = "tx recipients"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_VALUES] = "tx values"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_ADDRESSES] = "tx addresses"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_HASHES] = "tx hashes"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_DATES] = "tx dates"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_SYMBOLS] = "tx symbols"
+	dbTypStr[db.DATATYPE_USERDATA + 1 + common.DATA_TX_DECIMALS] = "tx decimals"
+}

debug/db_test.go

@@ -0,0 +1,78 @@
+package debug
+
+import (
+	"testing"
+
+	"git.grassecon.net/urdt/ussd/common"
+	"git.defalsify.org/vise.git/db"
+)
+
+func TestDebugDbSubKeyInfo(t *testing.T) {
+	s := "foo"
+	b := []byte{0x20}
+	b = append(b, []byte(s)...)
+	b = append(b, []byte{0x00, 0x02}...)
+	r, err := ToKeyInfo(b, s)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if r.SessionId != s {
+		t.Fatalf("expected %s, got %s", s, r.SessionId)
+	}
+	if r.Typ != 32 {
+		t.Fatalf("expected 64, got %d", r.Typ)
+	}
+	if r.SubTyp != 2 {
+		t.Fatalf("expected 2, got %d", r.SubTyp)
+	}
+	if DebugCap & 1 > 0 {
+		if r.Label != "tracking id" {
+			t.Fatalf("expected 'tracking id', got '%s'", r.Label)
+		}
+	}
+}
+
+func TestDebugDbKeyInfo(t *testing.T) {
+	s := "bar"
+	b := []byte{0x10}
+	b = append(b, []byte(s)...)
+	r, err := ToKeyInfo(b, s)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if r.SessionId != s {
+		t.Fatalf("expected %s, got %s", s, r.SessionId)
+	}
+	if r.Typ != 16 {
+		t.Fatalf("expected 16, got %d", r.Typ)
+	}
+	if DebugCap & 1 > 0 {
+		if r.Label != "internal state" {
+			t.Fatalf("expected 'internal_state', got '%s'", r.Label)
+		}
+	}
+}
+
+func TestDebugDbKeyInfoRestore(t *testing.T) {
+	s := "bar"
+	b := []byte{db.DATATYPE_USERDATA}
+	b = append(b, []byte(s)...)
+	k := common.ToBytes(common.DATA_ACTIVE_SYM)
+	b = append(b, k...)
+
+	r, err := ToKeyInfo(b, s)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if r.SessionId != s {
+		t.Fatalf("expected %s, got %s", s, r.SessionId)
+	}
+	if r.Typ != 32 {
+		t.Fatalf("expected 32, got %d", r.Typ)
+	}
+	if DebugCap & 1 > 0 {
+		if r.Label != "active sym" {
+			t.Fatalf("expected 'active sym', got '%s'", r.Label)
+		}
+	}
+}

devtools/store/dump/main.go

@@ -0,0 +1,89 @@
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"os"
+	"path"
+
+	"git.grassecon.net/urdt/ussd/config"
+	"git.grassecon.net/urdt/ussd/initializers"
+	"git.grassecon.net/urdt/ussd/internal/storage"
+	"git.grassecon.net/urdt/ussd/debug"
+	"git.defalsify.org/vise.git/db"
+	"git.defalsify.org/vise.git/logging"
+)
+
+var (
+	logg      = logging.NewVanilla()
+	scriptDir = path.Join("services", "registration")
+)
+
+func init() {
+	initializers.LoadEnvVariables()
+}
+
+
+func formatItem(k []byte, v []byte) (string, error) {
+	o, err := debug.FromKey(k)
+	if err != nil {
+		return "", err
+	}
+	s := fmt.Sprintf("%vValue: %v\n\n", o, string(v))
+	return s, nil
+}
+
+func main() {
+	config.LoadConfig()
+
+	var dbDir string
+	var sessionId string
+	var database string
+	var engineDebug bool
+
+	flag.StringVar(&sessionId, "session-id", "075xx2123", "session id")
+	flag.StringVar(&database, "db", "gdbm", "database to be used")
+	flag.StringVar(&dbDir, "dbdir", ".state", "database dir to read from")
+	flag.BoolVar(&engineDebug, "d", false, "use engine debug output")
+	flag.Parse()
+
+	ctx := context.Background()
+	ctx = context.WithValue(ctx, "SessionId", sessionId)
+	ctx = context.WithValue(ctx, "Database", database)
+
+	resourceDir := scriptDir
+	menuStorageService := storage.NewMenuStorageService(dbDir, resourceDir)
+
+	store, err := menuStorageService.GetUserdataDb(ctx)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "get userdata db: %v\n", err.Error())
+		os.Exit(1)
+	}
+	store.SetPrefix(db.DATATYPE_USERDATA)
+
+	d, err := store.Dump(ctx, []byte(sessionId))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "store dump fail: %v\n", err.Error())
+		os.Exit(1)
+	}
+
+	for true {
+		k, v := d.Next(ctx)
+		if k == nil {
+			break
+		}
+		r, err := formatItem(k, v)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "format db item error: %v", err)
+			os.Exit(1)
+		}
+		fmt.Printf(r)
+	}
+
+	err = store.Close()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, err.Error())
+		os.Exit(1)
+	}
+}

devtools/store/generate/main.go

@@ -0,0 +1,79 @@
+package main
+
+import (
+	"context"
+	"crypto/sha1"
+	"flag"
+	"fmt"
+	"os"
+	"path"
+
+	"git.defalsify.org/vise.git/logging"
+	"git.grassecon.net/urdt/ussd/config"
+	"git.grassecon.net/urdt/ussd/internal/storage"
+	"git.grassecon.net/urdt/ussd/initializers"
+	"git.grassecon.net/urdt/ussd/common"
+)
+
+var (
+	logg      = logging.NewVanilla()
+	scriptDir = path.Join("services", "registration")
+)
+
+func init() {
+	initializers.LoadEnvVariables()
+}
+
+
+func main() {
+	config.LoadConfig()
+
+	var dbDir string
+	var sessionId string
+	var database string
+	var engineDebug bool
+
+	flag.StringVar(&sessionId, "session-id", "075xx2123", "session id")
+	flag.StringVar(&database, "db", "gdbm", "database to be used")
+	flag.StringVar(&dbDir, "dbdir", ".state", "database dir to read from")
+	flag.BoolVar(&engineDebug, "d", false, "use engine debug output")
+	flag.Parse()
+
+	ctx := context.Background()
+	ctx = context.WithValue(ctx, "SessionId", sessionId)
+	ctx = context.WithValue(ctx, "Database", database)
+
+	resourceDir := scriptDir
+	menuStorageService := storage.NewMenuStorageService(dbDir, resourceDir)
+
+	store, err := menuStorageService.GetUserdataDb(ctx)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, err.Error())
+		os.Exit(1)
+	}
+	userStore := common.UserDataStore{store}
+
+	h := sha1.New()
+	h.Write([]byte(sessionId))
+	address := h.Sum(nil)
+	addressString := fmt.Sprintf("%x", address)
+
+	err = userStore.WriteEntry(ctx, sessionId, common.DATA_PUBLIC_KEY, []byte(addressString))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, err.Error())
+		os.Exit(1)
+	}
+
+	err = userStore.WriteEntry(ctx, addressString, common.DATA_PUBLIC_KEY_REVERSE, []byte(sessionId))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, err.Error())
+		os.Exit(1)
+	}
+
+	err = store.Close()
+	if err != nil {
+		fmt.Fprintf(os.Stderr, err.Error())
+		os.Exit(1)
+	}
+	
+}

doc/data.md

@@ -0,0 +1,28 @@
+# Internals
+
+## Version
+
+This document describes component versions:
+
+* `urdt-ussd` `v0.5.0-beta`
+* `go-vise` `v0.2.2`
+
+
+## User profile data
+
+All user profile items are stored under keys matching the user's session id, prefixed with the 8-bit value `git.defalsify.org/vise.git/db.DATATYPE_USERDATA` (32), and followed with a 16-big big-endian value subprefix.
+
+For example, given the sessionId `+254123` and the key `git.grassecon.net/urdt-ussd/common.DATA_PUBLIC_KEY` (2) will be stored under the key:
+
+```
+0x322b3235343132330002
+
+prefix   sessionid       subprefix
+32       2b323534313233  0002
+```
+
+### Sub-prefixes
+
+All sub-prefixes are defined as constants in the `git.grassecon.net/urdt-ussd/common` package. The constant names have the prefix `DATA_`
+
+Please refer to inline godoc documentation for the `git.grassecon.net/urdt-ussd/common` package for details on each data item.

go.mod

@@ -3,7 +3,7 @@ module git.grassecon.net/urdt/ussd
 go 1.23.0
 
 require (
-	git.defalsify.org/vise.git v0.2.1-0.20241122120231-9e9ee5bdfa7a
+	git.defalsify.org/vise.git v0.2.3-0.20250103172917-3e190a44568d
 	github.com/alecthomas/assert/v2 v2.2.2
 	github.com/gofrs/uuid v4.4.0+incompatible
 	github.com/grassrootseconomics/eth-custodial v1.3.0-beta
@@ -11,6 +11,7 @@ require (
 	github.com/joho/godotenv v1.5.1
 	github.com/peteole/testdata-loader v0.3.0
 	github.com/stretchr/testify v1.9.0
+	golang.org/x/crypto v0.27.0
 	gopkg.in/leonelquinteros/gotext.v1 v1.3.1
 )
 
@@ -32,7 +33,6 @@ require (
 	github.com/rogpeppe/go-internal v1.13.1 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect
 	github.com/x448/float16 v0.8.4 // indirect
-	golang.org/x/crypto v0.27.0 // indirect
 	golang.org/x/sync v0.8.0 // indirect
 	golang.org/x/text v0.18.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

go.sum

@@ -1,5 +1,5 @@
-git.defalsify.org/vise.git v0.2.1-0.20241122120231-9e9ee5bdfa7a h1:LvGKktk0kUnuRN3nF9r15D8OoV0sFaMmQr52kGq2gtE=
+git.defalsify.org/vise.git v0.2.3-0.20250103172917-3e190a44568d h1:bPAOVZOX4frSGhfOdcj7kc555f8dc9DmMd2YAyC2AMw=
-git.defalsify.org/vise.git v0.2.1-0.20241122120231-9e9ee5bdfa7a/go.mod h1:jyBMe1qTYUz3mmuoC9JQ/TvFeW0vTanCUcPu3H8p4Ck=
+git.defalsify.org/vise.git v0.2.3-0.20250103172917-3e190a44568d/go.mod h1:jyBMe1qTYUz3mmuoC9JQ/TvFeW0vTanCUcPu3H8p4Ck=
 github.com/alecthomas/assert/v2 v2.2.2 h1:Z/iVC0xZfWTaFNE6bA3z07T86hd45Xe2eLt6WVy2bbk=
 github.com/alecthomas/assert/v2 v2.2.2/go.mod h1:pXcQ2Asjp247dahGEmsZ6ru0UVwnkhktn7S0bBDLxvQ=
 github.com/alecthomas/participle/v2 v2.0.0 h1:Fgrq+MbuSsJwIkw3fEj9h75vDP0Er5JzepJ0/HNHv0g=

internal/handlers/base.go

@@ -55,6 +55,9 @@ func(f *BaseSessionHandler) Process(rqs RequestSession) (RequestSession, error)
 	}
 
 	f.hn = f.hn.WithPersister(rqs.Storage.Persister)
+	defer func() {
+		f.hn.Exit()
+	}()
 	eni := f.GetEngine(rqs.Config, f.rs, rqs.Storage.Persister)
 	en, ok := eni.(*engine.DefaultEngine)
 	if !ok {

internal/handlers/handlerservice.go

@@ -2,6 +2,7 @@ package handlers
 
 import (
 	"context"
+	"strings"
 
 	"git.defalsify.org/vise.git/asm"
 	"git.defalsify.org/vise.git/db"
@@ -64,7 +65,11 @@ func (ls *LocalHandlerService) SetDataStore(db *db.Db) {
 }
 
 func (ls *LocalHandlerService) GetHandler(accountService remote.AccountServiceInterface) (*ussd.Handlers, error) {
-	ussdHandlers, err := ussd.NewHandlers(ls.Parser, *ls.UserdataStore, ls.AdminStore, accountService)
+	replaceSeparatorFunc := func(input string) string {
+		return strings.ReplaceAll(input, ":", ls.Cfg.MenuSeparator)
+	}
+
+	ussdHandlers, err := ussd.NewHandlers(ls.Parser, *ls.UserdataStore, ls.AdminStore, accountService, replaceSeparatorFunc)
 	if err != nil {
 		return nil, err
 	}
@@ -111,7 +116,7 @@ func (ls *LocalHandlerService) GetHandler(accountService remote.AccountServiceIn
 	ls.DbRs.AddLocalFunc("set_voucher", ussdHandlers.SetVoucher)
 	ls.DbRs.AddLocalFunc("get_voucher_details", ussdHandlers.GetVoucherDetails)
 	ls.DbRs.AddLocalFunc("reset_valid_pin", ussdHandlers.ResetValidPin)
-	ls.DbRs.AddLocalFunc("check_pin_mismatch", ussdHandlers.CheckPinMisMatch)
+	ls.DbRs.AddLocalFunc("check_pin_mismatch", ussdHandlers.CheckBlockedNumPinMisMatch)
 	ls.DbRs.AddLocalFunc("validate_blocked_number", ussdHandlers.ValidateBlockedNumber)
 	ls.DbRs.AddLocalFunc("retrieve_blocked_number", ussdHandlers.RetrieveBlockedNumber)
 	ls.DbRs.AddLocalFunc("reset_unregistered_number", ussdHandlers.ResetUnregisteredNumber)
@@ -121,6 +126,8 @@ func (ls *LocalHandlerService) GetHandler(accountService remote.AccountServiceIn
 	ls.DbRs.AddLocalFunc("check_transactions", ussdHandlers.CheckTransactions)
 	ls.DbRs.AddLocalFunc("get_transactions", ussdHandlers.GetTransactionsList)
 	ls.DbRs.AddLocalFunc("view_statement", ussdHandlers.ViewTransactionStatement)
+	ls.DbRs.AddLocalFunc("update_all_profile_items", ussdHandlers.UpdateAllProfileItems)
+	ls.DbRs.AddLocalFunc("set_back", ussdHandlers.SetBack)
 
 	return ussdHandlers, nil
 }

internal/handlers/single.go

@@ -6,9 +6,9 @@ import (
 	"io"
 
 	"git.defalsify.org/vise.git/engine"
-	"git.defalsify.org/vise.git/resource"
-	"git.defalsify.org/vise.git/persist"
 	"git.defalsify.org/vise.git/logging"
+	"git.defalsify.org/vise.git/persist"
+	"git.defalsify.org/vise.git/resource"
 
 	"git.grassecon.net/urdt/ussd/internal/storage"
 )
@@ -20,33 +20,33 @@ var (
 var (
 	ErrInvalidRequest = errors.New("invalid request for context")
 	ErrSessionMissing = errors.New("missing session")
-	ErrInvalidInput = errors.New("invalid input")
+	ErrInvalidInput   = errors.New("invalid input")
-	ErrStorage = errors.New("storage retrieval fail")
+	ErrStorage        = errors.New("storage retrieval fail")
-	ErrEngineType = errors.New("incompatible engine")
+	ErrEngineType     = errors.New("incompatible engine")
-	ErrEngineInit = errors.New("engine init fail")
+	ErrEngineInit     = errors.New("engine init fail")
-	ErrEngineExec = errors.New("engine exec fail")
+	ErrEngineExec     = errors.New("engine exec fail")
 )
 
 type RequestSession struct {
-	Ctx context.Context
+	Ctx      context.Context
-	Config engine.Config
+	Config   engine.Config
-	Engine engine.Engine
+	Engine   engine.Engine
-	Input []byte
+	Input    []byte
-	Storage *storage.Storage
+	Storage  *storage.Storage
-	Writer io.Writer
+	Writer   io.Writer
 	Continue bool
 }
 
 // TODO: seems like can remove this.
 type RequestParser interface {
-	GetSessionId(rq any) (string, error)
+	GetSessionId(context context.Context, rq any) (string, error)
 	GetInput(rq any) ([]byte, error)
 }
 
 type RequestHandler interface {
 	GetConfig() engine.Config
 	GetRequestParser() RequestParser
-	GetEngine(cfg engine.Config, rs resource.Resource, pe *persist.Persister) engine.Engine 
+	GetEngine(cfg engine.Config, rs resource.Resource, pe *persist.Persister) engine.Engine
 	Process(rs RequestSession) (RequestSession, error)
 	Output(rs RequestSession) (RequestSession, error)
 	Reset(rs RequestSession) (RequestSession, error)

internal/handlers/ussd/menuhandler_test.go

@@ -5,15 +5,18 @@ import (
 	"fmt"
 	"log"
 	"path"
+	"strings"
 	"testing"
 
+	"git.defalsify.org/vise.git/cache"
 	"git.defalsify.org/vise.git/lang"
 	"git.defalsify.org/vise.git/persist"
 	"git.defalsify.org/vise.git/resource"
 	"git.defalsify.org/vise.git/state"
-	"git.grassecon.net/urdt/ussd/internal/storage"
+	dbstorage "git.grassecon.net/urdt/ussd/internal/storage/db"
 	"git.grassecon.net/urdt/ussd/internal/testutil/mocks"
 	"git.grassecon.net/urdt/ussd/internal/testutil/testservice"
+	"git.grassecon.net/urdt/ussd/internal/utils"
 	"git.grassecon.net/urdt/ussd/models"
 
 	"git.grassecon.net/urdt/ussd/common"
@@ -22,6 +25,7 @@ import (
 	testdataloader "github.com/peteole/testdata-loader"
 	"github.com/stretchr/testify/require"
 
+	visedb "git.defalsify.org/vise.git/db"
 	memdb "git.defalsify.org/vise.git/db/mem"
 	dataserviceapi "github.com/grassrootseconomics/ussd-data-service/pkg/api"
 )
@@ -31,6 +35,11 @@ var (
 	flagsPath = path.Join(baseDir, "services", "registration", "pp.csv")
 )
 
+// mockReplaceSeparator function
+var mockReplaceSeparator = func(input string) string {
+	return strings.ReplaceAll(input, ":", ": ")
+}
+
 // InitializeTestStore sets up and returns an in-memory database and store.
 func InitializeTestStore(t *testing.T) (context.Context, *common.UserDataStore) {
 	ctx := context.Background()
@@ -50,13 +59,14 @@ func InitializeTestStore(t *testing.T) (context.Context, *common.UserDataStore)
 	return ctx, store
 }
 
-func InitializeTestSubPrefixDb(t *testing.T, ctx context.Context) *storage.SubPrefixDb {
+func InitializeTestSubPrefixDb(t *testing.T, ctx context.Context) *dbstorage.SubPrefixDb {
 	db := memdb.NewMemDb()
 	err := db.Connect(ctx, "")
 	if err != nil {
 		t.Fatal(err)
 	}
-	spdb := storage.NewSubPrefixDb(db, []byte("vouchers"))
+	prefix := common.ToBytes(visedb.DATATYPE_USERDATA)
+	spdb := dbstorage.NewSubPrefixDb(db, prefix)
 
 	return spdb
 }
@@ -65,12 +75,15 @@ func TestNewHandlers(t *testing.T) {
 	_, store := InitializeTestStore(t)
 
 	fm, err := NewFlagManager(flagsPath)
-	accountService := testservice.TestAccountService{}
 	if err != nil {
-		t.Logf(err.Error())
+		log.Fatal(err)
 	}
+
+	accountService := testservice.TestAccountService{}
+
+	// Test case for valid UserDataStore
 	t.Run("Valid UserDataStore", func(t *testing.T) {
-		handlers, err := NewHandlers(fm.parser, store, nil, &accountService)
+		handlers, err := NewHandlers(fm.parser, store, nil, &accountService, mockReplaceSeparator)
 		if err != nil {
 			t.Fatalf("expected no error, got %v", err)
 		}
@@ -80,23 +93,130 @@ func TestNewHandlers(t *testing.T) {
 		if handlers.userdataStore == nil {
 			t.Fatal("expected userdataStore to be set in handlers")
 		}
+		if handlers.ReplaceSeparatorFunc == nil {
+			t.Fatal("expected ReplaceSeparatorFunc to be set in handlers")
+		}
+
+		// Test ReplaceSeparatorFunc functionality
+		input := "1:Menu item"
+		expectedOutput := "1: Menu item"
+		if handlers.ReplaceSeparatorFunc(input) != expectedOutput {
+			t.Fatalf("ReplaceSeparatorFunc function did not return expected output: got %v, want %v", handlers.ReplaceSeparatorFunc(input), expectedOutput)
+		}
 	})
 
-	// Test case for nil userdataStore
+	// Test case for nil UserDataStore
 	t.Run("Nil UserDataStore", func(t *testing.T) {
-		handlers, err := NewHandlers(fm.parser, nil, nil, &accountService)
+		handlers, err := NewHandlers(fm.parser, nil, nil, &accountService, mockReplaceSeparator)
 		if err == nil {
 			t.Fatal("expected an error, got none")
 		}
 		if handlers != nil {
 			t.Fatal("expected handlers to be nil")
 		}
-		if err.Error() != "cannot create handler with nil userdata store" {
+		expectedError := "cannot create handler with nil userdata store"
-			t.Fatalf("expected specific error, got %v", err)
+		if err.Error() != expectedError {
+			t.Fatalf("expected error '%s', got '%v'", expectedError, err)
 		}
 	})
 }
 
+func TestInit(t *testing.T) {
+	sessionId := "session123"
+	ctx, store := InitializeTestStore(t)
+	ctx = context.WithValue(ctx, "SessionId", sessionId)
+
+	fm, err := NewFlagManager(flagsPath)
+	if err != nil {
+		t.Fatal(err.Error())
+	}
+
+	adminstore, err := utils.NewAdminStore(ctx, "admin_numbers")
+	if err != nil {
+		t.Fatal(err.Error())
+	}
+
+	st := state.NewState(128)
+	ca := cache.NewCache()
+
+	flag_admin_privilege, _ := fm.GetFlag("flag_admin_privilege")
+
+	tests := []struct {
+		name           string
+		setup          func() (*Handlers, context.Context)
+		input          []byte
+		expectedResult resource.Result
+	}{
+		{
+			name: "Handler not ready",
+			setup: func() (*Handlers, context.Context) {
+				return &Handlers{}, ctx
+			},
+			input:          []byte("1"),
+			expectedResult: resource.Result{},
+		},
+		{
+			name: "State and memory initialization",
+			setup: func() (*Handlers, context.Context) {
+				pe := persist.NewPersister(store).WithSession(sessionId).WithContent(st, ca)
+				h := &Handlers{
+					flagManager: fm.parser,
+					adminstore:  adminstore,
+					pe:          pe,
+				}
+				return h, context.WithValue(ctx, "SessionId", sessionId)
+			},
+			input: []byte("1"),
+			expectedResult: resource.Result{
+				FlagReset: []uint32{flag_admin_privilege},
+			},
+		},
+		{
+			name: "Non-admin session initialization",
+			setup: func() (*Handlers, context.Context) {
+				pe := persist.NewPersister(store).WithSession("0712345678").WithContent(st, ca)
+				h := &Handlers{
+					flagManager: fm.parser,
+					adminstore:  adminstore,
+					pe:          pe,
+				}
+				return h, context.WithValue(context.Background(), "SessionId", "0712345678")
+			},
+			input: []byte("1"),
+			expectedResult: resource.Result{
+				FlagReset: []uint32{flag_admin_privilege},
+			},
+		},
+		{
+			name: "Move to top node on empty input",
+			setup: func() (*Handlers, context.Context) {
+				pe := persist.NewPersister(store).WithSession(sessionId).WithContent(st, ca)
+				h := &Handlers{
+					flagManager: fm.parser,
+					adminstore:  adminstore,
+					pe:          pe,
+				}
+				st.Code = []byte("some pending bytecode")
+				return h, context.WithValue(ctx, "SessionId", sessionId)
+			},
+			input: []byte(""),
+			expectedResult: resource.Result{
+				FlagReset: []uint32{flag_admin_privilege},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			h, testCtx := tt.setup()
+			res, err := h.Init(testCtx, "", tt.input)
+
+			assert.NoError(t, err, "Unexpected error occurred")
+			assert.Equal(t, res, tt.expectedResult, "Expected result should match actual result")
+		})
+	}
+}
+
 func TestCreateAccount(t *testing.T) {
 	sessionId := "session123"
 	ctx, store := InitializeTestStore(t)
@@ -179,11 +299,14 @@ func TestSaveFirstname(t *testing.T) {
 	fm, _ := NewFlagManager(flagsPath)
 
 	flag_allow_update, _ := fm.GetFlag("flag_allow_update")
+	flag_firstname_set, _ := fm.GetFlag("flag_firstname_set")
 
 	// Set the flag in the State
-	mockState := state.NewState(16)
+	mockState := state.NewState(128)
 	mockState.SetFlag(flag_allow_update)
 
+	expectedResult := resource.Result{}
+
 	// Define test data
 	firstName := "John"
 
@@ -191,6 +314,8 @@ func TestSaveFirstname(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	expectedResult.FlagSet = []uint32{flag_firstname_set}
+
 	// Create the Handlers instance with the mock store
 	h := &Handlers{
 		userdataStore: store,
@@ -203,7 +328,7 @@ func TestSaveFirstname(t *testing.T) {
 
 	// Assert results
 	assert.NoError(t, err)
-	assert.Equal(t, resource.Result{}, res)
+	assert.Equal(t, expectedResult, res)
 
 	// Verify that the DATA_FIRST_NAME entry has been updated with the temporary value
 	storedFirstName, _ := store.ReadEntry(ctx, sessionId, common.DATA_FIRST_NAME)
@@ -218,11 +343,16 @@ func TestSaveFamilyname(t *testing.T) {
 	fm, _ := NewFlagManager(flagsPath)
 
 	flag_allow_update, _ := fm.GetFlag("flag_allow_update")
+	flag_firstname_set, _ := fm.GetFlag("flag_familyname_set")
 
 	// Set the flag in the State
-	mockState := state.NewState(16)
+	mockState := state.NewState(128)
 	mockState.SetFlag(flag_allow_update)
 
+	expectedResult := resource.Result{}
+
+	expectedResult.FlagSet = []uint32{flag_firstname_set}
+
 	// Define test data
 	familyName := "Doeee"
 
@@ -242,7 +372,7 @@ func TestSaveFamilyname(t *testing.T) {
 
 	// Assert results
 	assert.NoError(t, err)
-	assert.Equal(t, resource.Result{}, res)
+	assert.Equal(t, expectedResult, res)
 
 	// Verify that the DATA_FAMILY_NAME entry has been updated with the temporary value
 	storedFamilyName, _ := store.ReadEntry(ctx, sessionId, common.DATA_FAMILY_NAME)
@@ -257,11 +387,14 @@ func TestSaveYoB(t *testing.T) {
 	fm, _ := NewFlagManager(flagsPath)
 
 	flag_allow_update, _ := fm.GetFlag("flag_allow_update")
+	flag_yob_set, _ := fm.GetFlag("flag_yob_set")
 
 	// Set the flag in the State
-	mockState := state.NewState(16)
+	mockState := state.NewState(108)
 	mockState.SetFlag(flag_allow_update)
 
+	expectedResult := resource.Result{}
+
 	// Define test data
 	yob := "1980"
 
@@ -269,6 +402,8 @@ func TestSaveYoB(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	expectedResult.FlagSet = []uint32{flag_yob_set}
+
 	// Create the Handlers instance with the mock store
 	h := &Handlers{
 		userdataStore: store,
@@ -281,7 +416,7 @@ func TestSaveYoB(t *testing.T) {
 
 	// Assert results
 	assert.NoError(t, err)
-	assert.Equal(t, resource.Result{}, res)
+	assert.Equal(t, expectedResult, res)
 
 	// Verify that the DATA_YOB entry has been updated with the temporary value
 	storedYob, _ := store.ReadEntry(ctx, sessionId, common.DATA_YOB)
@@ -296,11 +431,14 @@ func TestSaveLocation(t *testing.T) {
 	fm, _ := NewFlagManager(flagsPath)
 
 	flag_allow_update, _ := fm.GetFlag("flag_allow_update")
+	flag_location_set, _ := fm.GetFlag("flag_location_set")
 
 	// Set the flag in the State
-	mockState := state.NewState(16)
+	mockState := state.NewState(108)
 	mockState.SetFlag(flag_allow_update)
 
+	expectedResult := resource.Result{}
+
 	// Define test data
 	location := "Kilifi"
 
@@ -308,6 +446,8 @@ func TestSaveLocation(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	expectedResult.FlagSet = []uint32{flag_location_set}
+
 	// Create the Handlers instance with the mock store
 	h := &Handlers{
 		userdataStore: store,
@@ -320,7 +460,7 @@ func TestSaveLocation(t *testing.T) {
 
 	// Assert results
 	assert.NoError(t, err)
-	assert.Equal(t, resource.Result{}, res)
+	assert.Equal(t, expectedResult, res)
 
 	// Verify that the DATA_LOCATION entry has been updated with the temporary value
 	storedLocation, _ := store.ReadEntry(ctx, sessionId, common.DATA_LOCATION)
@@ -335,11 +475,14 @@ func TestSaveOfferings(t *testing.T) {
 	fm, _ := NewFlagManager(flagsPath)
 
 	flag_allow_update, _ := fm.GetFlag("flag_allow_update")
+	flag_offerings_set, _ := fm.GetFlag("flag_offerings_set")
 
 	// Set the flag in the State
-	mockState := state.NewState(16)
+	mockState := state.NewState(108)
 	mockState.SetFlag(flag_allow_update)
 
+	expectedResult := resource.Result{}
+
 	// Define test data
 	offerings := "Bananas"
 
@@ -347,6 +490,8 @@ func TestSaveOfferings(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	expectedResult.FlagSet = []uint32{flag_offerings_set}
+
 	// Create the Handlers instance with the mock store
 	h := &Handlers{
 		userdataStore: store,
@@ -359,7 +504,7 @@ func TestSaveOfferings(t *testing.T) {
 
 	// Assert results
 	assert.NoError(t, err)
-	assert.Equal(t, resource.Result{}, res)
+	assert.Equal(t, expectedResult, res)
 
 	// Verify that the DATA_OFFERINGS entry has been updated with the temporary value
 	storedOfferings, _ := store.ReadEntry(ctx, sessionId, common.DATA_OFFERINGS)
@@ -374,9 +519,10 @@ func TestSaveGender(t *testing.T) {
 	fm, _ := NewFlagManager(flagsPath)
 
 	flag_allow_update, _ := fm.GetFlag("flag_allow_update")
+	flag_gender_set, _ := fm.GetFlag("flag_gender_set")
 
 	// Set the flag in the State
-	mockState := state.NewState(16)
+	mockState := state.NewState(108)
 	mockState.SetFlag(flag_allow_update)
 
 	// Define test cases
@@ -420,12 +566,16 @@ func TestSaveGender(t *testing.T) {
 				flagManager:   fm.parser,
 			}
 
+			expectedResult := resource.Result{}
+
 			// Call the method
 			res, err := h.SaveGender(ctx, "save_gender", tt.input)
 
+			expectedResult.FlagSet = []uint32{flag_gender_set}
+
 			// Assert results
 			assert.NoError(t, err)
-			assert.Equal(t, resource.Result{}, res)
+			assert.Equal(t, expectedResult, res)
 
 			// Verify that the DATA_GENDER entry has been updated with the temporary value
 			storedGender, _ := store.ReadEntry(ctx, sessionId, common.DATA_GENDER)
@@ -897,7 +1047,14 @@ func TestAuthorize(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			err = store.WriteEntry(ctx, sessionId, common.DATA_ACCOUNT_PIN, []byte(accountPIN))
+			// Hash the PIN
+			hashedPIN, err := common.HashPIN(accountPIN)
+			if err != nil {
+				logg.ErrorCtxf(ctx, "failed to hash temporaryPin", "error", err)
+				t.Fatal(err)
+			}
+
+			err = store.WriteEntry(ctx, sessionId, common.DATA_ACCOUNT_PIN, []byte(hashedPIN))
 			if err != nil {
 				t.Fatal(err)
 			}
@@ -1349,59 +1506,6 @@ func TestQuit(t *testing.T) {
 	}
 }
 
-func TestIsValidPIN(t *testing.T) {
-	tests := []struct {
-		name     string
-		pin      string
-		expected bool
-	}{
-		{
-			name:     "Valid PIN with 4 digits",
-			pin:      "1234",
-			expected: true,
-		},
-		{
-			name:     "Valid PIN with leading zeros",
-			pin:      "0001",
-			expected: true,
-		},
-		{
-			name:     "Invalid PIN with less than 4 digits",
-			pin:      "123",
-			expected: false,
-		},
-		{
-			name:     "Invalid PIN with more than 4 digits",
-			pin:      "12345",
-			expected: false,
-		},
-		{
-			name:     "Invalid PIN with letters",
-			pin:      "abcd",
-			expected: false,
-		},
-		{
-			name:     "Invalid PIN with special characters",
-			pin:      "12@#",
-			expected: false,
-		},
-		{
-			name:     "Empty PIN",
-			pin:      "",
-			expected: false,
-		},
-	}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			actual := isValidPIN(tt.pin)
-			if actual != tt.expected {
-				t.Errorf("isValidPIN(%q) = %v; expected %v", tt.pin, actual, tt.expected)
-			}
-		})
-	}
-}
-
 func TestValidateAmount(t *testing.T) {
 	fm, err := NewFlagManager(flagsPath)
 	if err != nil {
@@ -1498,10 +1602,10 @@ func TestValidateRecipient(t *testing.T) {
 	}{
 		{
 			name:  "Test with invalid recepient",
-			input: []byte("9234adf5"),
+			input: []byte("7?1234"),
 			expectedResult: resource.Result{
 				FlagSet: []uint32{flag_invalid_recipient},
-				Content: "9234adf5",
+				Content: "7?1234",
 			},
 		},
 		{
@@ -1517,22 +1621,40 @@ func TestValidateRecipient(t *testing.T) {
 			input:          []byte("0711223344"),
 			expectedResult: resource.Result{},
 		},
+		{
+			name:           "Test with address",
+			input:          []byte("0xd4c288865Ce0985a481Eef3be02443dF5E2e4Ea9"),
+			expectedResult: resource.Result{},
+		},
+		{
+			name:           "Test with alias recepient",
+			input:          []byte("alias123"),
+			expectedResult: resource.Result{},
+		},
 	}
 
 	// store a public key for the valid recipient
-	err = store.WriteEntry(ctx, "0711223344", common.DATA_PUBLIC_KEY, []byte(publicKey))
+	err = store.WriteEntry(ctx, "+254711223344", common.DATA_PUBLIC_KEY, []byte(publicKey))
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			mockAccountService := new(mocks.MockAccountService)
 			// Create the Handlers instance
 			h := &Handlers{
-				flagManager:   fm.parser,
+				flagManager:    fm.parser,
-				userdataStore: store,
+				userdataStore:  store,
+				accountService: mockAccountService,
 			}
 
+			aliasResponse := &dataserviceapi.AliasAddress{
+				Address: "0xd4c288865Ce0985a481Eef3be02443dF5E2e4Ea9",
+			}
+
+			mockAccountService.On("CheckAliasAddress", string(tt.input)).Return(aliasResponse, nil)
+
 			// Call the method
 			res, err := h.ValidateRecipient(ctx, "validate_recepient", tt.input)
 
@@ -1564,7 +1686,7 @@ func TestCheckBalance(t *testing.T) {
 			publicKey:      "0X98765432109",
 			activeSym:      "ETH",
 			activeBal:      "1.5",
-			expectedResult: resource.Result{Content: "Balance: 1.5 ETH\n"},
+			expectedResult: resource.Result{Content: "Balance: 1.50 ETH\n"},
 			expectError:    false,
 		},
 	}
@@ -1630,7 +1752,7 @@ func TestGetProfile(t *testing.T) {
 			result: resource.Result{
 				Content: fmt.Sprintf(
 					"Name: %s\nGender: %s\nAge: %s\nLocation: %s\nYou provide: %s\n",
-					"John Doee", "Male", "48", "Kilifi", "Bananas",
+					"John Doee", "Male", "49", "Kilifi", "Bananas",
 				),
 			},
 		},
@@ -1642,7 +1764,7 @@ func TestGetProfile(t *testing.T) {
 			result: resource.Result{
 				Content: fmt.Sprintf(
 					"Jina: %s\nJinsia: %s\nUmri: %s\nEneo: %s\nUnauza: %s\n",
-					"John Doee", "Male", "48", "Kilifi", "Bananas",
+					"John Doee", "Male", "49", "Kilifi", "Bananas",
 				),
 			},
 		},
@@ -1654,7 +1776,7 @@ func TestGetProfile(t *testing.T) {
 			result: resource.Result{
 				Content: fmt.Sprintf(
 					"Name: %s\nGender: %s\nAge: %s\nLocation: %s\nYou provide: %s\n",
-					"John Doee", "Male", "48", "Kilifi", "Bananas",
+					"John Doee", "Male", "49", "Kilifi", "Bananas",
 				),
 			},
 		},
@@ -1919,7 +2041,7 @@ func TestCheckVouchers(t *testing.T) {
 	assert.NoError(t, err)
 
 	// Read voucher sym data from the store
-	voucherData, err := spdb.Get(ctx, []byte("sym"))
+	voucherData, err := spdb.Get(ctx, common.ToBytes(common.DATA_VOUCHER_SYMBOLS))
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -1932,26 +2054,31 @@ func TestCheckVouchers(t *testing.T) {
 
 func TestGetVoucherList(t *testing.T) {
 	sessionId := "session123"
+
 	ctx := context.WithValue(context.Background(), "SessionId", sessionId)
 
 	spdb := InitializeTestSubPrefixDb(t, ctx)
 
+	// Initialize Handlers
 	h := &Handlers{
-		prefixDb: spdb,
+		prefixDb:             spdb,
+		ReplaceSeparatorFunc: mockReplaceSeparator,
 	}
 
-	expectedSym := []byte("1:SRF\n2:MILO")
+	mockSyms := []byte("1:SRF\n2:MILO")
 
 	// Put voucher sym data from the store
-	err := spdb.Put(ctx, []byte("sym"), expectedSym)
+	err := spdb.Put(ctx, common.ToBytes(common.DATA_VOUCHER_SYMBOLS), mockSyms)
 	if err != nil {
 		t.Fatal(err)
 	}
 
+	expectedSyms := []byte("1: SRF\n2: MILO")
+
 	res, err := h.GetVoucherList(ctx, "", []byte(""))
 
 	assert.NoError(t, err)
-	assert.Equal(t, res.Content, string(expectedSym))
+	assert.Equal(t, res.Content, string(expectedSyms))
 }
 
 func TestViewVoucher(t *testing.T) {
@@ -1973,16 +2100,16 @@ func TestViewVoucher(t *testing.T) {
 	}
 
 	// Define mock voucher data
-	mockData := map[string][]byte{
+	mockData := map[common.DataTyp][]byte{
-		"sym":  []byte("1:SRF\n2:MILO"),
+		common.DATA_VOUCHER_SYMBOLS:   []byte("1:SRF\n2:MILO"),
-		"bal":  []byte("1:100\n2:200"),
+		common.DATA_VOUCHER_BALANCES:  []byte("1:100\n2:200"),
-		"deci": []byte("1:6\n2:4"),
+		common.DATA_VOUCHER_DECIMALS:  []byte("1:6\n2:4"),
-		"addr": []byte("1:0xd4c288865Ce\n2:0x41c188d63Qa"),
+		common.DATA_VOUCHER_ADDRESSES: []byte("1:0xd4c288865Ce\n2:0x41c188d63Qa"),
 	}
 
 	// Put the data
 	for key, value := range mockData {
-		err = spdb.Put(ctx, []byte(key), []byte(value))
+		err = spdb.Put(ctx, []byte(common.ToBytes(key)), []byte(value))
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -1990,7 +2117,7 @@ func TestViewVoucher(t *testing.T) {
 
 	res, err := h.ViewVoucher(ctx, "view_voucher", []byte("1"))
 	assert.NoError(t, err)
-	assert.Equal(t, res.Content, "SRF\n100")
+	assert.Equal(t, res.Content, "Symbol: SRF\nBalance: 100")
 }
 
 func TestSetVoucher(t *testing.T) {
@@ -2024,3 +2151,42 @@ func TestSetVoucher(t *testing.T) {
 
 	assert.Equal(t, string(tempData.TokenSymbol), res.Content)
 }
+
+func TestGetVoucherDetails(t *testing.T) {
+	ctx, store := InitializeTestStore(t)
+	fm, err := NewFlagManager(flagsPath)
+	if err != nil {
+		t.Logf(err.Error())
+	}
+	mockAccountService := new(mocks.MockAccountService)
+
+	sessionId := "session123"
+	ctx = context.WithValue(ctx, "SessionId", sessionId)
+	expectedResult := resource.Result{}
+
+	tokA_AAddress := "0x0000000000000000000000000000000000000000"
+
+	h := &Handlers{
+		userdataStore:  store,
+		flagManager:    fm.parser,
+		accountService: mockAccountService,
+	}
+	err = store.WriteEntry(ctx, sessionId, common.DATA_ACTIVE_ADDRESS, []byte(tokA_AAddress))
+	if err != nil {
+		t.Fatal(err)
+	}
+	tokenDetails := &models.VoucherDataResult{
+		TokenName:      "Token A",
+		TokenSymbol:    "TOKA",
+		TokenLocation:  "Kilifi,Kenya",
+		TokenCommodity: "Farming",
+	}
+	expectedResult.Content = fmt.Sprintf(
+		"Name: %s\nSymbol: %s\nCommodity: %s\nLocation: %s", tokenDetails.TokenName, tokenDetails.TokenSymbol, tokenDetails.TokenCommodity, tokenDetails.TokenLocation,
+	)
+	mockAccountService.On("VoucherData", string(tokA_AAddress)).Return(tokenDetails, nil)
+
+	res, err := h.GetVoucherDetails(ctx, "SessionId", []byte(""))
+	assert.NoError(t, err)
+	assert.Equal(t, expectedResult, res)
+}

internal/http/at/parse.go

@@ -0,0 +1,119 @@
+package at
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
+	"net/url"
+	"strings"
+
+	"git.grassecon.net/urdt/ussd/common"
+	"git.grassecon.net/urdt/ussd/internal/handlers"
+)
+
+type ATRequestParser struct {
+}
+
+func (arp *ATRequestParser) GetSessionId(ctx context.Context, rq any) (string, error) {
+	rqv, ok := rq.(*http.Request)
+	if !ok {
+		logg.Warnf("got an invalid request", "req", rq)
+		return "", handlers.ErrInvalidRequest
+	}
+	// Capture body (if any) for logging
+	body, err := io.ReadAll(rqv.Body)
+	if err != nil {
+		logg.Warnf("failed to read request body", "err", err)
+		return "", fmt.Errorf("failed to read request body: %v", err)
+	}
+	// Reset the body for further reading
+	rqv.Body = io.NopCloser(bytes.NewReader(body))
+
+	// Log the body as JSON
+	bodyLog := map[string]string{"body": string(body)}
+	logBytes, err := json.Marshal(bodyLog)
+	if err != nil {
+		logg.Warnf("failed to marshal request body", "err", err)
+	} else {
+		decodedStr := string(logBytes)
+		sessionId, err := extractATSessionId(decodedStr)
+		if err != nil {
+			ctx = context.WithValue(ctx, "AT-SessionId", sessionId)
+		}
+		logg.DebugCtxf(ctx, "Received request:", decodedStr)
+	}
+
+	if err := rqv.ParseForm(); err != nil {
+		logg.Warnf("failed to parse form data", "err", err)
+		return "", fmt.Errorf("failed to parse form data: %v", err)
+	}
+
+	phoneNumber := rqv.FormValue("phoneNumber")
+	if phoneNumber == "" {
+		return "", fmt.Errorf("no phone number found")
+	}
+
+	formattedNumber, err := common.FormatPhoneNumber(phoneNumber)
+	if err != nil {
+		logg.Warnf("failed to format phone number", "err", err)
+		return "", fmt.Errorf("failed to format number")
+	}
+
+	return formattedNumber, nil
+}
+
+func (arp *ATRequestParser) GetInput(rq any) ([]byte, error) {
+	rqv, ok := rq.(*http.Request)
+	if !ok {
+		return nil, handlers.ErrInvalidRequest
+	}
+	if err := rqv.ParseForm(); err != nil {
+		return nil, fmt.Errorf("failed to parse form data: %v", err)
+	}
+
+	text := rqv.FormValue("text")
+
+	parts := strings.Split(text, "*")
+	if len(parts) == 0 {
+		return nil, fmt.Errorf("no input found")
+	}
+
+	return []byte(parts[len(parts)-1]), nil
+}
+
+func parseQueryParams(query string) map[string]string {
+	params := make(map[string]string)
+
+	queryParams := strings.Split(query, "&")
+	for _, param := range queryParams {
+		// Split each key-value pair by '='
+		parts := strings.SplitN(param, "=", 2)
+		if len(parts) == 2 {
+			params[parts[0]] = parts[1]
+		}
+	}
+	return params
+}
+
+func extractATSessionId(decodedStr string) (string, error) {
+	var data map[string]string
+	err := json.Unmarshal([]byte(decodedStr), &data)
+
+	if err != nil {
+		logg.Errorf("Error unmarshalling JSON: %v", err)
+		return "", nil
+	}
+	decodedBody, err := url.QueryUnescape(data["body"])
+	if err != nil {
+		logg.Errorf("Error URL-decoding body: %v", err)
+		return "", nil
+	}
+	params := parseQueryParams(decodedBody)
+
+	sessionId := params["sessionId"]
+	return sessionId, nil
+
+}

internal/http/at/server.go

@@ -1,19 +1,25 @@
-package http
+package at
 
 import (
 	"io"
 	"net/http"
 
+	"git.defalsify.org/vise.git/logging"
 	"git.grassecon.net/urdt/ussd/internal/handlers"
+	httpserver "git.grassecon.net/urdt/ussd/internal/http"
+)
+
+var (
+	logg = logging.NewVanilla().WithDomain("atserver").WithContextKey("SessionId").WithContextKey("AT-SessionId")
 )
 
 type ATSessionHandler struct {
-	*SessionHandler
+	*httpserver.SessionHandler
 }
 
 func NewATSessionHandler(h handlers.RequestHandler) *ATSessionHandler {
 	return &ATSessionHandler{
-		SessionHandler: ToSessionHandler(h),
+		SessionHandler: httpserver.ToSessionHandler(h),
 	}
 }
 
@@ -28,21 +34,21 @@ func (ash *ATSessionHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
 
 	rp := ash.GetRequestParser()
 	cfg := ash.GetConfig()
-	cfg.SessionId, err = rp.GetSessionId(req)
+	cfg.SessionId, err = rp.GetSessionId(req.Context(), req)
 	if err != nil {
 		logg.ErrorCtxf(rqs.Ctx, "", "header processing error", err)
-		ash.writeError(w, 400, err)
+		ash.WriteError(w, 400, err)
 		return
 	}
 	rqs.Config = cfg
 	rqs.Input, err = rp.GetInput(req)
 	if err != nil {
 		logg.ErrorCtxf(rqs.Ctx, "", "header processing error", err)
-		ash.writeError(w, 400, err)
+		ash.WriteError(w, 400, err)
 		return
 	}
 
-	rqs, err = ash.Process(rqs) 
+	rqs, err = ash.Process(rqs)
 	switch err {
 	case nil: // set code to 200 if no err
 		code = 200
@@ -53,7 +59,7 @@ func (ash *ATSessionHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
 	}
 
 	if code != 200 {
-		ash.writeError(w, 500, err)
+		ash.WriteError(w, 500, err)
 		return
 	}
 
@@ -61,13 +67,13 @@ func (ash *ATSessionHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)
 	w.Header().Set("Content-Type", "text/plain")
 	rqs, err = ash.Output(rqs)
 	if err != nil {
-		ash.writeError(w, 500, err)
+		ash.WriteError(w, 500, err)
 		return
 	}
 
 	rqs, err = ash.Reset(rqs)
 	if err != nil {
-		ash.writeError(w, 500, err)
+		ash.WriteError(w, 500, err)
 		return
 	}
 }
@@ -89,4 +95,4 @@ func (ash *ATSessionHandler) Output(rqs handlers.RequestSession) (handlers.Reque
 
 	_, err = rqs.Engine.Flush(rqs.Ctx, rqs.Writer)
 	return rqs, err
-}
+}

internal/http/at/server_test.go

@@ -1,7 +1,6 @@
-package http
+package at
 
 import (
-	"bytes"
 	"context"
 	"errors"
 	"io"
@@ -16,16 +15,6 @@ import (
 	"git.grassecon.net/urdt/ussd/internal/testutil/mocks/httpmocks"
 )
 
-// invalidRequestType is a custom type to test invalid request scenarios
-type invalidRequestType struct{}
-
-// errorReader is a helper type that always returns an error when Read is called
-type errorReader struct{}
-
-func (e *errorReader) Read(p []byte) (n int, err error) {
-	return 0, errors.New("read error")
-}
-
 func TestNewATSessionHandler(t *testing.T) {
 	mockHandler := &httpmocks.MockRequestHandler{}
 	ash := NewATSessionHandler(mockHandler)
@@ -242,208 +231,4 @@ func TestATSessionHandler_Output(t *testing.T) {
 	}
 }
 
-func TestSessionHandler_ServeHTTP(t *testing.T) {
-	tests := []struct {
-		name           string
-		sessionID      string
-		input          []byte
-		parserErr      error
-		processErr     error
-		outputErr      error
-		resetErr       error
-		expectedStatus int
-	}{
-		{
-			name:           "Success",
-			sessionID:      "123",
-			input:          []byte("test input"),
-			expectedStatus: http.StatusOK,
-		},
-		{
-			name:           "Missing Session ID",
-			sessionID:      "",
-			parserErr:      handlers.ErrSessionMissing,
-			expectedStatus: http.StatusBadRequest,
-		},
-		{
-			name:           "Process Error",
-			sessionID:      "123",
-			input:          []byte("test input"),
-			processErr:     handlers.ErrStorage,
-			expectedStatus: http.StatusInternalServerError,
-		},
-		{
-			name:           "Output Error",
-			sessionID:      "123",
-			input:          []byte("test input"),
-			outputErr:      errors.New("output error"),
-			expectedStatus: http.StatusOK,
-		},
-		{
-			name:           "Reset Error",
-			sessionID:      "123",
-			input:          []byte("test input"),
-			resetErr:       errors.New("reset error"),
-			expectedStatus: http.StatusOK,
-		},
-	}
 
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			mockRequestParser := &httpmocks.MockRequestParser{
-				GetSessionIdFunc: func(any) (string, error) {
-					return tt.sessionID, tt.parserErr
-				},
-				GetInputFunc: func(any) ([]byte, error) {
-					return tt.input, nil
-				},
-			}
-
-			mockRequestHandler := &httpmocks.MockRequestHandler{
-				ProcessFunc: func(rs handlers.RequestSession) (handlers.RequestSession, error) {
-					return rs, tt.processErr
-				},
-				OutputFunc: func(rs handlers.RequestSession) (handlers.RequestSession, error) {
-					return rs, tt.outputErr
-				},
-				ResetFunc: func(rs handlers.RequestSession) (handlers.RequestSession, error) {
-					return rs, tt.resetErr
-				},
-				GetRequestParserFunc: func() handlers.RequestParser {
-					return mockRequestParser
-				},
-				GetConfigFunc: func() engine.Config {
-					return engine.Config{}
-				},
-			}
-
-			sessionHandler := ToSessionHandler(mockRequestHandler)
-
-			req := httptest.NewRequest(http.MethodPost, "/", bytes.NewBuffer(tt.input))
-			req.Header.Set("X-Vise-Session", tt.sessionID)
-
-			rr := httptest.NewRecorder()
-
-			sessionHandler.ServeHTTP(rr, req)
-
-			if status := rr.Code; status != tt.expectedStatus {
-				t.Errorf("handler returned wrong status code: got %v want %v",
-					status, tt.expectedStatus)
-			}
-		})
-	}
-}
-
-func TestSessionHandler_writeError(t *testing.T) {
-	handler := &SessionHandler{}
-	mockWriter := &httpmocks.MockWriter{}
-	err := errors.New("test error")
-
-	handler.writeError(mockWriter, http.StatusBadRequest, err)
-
-	if mockWriter.WrittenString != "" {
-		t.Errorf("Expected empty body, got %s", mockWriter.WrittenString)
-	}
-}
-
-func TestDefaultRequestParser_GetSessionId(t *testing.T) {
-	tests := []struct {
-		name          string
-		request       any
-		expectedID    string
-		expectedError error
-	}{
-		{
-			name: "Valid Session ID",
-			request: func() *http.Request {
-				req := httptest.NewRequest(http.MethodPost, "/", nil)
-				req.Header.Set("X-Vise-Session", "123456")
-				return req
-			}(),
-			expectedID:    "123456",
-			expectedError: nil,
-		},
-		{
-			name:          "Missing Session ID",
-			request:       httptest.NewRequest(http.MethodPost, "/", nil),
-			expectedID:    "",
-			expectedError: handlers.ErrSessionMissing,
-		},
-		{
-			name:          "Invalid Request Type",
-			request:       invalidRequestType{},
-			expectedID:    "",
-			expectedError: handlers.ErrInvalidRequest,
-		},
-	}
-
-	parser := &DefaultRequestParser{}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			id, err := parser.GetSessionId(tt.request)
-
-			if id != tt.expectedID {
-				t.Errorf("Expected session ID %s, got %s", tt.expectedID, id)
-			}
-
-			if err != tt.expectedError {
-				t.Errorf("Expected error %v, got %v", tt.expectedError, err)
-			}
-		})
-	}
-}
-
-func TestDefaultRequestParser_GetInput(t *testing.T) {
-	tests := []struct {
-		name          string
-		request       any
-		expectedInput []byte
-		expectedError error
-	}{
-		{
-			name: "Valid Input",
-			request: func() *http.Request {
-				return httptest.NewRequest(http.MethodPost, "/", bytes.NewBufferString("test input"))
-			}(),
-			expectedInput: []byte("test input"),
-			expectedError: nil,
-		},
-		{
-			name:          "Empty Input",
-			request:       httptest.NewRequest(http.MethodPost, "/", nil),
-			expectedInput: []byte{},
-			expectedError: nil,
-		},
-		{
-			name:          "Invalid Request Type",
-			request:       invalidRequestType{},
-			expectedInput: nil,
-			expectedError: handlers.ErrInvalidRequest,
-		},
-		{
-			name: "Read Error",
-			request: func() *http.Request {
-				return httptest.NewRequest(http.MethodPost, "/", &errorReader{})
-			}(),
-			expectedInput: nil,
-			expectedError: errors.New("read error"),
-		},
-	}
-
-	parser := &DefaultRequestParser{}
-
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			input, err := parser.GetInput(tt.request)
-
-			if !bytes.Equal(input, tt.expectedInput) {
-				t.Errorf("Expected input %s, got %s", tt.expectedInput, input)
-			}
-
-			if err != tt.expectedError && (err == nil || err.Error() != tt.expectedError.Error()) {
-				t.Errorf("Expected error %v, got %v", tt.expectedError, err)
-			}
-		})
-	}
-}

internal/http/parse.go

@@ -0,0 +1,37 @@
+package http
+
+import (
+	"context"
+	"io/ioutil"
+	"net/http"
+
+	"git.grassecon.net/urdt/ussd/internal/handlers"
+)
+
+type DefaultRequestParser struct {
+}
+
+func (rp *DefaultRequestParser) GetSessionId(ctx context.Context, rq any) (string, error) {
+	rqv, ok := rq.(*http.Request)
+	if !ok {
+		return "", handlers.ErrInvalidRequest
+	}
+	v := rqv.Header.Get("X-Vise-Session")
+	if v == "" {
+		return "", handlers.ErrSessionMissing
+	}
+	return v, nil
+}
+
+func (rp *DefaultRequestParser) GetInput(rq any) ([]byte, error) {
+	rqv, ok := rq.(*http.Request)
+	if !ok {
+		return nil, handlers.ErrInvalidRequest
+	}
+	defer rqv.Body.Close()
+	v, err := ioutil.ReadAll(rqv.Body)
+	if err != nil {
+		return nil, err
+	}
+	return v, nil
+}

internal/http/server.go

@@ -1,7 +1,6 @@
 package http
 
 import (
-	"io/ioutil"
 	"net/http"
 	"strconv"
 
@@ -14,35 +13,6 @@ var (
 	logg = logging.NewVanilla().WithDomain("httpserver")
 )
 
-type DefaultRequestParser struct {
-}
-
-
-func(rp *DefaultRequestParser) GetSessionId(rq any) (string, error) {
-	rqv, ok := rq.(*http.Request)
-	if !ok {
-		return "", handlers.ErrInvalidRequest
-	}
-	v := rqv.Header.Get("X-Vise-Session")
-	if v == "" {
-		return "", handlers.ErrSessionMissing
-	}
-	return v, nil
-}
-
-func(rp *DefaultRequestParser) GetInput(rq any) ([]byte, error) {
-	rqv, ok := rq.(*http.Request)
-	if !ok {
-		return nil, handlers.ErrInvalidRequest
-	}
-	defer rqv.Body.Close()
-	v, err := ioutil.ReadAll(rqv.Body)
-	if err != nil {
-		return nil, err
-	}
-	return v, nil
-}
-
 type SessionHandler struct {
 	handlers.RequestHandler
 }
@@ -53,40 +23,39 @@ func ToSessionHandler(h handlers.RequestHandler) *SessionHandler {
 	}
 }
 
-func(f *SessionHandler) writeError(w http.ResponseWriter, code int, err error) {
+func (f *SessionHandler) WriteError(w http.ResponseWriter, code int, err error) {
 	s := err.Error()
 	w.Header().Set("Content-Length", strconv.Itoa(len(s)))
 	w.WriteHeader(code)
-	_, err = w.Write([]byte{})
+	_, err = w.Write([]byte(s))
 	if err != nil {
 		logg.Errorf("error writing error!!", "err", err, "olderr", s)
 		w.WriteHeader(500)
 	}
-	return 
 }
 
-func(f *SessionHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
+func (f *SessionHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	var code int
 	var err error
 	var perr error
 
 	rqs := handlers.RequestSession{
-		Ctx: req.Context(),
+		Ctx:    req.Context(),
 		Writer: w,
 	}
 
 	rp := f.GetRequestParser()
 	cfg := f.GetConfig()
-	cfg.SessionId, err = rp.GetSessionId(req)
+	cfg.SessionId, err = rp.GetSessionId(req.Context(), req)
 	if err != nil {
 		logg.ErrorCtxf(rqs.Ctx, "", "header processing error", err)
-		f.writeError(w, 400, err)
+		f.WriteError(w, 400, err)
 	}
 	rqs.Config = cfg
 	rqs.Input, err = rp.GetInput(req)
 	if err != nil {
 		logg.ErrorCtxf(rqs.Ctx, "", "header processing error", err)
-		f.writeError(w, 400, err)
+		f.WriteError(w, 400, err)
 		return
 	}
 
@@ -103,7 +72,7 @@ func(f *SessionHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	}
 
 	if code != 200 {
-		f.writeError(w, 500, err)
+		f.WriteError(w, 500, err)
 		return
 	}
 
@@ -112,11 +81,11 @@ func(f *SessionHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 	rqs, err = f.Output(rqs)
 	rqs, perr = f.Reset(rqs)
 	if err != nil {
-		f.writeError(w, 500, err)
+		f.WriteError(w, 500, err)
 		return
 	}
 	if perr != nil {
-		f.writeError(w, 500, perr)
+		f.WriteError(w, 500, perr)
 		return
 	}
 }

internal/http/server_test.go

@@ -0,0 +1,230 @@
+package http
+
+import (
+	"bytes"
+	"context"
+	"errors"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"git.defalsify.org/vise.git/engine"
+	"git.grassecon.net/urdt/ussd/internal/handlers"
+	"git.grassecon.net/urdt/ussd/internal/testutil/mocks/httpmocks"
+)
+
+// invalidRequestType is a custom type to test invalid request scenarios
+type invalidRequestType struct{}
+
+// errorReader is a helper type that always returns an error when Read is called
+type errorReader struct{}
+
+func (e *errorReader) Read(p []byte) (n int, err error) {
+	return 0, errors.New("read error")
+}
+
+func TestSessionHandler_ServeHTTP(t *testing.T) {
+	tests := []struct {
+		name           string
+		sessionID      string
+		input          []byte
+		parserErr      error
+		processErr     error
+		outputErr      error
+		resetErr       error
+		expectedStatus int
+	}{
+		{
+			name:           "Success",
+			sessionID:      "123",
+			input:          []byte("test input"),
+			expectedStatus: http.StatusOK,
+		},
+		{
+			name:           "Missing Session ID",
+			sessionID:      "",
+			parserErr:      handlers.ErrSessionMissing,
+			expectedStatus: http.StatusBadRequest,
+		},
+		{
+			name:           "Process Error",
+			sessionID:      "123",
+			input:          []byte("test input"),
+			processErr:     handlers.ErrStorage,
+			expectedStatus: http.StatusInternalServerError,
+		},
+		{
+			name:           "Output Error",
+			sessionID:      "123",
+			input:          []byte("test input"),
+			outputErr:      errors.New("output error"),
+			expectedStatus: http.StatusOK,
+		},
+		{
+			name:           "Reset Error",
+			sessionID:      "123",
+			input:          []byte("test input"),
+			resetErr:       errors.New("reset error"),
+			expectedStatus: http.StatusOK,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			mockRequestParser := &httpmocks.MockRequestParser{
+				GetSessionIdFunc: func(any) (string, error) {
+					return tt.sessionID, tt.parserErr
+				},
+				GetInputFunc: func(any) ([]byte, error) {
+					return tt.input, nil
+				},
+			}
+
+			mockRequestHandler := &httpmocks.MockRequestHandler{
+				ProcessFunc: func(rs handlers.RequestSession) (handlers.RequestSession, error) {
+					return rs, tt.processErr
+				},
+				OutputFunc: func(rs handlers.RequestSession) (handlers.RequestSession, error) {
+					return rs, tt.outputErr
+				},
+				ResetFunc: func(rs handlers.RequestSession) (handlers.RequestSession, error) {
+					return rs, tt.resetErr
+				},
+				GetRequestParserFunc: func() handlers.RequestParser {
+					return mockRequestParser
+				},
+				GetConfigFunc: func() engine.Config {
+					return engine.Config{}
+				},
+			}
+
+			sessionHandler := ToSessionHandler(mockRequestHandler)
+
+			req := httptest.NewRequest(http.MethodPost, "/", bytes.NewBuffer(tt.input))
+			req.Header.Set("X-Vise-Session", tt.sessionID)
+
+			rr := httptest.NewRecorder()
+
+			sessionHandler.ServeHTTP(rr, req)
+
+			if status := rr.Code; status != tt.expectedStatus {
+				t.Errorf("handler returned wrong status code: got %v want %v",
+					status, tt.expectedStatus)
+			}
+		})
+	}
+}
+
+func TestSessionHandler_WriteError(t *testing.T) {
+	handler := &SessionHandler{}
+	mockWriter := &httpmocks.MockWriter{}
+	err := errors.New("test error")
+
+	handler.WriteError(mockWriter, http.StatusBadRequest, err)
+
+	if mockWriter.WrittenString != "" {
+		t.Errorf("Expected empty body, got %s", mockWriter.WrittenString)
+	}
+}
+
+func TestDefaultRequestParser_GetSessionId(t *testing.T) {
+	tests := []struct {
+		name          string
+		request       any
+		expectedID    string
+		expectedError error
+	}{
+		{
+			name: "Valid Session ID",
+			request: func() *http.Request {
+				req := httptest.NewRequest(http.MethodPost, "/", nil)
+				req.Header.Set("X-Vise-Session", "123456")
+				return req
+			}(),
+			expectedID:    "123456",
+			expectedError: nil,
+		},
+		{
+			name:          "Missing Session ID",
+			request:       httptest.NewRequest(http.MethodPost, "/", nil),
+			expectedID:    "",
+			expectedError: handlers.ErrSessionMissing,
+		},
+		{
+			name:          "Invalid Request Type",
+			request:       invalidRequestType{},
+			expectedID:    "",
+			expectedError: handlers.ErrInvalidRequest,
+		},
+	}
+
+	parser := &DefaultRequestParser{}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			id, err := parser.GetSessionId(context.Background(),tt.request)
+
+			if id != tt.expectedID {
+				t.Errorf("Expected session ID %s, got %s", tt.expectedID, id)
+			}
+
+			if err != tt.expectedError {
+				t.Errorf("Expected error %v, got %v", tt.expectedError, err)
+			}
+		})
+	}
+}
+
+func TestDefaultRequestParser_GetInput(t *testing.T) {
+	tests := []struct {
+		name          string
+		request       any
+		expectedInput []byte
+		expectedError error
+	}{
+		{
+			name: "Valid Input",
+			request: func() *http.Request {
+				return httptest.NewRequest(http.MethodPost, "/", bytes.NewBufferString("test input"))
+			}(),
+			expectedInput: []byte("test input"),
+			expectedError: nil,
+		},
+		{
+			name:          "Empty Input",
+			request:       httptest.NewRequest(http.MethodPost, "/", nil),
+			expectedInput: []byte{},
+			expectedError: nil,
+		},
+		{
+			name:          "Invalid Request Type",
+			request:       invalidRequestType{},
+			expectedInput: nil,
+			expectedError: handlers.ErrInvalidRequest,
+		},
+		{
+			name: "Read Error",
+			request: func() *http.Request {
+				return httptest.NewRequest(http.MethodPost, "/", &errorReader{})
+			}(),
+			expectedInput: nil,
+			expectedError: errors.New("read error"),
+		},
+	}
+
+	parser := &DefaultRequestParser{}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			input, err := parser.GetInput(tt.request)
+
+			if !bytes.Equal(input, tt.expectedInput) {
+				t.Errorf("Expected input %s, got %s", tt.expectedInput, input)
+			}
+
+			if err != tt.expectedError && (err == nil || err.Error() != tt.expectedError.Error()) {
+				t.Errorf("Expected error %v, got %v", tt.expectedError, err)
+			}
+		})
+	}
+}

internal/ssh/keystore.go

@@ -0,0 +1,65 @@
+package ssh
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"path"
+
+	"golang.org/x/crypto/ssh"
+
+	"git.defalsify.org/vise.git/db"
+
+	"git.grassecon.net/urdt/ussd/internal/storage"
+	dbstorage "git.grassecon.net/urdt/ussd/internal/storage/db/gdbm"
+)
+
+type SshKeyStore struct {
+	store db.Db
+}
+
+func NewSshKeyStore(ctx context.Context, dbDir string) (*SshKeyStore, error) {
+	keyStore := &SshKeyStore{}
+	keyStoreFile := path.Join(dbDir, "ssh_authorized_keys.gdbm")
+	keyStore.store = dbstorage.NewThreadGdbmDb()
+	err := keyStore.store.Connect(ctx, keyStoreFile)
+	if err != nil {
+		return nil, err
+	}
+	return keyStore, nil
+}
+
+func(s *SshKeyStore) AddFromFile(ctx context.Context, fp string, sessionId string) error {
+	_, err := os.Stat(fp)
+	if err != nil {
+		return fmt.Errorf("cannot open ssh server public key file: %v\n", err)
+	}
+
+	publicBytes, err := os.ReadFile(fp)
+	if err != nil {
+		return fmt.Errorf("Failed to load public key: %v", err)
+	}
+	pubKey, _, _, _, err := ssh.ParseAuthorizedKey(publicBytes)
+	if err != nil {
+		return fmt.Errorf("Failed to parse public key: %v", err)
+	}
+	k := append([]byte{0x01}, pubKey.Marshal()...)
+	s.store.SetPrefix(storage.DATATYPE_EXTEND)
+	logg.Infof("Added key", "sessionId", sessionId, "public key", string(publicBytes))
+	return s.store.Put(ctx, k, []byte(sessionId))
+}
+
+func(s *SshKeyStore) Get(ctx context.Context, pubKey ssh.PublicKey) (string, error) {
+	s.store.SetLanguage(nil)
+	s.store.SetPrefix(storage.DATATYPE_EXTEND)
+	k := append([]byte{0x01}, pubKey.Marshal()...)
+	v, err := s.store.Get(ctx, k)
+	if err != nil {
+		return "", err
+	}
+	return string(v), nil
+}
+
+func(s *SshKeyStore) Close() error {
+	return s.store.Close()
+}

internal/ssh/ssh.go

@@ -0,0 +1,287 @@
+package ssh
+
+import (
+	"context"
+	"encoding/hex"
+	"encoding/base64"
+	"errors"
+	"fmt"
+	"net"
+	"os"
+	"sync"
+
+	"golang.org/x/crypto/ssh"
+
+	"git.defalsify.org/vise.git/engine"
+	"git.defalsify.org/vise.git/logging"
+	"git.defalsify.org/vise.git/resource"
+	"git.defalsify.org/vise.git/state"
+
+	"git.grassecon.net/urdt/ussd/internal/handlers"
+	"git.grassecon.net/urdt/ussd/internal/storage"
+	"git.grassecon.net/urdt/ussd/remote"
+)
+
+var (
+	logg = logging.NewVanilla().WithDomain("ssh")
+)
+
+type auther struct {
+	Ctx context.Context
+	keyStore *SshKeyStore
+	auth map[string]string
+}
+
+func NewAuther(ctx context.Context, keyStore *SshKeyStore) *auther {
+	return &auther{
+		Ctx: ctx,
+		keyStore: keyStore,
+		auth: make(map[string]string),
+	}
+}
+
+func(a *auther) Check(conn ssh.ConnMetadata, pubKey ssh.PublicKey) (*ssh.Permissions, error) {
+	va, err := a.keyStore.Get(a.Ctx, pubKey)
+	if err != nil {
+		return nil, err
+	}
+	ka := hex.EncodeToString(conn.SessionID())
+	a.auth[ka] = va 
+	fmt.Fprintf(os.Stderr, "connect: %s -> %s\n", ka, va)
+	return nil, nil
+}
+
+func(a *auther) FromConn(c *ssh.ServerConn) (string, error) {
+	if c == nil {
+		return "", errors.New("nil server conn")
+	}
+	if c.Conn == nil {
+		return "", errors.New("nil underlying conn")
+	}
+	return a.Get(c.Conn.SessionID())
+}
+
+
+func(a *auther) Get(k []byte) (string, error) {
+	ka := hex.EncodeToString(k)
+	v, ok := a.auth[ka]
+	if !ok {
+		return "", errors.New("not found")
+	}
+	return v, nil
+}
+
+func(s *SshRunner) serve(ctx context.Context, sessionId string, ch ssh.NewChannel, en engine.Engine) error {
+	if ch == nil {
+		return errors.New("nil channel")
+	}
+	if ch.ChannelType() != "session" {
+		ch.Reject(ssh.UnknownChannelType, "that is not the channel you are looking for")
+		return errors.New("not a session")
+	}
+	channel, requests, err := ch.Accept()
+	if err != nil {
+		panic(err)
+	}
+	defer channel.Close()
+	s.wg.Add(1)
+	go func(reqIn <-chan *ssh.Request) {
+		defer s.wg.Done()
+		for req := range reqIn {
+			req.Reply(req.Type == "shell", nil)	
+		}
+		_ = requests
+	}(requests)
+
+	cont, err := en.Exec(ctx, []byte{})
+	if err != nil {
+		return fmt.Errorf("initial engine exec err: %v", err)
+	}
+
+	var input [state.INPUT_LIMIT]byte
+	for cont {
+		c, err := en.Flush(ctx, channel)
+		if err != nil {
+			return fmt.Errorf("flush err: %v", err)
+		}
+		_, err = channel.Write([]byte{0x0a})
+		if err != nil {
+			return fmt.Errorf("newline err: %v", err)
+		}
+		c, err = channel.Read(input[:])
+		if err != nil {
+			return fmt.Errorf("read input fail: %v", err)
+		}
+		logg.TraceCtxf(ctx, "input read", "c", c, "input", input[:c-1])
+		cont, err = en.Exec(ctx, input[:c-1])
+		if err != nil {
+			return fmt.Errorf("engine exec err: %v", err)
+		}
+		logg.TraceCtxf(ctx, "exec cont", "cont", cont, "en", en)
+		_ = c
+	}
+	c, err := en.Flush(ctx, channel)
+	if err != nil {
+		return fmt.Errorf("last flush err: %v", err)
+	}
+	_ = c
+	return nil
+}
+
+type SshRunner struct {
+	Ctx context.Context
+	Cfg engine.Config
+	FlagFile string
+	DbDir string
+	ResourceDir string
+	Debug bool
+	SrvKeyFile string
+	Host string
+	Port uint
+	wg sync.WaitGroup
+	lst net.Listener
+}
+
+func(s *SshRunner) Stop() error {
+	return s.lst.Close()
+}
+
+func(s *SshRunner) GetEngine(sessionId string) (engine.Engine, func(), error) {
+	ctx := s.Ctx
+	menuStorageService := storage.NewMenuStorageService(s.DbDir, s.ResourceDir)
+
+	err := menuStorageService.EnsureDbDir()
+	if err != nil {
+		return nil, nil, err
+	}
+
+	rs, err := menuStorageService.GetResource(ctx)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	pe, err := menuStorageService.GetPersister(ctx)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	userdatastore, err := menuStorageService.GetUserdataDb(ctx)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	dbResource, ok := rs.(*resource.DbResource)
+	if !ok {
+		return nil, nil, err
+	}
+
+	lhs, err := handlers.NewLocalHandlerService(ctx, s.FlagFile, true, dbResource, s.Cfg, rs)
+	lhs.SetDataStore(&userdatastore)
+	lhs.SetPersister(pe)
+	lhs.Cfg.SessionId = sessionId
+
+	if err != nil {
+		return nil, nil, err
+	}
+
+	// TODO: clear up why pointer here and by-value other cmds
+	accountService := &remote.AccountService{}
+	hl, err := lhs.GetHandler(accountService)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	en := lhs.GetEngine()
+	en = en.WithFirst(hl.Init)
+	if s.Debug {
+		en = en.WithDebug(nil)
+	}
+	// TODO: this is getting very hacky!
+	closer := func() {
+		err := menuStorageService.Close()
+		if err != nil {
+			logg.ErrorCtxf(ctx, "menu storage service cleanup fail", "err", err)
+		}
+	}
+	return en, closer, nil
+}
+
+// adapted example from crypto/ssh package, NewServerConn doc
+func(s *SshRunner) Run(ctx context.Context, keyStore *SshKeyStore) {
+	running := true
+
+	// TODO: waitgroup should probably not be global
+	defer s.wg.Wait()
+
+	auth := NewAuther(ctx, keyStore)
+	cfg := ssh.ServerConfig{
+		PublicKeyCallback: auth.Check,
+	}
+
+	privateBytes, err := os.ReadFile(s.SrvKeyFile)
+	if err != nil {
+		logg.ErrorCtxf(ctx, "Failed to load private key", "err", err)
+	}
+	private, err := ssh.ParsePrivateKey(privateBytes)
+	if err != nil {
+		logg.ErrorCtxf(ctx, "Failed to parse private key", "err", err)
+	}
+	srvPub := private.PublicKey()
+	srvPubStr := base64.StdEncoding.EncodeToString(srvPub.Marshal())
+	logg.InfoCtxf(ctx, "have server key", "type", srvPub.Type(), "public", srvPubStr)
+	cfg.AddHostKey(private)
+
+	s.lst, err = net.Listen("tcp", fmt.Sprintf("%s:%d", s.Host, s.Port))
+	if err != nil {
+		panic(err)
+	}
+
+	for running {
+		conn, err := s.lst.Accept()
+		if err != nil {
+			logg.ErrorCtxf(ctx, "ssh accept error", "err", err)
+			running = false
+			continue
+		}
+
+		go func(conn net.Conn) {
+			defer conn.Close()
+			for true {
+				srvConn, nC, rC, err := ssh.NewServerConn(conn, &cfg)
+				if err != nil {
+					logg.InfoCtxf(ctx, "rejected client", "err", err)
+					return
+				}
+				logg.DebugCtxf(ctx, "ssh client connected", "conn", srvConn)
+
+				s.wg.Add(1)
+				go func() {
+					ssh.DiscardRequests(rC)
+					s.wg.Done()
+				}()
+				
+				sessionId, err := auth.FromConn(srvConn)
+				if err != nil {
+					logg.ErrorCtxf(ctx, "Cannot find authentication")
+					return
+				}
+				en, closer, err := s.GetEngine(sessionId)
+				if err != nil {
+					logg.ErrorCtxf(ctx, "engine won't start", "err", err)
+					return
+				}
+				defer func() {
+					err := en.Finish()
+					if err != nil {
+						logg.ErrorCtxf(ctx, "engine won't stop", "err", err)
+					}
+					closer()
+				}()
+				for ch := range nC {
+					err = s.serve(ctx, sessionId, ch, en)
+					logg.ErrorCtxf(ctx, "ssh server finish", "err", err)
+				}
+			}
+		}(conn)
+	}
+}

internal/storage/db/gdbm/gdbm.go

@@ -6,6 +6,11 @@ import (
 	"git.defalsify.org/vise.git/db"
 	gdbmdb "git.defalsify.org/vise.git/db/gdbm"
 	"git.defalsify.org/vise.git/lang"
+	"git.defalsify.org/vise.git/logging"
+)
+
+var (
+	logg = logging.NewVanilla().WithDomain("gdbmstorage")
 )
 
 var (
@@ -115,7 +120,8 @@ func(tdb *ThreadGdbmDb) Close() error {
 	return err
 }
 
-func(tdb *ThreadGdbmDb) Dump(_ context.Context, _ []byte) (*db.Dumper, error) {
+func(tdb *ThreadGdbmDb) Dump(ctx context.Context, key []byte) (*db.Dumper, error) {
-	logg.Warnf("method not implemented for thread gdbm db")
+	tdb.reserve()
-	return nil, nil
+	defer tdb.release()
+	return tdb.db.Dump(ctx, key)
 }

internal/storage/db/sub_prefix_db.go

@@ -6,10 +6,6 @@ import (
 	"git.defalsify.org/vise.git/db"
 )
 
-const (
-	DATATYPE_USERSUB = 64
-)
-
 // PrefixDb interface abstracts the database operations.
 type PrefixDb interface {
 	Get(ctx context.Context, key []byte) ([]byte, error)
@@ -35,13 +31,13 @@ func (s *SubPrefixDb) toKey(k []byte) []byte {
 }
 
 func (s *SubPrefixDb) Get(ctx context.Context, key []byte) ([]byte, error) {
-	s.store.SetPrefix(DATATYPE_USERSUB)
+	s.store.SetPrefix(db.DATATYPE_USERDATA)
 	key = s.toKey(key)
 	return s.store.Get(ctx, key)
 }
 
 func (s *SubPrefixDb) Put(ctx context.Context, key []byte, val []byte) error {
-	s.store.SetPrefix(DATATYPE_USERSUB)
+	s.store.SetPrefix(db.DATATYPE_USERDATA)
 	key = s.toKey(key)
 	return s.store.Put(ctx, key, val)
 }

internal/storage/storage.go

@@ -5,6 +5,10 @@ import (
 	"git.defalsify.org/vise.git/persist"
 )
 
+const (
+	DATATYPE_EXTEND = 128
+)
+
 type Storage struct {
 	Persister *persist.Persister
 	UserdataDb db.Db	

internal/storage/storageservice.go

@@ -13,6 +13,7 @@ import (
 	"git.defalsify.org/vise.git/persist"
 	"git.defalsify.org/vise.git/resource"
 	"git.grassecon.net/urdt/ussd/initializers"
+	gdbmstorage "git.grassecon.net/urdt/ussd/internal/storage/db/gdbm"
 )
 
 var (
@@ -75,7 +76,7 @@ func (ms *MenuStorageService) getOrCreateDb(ctx context.Context, existingDb db.D
 		connStr := buildConnStr()
 		err = newDb.Connect(ctx, connStr)
 	} else {
-		newDb = NewThreadGdbmDb()
+		newDb = gdbmstorage.NewThreadGdbmDb()
 		storeFile := path.Join(ms.dbDir, fileName)
 		err = newDb.Connect(ctx, storeFile)
 	}

internal/testutil/mocks/httpmocks/requestparsermock.go

@@ -1,12 +1,14 @@
 package httpmocks
 
+import "context"
+
 // MockRequestParser implements the handlers.RequestParser interface for testing
 type MockRequestParser struct {
 	GetSessionIdFunc func(any) (string, error)
 	GetInputFunc     func(any) ([]byte, error)
 }
 
-func (m *MockRequestParser) GetSessionId(rq any) (string, error) {
+func (m *MockRequestParser) GetSessionId(ctx context.Context, rq any) (string, error) {
 	return m.GetSessionIdFunc(rq)
 }
 

internal/testutil/mocks/servicemock.go

@@ -49,6 +49,6 @@ func (m *MockAccountService) TokenTransfer(ctx context.Context, amount, from, to
 }
 
 func (m *MockAccountService) CheckAliasAddress(ctx context.Context, alias string) (*dataserviceapi.AliasAddress, error) {
-	args := m.Called()
+	args := m.Called(alias)
 	return args.Get(0).(*dataserviceapi.AliasAddress), args.Error(1)
 }

internal/utils/age.go

@@ -1,6 +1,9 @@
 package utils
 
-import "time"
+import (
+	"strconv"
+	"time"
+)
 
 // CalculateAge calculates the age based on a given birthdate and the current date in the format dd/mm/yy
 // It adjusts for cases where the current date is before the birthday in the current year.
@@ -25,11 +28,29 @@ func CalculateAge(birthdate, today time.Time) int {
 // It subtracts the YOB from the current year to determine the age.
 //
 // Parameters:
-//   yob: The year of birth as an integer.
+//
+//	yob: The year of birth as an integer.
 //
 // Returns:
-//   The calculated age as an integer.
+//
+//	The calculated age as an integer.
 func CalculateAgeWithYOB(yob int) int {
-    currentYear := time.Now().Year()
+	currentYear := time.Now().Year()
-    return currentYear - yob
+	return currentYear - yob
-}
+}
+
+
+//IsValidYob checks if the provided yob can be considered valid 
+func IsValidYOb(yob string) bool {
+	currentYear := time.Now().Year()
+	yearOfBirth, err := strconv.ParseInt(yob, 10, 64)
+	if err != nil {
+		return false
+	}
+	if yearOfBirth >= 1900 && int(yearOfBirth) <= currentYear {
+		return true
+	} else {
+		return false
+	}
+
+}

internal/utils/isocode.go

@@ -1,9 +1,9 @@
 package utils
 
 var isoCodes = map[string]bool{
-	"eng": true, // English
+	"eng":     true, // English
-	"swa": true, // Swahili
+	"swa":     true, // Swahili
-
+	"default": true, // Default language: English
 }
 
 func IsValidISO639(code string) bool {

internal/utils/name.go

@@ -0,0 +1,17 @@
+package utils
+
+func ConstructName(firstName, familyName, defaultValue string) string {
+	name := defaultValue
+	if familyName != defaultValue {
+		if firstName != defaultValue {
+			name = firstName + " " + familyName
+		} else {
+			name = familyName
+		}
+	} else {
+		if firstName != defaultValue {
+			name = firstName
+		}
+	}
+	return name
+}

menutraversal_test/group_test.json

@@ -54,7 +54,7 @@
                 },
                 {
                     "input": "1235",
-                    "expectedContent": "Incorrect pin\n1:Retry\n9:Quit"
+                    "expectedContent": "Incorrect PIN\n1:Retry\n9:Quit"
                 },
                 {
                     "input": "1",
@@ -62,10 +62,10 @@
                 },
                 {
                     "input": "1234",
-                    "expectedContent": "Select language:\n0:english\n1:kiswahili"
+                    "expectedContent": "Select language:\n1:English\n2:Kiswahili"
                 },
                 {
-                    "input": "0",
+                    "input": "1",
                     "expectedContent": "Your language change request was successful.\n0:Back\n9:Quit"
                 },
                 {
@@ -95,7 +95,7 @@
                 },
                 {
                     "input": "1235",
-                    "expectedContent": "Incorrect pin\n1:Retry\n9:Quit"
+                    "expectedContent": "Incorrect PIN\n1:Retry\n9:Quit"
                 },
                 {
                     "input": "1",
@@ -141,7 +141,7 @@
                 },
                 {
                     "input": "1235",
-                    "expectedContent": "Incorrect pin\n1:Retry\n9:Quit"
+                    "expectedContent": "Incorrect PIN\n1:Retry\n9:Quit"
                 },
                 {
                     "input": "1",
@@ -167,7 +167,7 @@
             ]
         },
         {
-            "name": "menu_my_account_edit_firstname",
+            "name": "menu_my_account_edit_all_account_details_starting_from_firstname",
             "steps": [
                 {
                     "input": "",
@@ -187,6 +187,26 @@
                 },
                 {
                     "input": "foo",
+                    "expectedContent": "Enter family name:\n0:Back"
+                },
+                {
+                    "input": "bar",
+                    "expectedContent": "Select gender: \n1:Male\n2:Female\n3:Unspecified\n0:Back"
+                },
+                {
+                    "input": "1",
+                    "expectedContent":  "Enter your year of birth\n0:Back"
+                },
+                {
+                    "input": "1940",
+                    "expectedContent": "Enter your location:\n0:Back"
+                },
+                {
+                    "input": "Kilifi",
+                    "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                },
+                {
+                    "input": "Bananas",
                     "expectedContent": "Please enter your PIN:"
                 },
                 {
@@ -197,10 +217,6 @@
                     "input": "0",
                     "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
                 },
-                {
-                    "input": "0",
-                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
-                },
                 {
                     "input": "0",
                     "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
@@ -208,7 +224,7 @@
             ]
         },
         {
-            "name": "menu_my_account_edit_familyname",
+            "name": "menu_my_account_edit_familyname_when_all_account__details_have_been_set",
             "steps": [
                 {
                     "input": "",
@@ -238,10 +254,6 @@
                     "input": "0",
                     "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
                 },
-                {
-                    "input": "0",
-                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
-                },
                 {
                     "input": "0",
                     "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
@@ -250,7 +262,7 @@
             ]
         },
         {
-            "name": "menu_my_account_edit_gender",
+            "name": "menu_my_account_edit_gender_when_all_account__details_have_been_set",
             "steps": [
                 {
                     "input": "",
@@ -280,10 +292,6 @@
                     "input": "0",
                     "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
                 },
-                {
-                    "input": "0",
-                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
-                },
                 {
                     "input": "0",
                     "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
@@ -291,7 +299,7 @@
             ]
         },
         {
-            "name": "menu_my_account_edit_yob",
+            "name": "menu_my_account_edit_yob_when_all_account__details_have_been_set",
             "steps": [
                 {
                     "input": "",
@@ -321,10 +329,6 @@
                     "input": "0",
                     "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
                 },
-                {
-                    "input": "0",
-                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
-                },
                 {
                     "input": "0",
                     "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
@@ -332,7 +336,7 @@
             ]
         },
         {
-            "name": "menu_my_account_edit_location",
+            "name": "menu_my_account_edit_location_when_all_account_details_have_been_set",
             "steps": [
                 {
                     "input": "",
@@ -362,10 +366,6 @@
                     "input": "0",
                     "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
                 },
-                {
-                    "input": "0",
-                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
-                },
                 {
                     "input": "0",
                     "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
@@ -373,7 +373,7 @@
             ]
         },
         {
-            "name": "menu_my_account_edit_offerings",
+            "name": "menu_my_account_edit_offerings_when_all_account__details_have_been_set",
             "steps": [
                 {
                     "input": "",
@@ -403,10 +403,6 @@
                     "input": "0",
                     "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
                 },
-                {
-                    "input": "0",
-                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
-                },
                 {
                     "input": "0",
                     "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
@@ -434,16 +430,12 @@
                 },
                 {
                     "input": "1234",
-                    "expectedContent": "My profile:\nName: foo bar\nGender: male\nAge: 79\nLocation: Kilifi\nYou provide: Bananas\n\n0:Back"
+                    "expectedContent": "My profile:\nName: foo bar\nGender: male\nAge: 80\nLocation: Kilifi\nYou provide: Bananas\n\n0:Back\n9:Quit"
                 },
                 {
                     "input": "0",
                     "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
                 },
-                {
-                    "input": "0",
-                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
-                },
                 {
                     "input": "0",
                     "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"

menutraversal_test/menu_traversal_test.go

@@ -3,6 +3,7 @@ package menutraversaltest
 import (
 	"bytes"
 	"context"
+	"flag"
 	"log"
 	"math/rand"
 	"os"
@@ -15,14 +16,15 @@ import (
 )
 
 var (
-	testData      = driver.ReadData()
+	testData  = driver.ReadData()
-	testStore     = ".test_state"
+	testStore = ".test_state"
-	groupTestFile = "group_test.json"
+	sessionID string
-	sessionID     string
+	src       = rand.NewSource(42)
-	src           = rand.NewSource(42)
+	g         = rand.New(src)
-	g             = rand.New(src)
 )
 
+var groupTestFile = flag.String("test-file", "group_test.json", "The test file to use for running the group tests")
+
 func GenerateSessionId() string {
 	uu := uuid.NewGenWithOptions(uuid.WithRandomReader(g))
 	v, err := uu.NewV4()
@@ -296,9 +298,10 @@ func TestMainMenuSend(t *testing.T) {
 	ctx := context.Background()
 	sessions := testData
 	for _, session := range sessions {
-		groups := driver.FilterGroupsByName(session.Groups, "send_with_invalid_inputs")
+		groups := driver.FilterGroupsByName(session.Groups, "send_with_invite")
 		for _, group := range groups {
-			for _, step := range group.Steps {
+			for index, step := range group.Steps {
+				t.Logf("step %v with input %v", index, step.Input)
 				cont, err := en.Exec(ctx, []byte(step.Input))
 				if err != nil {
 					t.Fatalf("Test case '%s' failed at input '%s': %v", group.Name, step.Input, err)
@@ -337,7 +340,7 @@ func TestMainMenuSend(t *testing.T) {
 }
 
 func TestGroups(t *testing.T) {
-	groups, err := driver.LoadTestGroups(groupTestFile)
+	groups, err := driver.LoadTestGroups(*groupTestFile)
 	if err != nil {
 		log.Fatalf("Failed to load test groups: %v", err)
 	}

menutraversal_test/profile_edit_start_familyname.json

@@ -0,0 +1,68 @@
+{
+    "groups": [
+        { 
+                "name": "menu_my_account_edit_all_account_details_starting_from_family_name",
+                "steps": [
+                    {
+                        "input": "",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "2",
+                        "expectedContent": "Enter family name:\n0:Back"
+                    },
+                    {
+                        "input": "bar",
+                        "expectedContent": "Select gender: \n1:Male\n2:Female\n3:Unspecified\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent":  "Enter your year of birth\n0:Back"
+                    },
+                    {
+                        "input": "1940",
+                        "expectedContent": "Enter your location:\n0:Back"
+                    },
+                    {
+                        "input": "Kilifi",
+                        "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                    },
+                    {
+                        "input": "Bananas",
+                        "expectedContent": "Please enter your PIN:"
+                    },
+                    {
+                        "input": "1234",
+                        "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    }
+                ]
+            }
+    ]
+}
+      
+        
+       
+        
+    
+
+
+    
+
+
+    

menutraversal_test/profile_edit_start_firstname.json

@@ -0,0 +1,61 @@
+{
+    "groups": [
+        { 
+            "name": "menu_my_account_edit_all_account_details_starting_from_firstname",
+            "steps": [
+                {
+                    "input": "",
+                    "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                },
+                {
+                    "input": "3",
+                    "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
+                },
+                {
+                    "input": "1",
+                    "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                },
+                {
+                    "input": "1",
+                    "expectedContent": "Enter your first names:\n0:Back"
+                },
+                {
+                    "input": "foo",
+                    "expectedContent": "Enter family name:\n0:Back"
+                },
+                {
+                    "input": "bar",
+                    "expectedContent": "Select gender: \n1:Male\n2:Female\n3:Unspecified\n0:Back"
+                },
+                {
+                    "input": "1",
+                    "expectedContent":  "Enter your year of birth\n0:Back"
+                },
+                {
+                    "input": "1940",
+                    "expectedContent": "Enter your location:\n0:Back"
+                },
+                {
+                    "input": "Kilifi",
+                    "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                },
+                {
+                    "input": "Bananas",
+                    "expectedContent": "Please enter your PIN:"
+                },
+                {
+                    "input": "1234",
+                    "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                },
+                {
+                    "input": "0",
+                    "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                },
+                {
+                    "input": "0",
+                    "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                }
+            ]
+        }
+    ]
+}

menutraversal_test/profile_edit_start_gender.json

@@ -0,0 +1,55 @@
+{
+    "groups": [
+        { 
+                "name": "menu_my_account_edit_all_account_details_starting_from_gender",
+                "steps": [
+                    {
+                        "input": "",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "Select gender: \n1:Male\n2:Female\n3:Unspecified\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent":  "Enter your year of birth\n0:Back"
+                    },
+                    {
+                        "input": "1940",
+                        "expectedContent": "Enter your location:\n0:Back"
+                    },
+                    {
+                        "input": "Kilifi",
+                        "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                    },
+                    {
+                        "input": "Bananas",
+                        "expectedContent": "Please enter your PIN:"
+                    },
+                    {
+                        "input": "1234",
+                        "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    }
+                ]
+            }
+    ]
+}
+      
+      

menutraversal_test/profile_edit_start_location.json

@@ -0,0 +1,46 @@
+{
+    "groups": [
+        { 
+                "name": "menu_my_account_edit_all_account_details_starting_from_location",
+                "steps": [
+                    {
+                        "input": "",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },  
+                    {
+                        "input": "5",
+                        "expectedContent": "Enter your location:\n0:Back"
+                    },
+                    {
+                        "input": "Kilifi",
+                        "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                    },
+                    {
+                        "input": "Bananas",
+                        "expectedContent": "Please enter your PIN:"
+                    },
+                    {
+                        "input": "1234",
+                        "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    }
+                ]
+            }
+    ]
+}
+     

menutraversal_test/profile_edit_start_offerings.json

@@ -0,0 +1,42 @@
+{
+    "groups": [
+        { 
+                "name": "menu_my_account_edit_all_account_details_starting_from_offerings",
+                "steps": [
+                    {
+                        "input": "",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "6",
+                        "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                    },
+                    {
+                        "input": "Bananas",
+                        "expectedContent": "Please enter your PIN:"
+                    },
+                    {
+                        "input": "1234",
+                        "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    }
+                ]
+            }
+    ]
+}
+     

menutraversal_test/profile_edit_start_yob.json

@@ -0,0 +1,50 @@
+{
+    "groups": [
+        { 
+                "name": "menu_my_account_edit_all_account_details_starting_from_yob",
+                "steps": [
+                    {
+                        "input": "",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "4",
+                        "expectedContent":  "Enter your year of birth\n0:Back"
+                    },
+                    {
+                        "input": "1940",
+                        "expectedContent": "Enter your location:\n0:Back"
+                    },
+                    {
+                        "input": "Kilifi",
+                        "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                    },
+                    {
+                        "input": "Bananas",
+                        "expectedContent": "Please enter your PIN:"
+                    },
+                    {
+                        "input": "1234",
+                        "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    }
+                ]
+            }
+    ]
+}
+     

menutraversal_test/profile_edit_when_adjacent_item_set.json

@@ -0,0 +1,70 @@
+{
+    "groups": [
+        { 
+                "name": "menu_my_account_edit_familyname_when_adjacent_profile_information_set",
+                "steps": [
+                    {
+                        "input": "",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "My Account\n1:Profile\n2:Change language\n3:Check balances\n4:Check statement\n5:PIN options\n6:My Address\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "3",
+                        "expectedContent": "Select gender: \n1:Male\n2:Female\n3:Unspecified\n0:Back"
+                    },
+                    {
+                        "input": "1",
+                        "expectedContent":  "Enter your year of birth\n0:Back"
+                    },
+                    {
+                        "input": "1940",
+                        "expectedContent": "Enter your location:\n0:Back"
+                    },
+                    {
+                        "input": "Kilifi",
+                        "expectedContent": "Enter the services or goods you offer: \n0:Back"
+                    },
+                    {
+                        "input": "Bananas",
+                        "expectedContent": "Please enter your PIN:"
+                    },
+                    {
+                        "input": "1234",
+                        "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "2",
+                        "expectedContent": "Enter family name:\n0:Back"
+                    },
+                    {
+                        "input": "foo2",
+                        "expectedContent": "Please enter your PIN:"
+                    },
+                    {
+                        "input": "1234",
+                        "expectedContent": "Profile updated successfully\n\n0:Back\n9:Quit"
+                    },
+                    {
+                       "input": "0",
+                       "expectedContent": "My profile\n1:Edit name\n2:Edit family name\n3:Edit gender\n4:Edit year of birth\n5:Edit location\n6:Edit offerings\n7:View profile\n0:Back"
+                    },
+                    {
+                        "input": "0",
+                        "expectedContent": "{balance}\n\n1:Send\n2:My Vouchers\n3:My Account\n4:Help\n9:Quit"
+                    }
+                ]
+            }
+    ]
+}
+    

menutraversal_test/test_setup.json

@@ -7,14 +7,14 @@
                 "steps": [
                     {
                         "input": "",
-                        "expectedContent": "Welcome to Sarafu Network\nPlease select a language\n0:english\n1:kiswahili"
+                        "expectedContent": "Welcome to Sarafu Network\nPlease select a language\n1:English\n2:Kiswahili"
                     },
                     {
-                        "input": "0",
+                        "input": "1",
-                        "expectedContent": "Do you agree to terms and conditions?\n0:yes\n1:no"
+                        "expectedContent": "Do you agree to terms and conditions?\nhttps://grassecon.org/pages/terms-and-conditions\n\n1:Yes\n2:No"
                     },
                     {
-                        "input": "0",
+                        "input": "1",
                         "expectedContent": "Please enter a new four number PIN for your account:\n0:Exit"
                     },
                     {
@@ -40,14 +40,14 @@
                 "steps": [
                     {
                         "input": "",
-                        "expectedContent": "Welcome to Sarafu Network\nPlease select a language\n0:english\n1:kiswahili"
+                        "expectedContent": "Welcome to Sarafu Network\nPlease select a language\n1:English\n2:Kiswahili"
-                    },
-                    {
-                        "input": "0",
-                        "expectedContent": "Do you agree to terms and conditions?\n0:yes\n1:no"
                     },
                     {
                         "input": "1",
+                        "expectedContent": "Do you agree to terms and conditions?\nhttps://grassecon.org/pages/terms-and-conditions\n\n1:Yes\n2:No"
+                    },
+                    {
+                        "input": "2",
                         "expectedContent": "Thank you for using Sarafu. Goodbye!"
                     }
                 ]
@@ -64,8 +64,8 @@
                         "expectedContent": "Enter recipient's phone number/address/alias:\n0:Back"
                     },
                     {
-                        "input": "000",
+                        "input": "0@0",
-                        "expectedContent": "000 is invalid, please try again:\n1:Retry\n9:Quit"
+                        "expectedContent": "0@0 is invalid, please try again:\n1:Retry\n9:Quit"
                     },
                     {
                         "input": "1",

models/profile.go

@@ -0,0 +1,18 @@
+package models
+
+type Profile struct {
+	ProfileItems []string
+	Max          int
+}
+
+func (p *Profile) InsertOrShift(index int, value string) {
+	if index < len(p.ProfileItems) {
+		p.ProfileItems = append(p.ProfileItems[:index], value)
+	} else {
+		for len(p.ProfileItems) < index {
+			p.ProfileItems = append(p.ProfileItems, "0")
+		}
+		p.ProfileItems = append(p.ProfileItems, "0") 
+		p.ProfileItems[index] = value
+	}
+}

models/voucher_data_result.go

@@ -1,8 +1,10 @@
 package models
 
 type VoucherDataResult struct {
-	TokenName     string `json:"tokenName"`
+	TokenName      string `json:"tokenName"`
-	TokenSymbol   string `json:"tokenSymbol"`
+	TokenSymbol    string `json:"tokenSymbol"`
-	TokenDecimals int    `json:"tokenDecimals"`
+	TokenDecimals  int    `json:"tokenDecimals"`
-	SinkAddress   string `json:"sinkAddress"`
+	SinkAddress    string `json:"sinkAddress"`
+	TokenCommodity string `json:"tokenCommodity"`
+	TokenLocation  string `json:"tokenLocation"`
 }

services/registration/_catch_swa

@@ -0,0 +1 @@
+Tatizo la kimtambo limetokea,tafadhali jaribu tena baadaye.

services/registration/balances.vis

@@ -7,3 +7,4 @@ HALT
 INCMP _ 0
 INCMP my_balance 1
 INCMP community_balance 2
+INCMP . * 

services/registration/change_language.vis

@@ -2,9 +2,9 @@ LOAD reset_account_authorized 0
 LOAD reset_incorrect 0
 CATCH incorrect_pin flag_incorrect_pin 1
 CATCH pin_entry flag_account_authorized 0
-MOUT english 0
+MOUT english 1
-MOUT kiswahili 1
+MOUT kiswahili 2
 HALT
-INCMP set_default 0
+INCMP set_eng 1
-INCMP set_swa 1
+INCMP set_swa 2
 INCMP . *

services/registration/community_balance.vis

@@ -9,3 +9,4 @@ MOUT quit 9
 HALT
 INCMP _ 0
 INCMP quit 9
+INCMP . * 

services/registration/edit_family_name.vis

@@ -2,9 +2,17 @@ CATCH incorrect_pin flag_incorrect_pin 1
 CATCH update_familyname flag_allow_update 1
 LOAD get_current_profile_info 0
 RELOAD get_current_profile_info
+MAP get_current_profile_info
 MOUT back 0
 HALT
-LOAD save_familyname 0
+RELOAD set_back 
+CATCH _ flag_back_set 1
+LOAD save_familyname 64
 RELOAD save_familyname
-INCMP _ 0
+CATCH pin_entry flag_familyname_set 1
-INCMP pin_entry *
+CATCH select_gender flag_gender_set 0
+CATCH edit_yob flag_yob_set 0
+CATCH edit_location flag_location_set 0
+CATCH edit_offerings flag_offerings_set 0
+CATCH pin_entry flag_familyname_set 0
+INCMP select_gender *

services/registration/edit_first_name.vis

@@ -5,7 +5,14 @@ RELOAD get_current_profile_info
 MAP get_current_profile_info
 MOUT back 0
 HALT
-LOAD save_firstname 0
+RELOAD set_back 
+CATCH _ flag_back_set 1
+LOAD save_firstname 128
 RELOAD save_firstname
-INCMP _ 0
+CATCH pin_entry flag_firstname_set 1
-INCMP pin_entry *
+CATCH edit_family_name flag_familyname_set 0
+CATCH edit_gender flag_gender_set 0
+CATCH edit_yob flag_yob_set 0
+CATCH edit_location flag_location_set 0
+CATCH edit_offerings flag_offerings_set 0
+CATCH pin_entry flag_firstname_set 0

services/registration/edit_first_name_swa

@@ -1,2 +1,2 @@
-Jina la kwanza la sasa {{.get_current_profile_info}}
+Jina la kwanza la sasa: {{.get_current_profile_info}}
 Weka majina yako ya kwanza:

services/registration/edit_location.vis

@@ -2,9 +2,14 @@ CATCH incorrect_pin flag_incorrect_pin 1
 CATCH update_location flag_allow_update 1
 LOAD get_current_profile_info 0
 RELOAD get_current_profile_info
+LOAD save_location 16
 MOUT back 0
 HALT
-LOAD save_location 0
+RELOAD set_back 
+CATCH _ flag_back_set 1
 RELOAD save_location
 INCMP _ 0
-INCMP pin_entry *
+CATCH pin_entry flag_location_set 1
+CATCH edit_offerings flag_offerings_set 0
+CATCH pin_entry flag_location_set 0
+INCMP edit_offerings *

services/registration/edit_location_swa

@@ -1,2 +1,2 @@
-Eneo la sasa {{.get_current_profile_info}}
+Eneo la sasa: {{.get_current_profile_info}}
 Weka eneo:

services/registration/edit_offerings.vis

@@ -2,9 +2,12 @@ CATCH incorrect_pin flag_incorrect_pin 1
 CATCH update_offerings flag_allow_update 1
 LOAD get_current_profile_info 0
 RELOAD get_current_profile_info
-LOAD save_offerings 0
+LOAD save_offerings 8
 MOUT back 0
 HALT
+RELOAD set_back 
+CATCH _ flag_back_set 1
 RELOAD save_offerings
 INCMP _ 0
-INCMP pin_entry *
+CATCH pin_entry flag_offerings_set 1
+INCMP update_profile_items *

services/registration/edit_profile.vis

@@ -11,7 +11,8 @@ MOUT edit_offerings 6
 MOUT view 7
 MOUT back 0
 HALT
-INCMP my_account 0
+LOAD set_back 6
+INCMP ^ 0
 INCMP edit_first_name 1
 INCMP edit_family_name 2
 INCMP select_gender 3
@@ -19,3 +20,4 @@ INCMP edit_yob 4
 INCMP edit_location 5
 INCMP edit_offerings 6
 INCMP view_profile 7
+INCMP . * 

services/registration/edit_yob.vis

@@ -5,10 +5,15 @@ RELOAD get_current_profile_info
 MAP get_current_profile_info
 MOUT back 0
 HALT
+RELOAD set_back 
+CATCH _ flag_back_set 1
 LOAD verify_yob 6
 RELOAD verify_yob
 CATCH incorrect_date_format flag_incorrect_date_format 1
-LOAD save_yob 0
+LOAD save_yob 32
 RELOAD save_yob
-INCMP _ 0
+CATCH pin_entry flag_yob_set 1
-INCMP pin_entry *
+CATCH edit_location flag_location_set 0
+CATCH edit_offerings flag_offerings_set 0
+CATCH pin_entry flag_yob_set 0
+INCMP edit_location *

services/registration/edit_yob_swa

@@ -1,2 +1,2 @@
-Mwaka wa sasa wa kuzaliwa {{.get_current_profile_info}}
+Mwaka wa sasa wa kuzaliwa: {{.get_current_profile_info}}
 Weka mwaka wa kuzaliwa

services/registration/english_menu

@@ -0,0 +1 @@
+English

services/registration/incorrect_pin

@@ -1 +1 @@
-Incorrect pin
+Incorrect PIN

services/registration/invalid_pin_swa

@@ -1 +1 @@
-PIN mpya na udhibitisho wa pin mpya hazilingani.Tafadhali jaribu tena.Kwa usaidizi piga simu +254757628885.
+PIN mpya na udhibitisho wa PIN mpya hazilingani.Tafadhali jaribu tena.Kwa usaidizi piga simu +254757628885.

services/registration/kiswahili_menu

@@ -0,0 +1 @@
+Kiswahili

services/registration/locale/swa/default.po

@@ -13,7 +13,7 @@ msgstr "Kwa usaidizi zaidi,piga: 0757628885"
 msgid "Balance: %s\n"
 msgstr "Salio: %s\n"
 
-msid "Your invite request for %s to Sarafu Network failed. Please try again later."
+msgid "Your invite request for %s to Sarafu Network failed. Please try again later."
 msgstr "Ombi lako la kumwalika %s kwa matandao wa Sarafu halikufaulu. Tafadhali jaribu tena baadaye."
 
 msgid "Your invitation to %s to join Sarafu Network has been sent."
@@ -23,4 +23,7 @@ msgid "Your request failed. Please try again later."
 msgstr "Ombi lako halikufaulu. Tafadhali jaribu tena baadaye."
 
 msgid "Community Balance: 0.00"
-msgid "Salio la Kikundi: 0.00"
+msgstr "Salio la Kikundi: 0.00"
+
+msgid "Symbol: %s\nBalance: %s"
+msgstr "Sarafu: %s\nSalio: %s"

services/registration/main.vis

@@ -1,10 +1,10 @@
 LOAD set_default_voucher 8
 RELOAD set_default_voucher
-LOAD check_balance 64
-RELOAD check_balance
 LOAD check_vouchers 10
 RELOAD check_vouchers
-CATCH api_failure  flag_api_call_error  1
+LOAD check_balance 128
+RELOAD check_balance
+CATCH api_failure flag_api_call_error 1
 MAP check_balance
 MOUT send 1
 MOUT vouchers 2

services/registration/my_account.vis

@@ -14,3 +14,4 @@ INCMP balances 3
 INCMP check_statement 4
 INCMP pin_management 5
 INCMP address 6
+INCMP . *

services/registration/my_balance.vis

@@ -9,3 +9,4 @@ MOUT quit 9
 HALT
 INCMP _ 0
 INCMP quit 9
+INCMP . * 

services/registration/my_balance_swa

@@ -1 +1 @@
-Salio lako ni: 0.00 SRF
+{{.check_balance}}

services/registration/next_menu

@@ -0,0 +1 @@
+Next

services/registration/next_menu_swa

@@ -0,0 +1 @@
+Mbele

services/registration/no_menu

@@ -1 +1 @@
-no
+No

services/registration/no_menu_swa

@@ -1 +1 @@
-la
+La

services/registration/pp.csv

@@ -21,3 +21,10 @@ flag,flag_admin_privilege,27,this is set when a user has admin privileges.
 flag,flag_unregistered_number,28,this is set when an unregistered phonenumber tries to perform an action
 flag,flag_no_transfers,29,this is set when a user does not have any transactions
 flag,flag_incorrect_statement,30,this is set when the selected statement is invalid
+flag,flag_firstname_set,31,this is set when the first name of the profile is set
+flag,flag_familyname_set,32,this is set when the family name of the profile is set
+flag,flag_yob_set,33,this is set when the yob of the profile is set
+flag,flag_gender_set,34,this is set when the gender of the profile is set
+flag,flag_location_set,35,this is set when the location of the profile is set
+flag,flag_offerings_set,36,this is set when the offerings of the profile is set
+flag,flag_back_set,37,this is set when it is a back navigation

services/registration/prev_menu

@@ -0,0 +1 @@
+Prev

services/registration/prev_menu_swa

@@ -0,0 +1 @@
+Nyuma

services/registration/profile_update_success.vis

@@ -1,3 +1,5 @@
+LOAD update_all_profile_items 0
+RELOAD update_all_profile_items
 MOUT back 0
 MOUT quit 9
 HALT

services/registration/select_gender.vis

@@ -11,3 +11,4 @@ INCMP _ 0
 INCMP set_male 1
 INCMP set_female 2
 INCMP set_unspecified 3
+INCMP . *

services/registration/select_gender_swa

@@ -1,2 +1,2 @@
-Jinsia ya sasa {{.get_current_profile_info}}
+Jinsia ya sasa: {{.get_current_profile_info}}
 Chagua jinsia

services/registration/select_language.vis

@@ -1,6 +1,6 @@
-MOUT english 0
+MOUT english 1
-MOUT kiswahili 1
+MOUT kiswahili 2
 HALT
-INCMP set_eng 0
+INCMP set_eng 1
-INCMP set_swa 1
+INCMP set_swa 2
 INCMP . *

services/registration/set_default.vis

@@ -0,0 +1,4 @@
+LOAD set_language 6
+RELOAD set_language
+CATCH terms flag_account_created 0
+MOVE language_changed

services/registration/set_eng.vis

@@ -1,3 +1,4 @@
 LOAD set_language 6
+RELOAD set_language
 CATCH terms flag_account_created 0
 MOVE language_changed

services/registration/set_female.vis

@@ -1,4 +1,10 @@
-LOAD save_gender 0
+LOAD save_gender 32
+RELOAD save_gender
 CATCH incorrect_pin flag_incorrect_pin 1
 CATCH update_gender flag_allow_update 1
-MOVE pin_entry
+CATCH pin_entry flag_gender_set 1
+CATCH edit_yob flag_yob_set 0
+CATCH edit_location flag_location_set 0
+CATCH edit_offerings flag_offerings_set 0
+CATCH pin_entry flag_gender_set 0
+MOVE edit_yob

services/registration/set_male.vis

@@ -1,4 +1,10 @@
-LOAD save_gender 0
+LOAD save_gender 16
+RELOAD save_gender
 CATCH incorrect_pin flag_incorrect_pin 1
 CATCH update_gender flag_allow_update 1
-MOVE pin_entry
+CATCH pin_entry flag_gender_set 1
+CATCH edit_yob flag_yob_set 0
+CATCH edit_location flag_location_set 0
+CATCH edit_offerings flag_offerings_set 0
+CATCH pin_entry flag_gender_set 0
+MOVE edit_yob

services/registration/set_swa.vis

@@ -1,3 +1,4 @@
 LOAD set_language 6
+RELOAD set_language
 CATCH terms flag_account_created 0
 MOVE language_changed

services/registration/set_unspecified.vis

@@ -1,4 +1,10 @@
-LOAD save_gender 0
+LOAD save_gender 8
+RELOAD save_gender
 CATCH incorrect_pin flag_incorrect_pin 1
 CATCH update_gender flag_allow_update 1
-MOVE pin_entry
+CATCH pin_entry flag_gender_set 1
+CATCH edit_yob flag_yob_set 0
+CATCH edit_location flag_location_set 0
+CATCH edit_offerings flag_offerings_set 0
+CATCH pin_entry flag_gender_set 0
+MOVE edit_yob