mirror of https://github.com/status-im/swarms.git
112 lines
3.4 KiB
Markdown
112 lines
3.4 KiB
Markdown
|
## Preamble
|
|||
|
|
|
|||
|
|
Idea: <to be assigned>
|
|||
|
|
Title: Status GO-SDK
|
|||
|
|
Status: Draft
|
|||
|
|
Created: 2018-04-03
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Summary
|
|||
|
|
|
|||
|
|
Provide an easy to use GO-SDK library to allow community developers easily interact with status messaging.
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Swarm Participants
|
|||
|
|
- Lead Contributor: @adriacidre
|
|||
|
|
- Contributor:
|
|||
|
|
- Contributor:
|
|||
|
|
- Testing & Evaluation:
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Product Overview
|
|||
|
|
|
|||
|
|
### Product Description
|
|||
|
|
|
|||
|
|
One of the main goals of status is to grow its community, however is not easy to work on status-go project as a community developer.
|
|||
|
|
Is not easy to set up an environment
|
|||
|
|
|
|||
|
|
- Identify where to start
|
|||
|
|
- Interact with status messaging system.
|
|||
|
|
- Test your changes
|
|||
|
|
|
|||
|
|
The idea behind this swarm is to simplify this by allowing community developers to interact with status, based uniquely on status-go library.
|
|||
|
|
|
|||
|
|
### Requirements & Dependencies
|
|||
|
|
|
|||
|
|
- *Easy to use SDK* : Using a sdk should be as easy as using any other messaging system, allowing you to subscribe or publish to specific chats.
|
|||
|
|
- *The less dependencies the better* : ATM and in order to interact with status messaging system we need to interact with code on status-go and status-react repos. This should be simplified to allow devs work only on top of status-go
|
|||
|
|
- *Quick dev environment setup* : Following the previous point, if we’re only based on status-go, dev environment should be trivial. Should be easy to build apps and distribute them as binaries for different platforms.
|
|||
|
|
|
|||
|
|
|
|||
|
|
### Minimum Viable Product
|
|||
|
|
|
|||
|
|
MVP should allow a developer to accomplish some minimal actions:
|
|||
|
|
|
|||
|
|
- Connect : creates a new connection
|
|||
|
|
- Close : closes active connection
|
|||
|
|
- Auth : login as a specific user
|
|||
|
|
- Subscribe : subscribe to a channel
|
|||
|
|
- Unsubscribe : unsubscribe from a channel
|
|||
|
|
- Publish : send a message.
|
|||
|
|
|
|||
|
|
_All methods should work for 1to1, groups and public chats._
|
|||
|
|
|
|||
|
|
With this methods building a simple `autoresponder bot` should be as simple as:
|
|||
|
|
|
|||
|
|
**TO BE DEFINED**
|
|||
|
|
```go
|
|||
|
|
|
|||
|
|
// Connect to the default status url and defer closing the connection
|
|||
|
|
st, _ := status.Connect(st.DefaultAddr) // -> localhost:51515
|
|||
|
|
defer st.Close()
|
|||
|
|
|
|||
|
|
// Authenticate as an specific user
|
|||
|
|
st, _ = status.Auth([]byte(“S3cretT0ken”))
|
|||
|
|
|
|||
|
|
// Subscribes to any message on chat chatID
|
|||
|
|
sub, _ := st.Subscribe("chatID", func(m *st.Msg) {
|
|||
|
|
// Replies the received message
|
|||
|
|
m.Reply([]byte("I can help!”))
|
|||
|
|
sub.Unsubscribe()
|
|||
|
|
})
|
|||
|
|
|
|||
|
|
// Simple message publisher
|
|||
|
|
st.Publish(“buddy_token", []byte("Hello World"))
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
SDK should be provided with different, easy to follow and well documented examples _(TBD)_:
|
|||
|
|
|
|||
|
|
- Autoresponder bot (nice for testing)
|
|||
|
|
- Google assistant integration
|
|||
|
|
- Slack proxy (use status from slack)
|
|||
|
|
- Reminders (set and get reminders)
|
|||
|
|
|
|||
|
|
Description: <!-- Description of Deliverables-->
|
|||
|
|
|
|||
|
|
### Useful links & Dependencies
|
|||
|
|
|
|||
|
|
- https://github.com/mandrigin/status-go-bots — http://offsite.chat and #humans-need-not-apply bots.
|
|||
|
|
- Pre-existing issue - https://github.com/status-im/ideas/issues/131
|
|||
|
|
|
|||
|
|
### Blockers
|
|||
|
|
New Status App communication protocol - https://github.com/status-im/ideas/issues/87
|
|||
|
|
|
|||
|
|
## Dates
|
|||
|
|
Goal Date: TBD
|
|||
|
|
|
|||
|
|
Description: TBD
|
|||
|
|
|
|||
|
|
Testing Days required: TBD
|
|||
|
|
|
|||
|
|
## Success Metrics
|
|||
|
|
TBD
|
|||
|
|
<!-- Assuming the idea ships, what would success look like? What are the most important metrics that you would move?
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Supporting Role Communication
|
|||
|
|
<!-- Once Requirements and Goals are fleshed out, then it should be communicated to supporting organelles if required -->
|
|||
|
|
|
|||
|
|
## Copyright
|
|||
|
|
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|