Skip to content

Commit

Permalink
Merge pull request #54 from Cryptech-Services/main
Browse files Browse the repository at this point in the history
SCP 1.2.0 updates
  • Loading branch information
cryptokritter committed Sep 16, 2023
2 parents 3b1591b + 8bbcd4a commit 816dff3
Show file tree
Hide file tree
Showing 8 changed files with 458 additions and 329 deletions.
17 changes: 8 additions & 9 deletions .github/workflows/node.js.yml
Expand Up @@ -2,11 +2,10 @@ name: Lint

on:
pull_request:
branches: [ main ]
branches: [main]

jobs:
build:

runs-on: ubuntu-latest

strategy:
Expand All @@ -15,10 +14,10 @@ jobs:
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: ./node_modules/.bin/eslint -c ./.eslintrc.js src/*.js
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: npm run lint --if-present
42 changes: 23 additions & 19 deletions docs/guides/de/installation.md
Expand Up @@ -2,7 +2,7 @@

Diese Anleitung beschreibt, wie **StakeCube Protocol (SCP)** Installiert und konfiguriert wird.

Je nach Verwendungsgebiet und Ziel der Implementierung kann SCP mit einer vollwertigen StakeCubeCoin (SCC) Node oder als *Lightwallet* Betrieben werden. Beide Optionen werden nachfolgend beschrieben.
Je nach Verwendungsgebiet und Ziel der Implementierung kann SCP mit einer vollwertigen StakeCubeCoin (SCC) Node oder als _Lightwallet_ Betrieben werden. Beide Optionen werden nachfolgend beschrieben.

Die vollständige Implementierung ist empfohlen, wenn SCP Transaktionen durchgeführt werden müssen; wie die Ein-und Auszahlungen von SCC und Tokens.

Expand All @@ -12,28 +12,30 @@ Die Lightwallet Option ist gleichzeitig der Fallback-Mechanismus, wenn die lokal

## Voraussetzung

Für die Installation von SCC und SCP ist eine Linux-Distribution empfohlen. Voller Root-Zugriff ist Voraussetzung.
Für die Installation von SCC und SCP ist eine Linux-Distribution empfohlen. Voller Root-Zugriff ist Voraussetzung.

Hardware Empfehlung für vollständige Implementierung (inkl. SCC):

- 2 CPU Kerne
- 8 GB RAM
- 200 GB SSD

Hardware Empfehlung für SCP (ohne SCC):

- 1 CPU Kern
- 2 GB RAM
- 25 GB SSD

> Für diese Anleitung wird folgende Systemumgebung genutzt:
>
> - Betriebssystem: Ubuntu 20.04 LTS
> - Die Installation wird im /home/ Verzeichnis des Server durchgeführt.
> - Die Installation wird im /home/ Verzeichnis des Server durchgeführt.
> - Editor: nano ( sudo apt install nano )
> - Git für SCP Download ( sudo apt install git )
> - Unzip um Archive zu entpacken ( sudo apt install unzip )
## Installationsanleitung

Bringen Sie das Betriebssystem auf den aktuellsten Stand:

```bash
Expand Down Expand Up @@ -66,6 +68,7 @@ nano .stakecubecoin/stakecubecoin.conf
```

Inhalt der Konfigurationsdatei:

```bash
rpcuser=username
rpcpassword=passwort
Expand All @@ -88,7 +91,8 @@ cd /etc/systemd/system
nano scc.service
```

Inhalt der *scc.service* Datei
Inhalt der _scc.service_ Datei

```bash
[Unit]
Description=scc service
Expand Down Expand Up @@ -120,7 +124,7 @@ systemctl enable scc
systemctl start scc
```

Nun wird das Programm die Blockchain-Daten im Hintergrund herunterladen. Dies kann einige Stunden in Anspruch nehmen.
Nun wird das Programm die Blockchain-Daten im Hintergrund herunterladen. Dies kann einige Stunden in Anspruch nehmen.

Kontrollieren Sie mit folgenden CLI Befehlen die Anzahl der Verbindungen zum Netzwerk, die aktuelle Blockhöhe und den Blockhash:

Expand All @@ -130,9 +134,9 @@ scc getblockcount
scc getblockhash <block> // scc getblockhash 181818
```

Nutzen Sie einen Blockchain-Explorer wie https://scc.ccore.online, um Ihre Node mit dem StakeCubeCoin Netzwerk zu vergleichen.
Nutzen Sie einen Blockchain-Explorer wie https://www.coinexplorer.net/SCC, um Ihre Node mit dem StakeCubeCoin Netzwerk zu vergleichen.

Damit ist die Installation für SCC abgeschlossen.
Damit ist die Installation für SCC abgeschlossen.

Sie finden mögliche Fehlerbehebungen am Ende dieses Dokuments.

Expand Down Expand Up @@ -164,36 +168,37 @@ cd scp/
npm i
```

*Optional*:
_Optional_:
Erstellen Sie die SCP Konfigurations-Datei, wenn Sie den SCC Daemon (vollständige Integration) nutzen:

```bash
```bash
cd ~
mkdir .config .config/SCPWallet
cd .config/SCPWallet/
nano scp.conf
```

Inhalt der *scp.conf*
```bash
Inhalt der _scp.conf_

```bash
coredatadir=/home/scc/.stakecubecoin/
coreconfname=stakecubecoin.conf
```

Starten Sie SCP mit pm2:

```bash
cd /home/scp/
cd /home/scp/
pm2 start src/index.js
```

Speichern Sie den Prozess, um Ihre Prozessliste über erwartete oder unerwartete Neustarts des Servers hinweg intakt zu halten:

```bash
```bash
pm2 save
```

Rufen Sie die Log-Datei auf:
Rufen Sie die Log-Datei auf:

```bash
pm2 logs 0
Expand All @@ -203,8 +208,7 @@ Eine erfolgreiche Installation und Verbindung zur Ihrer SCC Core wallet zeigt ä

Init: Finished - Running as Fullnode! (Syncing)


Damit ist SCP installiert, als Prozess eingerichtet und bereit zur Nutzung per Schnittstelle.
Damit ist SCP installiert, als Prozess eingerichtet und bereit zur Nutzung per Schnittstelle.

### Zugriff sicherer machen

Expand All @@ -227,11 +231,11 @@ Ersetzen Sie 1.1.1.1 durch Ihre IP.

### Fehlersuche und -behebung

*Problem:*
_Problem:_

SCC Node findet keine Verbindungen zum Netzwerk, synchronisiert nicht oder stürzt ab.

*Mögliche Lösungen:*
_Mögliche Lösungen:_

1. Bootstrap SCC

Expand Down
38 changes: 21 additions & 17 deletions docs/guides/en/installation.md
Expand Up @@ -2,9 +2,9 @@

This guide describes how to install and configure **StakeCube Protocol (SCP)**.

Depending on the field of application and the implementation goals, SCP can be operated with a full-fledged StakeCubeCoin (SCC) node or as a *Lightwallet*. Here we describe both options.
Depending on the field of application and the implementation goals, SCP can be operated with a full-fledged StakeCubeCoin (SCC) node or as a _Lightwallet_. Here we describe both options.

The full implementation is recommended for situations when full SCP transactions are necessary, like for example withdrawals and deposits of SCC or SCP tokens.
The full implementation is recommended for situations when full SCP transactions are necessary, like for example withdrawals and deposits of SCC or SCP tokens.

With the lightwallet option, SCP automatically connects to an SCC node operated by StakeCube.net. With this variant, it is not necessary to synchronize the entire blockchain, but it does not offer full flexibility or security.

Expand All @@ -19,21 +19,23 @@ Hardware recommendation for full implementation (including SCC):
- 2 CPU Cores
- 8 GB RAM
- 200 GB SSD

Hardware recommendation for SCP (without SCC):

- 1 CPU Core
- 2 GB RAM
- 25 GB SSD

> For this guide we used the following system environment:
> For this guide we used the following system environment:
>
> - Operating system: Ubuntu 20.04 LTS
> - The installation takes place in the /home/ directory of the server.
> - Editor: nano (sudo apt install nano)
> - Git to download SCP (sudo apt install git)
> - Unzip to unzip archives (sudo apt install unzip)
## Installation Guide

Updating the operating system:

```bash
Expand Down Expand Up @@ -67,6 +69,7 @@ nano .stakecubecoin/stakecubecoin.conf
```

Content of the configuration file:

```bash
rpcuser=username
rpcpassword=password
Expand All @@ -89,7 +92,8 @@ cd /etc/systemd/system
nano scc.service
```

Content of the *scc.service* file
Content of the _scc.service_ file

```bash
[Unit]
Description=scc service
Expand Down Expand Up @@ -121,7 +125,7 @@ systemctl enable scc
systemctl start scc
```

Now the program will download the blockchain data in the background. This can take a few hours.
Now the program will download the blockchain data in the background. This can take a few hours.

Use the following CLI commands to control the number of network connections, the current block height and the block hash:

Expand All @@ -131,7 +135,7 @@ scc getblockcount
scc getblockhash <block> // scc getblockhash 181818
```

Use a blockchain explorer such as https://scc.ccore.online to compare your node with the StakeCubeCoin network.
Use a blockchain explorer such as hhttps://www.coinexplorer.net/SCC to compare your node with the StakeCubeCoin network.

With this, the installation of SCC is complete.

Expand Down Expand Up @@ -165,18 +169,19 @@ cd scp/
npm i
```

*Optional*:
_Optional_:
Create the SCP configuration file if you use the SCC daemon (full integration):

```bash
```bash
cd ~
mkdir .config .config/SCPWallet
cd .config/SCPWallet/
nano scp.conf
```

Content of the *scp.conf* file
```bash
Content of the _scp.conf_ file

```bash
coredatadir=/home/scc/.stakecubecoin/
coreconfname=stakecubecoin.conf
apimodules=activity,blockchain,tokens,wallet,io
Expand All @@ -186,14 +191,14 @@ apiport=3000

Start SCP with pm2:

```bash
```bash
cd /home/scp/
pm2 start src/index.js
```

To keep your process intact in the event of expected or unexpected server restarts, save the process:
To keep your process intact in the event of expected or unexpected server restarts, save the process:

```bash
```bash
pm2 save
```

Expand All @@ -207,7 +212,6 @@ A successful installation and connection to your SCC Core wallet will show a mes

Init: Finished - Running as Fullnode! (Syncing)


SCP is now installed, set up as a process and ready to use via the interface.

### Make access more secure
Expand All @@ -231,11 +235,11 @@ Replace 1.1.1.1 with your IP.

### Troubleshooting

*Problem:*
_Problem:_

SCC Node cannot find any connections to the network, does not synchronize or crashes.

*Possible solutions:*
_Possible solutions:_

1. Bootstrap SCC

Expand Down

0 comments on commit 816dff3

Please sign in to comment.