status-im
/
swarms
mirror of https://github.com/status-im/swarms.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

[#IDEA-146] : Links to each milestone on the main readme

This commit is contained in:
Adrià Cidre 2018-04-16 11:48:05 +02:00
parent 063301fd28
commit 0edc11a8fa
No known key found for this signature in database
GPG Key ID: D246A27D58A92CAB
5 changed files with 40 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
ideas/146-status-go-sdk/1to1Channels.md
View File

@ -16,6 +16,9 @@ Basically the only difference between 1to1 and public is the field message type
### Ability to send 1 to 1 conversation ### Ability to send 1 to 1 conversation
### Ability to subscribe to 1 to 1 conversation ### Ability to subscribe to 1 to 1 conversation
### Ability to unsubscribe from a 1 to 1 conversation ### Ability to unsubscribe from a 1 to 1 conversation
### Documented API for 1 to 1 conversations ### Documented API for 1 to 1 conversations

7
ideas/146-status-go-sdk/ContactManagement.md
View File

@ -11,23 +11,26 @@ if account, err := conn.Invite("my_friend_public_key"); err != nil {
Before starting to chat with someone privately you should have its contact details. In order to do that, the next process should happen Before starting to chat with someone privately you should have its contact details. In order to do that, the next process should happen
##### Generate a new symkey (shh_newSymKey): ##### Generate a new symkey (shh_newSymKey):
Generates a new symetric key
``` ```
{"jsonrpc":"2.0","id":872,"method":"shh_newSymKey","params":[]} {"jsonrpc":"2.0","id":872,"method":"shh_newSymKey","params":[]}
``` ```
##### GetSymKey (shh_getSymKey): ##### GetSymKey (shh_getSymKey):
**[ TODO Describe what's this call doing...]** Polls any message for the symetric key
``` ```
{"jsonrpc":"2.0","id":873,"method":"shh_getSymKey","params":["14829092e1b30cb9ab643ef9aa3c37e5a576e69821259cc690f8cccedd08dc94"]} {"jsonrpc":"2.0","id":873,"method":"shh_getSymKey","params":["14829092e1b30cb9ab643ef9aa3c37e5a576e69821259cc690f8cccedd08dc94"]}
``` ```
** [ TBD : How do i calculate what's on params? ] **
##### Create filter for new topic (shh_newMessageFilter): ##### Create filter for new topic (shh_newMessageFilter):
``` ```
{"jsonrpc":"2.0","id":879,"method":"shh_newMessageFilter","params":[{"topics":["0x6c0b63af"],"symKeyID":"14829092e1b30cb9ab643ef9aa3c37e5a576e69821259cc690f8cccedd08dc94","allowP2P":true}]} {"jsonrpc":"2.0","id":879,"method":"shh_newMessageFilter","params":[{"topics":["0x6c0b63af"],"symKeyID":"14829092e1b30cb9ab643ef9aa3c37e5a576e69821259cc690f8cccedd08dc94","allowP2P":true}]}
``` ```
Main difference here with public channels is how the topic is calculated **[TODO DEFINE HOW'S CALUCULATED]** Main difference here with public channels is how the topic is calculated
**[ TODO DEFINE HOW TOPIC IS CALCULATED ]**
##### Send first message with my contact information (shh_post) ##### Send first message with my contact information (shh_post)

4
ideas/146-status-go-sdk/PrivateChannels.md
View File

@ -12,8 +12,8 @@ Interacting with private channels is complex than public channels as
### Ability to unsubscribe from a private groups ### Ability to unsubscribe from a private groups
**[ TBD ]** **[ TBD ]**
### Documented API for private groups interaction. ### Documented API for private groups
**[ TBD ]** **[ TBD ]**
### Working examples for private groups interaction. ### Working examples for private groups interaction
**[ TBD ]** **[ TBD ]**

4
ideas/146-status-go-sdk/PublicChannels.md
View File

@ -40,11 +40,11 @@ ch.Subscribe(func(m *sdk.Msg) {
``` ```
### Documented API for public channels interaction. ### Documented API for public channels interaction
This document can be adapted as a documentation for public channels interaction This document can be adapted as a documentation for public channels interaction
### Working examples for public channel interaction. ### Working examples for public channel interaction
Actually [here](https://github.com/status-im/status-go/blob/sdk/sdk/examples/) you'll find an example of a "ping pong game". Actually [here](https://github.com/status-im/status-go/blob/sdk/sdk/examples/) you'll find an example of a "ping pong game".

54
ideas/146-status-go-sdk/README.md
View File

@ -106,42 +106,44 @@ Testing Days required: TBD
## Success Metrics ## Success Metrics
#### Milestone 1: [Status messaging basic interaction](BasicSDK.md) #### Milestone 1: [Status messaging basic interaction](BasicSDK.md)
- [ ] Setup a new connection - [ ] [Setup a new connection](BasicSDK.md#setup-a-new-connection)
- [ ] Ability to close a specific connection - [ ] [Ability to close a specific connection](BasicSDK.md#ability-to-close-a-specific-connection)
- [ ] Ability to change connection configuration - [ ] [Ability to change connection configuration](BasicSDK.md#ability-to-change-connection-configuration)
- [ ] Ability to sign up on the platform - [ ] [Ability to sign up on the platform](BasicSDK.md#ability-to-sign-up-on-the-platform)
- [ ] Ability to login as a specific account - [ ] [Ability to login as a specific account](BasicSDK.md#ability-to-login-as-a-specific-account)
- [ ] Documented API for basic sdk interaction - [ ] [Documented API for basic sdk interaction](BasicSDK.md#documented-api-for-basic-sdk-interaction)
### Milestone 2: [Contact management](ContactManagement.md) #### Milestone 2: [Public channels interaction](PublicChannels.md)
- [ ] Invite new contact - [ ] [Ability to join public channels](PublicChannels.md#ability-to-join-public-channels)
- [ ] Accept new contact - [ ] [Ability to publish messages on public channels](PublicChannels.md#ability-to-publish-messages-on-public-channels)
- [ ] [Ability to subscribe to public channels](PublicChannels.md#ability-to-subscribe-to-publc-channels)
- [ ] [Ability to unsubscribe from a public channel](PublicChannels.md#ability-to-unsubscribe-from-a-public-channel)
- [ ] [Documented API for public channels interaction](PublicChannels.md#documented-api-for-public-channels-interaction)
- [ ] [Working examples for public channel interaction](PublicChannels.md#working-examples-for-public-channel-interaction)
### Milestone 3: [Contact management](ContactManagement.md)
- [ ] [Invite new contact](ContactManagement.md#invite-new-contact)
- [ ] [Accept a contact request](ContactManagement.md#accept-contact-request)
#### Milestone 3: [Public channels interaction](PublicChannels.md)
- [ ] Ability to join public channels
- [ ] Ability to publish messages on public channels
- [ ] Ability to subscribe to public channels
- [ ] Ability to unsubscribe from a public channel
- [ ] Documented API for public channels interaction.
- [ ] Working examples for public channel interaction.
#### Milestone 4: [1 to 1 messages interaction](1to1Channels.md) #### Milestone 4: [1 to 1 messages interaction](1to1Channels.md)
- [ ] Ability to send 1 to 1 conversation - [ ] TBD : [Ability to send 1 to 1 conversation](1to1Channels.md#ability-to-send-1-to-1-conversation)
- [ ] Ability to subscribe to 1 to 1 conversation - [ ] TBD : [Ability to subscribe to 1 to 1 conversation](1to1Channels.md#ability-to-subscribe-1-to-1-conversation)
- [ ] Ability to unsubscribe from a 1 to 1 conversation - [ ] TBD : [Ability to unsubscribe from a 1 to 1 conversation](1to1Channels.md#ability-to-unsubscribe-1-to-1-conversation)
- [ ] Documented API for 1 to 1 conversations - [ ] TBD : [Documented API for 1 to 1 conversation](1to1Channels.md#documented-api-for-1-to-1-conversations)
- [ ] Working examples for 1 to 1 conversations - [ ] TBD : [Working examples for 1 to 1 conversations](1to1Channels.md#working-examples-for-1-to-1-conversations)
#### Milestone 5: [Private groups interaction](PrivateChannels.md) #### Milestone 5: [Private groups interaction](PrivateChannels.md)
- [ ] Ability to publish messages on private groups - [ ] TBD : [Ability to publish messages on private groups](PrivateChannels.md#ability-to-publish-messages-on-private-groups)
- [ ] Ability to subscribe to private groups - [ ] TBD : [Ability to subscribe to private groups](PrivateChannels.md#ability-to-subscribe-to-private-groups)
- [ ] Ability to unsubscribe from a private groups - [ ] TBD : [Ability to unsubscribe from a private groups](PrivateChannels.md#ability-to-unsubscribe-to-private-groups)
- [ ] Documented API for private groups interaction. - [ ] TBD : [Documented API for private groups interaction](PrivateChannels.md#documented-api-for-private-groups)
- [ ] Working examples for private groups interaction. - [ ] TBD : [Working examples for private groups interaction](PrivateChannels.md#working-examples-for-private-groups-interaction)
#### Milestone 6: Extra methods #### Milestone 6: Extra methods
- [ ] Ability to recover your account - [ ] Ability to recover your account
- [ ] Ability to log out. - [ ] Ability to log out.
- [ ] ...
## Exit criteria: ## Exit criteria: