From 23bfdf4483f6ebf25fe72df2b3b7c6ee376e0202 Mon Sep 17 00:00:00 2001
From: Carlosokumu <carlosokumu254@gmail.com>
Date: Fri, 30 Aug 2024 09:15:04 +0300
Subject: [PATCH] add documentation lines

---
 internal/handlers/server/accountservice.go | 26 ++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/internal/handlers/server/accountservice.go b/internal/handlers/server/accountservice.go
index 791f2e7..f4375a1 100644
--- a/internal/handlers/server/accountservice.go
+++ b/internal/handlers/server/accountservice.go
@@ -18,6 +18,21 @@ type AccountServiceInterface interface {
 type AccountService struct {
 }
 
+
+
+// CheckAccountStatus retrieves the status of an account transaction based on the provided tracking ID.
+//
+// Parameters:
+//   - trackingId: A unique identifier for the account.This should be obtained from a previous call to
+//     CreateAccount or a similar function that returns an AccountResponse. The `trackingId` field in the
+//     AccountResponse struct can be used here to check the account status during a transaction.
+//
+//
+// Returns:
+//   - string: The status of the transaction as a string. If there is an error during the request or processing, this will be an empty string.
+//   - 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 (as *AccountService) CheckAccountStatus(trackingId string) (string, error) {
 	resp, err := http.Get(config.TrackStatusURL + trackingId)
 	if err != nil {
@@ -41,6 +56,10 @@ func (as *AccountService) CheckAccountStatus(trackingId string) (string, error)
 	return status, nil
 }
 
+
+// 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 (as *AccountService) CheckBalance(publicKey string) (string, error) {
 
 	resp, err := http.Get(config.BalanceURL + publicKey)
@@ -64,6 +83,13 @@ func (as *AccountService) CheckBalance(publicKey string) (string, error) {
 	return balance, nil
 }
 
+
+//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 (as *AccountService) CreateAccount() (*models.AccountResponse, error) {
 	resp, err := http.Post(config.CreateAccountURL, "application/json", nil)
 	if err != nil {