| rpip | title | description | author | discussions-to | status | type | category (*only required for Protocol ) | created | requires (*optional) |
|---|---|---|---|---|---|---|---|---|---|
<The RPIP title is a few words, not a complete sentence> |
<Description is one full (short) sentence> |
<a comma separated list of the author's or authors' name + GitHub username (in parenthesis), or name and email (in angle brackets). Example, FirstName LastName (@GitHubUsername), FirstName LastName <[email protected]>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)> |
<URL> |
Draft |
<Protocol, Meta, or Informational> |
<Core or RPRC> |
<date created on, in ISO 8601 (yyyy-mm-dd) format> |
<RPIP number(s)> |
This is the suggested template for new RPIPs.
Note that an RPIP number will be assigned by an editor. When opening a pull request to submit your RPIP, please use an abbreviated title in the filename, rpip-draft_title_abbrev.md.
The title should be 44 characters or less. It should not repeat the RPIP number in title, irrespective of the category.
Abstract is a multi-sentence (short paragraph) technical summary. This should be a very terse and human-readable version of the specification section. Someone should be able to read only the abstract to get the gist of what this specification does.
The motivation section should describe the "why" of this RPIP. What problem does it solve? Why should someone want to implement this standard? What benefit does it provide to the Ethereum ecosystem? What use cases does this RPIP address?
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
The technical specification should describe the syntax and semantics of any new feature.
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.
All RPIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The RPIP must explain how the author proposes to deal with these incompatibilities. RPIP submissions without a sufficient backwards compatibility treatise may be rejected outright.
Test cases for an implementation are mandatory for RPIPs that are affecting protocol changes. If the test suite is too large to reasonably be included inline, then consider adding it as one or more files in ../assets/rpip-####/.
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in ../assets/rpip-####/.
All RPIPs must contain a section that discusses the security implications/considerations relevant to the proposed change. Include information that might be important for security discussions, surfaces risks and can be used throughout the life cycle of the proposal. E.g. include security-relevant design decisions, concerns, important discussions, implementation-specific guidance and pitfalls, an outline of threats and risks and how they are being addressed. RPIP submissions missing the "Security Considerations" section will be rejected. An RPIP cannot proceed to status "Final" without a Security Considerations discussion deemed sufficient by the reviewers.
Copyright and related rights waived via CC0.
LaTeX rendering between github and the rpips portal at rpips.rocketpool.net can differ. The following recommendations are made so that your equations will appear correctly on both:
LaTeX blocks should be delimted using the below. This should display similarly on both github and the rpips portal.
Inline LaTeX is buggy on the portal, and should be avoided. $ LaTeX goes here $ dollar-sign delimiters will work in some simple cases, but not universally.
Note that the