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

chore!: rename qgb to blobstream #2639

Merged
merged 18 commits into from
Oct 18, 2023

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Oct 9, 2023

Overview

Closes #2613

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@rach-id rach-id added x/qgb backport:v1.x PR will be backported automatically to the v1.x branch upon merging x/blobstream item is directly relevant to the blob module labels Oct 9, 2023
@rach-id rach-id self-assigned this Oct 9, 2023
@celestia-bot celestia-bot requested a review from a team October 9, 2023 12:26

import "gogoproto/gogo.proto";
import "cosmos_proto/cosmos.proto";
import "google/api/annotations.proto";

option go_package = "github.com/celestiaorg/celestia-app/x/qgb/types";
option go_package = "github.com/celestiaorg/celestia-app/x/blobstream/types";
Copy link
Member Author

Choose a reason for hiding this comment

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

[note to reviewers]
This is API breaking

@rach-id rach-id added the warn:api breaking item will be break an API and require a major bump label Oct 9, 2023
package celestia.qgb.v1;
package celestia.blobstream.v1;
Copy link
Member

@evan-forbes evan-forbes Oct 9, 2023

Choose a reason for hiding this comment

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

since this is consensus breaking, we should not backport this change

Copy link
Member Author

Choose a reason for hiding this comment

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

why? we don't want to include the API breaking change in v1? I think it's okey as it won't require any hardspoon or so, just update the binary, no?

Copy link
Member

Choose a reason for hiding this comment

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

the path is included in the msg name, so changes this will result in different bytes included in any transactions or state. nodes with this change will know how to parse these txs, where nodes without the change will not

Copy link
Member

@evan-forbes evan-forbes Oct 9, 2023

Choose a reason for hiding this comment

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

therefore this can only be included in v2. It will also require a migration script, which I think we should include in this change. That likely means waiting for the upgrade and e2e code to be finished so that we can properly test it.

Recall our conversaions about not being able to change the name of the qgb in the code before mainnet

Copy link
Member Author

@rach-id rach-id Oct 9, 2023

Choose a reason for hiding this comment

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

so changes this will result in different bytes included in any transactions or state. nodes with this change will know how to parse these txs, where nodes without the change will not

This provided people are sending register evm address transactions on mocha, which I assume is not the case. If not, then I can revert the tx related changes and only leave the query ones.

For the store, I kept the same keys so it shouldn't be a problem.

@celestia-bot celestia-bot requested a review from a team October 9, 2023 12:30
@evan-forbes evan-forbes added consensus breaking modifies block validity rules in a way that will break consensus unless all nodes update their rules and removed backport:v1.x PR will be backported automatically to the v1.x branch upon merging labels Oct 9, 2023
@codecov-commenter
Copy link

codecov-commenter commented Oct 9, 2023

Codecov Report

Merging #2639 (ba08ef1) into main (c9f681d) will not change coverage.
The diff coverage is 9.75%.

@@           Coverage Diff           @@
##             main    #2639   +/-   ##
=======================================
  Coverage   21.11%   21.11%           
=======================================
  Files         138      138           
  Lines       15767    15767           
=======================================
  Hits         3329     3329           
  Misses      12115    12115           
  Partials      323      323           
Files Coverage Δ
app/version.go 50.00% <ø> (ø)
x/blobstream/abci.go 59.55% <100.00%> (ø)
x/blobstream/genesis.go 0.00% <ø> (ø)
x/blobstream/keeper/keeper.go 69.23% <ø> (ø)
x/blobstream/keeper/keeper_attestation.go 66.66% <ø> (ø)
x/blobstream/keeper/keeper_data_commitment.go 50.44% <ø> (ø)
x/blobstream/keeper/keeper_valset.go 44.73% <ø> (ø)
x/blobstream/keeper/msg_server.go 70.00% <ø> (ø)
x/blobstream/keeper/query_attestation.go 0.00% <ø> (ø)
x/blobstream/keeper/query_data_commitment.go 0.00% <ø> (ø)
... and 24 more

@rach-id rach-id changed the title chore: rename qgb to blobstream chore!: rename qgb to blobstream Oct 9, 2023
@rootulp rootulp modified the milestones: Post-mainnet, v2 Oct 9, 2023
@rach-id
Copy link
Member Author

rach-id commented Oct 11, 2023

I will update this PR not to include any consensus breaking change, so that we can merge it.
Then, we leave the consensus breaking changes to until we implement the upgrade handlers.

cc @evan-forbes

# Conflicts:
#	cmd/celestia-appd/cmd/root.go
#	test/util/testnode/full_node.go
#	x/blobstream/handler.go
#	x/blobstream/types/query.pb.go
@rach-id rach-id changed the title chore!: rename qgb to blobstream chore: rename qgb to blobstream Oct 11, 2023
@rach-id rach-id removed consensus breaking modifies block validity rules in a way that will break consensus unless all nodes update their rules warn:api breaking item will be break an API and require a major bump labels Oct 11, 2023
cmwaters
cmwaters previously approved these changes Oct 13, 2023
Copy link
Contributor

@cmwaters cmwaters left a comment

Choose a reason for hiding this comment

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

LGTM.

Can we add a quick note in the README.md that this was formerly known as the qgb module (just for posterity)

@rach-id
Copy link
Member Author

rach-id commented Oct 13, 2023

Can we add a quick note in the README.md that this was formerly known as the qgb module (just for posterity)

We're planning to write a short ADR documenting this, and this we can maybe add a small section in the README referencing the ADR.

@jcstein jcstein self-requested a review October 13, 2023 14:51
staheri14
staheri14 previously approved these changes Oct 17, 2023
@celestia-bot celestia-bot requested a review from a team October 17, 2023 20:20
scripts/single-node.sh Outdated Show resolved Hide resolved
@rach-id rach-id dismissed stale reviews from staheri14 and cmwaters via a93181f October 17, 2023 22:30
@rach-id rach-id merged commit 9cefa0d into celestiaorg:main Oct 18, 2023
26 of 27 checks passed
rach-id added a commit that referenced this pull request Oct 19, 2023
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

The dependencies part of
#2639

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords
mergify bot pushed a commit that referenced this pull request Oct 19, 2023
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

The dependencies part of
#2639

## Checklist

<!--
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords

(cherry picked from commit c517bd2)

# Conflicts:
#	go.mod
#	x/qgb/client/verify.go
0xchainlover pushed a commit to celestia-org/celestia-app that referenced this pull request Aug 1, 2024
<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

The dependencies part of
celestiaorg/celestia-app#2639

## Checklist

<!-- 
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
warn:api breaking item will be break an API and require a major bump x/blobstream item is directly relevant to the blob module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename the QGB module and docs
7 participants