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.

Sign up for GitHub

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

Jump to bottom

EPIC: Add an official spec for the app #650

Closed
31 of 36 tasks
Tracked by #514
evan-forbes opened this issue Aug 23, 2022 · 10 comments
Closed
31 of 36 tasks
Tracked by #514

EPIC: Add an official spec for the app #650

evan-forbes opened this issue Aug 23, 2022 · 10 comments
Assignees
@rootulp @cmwaters @staheri14 @rach-id @evan-forbes
Labels
epic item groups other items for easier tracking specs directly relevant to the specs

Comments

@evan-forbes
Copy link
Member

evan-forbes commented Aug 23, 2022 •
edited by rootulp
Loading

While archived, the specs contain a lot of really important and critical designs that are effectively cannon. We should move as much as we can over from them, while refactoring, modifying, and updating to match the current implementation.

some special love is needed for our the encoding section, as its much more difficult to decipher the share splitting/merging implementation

Pure specs

Needs implementation
@evan-forbes evan-forbes added documentation Improvements or additions to documentation epic item groups other items for easier tracking labels Aug 23, 2022
@rootulp
Copy link
Collaborator

rootulp commented Aug 23, 2022

One alternative approach is to unarchive the specs repo and remove the outdated specs.

@adlerjohn
Copy link
Member

Per-repo specs will be easier to maintain, as each team can update spec in tandem with implementation changes.

@evan-forbes evan-forbes mentioned this issue Aug 24, 2022
Closed
41 tasks
@rootulp rootulp mentioned this issue Aug 29, 2022
Open
@evan-forbes
Copy link
Member Author

I'm going to use this comment to continually add reminders as I think of them. Others should feel free to edit this comment or post their own comment as well.

we introduced a new validity rule here for MsgPayForData and MsgWirePayForData.
#666

@rootulp
Copy link
Collaborator

rootulp commented Aug 31, 2022

Relevant: #727

@evan-forbes
Copy link
Member Author

nice!! I didn't see that

@rootulp rootulp self-assigned this Sep 14, 2022
@adlerjohn adlerjohn added specs directly relevant to the specs and removed documentation Improvements or additions to documentation labels Sep 19, 2022
@adlerjohn
Copy link
Member

Can we turn this into a tracking issues @evan-forbes

@evan-forbes evan-forbes changed the title Add an official spec for the app Tracking: Add an official spec for the app Sep 19, 2022
@evan-forbes evan-forbes mentioned this issue Sep 24, 2022
Closed
@adlerjohn adlerjohn mentioned this issue Sep 27, 2022
Merged
@adlerjohn adlerjohn self-assigned this Oct 2, 2022
@adlerjohn adlerjohn mentioned this issue Nov 1, 2022
Closed
@rootulp

This comment was marked as outdated.

Sign in to view
@evan-forbes evan-forbes changed the title Tracking: Add an official spec for the app EPIC: Add an official spec for the app Nov 15, 2022
@evan-forbes evan-forbes added this to the Mainnet milestone Jan 18, 2023
@evan-forbes evan-forbes mentioned this issue Jan 18, 2023
Closed
9 tasks
@evan-forbes
Copy link
Member Author

evan-forbes commented Mar 16, 2023 •
edited
Loading

referencing a comment with changes that are likely a good idea to include above in some way

#796 (comment)

@evan-forbes
Copy link
Member Author

evan-forbes commented May 31, 2023 •
edited
Loading

here's an list from a recent sync on overhauling the spec. Some of these are duplicates from the main comment in this issue 🙏

@evan-forbes evan-forbes mentioned this issue Jun 12, 2023
Merged
5 tasks
@evan-forbes evan-forbes mentioned this issue Jun 20, 2023
Merged
5 tasks
evan-forbes added a commit that referenced this issue Jul 6, 2023
@evan-forbes @cmwaters
@rootulp @staheri14
docs: add block validity rules specs (#1966)
5bcf4ad 
## Overview

Figured we could at least use this as a place holder as a high level
summary of celestia-app, and to point to all the other portions of the
application.

part of and closes
#743
part of #650 


[rendered](https://github.com/celestiaorg/celestia-app/blob/b44960898f59ea3ed86430828606cdc72107a0be/specs/src/specs/block_validity_rules.md)

## Checklist

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

---------

Co-authored-by: Callum Waters <[email protected]>
Co-authored-by: Rootul P <[email protected]>
Co-authored-by: Sanaz Taheri <[email protected]>
@evan-forbes evan-forbes removed this from the Mainnet milestone Aug 7, 2023
rootulp added a commit to rootulp/celestia-app that referenced this issue Aug 30, 2023
@evan-forbes @cmwaters
@rootulp @staheri14
docs: add block validity rules specs (celestiaorg#1966)
ee1c4c3 
## Overview

Figured we could at least use this as a place holder as a high level
summary of celestia-app, and to point to all the other portions of the
application.

part of and closes
celestiaorg#743
part of celestiaorg#650 


[rendered](https://github.com/celestiaorg/celestia-app/blob/b44960898f59ea3ed86430828606cdc72107a0be/specs/src/specs/block_validity_rules.md)

## Checklist

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

---------

Co-authored-by: Callum Waters <[email protected]>
Co-authored-by: Rootul P <[email protected]>
Co-authored-by: Sanaz Taheri <[email protected]>
mergify bot pushed a commit that referenced this issue Aug 30, 2023
@evan-forbes @mergify
docs: add block validity rules specs (#1966)
fed7d25 
## Overview

Figured we could at least use this as a place holder as a high level
summary of celestia-app, and to point to all the other portions of the
application.

part of and closes
#743
part of #650

[rendered](https://github.com/celestiaorg/celestia-app/blob/b44960898f59ea3ed86430828606cdc72107a0be/specs/src/specs/block_validity_rules.md)

## Checklist

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

---------

Co-authored-by: Callum Waters <[email protected]>
Co-authored-by: Rootul P <[email protected]>
Co-authored-by: Sanaz Taheri <[email protected]>
(cherry picked from commit 5bcf4ad)
@evan-forbes
Copy link
Member Author

are there still issues that we think are worth blocking here or can we finally close this issue?

imo I think if we want to do another round of spec refactors/updates/additions we should reevaluate and create another epic

I'll close this issue without further feedback at the end of the week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rootulp rootulp

@cmwaters cmwaters

@staheri14 staheri14

@rach-id rach-id

@evan-forbes evan-forbes

Labels
epic item groups other items for easier tracking specs directly relevant to the specs
Projects
Engineering Team Epics
Status: Done
Core / App Epics
Status: Done
Milestone
No milestone
Development

No branches or pull requests
6 participants
@adlerjohn @rootulp @cmwaters @staheri14 @rach-id @evan-forbes