status-im/specs
2
0
Fork 0
mirror of https://github.com/status-im/specs.git synced 2025-01-12 23:24:30 +00:00
Code Issues Projects Releases Wiki Activity

Add link to superscripts (#157)

Browse Source
This commit is contained in:
Franck Royer 2021-10-11 12:04:26 +11:00 committed by GitHub
parent 3fdb5148f4
commit 06db81da79
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/stable/1-client.md
View File

@ -17,8 +17,8 @@ title: 1/CLIENT
This specification describes how to write a Status client for This specification describes how to write a Status client for
communicating with other Status clients. communicating with other Status clients.
This specification presents a reference implementation of the protocol <sup>1</sup> that is used This specification presents a reference implementation of the protocol <sup>[1](#footnotes)</sup> that is used
in a command line client <sup>2</sup> and a mobile app <sup>3</sup>. in a command line client <sup>[2](#footnotes)</sup> and a mobile app <sup>[3](#footnotes)</sup>.
This document consists of two parts. The first outlines the specifications that This document consists of two parts. The first outlines the specifications that
have to be implemented in order to be a full Status client. The second gives a design rationale and answers some common questions. have to be implemented in order to be a full Status client. The second gives a design rationale and answers some common questions.

4
docs/stable/10-waku-usage.md
View File

@ -151,7 +151,7 @@ Contact code topic MUST be created following the algorithm below:
```golang ```golang
contactCode := "0x" + hexEncode(activePublicKey) + "-contact-code" contactCode := "0x" + hexEncode(activePublicKey) + "-contact-code"
var hash []byte = keccak256(name) var hash []byte = keccak256(contactCode)
var topicLen int = 4 var topicLen int = 4
if len(hash) < topicLen { if len(hash) < topicLen {
@ -359,4 +359,4 @@ Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad4
- Changed `shh_markTrustedPeer` to `waku_markTrustedPeer` - Changed `shh_markTrustedPeer` to `waku_markTrustedPeer`
- [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/waku/api.go#L100-L108) - [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/waku/api.go#L100-L108)
- Changed `shhext_requestMessages` to `wakuext_requestMessages` - Changed `shhext_requestMessages` to `wakuext_requestMessages`
- [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/services/wakuext/api.go#L76-L139) - [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/services/wakuext/api.go#L76-L139)

4
docs/stable/2-account.md
View File

@ -72,8 +72,8 @@ The node verifies or derives everything else associated with the contact from th
- Whisper/Waku Chat Key (`IK`): `m/43'/60'/1581'/0'/0` (post Multiaccount integration) - Whisper/Waku Chat Key (`IK`): `m/43'/60'/1581'/0'/0` (post Multiaccount integration)
- following [EIP1581](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1581.md) - following [EIP1581](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1581.md)
<!-- WE CURRENTLY DO NOT IMPLEMENT ENCRYPTION KEY, FOR FUTURE - C.P. --> <!-- WE CURRENTLY DO NOT IMPLEMENT ENCRYPTION KEY, FOR FUTURE - C.P. -->
<!-- - DB encryption Key (`DBK`): `m/43'/60'/1581'/1'/0` (post Multiaccount integration) <!-- - DB encryption Key (`DBK`): `m/43'/60'/1581'/1'/0` (post Multiaccount integration) -->
- following [EIP1581](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1581.md) --> <!-- - following [EIP1581](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1581.md) -->
- Status Wallet paths: `m/44'/60'/0'/0/i` starting at `i=0` - Status Wallet paths: `m/44'/60'/0'/0/i` starting at `i=0`
- following [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) - following [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)
- NOTE: this (`i=0`) is also the current (and only) path for Whisper/Waku key before Multiaccount integration - NOTE: this (`i=0`) is also the current (and only) path for Whisper/Waku key before Multiaccount integration

2
docs/stable/3-whisper-usage.md
View File

@ -146,7 +146,7 @@ Contact code topic MUST be created following the algorithm below:
```golang ```golang
contactCode := "0x" + hexEncode(activePublicKey) + "-contact-code" contactCode := "0x" + hexEncode(activePublicKey) + "-contact-code"
var hash []byte = keccak256(name) var hash []byte = keccak256(contactCode)
var topicLen int = 4 var topicLen int = 4
if len(hash) < topicLen { if len(hash) < topicLen {