From eac9db5c9845f929f2d87140161efe9a56e6353c Mon Sep 17 00:00:00 2001
From: jbhusson <jonah@elixxir.io>
Date: Wed, 18 May 2022 07:46:31 -0400
Subject: [PATCH] Update comments
---
broadcast/asymmetricClient.go | 2 ++
broadcast/interface.go | 5 +++--
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/broadcast/asymmetricClient.go b/broadcast/asymmetricClient.go
index ab7b13a6b..33050a3a5 100644
--- a/broadcast/asymmetricClient.go
+++ b/broadcast/asymmetricClient.go
@@ -30,6 +30,8 @@ func (bc *broadcastClient) MaxAsymmetricPayloadSize() int {
// BroadcastAsymmetric broadcasts the payload to the channel. Requires a healthy network state to send
// Payload must be equal to bc.MaxAsymmetricPayloadSize, and the channel PrivateKey must be passed in
// Broadcast method must be set to asymmetric
+// When a payload is sent, it is split into partitons of size bc.channel.MaxAsymmetricPayloadSize
+// which are each encrypted using multicastRSA
func (bc *broadcastClient) BroadcastAsymmetric(pk multicastRSA.PrivateKey, payload []byte, cMixParams cmix.CMIXParams) (
id.Round, ephemeral.Id, error) {
if bc.param.Method != Asymmetric {
diff --git a/broadcast/interface.go b/broadcast/interface.go
index 4b7e119d6..aca75fd46 100644
--- a/broadcast/interface.go
+++ b/broadcast/interface.go
@@ -26,12 +26,13 @@ type ListenerFunc func(payload []byte,
receptionID receptionID.EphemeralIdentity, round rounds.Round)
type Channel interface {
- // MaxSymmetricPayloadSize returns the maximum size for a symmetric broadcasted payload.
+ // MaxSymmetricPayloadSize returns the maximum size for a symmetric broadcast payload.
MaxSymmetricPayloadSize() int
- // MaxAsymmetricPayloadSize returns the maximum size for an asymmetric broadcasted payload.
+ // MaxAsymmetricPayloadSize returns the maximum size for an asymmetric broadcast payload.
MaxAsymmetricPayloadSize() int
+ // Get returns the underlying crypto.Channel
Get() crypto.Channel
// Broadcast broadcasts the payload to the channel. The payload size must be
--
GitLab