Tracker: Remaining tasks for QGB 1.0

[rach-id]

This issue will be a tracker for the remaining work for the QGB 1.0 to be finalized. New tasks will be added as they pop up.
For now, the QGB work is under the following branch: https://github.com/celestiaorg/celestia-app/tree/qgb-integration, and will be merged to master once we have a stable version.

Must have

Orchestrator and Relayer

• QGB MVP tracker #320
• Write ADR for QGB Relayer and Orchestrator 1.0 #270
• Document the orchestrator and relayer usage orchestrator-relayer#2
• Make the parameters we're passing to the QGB Relayer/Orchestrator/Deployer configurable #307
• QGB Orchestrator should stop signing if no longer in the valset #406
• QGB relayer relay more than 2/3 signatures and less than all of them correctly #628

State machine

• QGB query the data commitment window from params #339
• Handle the valset genesis case correctly #373
• QGB keepers throwing exception when element not found #437
• QGB sign attestations only if part of the valset #480
• QGB Document the keystore or use existing code #498
• QGB use app config to register modules  #499
• QGB investigate the EndBlocker panics and document them #501
• QGB initialize needed entities in genesis #502
• QGB import Any type correctly #507
• QGB investigate concurrent map reads panic #518
• QGB verify the attestation is a data commitment when submitting the confirm #520
• QGB start valset nonce at 0 instead of 1 #521
• QGB data commitments/valsets state machine checks #631
• QGB state machine confirm signed by validator  #638

Cosmos-sdk

• Improve staking.validator queries for the new QGB added fields cosmos-sdk#129
• Replace EthAddress with Geth implementation of the Ethereum address for validator  cosmos-sdk#143
• Create validator Ethereum address during simulation tests in a correct way cosmos-sdk#144
• QGB update the qgb branch to have latest cosmos-sdk changes cosmos-sdk#220

CLI

• QGB CLI taking time to execute #451

Misc

• Deploy MVP QGB to ethereum testnet #326
• QGB deploy the QGB contract using the latest nonce #506
• QGB resolve merge conflicts with master #517

Investigations

• Investigate the QGB transactions cost #603
• Investigate the QGB relayer signatures issue  #604

Nice to have

High priority

• Improve QGB testing coverage #482
• QGB data commitment validator address confusion #243
• Be consistent in the naming for QGB #303
• Decide on a naming convention for the Ethereum/Orchestrator address in the validator struct  cosmos-sdk#136
• QGB orchestrator signing everything before implementing slashing #479
• QGB e2e use signaling channel to notify #522
• QGB implement exponential backoff #532
• QGB orchestrator checkout routine orchestrator-relayer#1
• QGB implement synchronous orchestrator #546
• QGB investigate indexing attestation confirms in multiple ways #552
• QGB add a check on the height when receiving data commitment request celestia-core#837
• Remove temporary import hack for protobuf any #744
• QGB use existing testing infrastructure #745
• QGB add validator edit test cases #768

Low priority

• Add qgb contract querying functionality to the cli #259
• Move the QGB module constants to a specific consts package #262
• Go over the small TODOs left in the QGB #305
• Implement the remaining CLI commands for querying the QGB #306
• Look into removing the BRIDGE_ID blobstream-contracts#71
• QGB use less magic numbers #503
• QGB E2E scripts retry starting nodes #504
• QGB use interface for Valset/DataCommitment confirms #505
• QGB separate panics in SetLatestAttestation #752

Already done

• qgb: Add ability to query for validator set by nonce #278
• Add DataCommitmentRequest to the qgb module #268
• Refactor orchestrator client for easier testing #264
• Replace start and end block range with nonce in the DataCommitmentConfirms #248
• Create a command that deploys the QGB smart contracts #258
• Add the qgb orchestrator as a sub command of the app #223
• Copy over the relevant tests from the Gravity module #220
• Add a parameter that indicates the frequency for which the validators are expected to sign DataCommitments #198
• Proposal: Add the orchestrator address and eth address to the validator struct #283
• QGB replay functionality #298
• Update the CLI flags to correctly reflect the parameters needed for QGB #302
• Add checks/tests to the newly added orchestrator/Ethereum addresses to the staking module cosmos-sdk#114
• Update the QGB go.mod to use the right cosmos-sdk version #304
• Remove the EthAddress struct from QGB and use cosmos-sdk one instead #308
• Add integration tests using dockerized testnet #324
• Implement a dockerized deployment of a celestia testnet bridged to an ethereuem testnet by the qgb #325
• Remove unused functionality #327
• Modify the relayer to also query for and submit data commitments #328
• MVP Relayer Tracking Issue #329
• QGB change relayer to send the height instead of the nonce #334
• Update the QGB to use the latest QGB contract wrapper #335
• Add valset request by nonce for QGB #343
• Valset/Data commitment requests security for QGB #349
• Data commitment roots for empty blocks returning same result #353
• QGB relayer wait for transactions to be confirmed #356
• QGB deploy command waits for contract deployment to be confirmed  #362
• Update the relaying mechanism to catch up correctly #370
• The relayer sometimes relays weird signatures #374
• QGB E2E test proposal #398
• QGB deploy command not querying the right valset to init the contract #403
• QGB base integration test scenarios #407
• Add QGB integration test github action #409
• Add an IntegrationTestSuite for the QGB IT #428
• QGB E2E use context and timeouts for stopping the network #438
• Implement the worker pool design pattern in QGB orchestrator #463
• Update the QGB implementation to support Universal nonce #467
• Contract not verifying valsets against the right checkpoint blobstream-contracts#120

[evan-forbes]

Context

We've been iterating on the design the orchestrator and relayer over the past few weeks in the qgb-integration branch. This has been incredibly helpful in figuring out exactly what needs to be done, how it should be done, along with continually refactoring how the team works best together. While reviewing this features branch will take time, and be done in chunks, I do believe that it will save reviewers time, and allow for a proper final review, instead of having to review each refactor.

Merging the feature branch

The plan to merge the qgb-integration branch into master is to first finish the above tasks and merge them into the feature branch. At this point, a fully functional QGB 1.0 (not MVP!) will be completed.

The final review process will begin with the review of the QGB 1.0 ADR #270. After that, we will cherry-pick chunks of the final iteration of the qgb into master. After this process is complete, we will cut a new breaking release of the app.

cc-ing the final reviewers: @adlerjohn @liamsi

[evan-forbes]

todo: move remaining issues to other epics, tracking issues, and/or repos

closing because we are no longer tracking v1