From 890f50704f20e518d9580dcf1436159ff047569a Mon Sep 17 00:00:00 2001
From: lash <dev@holbrook.no>
Date: Sun, 8 Dec 2024 21:21:48 +0000
Subject: [PATCH] Add documentation comments for db subprefix types

---
 common/db.go | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/common/db.go b/common/db.go
index 5532dc9..f20dbab 100644
--- a/common/db.go
+++ b/common/db.go
@@ -7,43 +7,88 @@ 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 (
+	// TODO: Seems unused
 	DATA_ACCOUNT DataTyp = iota
+	// TODO: Seems unused, only read not written
 	DATA_ACCOUNT_CREATED
+	// API Tracking id to follow status of account creation
 	DATA_TRACKING_ID
+	// EVM address returned from API on account creation
 	DATA_PUBLIC_KEY
+	// TODO: Seems unused
 	DATA_CUSTODIAL_ID
+	// Currently active PIN used to authenticate ussd state change requests
 	DATA_ACCOUNT_PIN
+	// TODO: Seems unused
 	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
-	// Start the sub prefix data at 256 (0x0100)
+)
+
+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.
 	DATA_TX_SENDERS
+	// 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
 )