Skip to main content

Template (PIP)

Easy copy pasting through HackMD markdown document: https://hackmd.io/@kngo/B1qLASdDt

PIP Number: [to be assigned]
Title: [PIP title]
Status: [WIP, Proposed]
Author(s): [a list of author(s) names, usernames]
Discussions-to: [Create a new thread on https://forum.polywrap.io and drop the link here]
Created: [date created on]
Requires (optional): [PIP number(s)]
Implementation (optional): [Added if PIP passes]
โ€Œ

Simple Summary#

โ€Œ "If you can't explain it simply, you don't understand it well enough." Simply describe the outcome the proposed change intends to achieve. This should be non-technical and accessible to a casual community member. โ€Œ

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 PIP is implemented, not why it should be done or how it will be done. If the PIP 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 IP. 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 PIP proposes changing how something is calculated, you must address why the current calculation is innaccurate or wrong. This is not the place to describe how the PIP will address the issue! โ€Œ

Specification#

Overview#

โ€Œ This is a high level overview of how the PIP 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 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 Polywrap DAO currently exposes or the creations of new ones. โ€Œ

Test Cases#

โ€Œ Test cases for an implementation are mandatory for PIPs but can be included with the implementation. โ€Œ

Copyright#

โ€Œ Copyright and related rights waived via CC0.