add documentation lines

This commit is contained in:
Carlosokumu 2024-08-27 10:15:11 +03:00
parent cb31616a87
commit db96f0e2e4
Signed by untrusted user: carlos
GPG Key ID: 7BD6BC8160A5C953
3 changed files with 11 additions and 2 deletions

View File

@ -9,6 +9,9 @@ import (
"git.grassecon.net/urdt/ussd/internal/models" "git.grassecon.net/urdt/ussd/internal/models"
) )
// CheckBalance retrieves the balance for a given public key from the custodial balance API endpoint.
// Parameters:
// - publicKey: The public key associated with the account whose balance needs to be checked.
func CheckBalance(publicKey string) (string, error) { func CheckBalance(publicKey string) (string, error) {
resp, err := http.Get(config.BalanceURL + publicKey) resp, err := http.Get(config.BalanceURL + publicKey)

View File

@ -9,7 +9,12 @@ import (
"git.grassecon.net/urdt/ussd/internal/models" "git.grassecon.net/urdt/ussd/internal/models"
) )
//CreateAccount creates a new account in the custodial system.
// Returns:
// - *models.AccountResponse: A pointer to an AccountResponse struct containing the details of the created account.
// If there is an error during the request or processing, this will be nil.
// - error: An error if any occurred during the HTTP request, reading the response, or unmarshalling the JSON data.
// If no error occurs, this will be nil.
func CreateAccount() (*models.AccountResponse, error) { func CreateAccount() (*models.AccountResponse, error) {
resp, err := http.Post(config.CreateAccountURL, "application/json", nil) resp, err := http.Post(config.CreateAccountURL, "application/json", nil)
if err != nil { if err != nil {

View File

@ -2,7 +2,8 @@ package utils
import "time" import "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.
func CalculateAge(birthdate, today time.Time) int { func CalculateAge(birthdate, today time.Time) int {
today = today.In(birthdate.Location()) today = today.In(birthdate.Location())
ty, tm, td := today.Date() ty, tm, td := today.Date()