mirror of
https://github.com/status-im/status-js-api.git
synced 2025-02-18 20:36:31 +00:00
Changing hardcoded values to constants
This commit is contained in:
Richard Ramos
commit
32d329d3a2
39
README.md
39
README.md
@ -1,7 +1,38 @@
|
||||
# status-js
|
||||
status-js
|
||||
===
|
||||
|
||||
# Config:
|
||||
<p align="center">
|
||||
Javascript client for sending / receiving messages in Status
|
||||
</p>
|
||||
<p align="center">
|
||||
<strong>WIP. DO NOT USE IN PRODUCTION. HIGH RISK ⚠</strong>
|
||||
</p>
|
||||
<br />
|
||||
|
||||
`geth --testnet --syncmode=light --ws --wsport=8546 --wsaddr=localhost --wsorigins=statusjs --maxpeers=25 --shh --shh.pow=0.002 --wsapi=eth,web3,net,shh,debug,admin`
|
||||
## Install
|
||||
clone the repo via git:
|
||||
```
|
||||
$ git clone https://github.com/status-im/status-js.git
|
||||
```
|
||||
And then install the dependencies with `npm`.
|
||||
```
|
||||
$ cd status-js
|
||||
$ npm install
|
||||
```
|
||||
|
||||
web3.ssh options: `powTime (1), ttl (10) and powTarget (0.002)
|
||||
`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](https://github.com/status-im/murmur/blob/master/src/data/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](https://get.status.im/chat/public/status-js) 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.
|
||||
|
||||
21
src/constants.js
Normal file
21
src/constants.js
Normal file
@ -0,0 +1,21 @@
|
||||
module.exports = {
|
||||
post: {
|
||||
POW_TIME: 1,
|
||||
TTL: 10,
|
||||
POW_TARGET: 0.002
|
||||
},
|
||||
messageTypes: {
|
||||
GROUP_MESSAGE: "~:public-group-user-message",
|
||||
USER_MESSAGE: "~:user-message"
|
||||
},
|
||||
messageTags: {
|
||||
message: "~#c4",
|
||||
chatRequest: "~#c2"
|
||||
},
|
||||
topics: {
|
||||
CONTACT_DISCOVERY_TOPIC: '0xf8946aac'
|
||||
},
|
||||
regExp: {
|
||||
CONTACT_CODE_REGEXP: /^(0x)?[0-9a-f]{130}$/i
|
||||
}
|
||||
}
|
||||
79
src/index.js
79
src/index.js
@ -1,22 +1,13 @@
|
||||
const Web3 = require('web3');
|
||||
const utils = require('./utils.js');
|
||||
const mailservers = require('./mailservers.js');
|
||||
const constants = require('./constants');
|
||||
|
||||
const { utils: { asciiToHex, hexToAscii, sha3 } } = Web3;
|
||||
|
||||
const POW_TIME = 1;
|
||||
const TTL = 10;
|
||||
const POW_TARGET = 0.002;
|
||||
|
||||
const GROUP_MESSAGE = "~:public-group-user-message";
|
||||
const USER_MESSAGE = "~:user-message";
|
||||
|
||||
const CONTACT_DISCOVERY_TOPIC = '0xf8946aac';
|
||||
|
||||
const CONTACT_CODE_REGEXP = /^(0x)?[0-9a-f]{130}$/i;
|
||||
|
||||
function createStatusPayload(content, messageType, clockValue, isJson) {
|
||||
const tag = '~#c4';
|
||||
const tag = constants.messageTags.message;
|
||||
const oneMonthInMs = 60 * 60 * 24 * 31 * 1000;
|
||||
if(clockValue < (new Date().getTime())){
|
||||
clockValue = (new Date().getTime() + oneMonthInMs) * 100;
|
||||
@ -60,7 +51,7 @@ class StatusJS {
|
||||
this.shh = web3.shh;
|
||||
this.mailservers = new mailservers(web3);
|
||||
|
||||
await web3.shh.setMinPoW(POW_TARGET);
|
||||
await web3.shh.setMinPoW(constants.post.POW_TARGET);
|
||||
_sig.set(
|
||||
this,
|
||||
privateKey ? await this.generateWhisperKeyFromWallet(privateKey) : await web3.shh.newKeyPair()
|
||||
@ -133,6 +124,10 @@ class StatusJS {
|
||||
}
|
||||
}
|
||||
|
||||
onChatRequest(cb){
|
||||
this.chatRequestCb = cb;
|
||||
}
|
||||
|
||||
onChannelMessage(channelName, cb) {
|
||||
if (!this.channels[channelName]) {
|
||||
return cb("unknown channel: " + channelName);
|
||||
@ -177,13 +172,14 @@ class StatusJS {
|
||||
onUserMessage(cb) {
|
||||
|
||||
const filters = {
|
||||
minPow: POW_TARGET,
|
||||
minPow: constants.post.POW_TARGET,
|
||||
privateKeyID: _sig.get(this),
|
||||
topics: [CONTACT_DISCOVERY_TOPIC],
|
||||
topics: [constants.topics.CONTACT_DISCOVERY_TOPIC],
|
||||
allowP2P: true
|
||||
};
|
||||
|
||||
const messageHandler = (data) => {
|
||||
console.log(data);
|
||||
if(!this.contacts[data.sig]){
|
||||
this.addContact(data.sig);
|
||||
}
|
||||
@ -193,7 +189,20 @@ class StatusJS {
|
||||
this.contacts[data.sig].lastClockValue = payloadArray[1][3];
|
||||
}
|
||||
|
||||
cb(null, {payload: hexToAscii(data.payload), data: data, username: this.contacts[data.sig].username});
|
||||
if(payloadArray[0] == constants.messageTags.message){
|
||||
cb(null, {payload: hexToAscii(data.payload), data: data, username: this.contacts[data.sig].username});
|
||||
} else if(payloadArray[0] == constants.messageTags.chatRequest) {
|
||||
this.contacts[data.sig].displayName = payloadArray[1][0];
|
||||
this.contacts[data.sig].profilePic = payloadArray[1][1];
|
||||
|
||||
if(this.chatRequestCb){
|
||||
this.chatRequestCb(null, {
|
||||
'username': this.contacts[data.sig].username,
|
||||
'displayName': this.contacts[data.sig].displayName,
|
||||
'profilePic': this.contacts[data.sig].profilePic,
|
||||
});
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@ -228,11 +237,11 @@ class StatusJS {
|
||||
this.shh.post({
|
||||
pubKey: contactCode,
|
||||
sig: _sig.get(this),
|
||||
ttl: TTL,
|
||||
topic: CONTACT_DISCOVERY_TOPIC,
|
||||
payload: createStatusPayload(msg, USER_MESSAGE, this.contacts[contactCode].lastClockValue),
|
||||
powTime: POW_TIME,
|
||||
powTarget: POW_TARGET
|
||||
ttl: constants.post.TTL,
|
||||
topic: constants.topics.CONTACT_DISCOVERY_TOPIC,
|
||||
payload: createStatusPayload(msg, constants.messageTypes.USER_MESSAGE, this.contacts[contactCode].lastClockValue),
|
||||
powTime: constants.post.POW_TIME,
|
||||
powTarget: constants.post.POW_TARGET
|
||||
}).then(() => {
|
||||
if (!cb) return;
|
||||
cb(null, true);
|
||||
@ -253,11 +262,11 @@ class StatusJS {
|
||||
this.shh.post({
|
||||
symKeyID: this.channels[channelName].channelKey,
|
||||
sig: _sig.get(this),
|
||||
ttl: TTL,
|
||||
ttl: constants.post.TTL,
|
||||
topic: this.channels[channelName].channelCode,
|
||||
payload: createStatusPayload(msg, GROUP_MESSAGE, this.channels[channelName].lastClockValue ),
|
||||
powTime: POW_TIME,
|
||||
powTarget: POW_TARGET
|
||||
payload: createStatusPayload(msg, constants.messageTypes.GROUP_MESSAGE, this.channels[channelName].lastClockValue ),
|
||||
powTime: constants.post.POW_TIME,
|
||||
powTarget: constants.post.POW_TARGET
|
||||
}).then(() => {
|
||||
if (!cb) return;
|
||||
cb(null, true);
|
||||
@ -268,7 +277,7 @@ class StatusJS {
|
||||
}
|
||||
|
||||
sendJsonMessage(destination, msg, cb) {
|
||||
if (CONTACT_CODE_REGEXP.test(destination)) {
|
||||
if (constants.regExp.CONTACT_CODE_REGEXP.test(destination)) {
|
||||
if(!this.contacts[destination]){
|
||||
this.addContact(destination);
|
||||
}
|
||||
@ -277,11 +286,11 @@ class StatusJS {
|
||||
this.shh.post({
|
||||
pubKey: destination,
|
||||
sig: _sig.get(this),
|
||||
ttl: TTL,
|
||||
topic: CONTACT_DISCOVERY_TOPIC,
|
||||
payload: createStatusPayload(msg, USER_MESSAGE, this.contacts[destination].lastClockValue, true),
|
||||
powTime: POW_TIME,
|
||||
powTarget: POW_TARGET
|
||||
ttl: constants.post.TTL,
|
||||
topic: constants.topics.CONTACT_DISCOVERY_TOPIC,
|
||||
payload: createStatusPayload(msg, constants.messageTypes.USER_MESSAGE, this.contacts[destination].lastClockValue, true),
|
||||
powTime: constants.post.POW_TIME,
|
||||
powTarget: constants.post.POW_TARGET
|
||||
}).then(() => {
|
||||
if (!cb) return;
|
||||
cb(null, true);
|
||||
@ -295,11 +304,11 @@ class StatusJS {
|
||||
this.shh.post({
|
||||
symKeyID: this.channels[destination].channelKey,
|
||||
sig: _sig.get(this),
|
||||
ttl: TTL,
|
||||
ttl: constants.post.TTL,
|
||||
topic: this.channels[destination].channelCode,
|
||||
payload: createStatusPayload(JSON.stringify(msg), GROUP_MESSAGE, this.channels[destination].lastClockValue, true),
|
||||
powTime: POW_TIME,
|
||||
powTarget: POW_TARGET
|
||||
payload: createStatusPayload(JSON.stringify(msg), constants.messageTypes.GROUP_MESSAGE, this.channels[destination].lastClockValue, true),
|
||||
powTime: constants.post.POW_TIME,
|
||||
powTarget: constants.post.POW_TARGET
|
||||
}).then(() => {
|
||||
if (!cb) return;
|
||||
cb(null, true);
|
||||
@ -311,7 +320,7 @@ class StatusJS {
|
||||
}
|
||||
|
||||
sendMessage(destination, msg, cb){
|
||||
if (CONTACT_CODE_REGEXP.test(destination)) {
|
||||
if (constants.regExp.CONTACT_CODE_REGEXP.test(destination)) {
|
||||
this.sendUserMessage(destination, msg, cb);
|
||||
} else {
|
||||
this.sendGroupMessage(destination, msg, cb);
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user