Compare commits
No commits in common. "master" and "v1.1.0" have entirely different histories.
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,2 +1,2 @@
|
|||||||
/config.js
|
config.js
|
||||||
node_modules/
|
node_modules/
|
||||||
|
19
LICENSE
19
LICENSE
@ -1,19 +0,0 @@
|
|||||||
Copyright (c) 2023 Râu Cao
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
56
README.md
56
README.md
@ -1,56 +0,0 @@
|
|||||||
# XMPP Lightning Anti-Spam
|
|
||||||
|
|
||||||
In order to combat spam in public chat rooms, they can be configured so that
|
|
||||||
new, unknown participants have to request voice before being able to write
|
|
||||||
messages (known as a "moderated channel").
|
|
||||||
|
|
||||||
This bot listens to those voice requests, and when it sees one, it sends a
|
|
||||||
direct message to the user, which offers to give them voice immediately, in
|
|
||||||
exchange for a small amount of sats[^1], payable via the Lightning Network[^2].
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
* [Node.js](https://nodejs.org) and [NPM](https://www.npmjs.com)
|
|
||||||
* An XMPP account, which has admin permissions for the channels you want it to
|
|
||||||
manage voice requests in
|
|
||||||
* A hosted Lightning Network account compatible with LndHub clients (e.g. a
|
|
||||||
[Kosmos](https://kosmos.org) or [Alby](https://getalby.com/)
|
|
||||||
account, or self-hosted with
|
|
||||||
[lndhub.go](https://github.com/getAlby/lndhub.go)).
|
|
||||||
|
|
||||||
## Setup
|
|
||||||
|
|
||||||
Clone this repository:
|
|
||||||
|
|
||||||
git clone https://gitea.kosmos.org/raucao/xmpp-lightning-antispam.git
|
|
||||||
|
|
||||||
Install required dependencies:
|
|
||||||
|
|
||||||
npm install
|
|
||||||
|
|
||||||
Create a config file from the included sample:
|
|
||||||
|
|
||||||
cp samples/config.js config.js
|
|
||||||
|
|
||||||
Edit the config file using your favorite editor:
|
|
||||||
|
|
||||||
vim config.js
|
|
||||||
|
|
||||||
Start the program:
|
|
||||||
|
|
||||||
npm start
|
|
||||||
|
|
||||||
## Deployment
|
|
||||||
|
|
||||||
Set up as described above, or use a cloud platform instead.
|
|
||||||
|
|
||||||
An example for a systemd service can be found in
|
|
||||||
`samples/xmpp-lightning-antispam.service`.
|
|
||||||
|
|
||||||
## Contact
|
|
||||||
|
|
||||||
E-Mail, Chat, Social, Lightning: raucao@kosmos.org
|
|
||||||
|
|
||||||
[^1]: Sats are the smallest unit of bitcoin (1 sat = 0.00000001 BTC)
|
|
||||||
[^2]: The Lightning Network is a peer-to-peer network for instantly and very
|
|
||||||
cheaply sending and receiving bitcoin directly between nodes
|
|
2
index.js
2
index.js
@ -121,7 +121,7 @@ function connectLndhub () {
|
|||||||
if (connected) {
|
if (connected) {
|
||||||
console.log("Connected to Lndhub");
|
console.log("Connected to Lndhub");
|
||||||
// automatically refresh auth token once a day
|
// automatically refresh auth token once a day
|
||||||
setInterval(() => lndhub.reauth(), 86400000);
|
setInterval(lndhub.reauth, 86400000);
|
||||||
} else {
|
} else {
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
|
32
package-lock.json
generated
32
package-lock.json
generated
@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "xmpp-lightning-antispam",
|
"name": "xmpp-lightning-antispam",
|
||||||
"version": "1.2.0",
|
"version": "1.1.0",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "xmpp-lightning-antispam",
|
"name": "xmpp-lightning-antispam",
|
||||||
"version": "1.2.0",
|
"version": "1.1.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@xmpp/client": "^0.13.1",
|
"@xmpp/client": "^0.13.1",
|
||||||
@ -941,12 +941,12 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/braces": {
|
"node_modules/braces": {
|
||||||
"version": "3.0.3",
|
"version": "3.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
|
"resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
|
||||||
"integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
|
"integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fill-range": "^7.1.1"
|
"fill-range": "^7.0.1"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=8"
|
"node": ">=8"
|
||||||
@ -1344,9 +1344,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/fill-range": {
|
"node_modules/fill-range": {
|
||||||
"version": "7.1.1",
|
"version": "7.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
|
"resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
|
||||||
"integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
|
"integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"to-regex-range": "^5.0.1"
|
"to-regex-range": "^5.0.1"
|
||||||
@ -3467,12 +3467,12 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"braces": {
|
"braces": {
|
||||||
"version": "3.0.3",
|
"version": "3.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
|
"resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
|
||||||
"integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
|
"integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"fill-range": "^7.1.1"
|
"fill-range": "^7.0.1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"browserslist": {
|
"browserslist": {
|
||||||
@ -3748,9 +3748,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"fill-range": {
|
"fill-range": {
|
||||||
"version": "7.1.1",
|
"version": "7.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
|
"resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
|
||||||
"integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
|
"integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"to-regex-range": "^5.0.1"
|
"to-regex-range": "^5.0.1"
|
||||||
|
@ -1,11 +1,10 @@
|
|||||||
{
|
{
|
||||||
"name": "xmpp-lightning-antispam",
|
"name": "xmpp-lightning-antispam",
|
||||||
"version": "1.2.0",
|
"version": "1.1.0",
|
||||||
"description": "A bot for moderated XMPP channels, offering voice for Lightning donations",
|
"description": "",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "node index.js",
|
|
||||||
"test": "echo \"Error: no test specified\" && exit 1"
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
},
|
},
|
||||||
"author": "Râu Cao",
|
"author": "Râu Cao",
|
||||||
|
@ -1,13 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=XMPP Lightning Antispam bot
|
|
||||||
After=network.target
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
User=deploy
|
|
||||||
WorkingDirectory=/opt/xmpp-lightning-antispam
|
|
||||||
ExecStart=/usr/bin/node index.js
|
|
||||||
Restart=on-failure
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
Loading…
x
Reference in New Issue
Block a user