You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 6, 2024. It is now read-only.
Thank you for being interested in contributing to the development of SmartSweeper.
4
+
5
+
## Code of Conduct
6
+
7
+
We ask that all contributors follow our [code of conduct](CODE_OF_CONDUCT.md). Please report unacceptable behavior to [smartsweeper@swiftlet.technology](mailto:smartsweeper@swiftlet.technology).
8
+
9
+
## How Can I Contribute?
10
+
### Reporting Bugs
11
+
12
+
1. Please check [existing issues](/issues) to make sure the bug hasn't already been reported. If it has and the issue is still open, please add a new comment to the existing issue.
13
+
1. If the bug hasn't been reported, create a new issue by filling in the [bug report template](docs/bug_report.md). Please include as much information as you can.
14
+
15
+
### Suggesting Enhancements
16
+
17
+
1. Please check [existing issues](/issues) to make sure that no one else has suggested the same enhancement. If someone has and the issue is still open, please add a new comment to the existing issue.
18
+
1. If the suggestion hasn't already been made, please follow [these guidelines](docs/enhancement_suggestion.md).
19
+
20
+
## Style Guidelines
21
+
22
+
There are three styles currently in use:
23
+
24
+
*```index.js```, ```smartcashapi.js```, and ```rpc-client.js``` more-or-less follow the [Electron style guidelines](https://electronjs.org/docs/development/coding-style)
25
+
* The other JavaScript files in general mostly follow the [W3Schools style guide](https://www.w3schools.com/js/js_conventions.asp).
26
+
* The file and folder structure in ```/app``` follows the [John Papa's Angular 1 style guide](https://github.com/johnpapa/angular-styleguide/blob/master/a1/README.md).
27
+
28
+
Going forward, all JavaScript will use the W3Schools style with an exception:
29
+
* Conditionals:
30
+
```javascript
31
+
if (time <20) {
32
+
greeting ="Good day";
33
+
}
34
+
else {
35
+
greeting ="Good evening";
36
+
}
37
+
```
38
+
39
+
This guide was inspired by the [Atom contribution guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md).
SmartSweeper is still in the development stage so it is unstable and missing functionality. DO NOT attempt to create transactions with this app.
3
+
### Note
4
+
SmartSweeper is currently in beta. You fund projects at your own risk.
7
5
6
+
### Description
7
+
Sweeper application for [SmartCash cryptocurrency](http://smartcash.cc) to allow easy retrieval of gift funds. Runs only on Windows 7, 8, and 10 at the moment. It isn't necessary to input your wallet passphrase to use SmartSweeper.
8
8
9
-
Description
10
-
---------------
11
-
Sweeper application for [SmartCash cryptocurrency](http://smartcash.cc) to allow easy retrieval of gift funds. Runs only on Windows at the moment. It isn't necessary to input your wallet passphrase to use SmartSweeper.
12
-
13
-
14
-
Features
15
-
---------------
9
+
### Features
16
10
* Create projects to organize promotions
17
-
* Send funds to multiple promotional wallets
11
+
* Send funds to promotional wallets (1-500 wallets, inclusive)
18
12
* Retrieve promotional funds from wallets that were not redeemed
19
13
* Print paper wallets
20
-
* Access logs
14
+
* User action logs and system logs
15
+
16
+
### Base Requirement
17
+
*[SmartCash Node Client](https://smartcash.cc/wallets/) for Windows - 1.2.6+ ([there is a bootstrap file to shorten sync time](https://smartcash.freshdesk.com/support/solutions/articles/35000027174-using-the-bootstrap-to-speedup-sync-process))
21
18
19
+
### Table of Contents
20
+
*[Installation](#installation)
21
+
*[Running from source](#running-from-source)
22
+
*[Configuration](#configuration)
23
+
*[Known issues](#known-issues)
24
+
*[Other software used](#other-software-used)
25
+
*[Contributing to SmartSweeper development](#contributing)
22
26
23
-
Releases
24
-
---------------
25
-
Releases are forthcoming. Please see the [dev branch](https://github.com/swiftlettech/smart-sweeper/tree/dev).
26
27
28
+
## Installation
29
+
Download a release and run the installer. You may need to run SmartSweeper as an administrator.
27
30
28
-
Requirements
29
-
---------------
31
+
32
+
## Running from source
33
+
#### Additional Requirements
30
34
*[Node.js](http://nodejs.org) - 8.9.0+
31
35
*[npm](http://npmjs.com) - 5.6.0+
32
-
*[SmartCash Node Client](https://smartcash.cc/wallets/) for Windows - 1.2.2+ ([there is a bootstrap file to shorten sync time](https://smartcash.freshdesk.com/support/solutions/articles/35000027174-using-the-bootstrap-to-speedup-sync-process))
33
-
34
-
Run node -v and npm -v from a command prompt to make sure they're in your PATH. Open your SmartCash desktop wallet application to make sure it is up to date before launching SmartSweeper.
35
36
37
+
Run ```node -v``` and ```npm -v``` from a command prompt to make sure both are in your PATH. Open your SmartCash node client to make sure it is synchronized before launching SmartSweeper.
36
38
37
-
Installation
38
-
---------------
39
+
#### Installation
39
40
```bash
40
41
npm install
41
42
```
42
43
43
-
44
-
To run
45
-
---------------
44
+
#### To run
46
45
```bash
47
46
npm start
48
47
```
49
48
50
49
51
-
Configuration
52
-
---------------
50
+
## Configuration
53
51
SmartSweeper can be configured by modifying .env in the root directory. The app will create it for you the first time you load it, but you can create the file yourself prior to that, which will help if you didn't use the default SmartCash installation path. The default values for Windows are shown below.
* rpc.host is the IP address that the SmartCash Node Client RPC server is bound to.
63
-
* rpc.port is the port that the SmartCash node client RPC server is listening on.
61
+
* rpc.port is the port that the SmartCash Node Client RPC server is listening on.
64
62
* rpc.username is the SmartCash Node Client RPC server username.
65
63
* rpc.password is the SmartCash Node Client RPC server password.
66
64
* smartcashPath is the full path to your SmartCash Node Client installation. You must include a trailing slash.
67
65
68
66
69
-
Your SmartCash wallet must be started with the following arguments:
67
+
Your SmartCash Node Client must be started with the following arguments:
70
68
```
71
-
-txindex=1 (if SmartCash Node Client is < v1.2.3)
72
69
-server
73
70
-rpcbind=127.0.0.1
74
71
-rpcport=9678
75
72
-rpcuser=rpcusername
76
73
-rpcpassword=rpcpassword
77
74
```
78
75
79
-
If it isn't running, SmartSweeper will start it for you with the above arguments. You can also [edit your wallet's smartcash.conf file](https://smartcash.freshdesk.com/support/solutions/articles/35000038702-smartcash-conf-configuration-file). Please don't do this with your wallet running.
76
+
If it isn't running, SmartSweeper will attempt to start it for you with the above arguments. You can also [edit your node client's smartcash.conf file](https://smartcash.freshdesk.com/support/solutions/articles/35000038702-smartcash-conf-configuration-file). Please don't do this with your client running.
80
77
81
78
```
82
-
txindex=1 (if SmartCash Node Client is < v1.2.3)
83
79
server=1
84
80
rpcbind=127.0.0.1
85
81
rpcport=9678
@@ -90,37 +86,45 @@ rpcpassword=rpcpassword
90
86
The values of rpc.host, rpc.port, rpc.username, and rpc.password in .env must match those in the program arguments or the smartcash.conf file.
91
87
92
88
93
-
User files
94
-
---------------
95
-
The database (smart-sweeper.json), the app config file (smart-sweeper-config.json) and the log files are saved in the following folders:
89
+
#### User files
90
+
The database (smart-sweeper.json), the app config file (smart-sweeper-config.json), the saved dashboard data file (smart-sweeper-data.json) and the log files are saved in the following folder:
96
91
97
92
***Windows**: %APPDATA%/SmartSweeper
98
93
99
-
The log files are also in JSON format and can be viewed with a general log viewer such as [glogg](https://github.com/nickbnf/glogg). **It is recommended that you back up smart-sweeper.json to a safe place.**
94
+
**It is strongly recommended that you regularly back up smart-sweeper.json to a safe place.**
95
+
96
+
The log files are also in JSON format and can be viewed with a general log viewer such as [glogg](https://github.com/nickbnf/glogg). The user logs record user actions while the system logs record system actions and errors (and includes transaction ids and public keys).
100
97
101
98
102
-
KNOWN ISSUES
103
-
---------------
104
-
* electron-store error: "EPERM operation not permitted" sometimes occurs on Windows when reading a config file. SmartSweeper will exit when it does.
99
+
## Known issues
100
+
* SmartSweeper may not open the SmartCash Node Client. If smartcash.conf hasn't been modified with the info above, SmartSweeper won't work if the node client is run manually.
101
+
* electron-store error "EPERM operation not permitted" sometimes occurs on Windows when reading a config file. SmartSweeper will exit when it does.
102
+
* Can't connect to the node client via RPC when it's syncing (SmartSweeper will display the "Can't connect to SmartCash Node Client." error). This will cause some actions to fail and some project data updates to not occur.
103
+
* Claimed funds info on the dashboard and the sweep funds page becomes inaccurate after one or more projects have been swept.
104
+
* Empty log files are sometimes created in the root SmartSweeper data folder.
105
+
* There is lag when entering text into input fields.
105
106
106
107
107
-
Other software used
108
-
-------------------
108
+
## Other software used
109
109
Software | License
110
110
-------- | --------
111
111
[AngularJS](http://angularjs.org) | MIT
112
112
[AngularUI Bootstrap](https://github.com/angular-ui/bootstrap) | MIT
113
113
[Bootstrap](https://getbootstrap.com/docs/3.3/) | MIT
114
114
[clipboard.js](https://clipboardjs.com) | MIT
115
+
[delayed-call](https://github.com/finnolav/delayed-call) | MIT
115
116
[devtron](https://github.com/electron/devtron) | MIT
116
117
[electron](https://github.com/electron/electron) | MIT
118
+
[electron-builder](https://github.com/electron-userland/electron-builder) | MIT
117
119
[electron-debug](https://github.com/sindresorhus/electron-debug) | MIT
118
120
[electron-is-dev](https://github.com/sindresorhus/electron-is-dev) | MIT
119
121
[electron-store](https://github.com/sindresorhus/electron-store) | MIT
122
+
[electron-unhandled](https://github.com/sindresorhus/electron-unhandled) | MIT
120
123
[electron-util](https://github.com/sindresorhus/electron-util) | MIT
121
124
[elemon](https://github.com/manidlou/elemon) | MIT
122
125
[exp-config](https://github.com/ExpressenAB/exp-config) | MIT
123
126
[melanke-watchjs](https://github.com/melanke/Watch.JS) | MIT
127
+
[Moment.js](https://github.com/moment/moment) | MIT
124
128
[node-smartcash](https://github.com/miyakoj/node-smartcash) | MIT
[winston](https://github.com/winstonjs/winston) | MIT
130
134
131
135
132
-
[The SmartCash Insight Explorer API](https://insight.smartcash.cc) is used to check the current block count and to get information about project addresses.
136
+
[The SmartCash Insight Explorer](https://insight.smartcash.cc) is used to check the current block count and to get information about project addresses.
You can [contribute to the development of SmartSweeper](CONTRIBUTING.md) by filing a bug report or by submitting a pull request. All contributors must follow our [code of conduct](docs/CODE_OF_CONDUCT.md).
0 commit comments