From a073ab1991e97e67142107ed3497b41403c00763 Mon Sep 17 00:00:00 2001
From: Jake Taylor <jake@elixxir.io>
Date: Thu, 23 Jun 2022 12:19:25 -0500
Subject: [PATCH] commented api functions
---
xxdk/cmix.go | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/xxdk/cmix.go b/xxdk/cmix.go
index 8be242968..ee7d46949 100644
--- a/xxdk/cmix.go
+++ b/xxdk/cmix.go
@@ -119,6 +119,8 @@ func NewVanityClient(ndfJSON, storageDir string, password []byte,
}
// OpenCmix session, but don't connect to the network or log in
+// NOTE: This is a helper function that, in most applications, should not be used on its own
+// Consider using LoadCmix instead, which calls this function for you.
func OpenCmix(storageDir string, password []byte,
parameters Params) (*Cmix, error) {
jww.INFO.Printf("OpenCmix()")
@@ -202,9 +204,9 @@ func NewProtoClient_Unsafe(ndfJSON, storageDir string, password []byte,
return nil
}
-// LoadCmix initializes a Cmix object from existing storage
+// LoadCmix initializes a Cmix object from existing storage and starts the network
func LoadCmix(storageDir string, password []byte, parameters Params) (*Cmix, error) {
- jww.INFO.Printf("Login()")
+ jww.INFO.Printf("LoadCmix()")
c, err := OpenCmix(storageDir, password, parameters)
if err != nil {
--
GitLab