feat!: refactor codebase #407
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wemeetagain
requested review from
achingbrain,
mpetrunic and
a team
and removed request for
a team
maschad
reviewed
Dec 19, 2023
|
|
||
| constructor (crypto: ICrypto, k: Uint8Array | undefined = undefined, n = 0) { | ||
| this.crypto = crypto | ||
| this.k = k |
There was a problem hiding this comment.
Single letter variable names should at least have comments for clarity
There was a problem hiding this comment.
If you use an IDE, all protocol-related types have comments.
maschad
reviewed
Dec 19, 2023
| @@ -181,8 +185,7 @@ export const defaultCrypto: ICryptoInterface = { | |||
| publicKey | |||
| ], X25519_PREFIX.byteLength + publicKey.byteLength) | |||
| } else { | |||
| publicKey.prepend(X25519_PREFIX) | |||
| publicKey = publicKey.subarray() | |||
| publicKey = new Uint8ArrayList(X25519_PREFIX, publicKey).subarray() | |||
There was a problem hiding this comment.
you should write a test to ensure that this state is consistent
There was a problem hiding this comment.
a regression test?
This fixes a bug where the input Uint8ArrayList was mutated. When that input Uint8ArrayList is part of the noise state, then that mutation breaks things.
mpetrunic
reviewed
Jan 4, 2024
mpetrunic
approved these changes
Jan 9, 2024
|
argh release-please never picked this up! @mpetrunic do you have any ideas? |
|
nevermind, it just appeared! |
Souch impatience and doubt in release-please 😋 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
Review notes:
src/protocol.tswhich contains the core noise protocol (agnostic to libp2p's usage)src/performHandshake.tswhich uses the noise protocol according to the libp2p spec. The initiator and responder flows are broken into separate functions.Description
src/handshakeswithsrc/protocol.ts, this is noise protocol code, following the spec verbatim, agnostic to libp2p usagesrc/xx-handshake.ts withsrc/performHandshake.ts` which performs a noise handshake, libp2p-style. This adds logging, reading/writing to a connection, and sending/receiving/verifying a libp2p noise payload.BREAKING CHANGE:
The return type of
ICryptoInterface#chaCha20Poly1305Decrypthas changed, now no longer returnsnullbut rather throws on invalid decryption.