specs/README.md

66 lines
2.4 KiB
Markdown
Raw Normal View History

2020-03-30 05:35:23 +00:00
---
layout: default
permalink: /
nav_exclude: true
---
2019-04-15 05:07:19 +00:00
# Specifications for Status clients
2019-03-25 04:33:20 +00:00
2019-07-12 03:17:30 +00:00
This repository contains a list of specifications for implementing Status and
its various capabilities.
2019-04-15 05:07:19 +00:00
2020-03-24 06:11:07 +00:00
## Spec lifecycle
2019-04-15 05:07:19 +00:00
2020-03-24 06:11:07 +00:00
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)
2019-07-12 03:17:30 +00:00
## Status Improvement Proposals (SIPs)
2020-03-24 06:11:07 +00:00
### Stable
2019-04-15 05:07:19 +00:00
2020-03-24 06:25:08 +00:00
The following SIPs are stable and running in production.
2020-03-27 07:27:24 +00:00
- [Status Client Specification](status-client-spec.md). The main specification for writing a Status client. **Start here**
2019-04-15 05:07:19 +00:00
2020-03-24 08:02:30 +00:00
- [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.
2020-03-24 06:49:53 +00:00
- [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.
2020-03-24 07:51:23 +00:00
- [Status Account Specification](status-account-spec.md). What a Status account is and how trust is established.
2020-03-24 08:05:35 +00:00
- [Status Payload Specification](status-payloads-spec.md). What the message payloads look like.
2020-03-27 07:27:24 +00:00
- [Status EIPs Standards](status-EIPs.md). Ethereum Improvement Proposals used in Status.
2020-03-24 08:08:06 +00:00
2019-07-12 03:17:30 +00:00
### Draft
2019-04-15 05:07:19 +00:00
2019-07-12 03:17:30 +00:00
The following SIPs are under consideration for standardization.
2019-04-15 05:07:19 +00:00
2020-03-24 06:11:07 +00:00
### 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.
2020-03-24 06:11:07 +00:00
### Deprecated
No deprecated specs right now.
2019-07-12 03:17:30 +00:00
## Protocol Research
2019-04-25 03:58:22 +00:00
2019-07-12 03:17:30 +00:00
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.
2019-04-22 04:43:13 +00:00
2019-08-14 13:28:30 +00:00
To see more on this, please visit the current home: [vac
protocol](https://specs.vac.dev).