#20: Added documentation

inklabs · May 10, 2021 · e80cfc2 · e80cfc2
1 parent 3d38a94
commit e80cfc2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/pkg/crypto/cryptotest/failing_event_encryptor.go b/pkg/crypto/cryptotest/failing_event_encryptor.go
@@ -8,6 +8,7 @@ import (
 
 type failingEventEncryptor struct{}
 
+// NewFailingEventEncryptor always errors on Encrypt/Decrypt
 func NewFailingEventEncryptor() *failingEventEncryptor {
 	return &failingEventEncryptor{}
 }

diff --git a/provider/encryptedstore/decrypting_record_subscriber.go b/provider/encryptedstore/decrypting_record_subscriber.go
@@ -10,6 +10,7 @@ type decryptingRecordSubscriber struct {
 	eventEncryptor crypto.EventEncryptor
 }
 
+// NewDecryptingRecordSubscriber decrypts records on Accept
 func NewDecryptingRecordSubscriber(parent rangedb.RecordSubscriber, eventEncryptor crypto.EventEncryptor) *decryptingRecordSubscriber {
 	return &decryptingRecordSubscriber{
 		parent:         parent,

diff --git a/provider/encryptedstore/encrypted_store.go b/provider/encryptedstore/encrypted_store.go
@@ -12,9 +12,10 @@ type encryptedStore struct {
 	eventEncryptor crypto.EventEncryptor
 }
 
-func New(parentStore rangedb.Store, eventEncryptor crypto.EventEncryptor) *encryptedStore {
+// New constructs an Encrypted Store that automatically encrypts/decrypts events for a decorated parent rangedb.Store.
+func New(parent rangedb.Store, eventEncryptor crypto.EventEncryptor) *encryptedStore {
 	return &encryptedStore{
-		parent:         parentStore,
+		parent:         parent,
 		eventEncryptor: eventEncryptor,
 	}
 }