Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add high-level architecture diagrams #1733

Merged
merged 3 commits into from
Mar 24, 2021
Merged

Conversation

t-bast
Copy link
Member

@t-bast t-bast commented Mar 22, 2021

It can be useful for newcomers to have a high-level view of the main components in eclair. This will help them quickly find where they should start digging into actual code to achieve what they want.

We're leaving a lot of details out to ensure this document stays up-to-date and doesn't need to completely change every time we slightly rework internal details of our architecture.

It can be useful for newcomers to have a high-level view of the main
components in eclair. This will help them quickly find where they should
start digging into actual code to achieve what they want.

We're leaving a lot of details out to ensure this document stays up-to-date
and doesn't need to completely change every time we slightly rework internal
details of our architecture.
docs/Architecture.md Outdated Show resolved Hide resolved
Copy link
Member

@pm47 pm47 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it looks pretty good, just one nit.

docs/Architecture.md Outdated Show resolved Hide resolved
@codecov-io
Copy link

Codecov Report

Merging #1733 (adcff41) into master (4bc2dec) will increase coverage by 0.28%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1733      +/-   ##
==========================================
+ Coverage   86.36%   86.64%   +0.28%     
==========================================
  Files         152      154       +2     
  Lines       11784    11987     +203     
  Branches      497      511      +14     
==========================================
+ Hits        10177    10386     +209     
+ Misses       1607     1601       -6     
Impacted Files Coverage Δ
...main/scala/fr/acinq/eclair/router/Validation.scala 90.76% <0.00%> (-1.54%) ⬇️
...ire/internal/channel/version0/ChannelCodecs0.scala 95.23% <0.00%> (-1.51%) ⬇️
...ire/internal/channel/version1/ChannelCodecs1.scala 98.94% <0.00%> (-1.06%) ⬇️
...c/main/scala/fr/acinq/eclair/channel/Helpers.scala 95.70% <0.00%> (-0.73%) ⬇️
...main/scala/fr/acinq/eclair/io/PeerConnection.scala 82.97% <0.00%> (-0.43%) ⬇️
...nq/eclair/blockchain/electrum/ElectrumWallet.scala 80.25% <0.00%> (-0.26%) ⬇️
...cala/fr/acinq/eclair/crypto/TransportHandler.scala 90.21% <0.00%> (ø)
...q/eclair/payment/receive/MultiPartPaymentFSM.scala 95.12% <0.00%> (ø)
...q/eclair/wire/internal/channel/ChannelCodecs.scala 100.00% <0.00%> (ø)
.../eclair/payment/relay/PostRestartHtlcCleaner.scala 90.62% <0.00%> (ø)
... and 31 more

@t-bast t-bast merged commit f39718a into master Mar 24, 2021
@t-bast t-bast deleted the architecture-documentation branch March 24, 2021 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants