Beam Documentation
WebsiteDownloadSupportCode
Search…
Beam Documentation
User Guides
Desktop Wallet
Mobile Wallet
Atomic Swaps
Mining Beam
DAppnet User Guide
Web Wallet (Masternet)
Overview
Beam Token Economics
BeamX Token Economics
Governance Evolution
BeamX DAO: Governance Framework
Technical BIP Template
General BIP Template
Resources
FAQ
Glossary
Blockchain Explorer
Developer Resources
Developer Docs
Beam Github
Beam Node User Guide
CLI Wallet User Guide
Beam Wallet API
Powered By GitBook
Technical BIP Template

Preamble

BIP#: <# to be assigned>
Title: <BIP 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
Type: BIP Type
Status: <Assigned by BIP Facilitator>
Date Proposed: <yyyy-mm-dd>
Date Ratified:<yyyy-mm-dd>
Dependencies: <List of dependent BIPs>
Replaces: <List of BIP it is replacing>
License: <added by BIP Author>
​

References

  • A list of supporting materials referenced by this BIP.

Sentence Summary

  • A description of what the Beam Improvement Proposal (BIP) is focused on. Suggest 30 words max.

Paragraph Summary

  • A description of what the Beam Improvement Proposal (BIP) is focused on. Suggest 100 words max.

Component Summary

  • A description of the purpose of each component in the BIP. Suggest 30 words max per component.

Motivation

  • A short description of the motivation behind the BIP.

Specification / Proposal Details

The details of the proposed technical solution. The specification should be detailed enough to allow an implementation team to begin development as well as testing. The specification for technical BIPs must include the following components:

Proposed Code

The final code that can be used directly in the executive vote to accept or reject the BIP.

Test Cases

For the implementation or testing of the proposed code
​

Security Considerations

  • This is one of the most important aspects of the Technical BIP 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 BIP process by providing proactive guidance on security considerations when proposing a change that will affect the Beam network.
  • Backwards compatibility

Auditor Information and Report

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

Licensing

Recommended licenses for developed code:
Overview - Previous
BeamX DAO: Governance Framework
Next - Overview
General BIP Template
Last modified 3mo ago
Copy link
Outline
Preamble
References
Sentence Summary
Paragraph Summary
Component Summary
Motivation
Specification / Proposal Details
Proposed Code
Test Cases
Security Considerations
Auditor Information and Report
Licensing