| rskip | title | description | status | purpose | author | layer | complexity | created |
|---|---|---|---|---|---|---|---|---|
0 |
RSKIP Purpose and Guidelines |
A RSKIP is a design document providing information to the RSK community describing a new feature for RSK, its processes, or its environment. |
Purpose and Guidelines |
Sec |
JL (@julianlen) |
Misc |
2 |
2021-04-15 |
| RSKIP | 0 |
|---|---|
| Title | RSKIP Purpose and Guidelines |
| Created | 15-APR-2021 |
| Author | JL |
| Purpose | Sec |
| Layer | Misc |
| Complexity | 2 |
| Status | Active |
RSKIP stands for RSK Improvement Proposal. A RSKIP is a design document providing information to the RSK community describing a new feature for RSK, its processes, or its environment. The RSKIP should provide a concise technical specification of the feature and a rationale for the feature. The RSKIP author is responsible for building consensus within the community and documenting dissenting opinions.
We intend RSKIPs to be the primary mechanism for proposing new features, collecting community input on an issue, and for documenting the design decisions that have gone into RSK. Because the RSKIPs are maintained as text files in a versioned repository, their revision history is the historical record of the feature proposal.
For RSK implementers, RSKIPs are a convenient way to track the progress and compatibility of their implementation. Ideally, each implementation maintainer would list the RSKIPs that they have implemented. This will give end users a convenient way to know the current status of a given implementation or library.
There are three types of RSKIP:
- A Standards Track RSKIP describes any change that affects most or all RSK implementation. This can be a change to a network protocol, a change in block or transaction validity rules, or any change or addition that affects the interoperability of applications using RSK. Furthermore, Standards Track RSKIPs can be broken down into the following categories.
- CORE - Consensus related
- Node - Related to node manager interfaces, such as RPC
- Net - Related to p2p networking
- UI - User Interface
- 2nd - 2nd layer protocols, such as off-chain payment channels
- DApp - Dapp application interfaces
- An Informational RSKIP describes an RSK design issue, or provides general guidelines or information to the RSK community, but does not propose a new feature. Informational RSKIPs do not necessarily represent an RSK community consensus or recommendation, so users and implementers are free to ignore Informational RSKIPs or follow their advice.
- A Process RSKIP describes a process surrounding RSK or proposes a change to (or an event in) a process. Process RSKIPs are like Standards-Track RSKIPs but they apply to areas other than the RSK protocol itself. They may propose an implementation, but not to RSK's codebase; they often require community consensus. Unlike Informational RSKIPs, they are more than recommendations, and users are typically not free to ignore them. Examples include procedures, guidelines, changes to the decision-making process, and changes to the tools or environment used in RSK development.
Describes what aspects of RSK will improve
- Sca - an RSKIP that improves scalability
- Usa - an RSKIP that improves usability
- Fair - an RSKIP that improves fairness
- Sec - an RSKIP that improves security
A RSKIP can include more than one purpose term
Describes the complexity of the improvement with one of the following levels
- 1 - Minimal
- 2 - Medium
- 3 - High
The RSKIP repository Editors change the RSKIPs status. Please publish all RSKIP-related in the forum and tag the RSKIP Editors, which is listed under RSKIP Editors below. Also, see RSKIP Editor Responsibilities & Workflow.
The RSKIP process begins with a new idea for RSK. It is highly recommended that a single RSKIP contain a single key proposal or new idea. The more focused the RSKIP, the more successful it tends to be. A change to one client doesn't require a RSKIP; a change that affects multiple clients, or defines a standard for multiple apps to use, does. The RSKIP editors reserve the right to reject RSKIP proposals if they appear too unfocused or too broad. When in doubt, split your RSKIP into several well-focused ones.
Each RSKIP must have a champion -- someone who writes the RSKIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The RSKIP champion should first attempt to ascertain whether the idea is RSKIP-able.
Vetting an idea publicly before going as far as writing a RSKIP is meant to save the potential author time. Asking the RSK community first if an idea is original, helps to prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions. It also helps to make sure the idea applies to the entire community and not just the author. It is highly recommended to open a discussion thread on the RSK Research and Innovation Forum. Another appropriate public channel to gauge interest around your RSKIP could be on the Issues section of this repository.
Reviewers and commenters are expected to provide thoughtful and actionable feedback. Summary rejections without justification are unhelpful. When possible, reviewers should point out possible paths the authors can take which could lead to eventual acceptance. Responses should be posted in the same channel as the proposal or in others with similar exposure.
Once the champion has asked the RSK community whether an idea has any chance of acceptance a draft RSKIP should be presented as a pull request (PR). This gives the author a chance to continuously edit the draft RSKIP for proper formatting and quality. This also allows for further public comments and the author of the RSKIP to address the proposal’s concerns.
If RSKIP editors approve, the issuer of the RSKIP must assign the PR number to the RSKIP, renaming it. Then label it as Standard Track, Informational, or Process, and give it the status "Draft". The editors will put what complexity level the RSKIP has, what kind of improvement it is, and then add it to the main git repository. The RSKIP editors will not deny RSKIP status without reason. Reasons for denying RSKIP status include duplication of effort, being technically unsound, not providing proper motivation, or addressing backward compatibility.
The RSKIP author may update the Draft as necessary in the git repository. Updates to drafts may also be submitted by the author as pull requests.
Standards Track RSKIPs consist of three parts, a design document, a reference implementation, and (if warranted) an update to the formal specification. The RSKIP should be reviewed and accepted before its integration begins, a reference implementation will aid people in studying the RSKIP.
Standards Track RSKIPs must include an implementation -- in the form of code, a patch, or an URL to the same -- before it can be considered an Accepted or Pending Fork.
For a RSKIP to be "Accepted" it must meet certain minimum criteria. It must be a clear and complete description of the proposed enhancement. The enhancement must represent a net improvement. The proposed implementation, if applicable, must be solid and must not complicate the protocol unduly. Once a RSKIP has been Accepted, the implementations must be completed. When the implementation is completed and accepted by the community, the status will be changed to “Pending Fork'' if necessary for a hard or soft fork, and Active if not.
A RSKIP can also be assigned the status “Deferred”. The RSKIP's author or editor can assign the RSKIP this status when no progress is being made on it. Once a RSKIP is deferred, its editor can re-assign it to have “Draft” status. An RSKIP that is not being considered for immediate adoption in the reference client may be reconsidered in the future for a subsequent release of the reference client.
A RSKIP Author(s) can withdrawn the proposed RSKIP. This state means finality and the RSKIP can no longer be resurrected using its number. If the idea is pursued at later date it is considered a new proposal.
A RSKIP can also be “Rejected”. Perhaps, after all, it was not a good idea. It is still important to have a record of this fact.
RSKIPs can also be superseded by a different RSKIP, rendering the original obsolete.
The possible paths of the status of RSKIPs are as follows:
Each RSKIP should have the following parts:
- Preamble -- RFC 822 style headers containing meta-data about the RSKIP, including the RSKIP number, a short descriptive title (limited to a maximum of 44 characters), the names, and optionally the contact info for each author, etc.
- Abstract -- a short (~200 word) description of the technical issue being addressed.
- Motivation -- Motivation is critical for RSKIPs that want to change the RSK protocol. It should clearly explain why the existing protocol specification is inadequate to address the problem that the RSKIP solves. RSKIP submissions without sufficient motivation may be rejected outright.
- Specification -- The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow competing, interoperable implementations for any of the current RSK platforms.
- Rationale -- The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages. The rationale should provide evidence of consensus within the community and discuss important objections or concerns raised during the discussion.
- Backward Compatibility -- All RSKIPs that introduce backward incompatibilities must include a section describing these incompatibilities and their severity. The RSKIP must explain how the author proposes to deal with these incompatibilities. RSKIP submissions without a sufficient backward compatibility treatise may be rejected outright.
- Implementations - The implementations must be completed before any RSKIP is given the status “Final”, but it need not be completed before the RSKIP is accepted. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of “rough consensus and running code” is still useful when it comes to resolving many discussions of API details.
- Test Cases - Test cases for implementation are mandatory for RSKIPs that are affecting consensus changes. Other RSKIPs can choose to include links to test cases if applicable.
- Copyright Waiver - All RSKIPs must be in the public domain. See the bottom of this RSKIP for an example copyright waiver.
- The final implementation must include test code and documentation appropriate for the RSK protocol.
RSKIPs should be written in markdown format. Here is a template to follow. Image files should be included in a subdirectory for that RSKIP.
Each RSKIP must begin with an RFC 822 style header preamble, preceded and followed by three hyphens (---). This header is also termed “front matter” by Jekyll. The headers must appear in the following order. Headers marked with "*" are optional and are described below. All other headers are required.
* RSKIP: RSKIP number (determined by the RSKIP editor)
* Title: RSKIP title
* Author: list of author's real names and optionally, email address or github user
* Discussions-To: email address, url to forum posts
* Status: <Draft | Active | Accepted | Deferred | Rejected | Withdrawn | Adopted | Superseded>
* Type: <Standards Track | Informational | Process>
* Created: date created on, in ISO 8601 (yyyy-mm-dd) format
* Replaces: RSKIP number
* Superseded-By: RSKIP number
* Resolution: url
The Author header lists the names, and optionally the email addresses of all the authors/owners of the RSKIP. The format of the Author header value must be
Random J. User [email protected] if the email address is included, and just
Random J. User if the address is not given.
If there are multiple authors, each should be on a separate line following RFC 2822 continuation line conventions.
Note: The Resolution header is required for Standards Track RSKIPs only. It contains a URL that should point to an email message or other web resource where the pronouncement about the RSKIP is made.
While a RSKIP is in private discussions (usually during the initial Draft phase), a Discussions-To header will indicate the mailing list or URL where the RSKIP is being discussed. No Discussions-To header is necessary if the RSKIP is being discussed privately with the author or on the RSK forum.
The Type header specifies the type of RSKIP: Standards Track, Informational, or Process. If the track is Standard please include the subcategory (core, networking, interface, etc).
The Created header records the date that the RSKIP was assigned a number, while Post-History is used to record the dates of when new versions of the RSKIP are posted to the Research and Innovation Forum. Both headers should be in yyyy-mm-dd format, e.g. 1994-08-12.
RSKIPs may have a Requires header, indicating the RSKIP numbers that this RSKIP depends on.
RSKIPs may also have a Superseded-By header indicating that a RSKIP has been rendered obsolete by a later document; the value is the number of the RSKIP that replaces the current document. The newer RSKIP must have a Replaces header containing the number of the RSKIP that it rendered obsolete.
RSKIPs may include auxiliary files such as diagrams. Such files must be named RSKIP-XXXX-Y.ext, where "XXXX" is the RSKIP number, "Y" is a serial number (starting at 1), and "ext" is replaced by the actual file extension (e.g. "png").
It occasionally becomes necessary to transfer ownership of RSKIPs to a new champion. In general, we'd like to retain the original author as a co-author of the transferred RSKIP, but that's really up to the original author. A good reason to transfer ownership would be that the original author no longer has the time or interest in updating it or following through with the RSKIP process, or has fallen off the face of the net (i.e. is unreachable or not responding to the forum). A bad reason to transfer ownership is due to not agreeing with the direction of the RSKIP. We try to build consensus around a RSKIP, but if that's not possible, you can always submit a competing RSKIP.
If you are interested in assuming ownership of a RSKIP, send a message asking to take over, addressed to both the original author and the RSKIP editor. If the original author doesn't respond promptly, the RSKIP editor will make a unilateral decision (it's not like such decisions can't be reversed).
* Sergio Lerner (@sergioLerner)
* Julian Len (@julianlen)
* Diego Masini (@diegomasini)
* Shreemoy Mishra (@smishraIOV)
* Javier Alvarez Cid-Fuentes (@javicid)
* Raul Laprida (@raullaprida)
For each new RSKIP that comes in, an editor does the following:
- Read the RSKIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to be accepted.
- The title should accurately describe the content.
- Edit the RSKIP for language (spelling, grammar, sentence structure, etc.), markup, code style. If the RSKIP isn't ready, the editor will send it back to the author for revision, with specific instructions.
Once the RSKIP is ready for the repository, the RSKIP editor will:
- Read the RSKIP to check if it is ready: sound and complete. The ideas must make technical sense, even if they don't seem likely to be accepted.
- The title should accurately describe the content.
- Edit the RSKIP for language (spelling, grammar, sentence structure, etc.), markup, code style. If the RSKIP isn't ready, the editor will send it back to the author for revision, with specific instructions.
- Once the RSKIP is ready for the repository, the RSKIP editor will:
- Add the RSKIP to the RSKIP’s repository on GitHub.
- List the RSKIP in README.md
- Send a message back to the RSKIP author with the next step.
- Many RSKIPs are written and maintained by developers with write access to the RSK codebase. The RSKIP editors monitor RSKIP changes and correct any structure, grammar, spelling, or markup mistakes we see.
The editors don't pass judgment on RSKIPs. We merely do the administrative & editorial part.
This document was derived heavily from Ethereum's EIP-1 written by Martin Becze and from Bitcoin's BIP-0001 written by Amir Taaki which in turn was derived from Python's PEP-0001. In many places, text was simply copied and modified. Although the PEP-0001 text was written by Barry Warsaw, Jeremy Hylton, and David Goodger, they are not responsible for its use in the RSK Improvement Process, and should not be bothered with technical questions specific to RSK or the RSKIP. Please direct all comments to the RSKIP editors.
Copyright and related rights waived via CC0.