status-im
/
status-js-api
mirror of https://github.com/status-im/status-js-api.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Status Javascript Client (WIP)
64 Commits 16 Branches 9 Tags 1.6 MiB
TypeScript 90.6%
JavaScript 9.4%
Go to file
Richard Ramos 2265d95a84 Mailserver request uses enum or string for topics 2018-12-06 11:55:18 -04:00
src Mailserver request uses enum or string for topics 2018-12-06 11:55:18 -04:00
test add generate whisper pubkey from wallet private key 2018-11-14 15:22:45 -05:00
.eslintrc.json add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
.gitignore add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
README.md add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
babel.config.js add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
package-lock.json add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
package.json add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
static-nodes.json add boot nodes list 2018-11-06 07:37:55 -05:00
test-mailserver.js Mailserver request uses enum or string for topics 2018-12-06 11:55:18 -04:00
test.js add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
test2.js add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00
tsconfig.json migrate mailservers to ts 2018-12-01 15:45:42 -05:00
tslint.json move remaining code to typescript 2018-12-01 17:36:29 -05:00
yarn.lock add dev pipeline; babel; linter; typescript support 2018-11-30 23:12:19 -05:00

README.md

status-js

Javascript client for sending / receiving messages in Status

WIP. DO NOT USE IN PRODUCTION. HIGH RISK ⚠


Install

clone the repo via git:

$ git clone https://github.com/status-im/status-js.git

And then install the dependencies with yarn.

$ cd status-js
$ yarn

To develop:

$ yarn run start
$ yarn run lint

status-js requires geth or murmur to be able to connect to Whisper. If using geth, you may start it with the following flags.

geth --testnet --syncmode=light --ws --wsport=8546 --wsaddr=localhost --wsorigins=statusjs --rpc --maxpeers=25 --shh --shh.pow=0.002 --wsapi=eth,web3,net,shh,debug,admin

Also, due to the lack of nodes with Whisper enabled, you need to create a static-nodes.json file, that must be placed in a specific path (if using testnet and Linux, ~/.ethereum/testnet/geth/static-nodes.json

API

TODO See test files for use in the meantime

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to status-js, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on #status-js channel to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.