mirror of https://github.com/status-im/specs.git
60 lines
2.3 KiB
Markdown
60 lines
2.3 KiB
Markdown
# Specifications for Status clients
|
|
|
|
This repository contains a list of specifications for implementing Status and
|
|
its various capabilities.
|
|
|
|
## Spec lifecycle
|
|
|
|
Every spec has its own lifecycle that shows its maturity. We indicate this in a similar fashion to [COSS Lifecycle](https://rfc.unprotocols.org/spec:2/COSS/):
|
|
|
|
![](assets/lifecycle.png)
|
|
|
|
## Status Improvement Proposals (SIPs)
|
|
|
|
### Stable
|
|
|
|
The following SIPs are stable and running in production.
|
|
|
|
|
|
- [Status Client Specification](status-client-spec.md). The main specification for writing a Status client. **Start here**
|
|
|
|
- [Status Secure Transport Specification](status-secure-transport-spec.md). How Status provide a secure transport with conversational security properties.
|
|
|
|
- [Status Whisper Mailserver Specification](status-whisper-mailserver-spec.md). How we use Whisper mailservers to provide offline inboxing.
|
|
|
|
- [Status EIPs Standards](status-EIPs.md). Ethereum Improvement Proposals used in Status.
|
|
|
|
- [Status Whisper Usage Specification](status-whisper-usage-spec.md). How we use Whisper to do routing, metadata protection and provide 1:1/group/public chat.
|
|
|
|
- [Status Account Specification](status-account-spec.md). What a Status account is and how trust is established.
|
|
|
|
- [Status Payload Specification](status-payloads-spec.md). What the message payloads look like.
|
|
|
|
- [Status EIPs Standards](status-EIPs.md). Ethereum Improvement Proposals used in Status.
|
|
|
|
### Draft
|
|
|
|
The following SIPs are under consideration for standardization.
|
|
|
|
### Raw
|
|
|
|
These parts are currently underspecified:
|
|
|
|
- [Status Blockchain Usage Specification](./status-blockchain-spec.md). How we use the Ethereum blockchain to facilitate the Web3 Browser and Wallet functionality
|
|
- [Status Storage Usage Specification](./status-storage-spec.md). How we use decentralized storage solutions to facilitate various Status features.
|
|
- [Status Browser Specification](./status-browser-spec.md). How the Status client interacts with both Web3 and Web2.
|
|
|
|
|
|
### Deprecated
|
|
|
|
No deprecated specs right now.
|
|
|
|
## Protocol Research
|
|
|
|
These are protocols that are currently being researched. These are designed to
|
|
be useful outside of Status as well. To the extent that these protocols are used
|
|
within Status clients, they will show up as SIPs in the future.
|
|
|
|
To see more on this, please visit the current home: [vac
|
|
protocol](https://specs.vac.dev).
|