Nervos Network RFCs

Nervos Network RFCs

Telegram Group

This repository contains proposals, standards and documentations related to Nervos Network.

The RFC (Request for Comments) process is intended to provide an open and community driven path for new protocols, improvements and best practices, so that all stakeholders can be confident about the direction of Nervos network is evolving in.

RFCs publication here does not make it formally accepted standard until its status becomes Standard.

Categories

Not all RFCs are standards, there are 2 categories:

  • Standards Track - RFC that is intended to be standard followed by protocols, clients and applications in Nervos network.
  • Informational - Anything related to Nervos network.

RFCs

NumberTitleAuthorCategoryStatus
1The Nervos Network Positioning PaperThe Nervos TeamInformationalDraft
2Nervos CKB: A Common Knowledge Base for Crypto-EconomyJan XieInformationalDraft
3CKB-VMXuejie XiaoInformationalDraft
4CKB Block Synchronization ProtocolIan YangStandards TrackProposal
5Privileged architecture support for CKB VMXuejie XiaoInformationalDraft
6Merkle Tree for Static DataKe WangStandards TrackProposal
7P2P Scoring System And Network SecurityJinyang JiangStandards TrackProposal
8SerializationBoyu YangStandards TrackProposal
9VM SyscallsXuejie XiaoStandards TrackProposal
10Eaglesong (Proof-of-Work Function for Nervos CKB)Alan SzepieniecStandards TrackProposal
11Transaction FilterQuake WangStandards TrackProposal
12Node DiscoveryLinfeng Qian, Jinyang JiangStandards TrackProposal
13Block TemplateDingwei ZhangStandards TrackProposal
14VM Cycle LimitsXuejie XiaoStandards TrackProposal
15Crypto-Economics of the Nervos Common Knowledge BaseKevin Wang, Jan Xie, Jiasun Li, David ZouInformationalDraft
17Transaction valid sinceJinyang JiangStandards TrackProposal
19Data StructuresXuejie XiaoInformationalDraft
20CKB Consensus ProtocolRen ZhangInformationalDraft
21CKB Address FormatCipher WangStandards TrackProposal
22CKB Transaction StructureIan YangInformationalDraft
23Deposit and Withdraw in Nervos DAOJan Xie, Xuejie Xiao, Ian YangStandards TrackProposal
24CKB System Script ListDylan DuanInformationalDraft
25Simple UDTXuejie XiaoStandards TrackProposal
26Anyone-Can-Pay LockXuejie XiaoStandards TrackProposal

Process

The RFC process attempts to be as simple as possible at beginning and evolves with the network.

1. Discuss Your Idea with Community

Before submiting a RFC pull request, you should proposal the idea or document to Nervos RFCs Chatroom or Nervos RFCs Mailing List.

2. Propose Your RFC

After discussion, please create a pull request to propose your RFC:

Copy 0000-template as rfcs/0000-feature-name, where feature-name is the descriptive name of the RFC. Don't assign an number yet.

Nervos RFCs should be written in English, but translated versions can be provided to help understanding. English version is the canonical version, check english version when there's ambiguity.

Nervos RFCs should follow the keyword conventions defined in RFC 2119, RFC 6919.

3. Review / Accept

The maintainers of RFCs and the community will review the PR, and you can update the RFC according to comments left in PR. When the RFC is ready and has enough supports, it will be accepted and merged into this repository.

An Informational RFC will be in Draft status once merged and published. It can be made Final by author at any time, or by RFC maintainers if there's no updates to the draft in 12 months.

4. (Standards Track) Propose Your Standard

A Standards Track RFC can be in 1 of 3 statuses:

  1. Proposal (Default)
  2. Standard
  3. Obsolete

A Standards Track RFC will be in Proposal status intially, it can always be updated and improved by PRs. When you believe it's rigorous and mature enough after more discussions, you should create a PR to propose making it a Standard.

The maintainers of RFCs will review the proposal, ask if there's any objections, and discuss about the PR. The PR will be accepted or closed based on rough consensus in this early stage.

License

This repository is being licensed under terms of MIT license.