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

[META] Make the Raiden Spec Alderaan Release Ready #252

Closed
21 tasks done
Dominik1999 opened this issue Sep 3, 2019 · 5 comments
Closed
21 tasks done

[META] Make the Raiden Spec Alderaan Release Ready #252

Dominik1999 opened this issue Sep 3, 2019 · 5 comments
Assignees
Milestone

Comments

@Dominik1999
Copy link
Contributor

Dominik1999 commented Sep 3, 2019

Get to a spec to be up-to-date with Alderaan

When we Release Alderaan on Mainnet we need a Raiden Spec, that is

  • up to date, i.e. every information is correct according to the current code base of the Raiden Client, the Raiden Services and the Raiden Contracts
  • a good read, i.e. we have examples of the data structure and the code that is used

Therefore, we need to make sure, that every chapter contains the correct information.

Overall:

  • make the table of contents consistent
  • start every chapter with an overview like in "Smart Contracts for Raiden Services", i.e. start with a general explanation and the goal
  • ensure that every chapter has a consistent structure (start with overview or summary, then continue with ...)

Raiden Message Specification

  • Raiden Message Specification has the correct data fields and tables, see e.g.Bring "Messages" section in spec up to date #327
  • Raiden Message Specification has correct, consistent and easy to read descriptions and definitions
  • Raiden Message Specification has a consistent example for the messages

Raiden Transport

Raiden Network Smart Contracts Specification

Smart Contracts for Raiden Services

Raiden Monitoring Service

  • Make sure Raiden Monitoring Service has the correct information, data fields and tables (coordinate with @palango )

Raiden Pathfinding Service

Mediation fees

Raiden Mobile Wallet Specification

  • Find out who is responsible for that chapter
  • Delete chapter, since it is not longer maintained

Raiden Terminology

  • Make sure Raiden Terminology has the correct information, data fields and tables (coordinate with)
  • Delete every term from Raiden Terminology that is not used
@pirapira
Copy link
Contributor

pirapira commented Sep 3, 2019

@jomuel
Copy link
Contributor

jomuel commented Sep 4, 2019

@pirapira do you want to do this together with the other contract spec issues?

@pirapira
Copy link
Contributor

pirapira commented Sep 4, 2019

Yep.

@Dominik1999
Copy link
Contributor Author

@jomuel thank you for taking care of this. What is missing here? Can you try to update and check the tick boxes?

@jomuel
Copy link
Contributor

jomuel commented Sep 26, 2019

Note on the Terminology section: Some terms that are not used in the spec, but common and useful, have been left in it. It is meant to be a glossary for the project after all, not just footnotes for the spec.

@Dominik1999 Dominik1999 added this to the Alderaan milestone Mar 25, 2020
@Dominik1999 Dominik1999 removed this from the Alderaan milestone Mar 25, 2020
@Dominik1999 Dominik1999 assigned Dominik1999 and unassigned jomuel and Dominik1999 Mar 25, 2020
@palango palango added this to the Alderaan milestone Mar 27, 2020
@Dominik1999 Dominik1999 changed the title Make the Raiden Spec Alderaan Release Ready [META] Make the Raiden Spec Alderaan Release Ready May 19, 2020
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

No branches or pull requests

5 participants