Skip to content

blockchain: rename to blocksync service#6755

Merged
cmwaters merged 14 commits intomasterfrom
callum/blocksync
Jul 28, 2021
Merged

blockchain: rename to blocksync service#6755
cmwaters merged 14 commits intomasterfrom
callum/blocksync

Conversation

@cmwaters
Copy link
Contributor

Closes: #6751, #4594

I have tried to rename both the blockchain package and service as well as the term fast sync to the single term block sync. There are some exceptions. In all ADR's, the term of fast sync is left as is. In the config, in order to avoid a breaking change, FastSyncConfig remains the same. Do we want to change this and thus break the config file (we might have already broken it with the privVal changes)?

@alexanderbez
Copy link
Contributor

I honestly feel like changing fast-sync nomenclature will be too much. It's already so engrained in so many things. Can we stick with just renaming the reactor/service for now?

@tac0turtle
Copy link
Contributor

Tend to agree with renaming of blockchain to blocksync. Ideally, we just rename what is "fast sync" to "block sync". This may only be docs

@cmwaters
Copy link
Contributor Author

When I was making the change I also asked myself whether renaming fast sync would be too much. I do agree that it is engrained in the minds of us as developers and many members of the wider community and it will continue to be called fast sync long after this gets merged. I do however think that having consistent terminology throughout the repo slightly outweighs this and I've tried to be very thorough about it (with the exception of the FastSyncConfig which I'm still not too sure if we want to rename or not).

@tac0turtle
Copy link
Contributor

When I was making the change I also asked myself whether renaming fast sync would be too much.

I am onboard with the rename, but not with renaming blockchain to blocksync. Blockchain is a generlized pkg for serving blocks, we just happen to have fast/block sync in it.

If we pull out fast sync from blockchain this would be simpler.

Also this PR doesnt solve #4594?

@cmwaters
Copy link
Contributor Author

cmwaters commented Jul 26, 2021

Blockchain is a generlized pkg for serving blocks, we just happen to have fast/block sync in it.

But I don't think it is a generalized pkg for serving blocks. Its purely for "block sync". It's not linked with the RPC, which serves blocks by directly connecting to the blockstore (and the blockstore is its own package). You can also (if you really wanted to) use consensus to fetch blocks.

Note: when I say "Its purely for "block sync"." - this is an opinion not a fact

@cmwaters cmwaters marked this pull request as ready for review July 26, 2021 08:38
@codecov
Copy link

codecov bot commented Jul 27, 2021

Codecov Report

Merging #6755 (c10b878) into master (e87b039) will increase coverage by 0.01%.
The diff coverage is 48.78%.

@@            Coverage Diff             @@
##           master    #6755      +/-   ##
==========================================
+ Coverage   62.43%   62.45%   +0.01%     
==========================================
  Files         306      306              
  Lines       40384    40384              
==========================================
+ Hits        25214    25220       +6     
+ Misses      13386    13385       -1     
+ Partials     1784     1779       -5     
Impacted Files Coverage Δ
config/toml.go 68.33% <ø> (ø)
internal/blocksync/v0/pool.go 82.33% <ø> (ø)
...l/blocksync/v2/internal/behavior/peer_behaviour.go 75.00% <ø> (ø)
...nternal/blocksync/v2/internal/behavior/reporter.go 51.28% <ø> (ø)
internal/blocksync/v2/io.go 0.00% <ø> (ø)
internal/blocksync/v2/metrics.go 16.25% <ø> (ø)
internal/blocksync/v2/processor.go 86.45% <ø> (ø)
internal/blocksync/v2/processor_context.go 66.66% <ø> (ø)
internal/blocksync/v2/routine.go 69.07% <ø> (ø)
internal/blocksync/v2/scheduler.go 85.44% <ø> (ø)
... and 31 more

@cmwaters cmwaters merged commit 6ff4c31 into master Jul 28, 2021
@cmwaters cmwaters deleted the callum/blocksync branch July 28, 2021 15:25
@tac0turtle tac0turtle mentioned this pull request Jul 27, 2022
39 tasks
mergify bot pushed a commit that referenced this pull request Aug 17, 2022
This is largely a cherry pick of #6755 with some additional fixups added where detected. 
This change moves the blockchain package to a package called blocksync. Additionally, it renames the relevant uses of the term `fastsync` to `blocksync`.

closes: #9227 

#### PR checklist

- [ ] Tests written/updated, or no tests needed
- [x] `CHANGELOG_PENDING.md` updated, or no changelog entry needed
- [x] Updated relevant documentation (`docs/`) and code comments, or no
      documentation updates needed
cmwaters pushed a commit that referenced this pull request Aug 19, 2022
This is largely a cherry pick of #6755 with some additional fixups added where detected. 
This change moves the blockchain package to a package called blocksync. Additionally, it renames the relevant uses of the term `fastsync` to `blocksync`.

closes: #9227 

#### PR checklist

- [ ] Tests written/updated, or no tests needed
- [x] `CHANGELOG_PENDING.md` updated, or no changelog entry needed
- [x] Updated relevant documentation (`docs/`) and code comments, or no
      documentation updates needed
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.

blockchain: rename to blocksync

4 participants