From 3ac50c3afbf63d62c2a21a9ce30b348ecfb48cbe Mon Sep 17 00:00:00 2001
From: Jake Taylor <jake@elixxir.io>
Date: Mon, 27 Jun 2022 13:06:27 -0500
Subject: [PATCH] added some comments
---
xxdk/e2e.go | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/xxdk/e2e.go b/xxdk/e2e.go
index ce139c294..0a58b8af5 100644
--- a/xxdk/e2e.go
+++ b/xxdk/e2e.go
@@ -35,14 +35,14 @@ type E2e struct {
}
// Login creates a new E2e backed by the xxdk.Cmix persistent versioned.KV
-// If identity == nil, a new ReceptionIdentity will be generated automagically
+// It bundles a Cmix object with a ReceptionIdentity object
+// and initializes the auth.State and e2e.Handler objects
func Login(client *Cmix, callbacks auth.Callbacks,
identity ReceptionIdentity) (m *E2e, err error) {
return login(client, callbacks, identity, client.GetStorage().GetKV())
}
// LoginEphemeral creates a new E2e backed by a totally ephemeral versioned.KV
-// If identity == nil, a new ReceptionIdentity will be generated automagically
func LoginEphemeral(client *Cmix, callbacks auth.Callbacks,
identity ReceptionIdentity) (m *E2e, err error) {
return login(client, callbacks, identity, versioned.NewKV(ekv.MakeMemstore()))
--
GitLab