Search…
πŸ“ƒ
Advanced Template
Copy our advanced template - it will make your day much easier.
​Google Doc Template - copy to your own .doc for easier drafting
SWIP Title: [SWIP title] Author(s): [a list of author(s) names, usernames] Created: [date created]

Summary

Simply describe the proposed change and what it intends to achieve. This should be non-technical and as accessible as possible to a casual community member or layman.

Abstract

A short (~200 word) description of the proposed change, the abstract should clearly describe the proposed change. This is what will be done if the SWIP is implemented, not why it should be done or how it will be done. If the SWIP proposes deploying a new contract, write, "we propose to deploy a new contract that will do x".

Motivation

This is the problem statement. This is the why of the SWIP. It should clearly explain why the current state of the protocol is inadequate. It is critical that you explain why the change is needed, if the SWIP proposes changing how something is calculated, you must address why the current calculation is inaccurate or wrong. This is not the place to describe how the SWIP will address the issue!

Specification

Overview

This is a high-level overview of how the SWIP will solve the problem. The overview should clearly describe how the new feature will be implemented.

Rationale

This is where you explain the reasoning behind how you propose to solve the problem. Why did you propose to implement the change in this way, what were the considerations and trade-offs? The rationale fleshes out what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during the discussion.

Technical Specification

The technical specification should outline the public API of the changes proposed. That is, changes to any of the interfaces of the SWIP currently exposes or the creations of new ones.

Test Cases

Test cases for implementation are mandatory for SWIP but can be included with the implementation.