Skip to content

Technical-AIP-Template.md

Latest commit

 

History

History
62 lines (42 loc) · 2.55 KB

Technical-AIP-Template.md

File metadata and controls

62 lines (42 loc) · 2.55 KB
Raw

Technical AIP Template

Preamble

AIP#: <# to be assigned>
Title: <AIP title>
Author(s): <List of authors' names and/or email addresses and GitHub handles>
Contributors: <List of contributor's names and/or email addresses and GitHub handles>
Tags: template
Category: Binding (Executable Purely On-Chain) vs. Signaling (Non-Binding Social Consensus Signal)
Status: <Assigned by AIP Editor>
Date Proposed: <yyyy-mm-dd>
Date Ratified: <yyyy-mm-dd>
Dependencies: <List of dependent AIPs>
Replaces: <List of AIP it is replacing>
License: <Sdded by AIP Author>

References

  • A list of supporting materials referenced by this AIP.

Summary

  • A short description of what the Astroport Improvement Proposal (AIP) is focused on. Suggest 30 words max.

Abstract

  • A 3-5 sentence description of the full AIP going through the problem it solves, how it's solved and who will and how it will be implemented.

Motivation

  • A short description of the motivation behind the AIP.

Specification

  • Proposed process standard details - describes the new process or feature and the problem it is solving.

Proposed Code

  • The final code that can be used directly in the Assembly vote to accept or reject the AIP.

Test Cases

  • For the implementation or testing of the proposed code

Security Considerations

  • This is one of the most important aspects of the Technical AIP proposal. The purpose of this section is to proactively document any security-relevant design information, decisions, potential failure modes, implementation details, and important discussions related to the proposed change. This section helps to optimize the AIP process by providing proactive guidance on security considerations when proposing a change that will affect the Astroport Protocol.

Auditor Information and Report

  • This section includes the audit partner details and the final audit report for the proposed code.

Licensing