Skip to content

Commit

Permalink
Merge pull request #77 from Adamant-im/dev
Browse files Browse the repository at this point in the history
v0.8.3
  • Loading branch information
dev-adamant-im authored Nov 24, 2023
2 parents 02adde3 + 7692d55 commit bca4f89
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 159 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ADAMANT

ADAMANT is a **decentralized blockchain messaging platform**. Applications use ADAMANT as an anonymous and encrypted relay and storage to enable messaging features. As examples, see [Messenger app](https://github.com/Adamant-im/adamant-im), [Blockchain 2FA](https://github.com/Adamant-im/adamant-2fa) and [Cryptocurrency Exchanger](https://github.com/Adamant-im/adamant-exchangebot) implementations.
ADAMANT is a **decentralized blockchain messaging platform**. Applications use ADAMANT as an anonymous and encrypted relay and storage to enable messaging features. For examples, see the [Messenger app](https://github.com/Adamant-im/adamant-im), [Blockchain 2FA](https://github.com/Adamant-im/adamant-2fa), and [Cryptocurrency Exchanger](https://github.com/Adamant-im/adamant-exchangebot) implementations.

For more information refer to ADAMANT website: <https://adamant.im>.
For more information, refer to the ADAMANT website: <https://adamant.im>.

![ADAMANT nodes](./img/adm-nodes.jpeg)

Expand All @@ -17,29 +17,29 @@ Additional information:

Comprehensive [API specification](https://github.com/Adamant-im/adamant/wiki) is available.

The manual describes API endpoints to manage accounts, transactions, chats, and a key-value storage (KVS). Additionally, the manual suggests valuable information on creating new accounts and encrypting and decrypting messages.
The manual describes API endpoints to manage accounts, transactions, chats, and key-value storage (KVS). Additionally, the manual suggests valuable information on creating new accounts and encrypting and decrypting messages.

## Set up

[How to run ADAMANT node (instructions for users)](https://medium.com/adamant-im/how-to-run-your-adamant-node-on-ubuntu-990e391e8fcc). You can skip them if you are experienced Linux user.
[How to run ADAMANT node (instructions for users)](https://medium.com/adamant-im/how-to-run-your-adamant-node-on-ubuntu-990e391e8fcc). You can skip them if you are an experienced Linux user.

### Requirements

- Ubuntu 18/20/22 (others are not tested)
- 2 GB RAM
- 60 GB disk space as on November 2022
- 70 GB disk space as of November 2023

### Installation script

For new droplets, use the [Installation script](./tools/install_node.sh), included in this repository, or run it from the ADAMANT website:

`sudo bash -c "$(wget -O - https://adamant.im/install_node.sh)"`

The script updates Ubuntu packages, creates user named adamant, installs PostgreSQL, Node.js and other necessary packages, sets up ADAMANT node, and optionally downloads up-to-date ADAMANT blockchain image.
The script updates Ubuntu packages, creates the user named `adamant`, installs PostgreSQL, Node.js, and other necessary packages, sets up the ADAMANT node, and optionally downloads an up-to-date ADAMANT blockchain image.

Script parameters:

- `-b`: choose GitHub branch for node installation. Example: `-b dev`. Default is `master`.
- `-b`: choose the GitHub branch for node installation. Example: `-b dev`. Default is `master`.
- `-n`: choose `mainnet` or `testnet` network. Example: `-n testnet`. Default is `mainnet`.

F. e.,
Expand All @@ -48,7 +48,7 @@ F. e.,

### Prerequisites

- Tool chain components — Used for compiling dependencies
- Toolchain components — Used for compiling dependencies

`sudo apt-get install -y python build-essential curl automake autoconf libtool`

Expand All @@ -58,18 +58,18 @@ F. e.,

- Node.js — Node.js serves as the underlying engine for code execution

System wide via package manager:
System-wide via package manager:

```
curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -
curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs
```

Locally using nvm:

```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
nvm i --lts=gallium
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
nvm i --lts=hydrogen
```

- Install PostgreSQL:
Expand All @@ -80,7 +80,7 @@ F. e.,
sudo apt-get update
sudo apt-get install -y postgresql postgresql-contrib libpq-dev
# Create user if you are working from superuser
# Create a user if you are working from superuser
adduser adamant
sudo usermod -aG sudo adamant
su - adamant
Expand Down Expand Up @@ -129,7 +129,7 @@ Make the necessary changes to the configuration values in the file. At minimum,

### Bootstrap with a blockchain image

Blockchain image saves time on node sync but you must completely trust the image. If you skip this step, your node will check every single transaction, which takes time (up for several days).
A blockchain image saves time on node sync, but you must completely trust the image. If you skip this step, your node will check every single transaction, which takes time (up to several days).

```
wget https://explorer.adamant.im/db_backup.sql.gz
Expand Down Expand Up @@ -162,7 +162,7 @@ To add ADAMANT node to crontab for autostart after system reboot (fix installati

## Tests

Before running any tests, run ADAMANT node with a testnet configuration:
Before running any tests, run the ADAMANT node with a testnet configuration:

```
npm run start:testnet
Expand Down Expand Up @@ -194,7 +194,7 @@ npm run test:single test/api/accounts.js

## License

Copyright © 2020-2022 ADAMANT Foundation
Copyright © 2020-2023 ADAMANT Foundation

Copyright © 2017-2020 ADAMANT TECH LABS LP

Expand Down
16 changes: 10 additions & 6 deletions config.default.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,11 @@
"enabled": true,
"list": [
{
"ip": "51.15.221.205",
"port": 36666
},
{
"ip": "51.15.88.53",
"ip": "5.161.68.61",
"port": 36666
},
{
"ip": "5.161.68.61",
"ip": "149.102.157.15",
"port": 36666
},
{
Expand All @@ -67,6 +63,14 @@
{
"ip": "138.201.152.191",
"port": 36666
},
{
"ip": "184.94.215.92",
"port": 45555
},
{
"ip": "207.244.243.23",
"port": 45555
}
],
"access": {
Expand Down
131 changes: 0 additions & 131 deletions config.json

This file was deleted.

13 changes: 7 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "adamant",
"version": "0.8.2",
"version": "0.8.3",
"description": "ADAMANT Blockchain Node",
"private": true,
"scripts": {
"start": "node app.js",
Expand Down Expand Up @@ -33,10 +34,10 @@
"cryptocurrency",
"dpos"
],
"author": "ADAMANT Tech Labs <[email protected]>, Lisk Foundation <[email protected]>, lightcurve GmbH <[email protected]>",
"author": "ADAMANT Foundation <[email protected]>, ADAMANT Tech Labs <[email protected]>, Lisk Foundation <[email protected]>, lightcurve GmbH <[email protected]>",
"license": "GPL-3.0",
"dependencies": {
"async": "=3.2.4",
"async": "=3.2.5",
"axios": "^0.27.2",
"bignumber.js": "=9.1.2",
"bitcore-mnemonic": "=8.25.36",
Expand Down Expand Up @@ -66,7 +67,7 @@
"pg-native": "=3.0.1",
"pg-promise": "=10.11.1",
"randomstring": "=1.3.0",
"redis": "=4.6.10",
"redis": "=4.6.11",
"rimraf": "=3.0.2",
"semver": "=7.5.4",
"socket.io": "^4.7.2",
Expand All @@ -83,7 +84,7 @@
"chai-bignumber": "^3.1.0",
"eslint-config-google": "^0.14.0",
"eslint-formatter-codeframe": "^7.32.1",
"eslint-plugin-jsdoc": "^46.8.2",
"eslint-plugin-jsdoc": "^46.9.0",
"grunt": "^1.6.1",
"grunt-cli": "^1.4.3",
"grunt-contrib-compress": "^2.0.0",
Expand All @@ -104,7 +105,7 @@
}
},
"config": {
"minVersion": ">=0.4.0"
"minVersion": ">=0.6.0"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit bca4f89

Please sign in to comment.