From 37b00f708c9b13ef6a3c14879b1b3ad54c495539 Mon Sep 17 00:00:00 2001 From: pm47 Date: Fri, 27 Jan 2017 18:17:59 +0100 Subject: [PATCH] small scaladoc fixes --- .../src/main/scala/fr/acinq/eclair/channel/Helpers.scala | 6 +++--- .../scala/fr/acinq/eclair/crypto/ChaCha20Poly1305.scala | 1 - 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/eclair-node/src/main/scala/fr/acinq/eclair/channel/Helpers.scala b/eclair-node/src/main/scala/fr/acinq/eclair/channel/Helpers.scala index db949f664..83278d562 100644 --- a/eclair-node/src/main/scala/fr/acinq/eclair/channel/Helpers.scala +++ b/eclair-node/src/main/scala/fr/acinq/eclair/channel/Helpers.scala @@ -223,10 +223,10 @@ object Helpers { * When an unexpected transaction spending the funding tx is detected: * 1) we find out if the published transaction is one of remote's revoked txs * 2) and then: - * a) if it is a revoked tx we build a set of transactions that will punish them by stealing all their funds - * b) otherwise there is nothing we can do + * a) if it is a revoked tx we build a set of transactions that will punish them by stealing all their funds + * b) otherwise there is nothing we can do * - * @return a list of transactions (one per HTLC that we can claim) if the tx is a revoked commitment, [[None]] otherwise + * @return a [[RevokedCommitPublished]] object containing punishment transactions if the tx is a revoked commitment */ def claimRevokedRemoteCommitTxOutputs(commitments: Commitments, tx: Transaction): Option[RevokedCommitPublished] = { import commitments._ diff --git a/eclair-node/src/main/scala/fr/acinq/eclair/crypto/ChaCha20Poly1305.scala b/eclair-node/src/main/scala/fr/acinq/eclair/crypto/ChaCha20Poly1305.scala index fb034b4ef..ca6e2b2f2 100644 --- a/eclair-node/src/main/scala/fr/acinq/eclair/crypto/ChaCha20Poly1305.scala +++ b/eclair-node/src/main/scala/fr/acinq/eclair/crypto/ChaCha20Poly1305.scala @@ -101,7 +101,6 @@ object ChaCha20Poly1305 extends Logging { * @param aad additional authentication data. can be empty * @param mac authentication mac * @return the decrypted plaintext if the mac is valid. - * @throws AssertionError error if the mac is invalid */ def decrypt(key: BinaryData, nonce: BinaryData, ciphertext: BinaryData, aad: BinaryData, mac: BinaryData): BinaryData = { val polykey: BinaryData = ChaCha20.encrypt(new Array[Byte](32), key, nonce)