specs/README.md

39 lines
1.8 KiB
Markdown
Raw Normal View History

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
2019-07-12 03:17:30 +00:00
## Current state
2019-04-15 05:07:19 +00:00
2019-08-27 12:42:02 +00:00
As of August 2019, we are currently in the process of documenting current
2019-07-12 03:17:30 +00:00
specifications. We are als implementing an isolated reference library for them.
These specifications are expected to be frozen at the Status V1 launch and be
used as a reference point for client implementers and security audits.
## Status Improvement Proposals (SIPs)
### Accepted
2019-04-15 05:07:19 +00:00
No accepted SIPs right now.
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
2019-09-18 09:22:14 +00:00
- [Status Client Specification](status-client-spec.md). The main specification for writing a Status client. **Start here**
2019-08-29 12:42:28 +00:00
- [Status Secure Transport Specification](status-secure-transport-spec.md). How Status provide a secure transport with conversational security properties.
2019-08-28 15:09:29 +00:00
- [Status Payload Specification](status-payloads-spec.md). What the message payloads look like.
- [Status Account Specification](status-account-spec.md). What a Status account is and how trust is established.
- [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.
2019-08-29 12:45:59 +00:00
- [Status Whisper Mailserver Specification](status-whisper-mailserver-spec.md). How we use Whisper mailservers to provide offline inboxing.
2019-11-27 05:54:04 +00:00
- [Status EIPs Standards](status-EIPs.md). Ethereum Improvement Proposals used in Status.
2019-04-22 04:06:36 +00:00
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).