Skip to content

Commit dab5fc1

Browse files
eviasevias
committed
v1.1.1: YourDLT: Distributed Ledgers for You
1 parent 05d4dca commit dab5fc1

File tree

17 files changed

+235
-18
lines changed

17 files changed

+235
-18
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Select one of the networks in the list above before you go on to setup your node
5151
### Installing the software
5252

5353
```
54-
$ npm i -g yourdlt@v1.0.0
54+
$ npm i -g yourdlt
5555
```
5656

5757
### Check your setup
@@ -60,7 +60,7 @@ Use the `-v` flag to print the `yourdlt` version.
6060

6161
```bash
6262
$ yourdlt -v
63-
yourdlt/1.0.0 linux-x64 node-v14.16.0
63+
yourdlt/1.1.1 linux-x64 node-v14.16.0
6464
```
6565

6666
### Customize the node
@@ -131,7 +131,7 @@ d. Keep this password in a secure place! ******
131131
2021-03-24T01:52:24.896Z info Running image using Exec: symbolplatform/symbol-server:tools-gcc-1.0.0.0 /usr/catapult/bin/catapult.tools.votingkey --secret=HIDDEN_KEY --startEpoch=1 --endEpoch=360 --output=/votingKeys/private_key_tree1.dat
132132
2021-03-24T01:52:26.914Z warn A new Voting File for the node node has been regenerated!
133133
2021-03-24T01:52:26.914Z warn Remember to send a Voting Key Link transaction from main NAHLG4HPLLFFM7F3WTMFXTW7RTSTYKFR7REQSLY using the Voting Public Key 9B8CACAD44534D4DB830BB18CDA34CD43E034EA1AAA942B5D6BE463B144E5CA4
134-
2021-03-24T01:52:26.914Z warn For linking, you can use symbol-bootstrap link command, the symbol cli, or the symbol desktop wallet.
134+
2021-03-24T01:52:26.914Z warn For linking, you can use yourdlt link command, the symbol cli, or the symbol desktop wallet.
135135
2021-03-24T01:52:26.914Z warn The voting public key is stored in the target`s addresses.yml for reference
136136
2021-03-24T01:52:26.937Z info Deleting folder dual-node/nemesis/seed
137137
2021-03-24T01:52:27.213Z info Configuration generated.

‎docs/clean.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ EXAMPLE
1919
$ yourdlt clean
2020
```
2121

22-
_See code: [src/commands/clean.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/clean.ts)_
22+
_See code: [src/commands/clean.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/clean.ts)_

‎docs/compose.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ EXAMPLE
3131
$ yourdlt compose
3232
```
3333

34-
_See code: [src/commands/compose.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/compose.ts)_
34+
_See code: [src/commands/compose.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/compose.ts)_

‎docs/config.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ EXAMPLES
5656
$ echo "$MY_ENV_VAR_PASSWORD" | yourdlt config -p testnet -a dual
5757
```
5858

59-
_See code: [src/commands/config.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/config.ts)_
59+
_See code: [src/commands/config.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/config.ts)_

‎docs/decrypt.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ EXAMPLES
5252
$ echo "$MY_ENV_VAR_PASSWORD" | yourdlt decrypt --source target/addresses.yml --destination plain-addresses.yml
5353
```
5454

55-
_See code: [src/commands/decrypt.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/decrypt.ts)_
55+
_See code: [src/commands/decrypt.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/decrypt.ts)_

‎docs/encrypt.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ EXAMPLES
4444
encrypted-custom-preset.yml
4545
```
4646

47-
_See code: [src/commands/encrypt.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/encrypt.ts)_
47+
_See code: [src/commands/encrypt.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/encrypt.ts)_

‎docs/enrolRewardProgram.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ EXAMPLES
4545
$ echo "$MY_ENV_VAR_PASSWORD" | yourdlt enrolRewardProgram --url http://external-rest:3000
4646
```
4747

48-
_See code: [src/commands/enrolRewardProgram.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/enrolRewardProgram.ts)_
48+
_See code: [src/commands/enrolRewardProgram.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/enrolRewardProgram.ts)_

‎docs/healthCheck.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ EXAMPLE
3434
$ yourdlt healthCheck
3535
```
3636

37-
_See code: [src/commands/healthCheck.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/healthCheck.ts)_
37+
_See code: [src/commands/healthCheck.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/healthCheck.ts)_

‎docs/index.md‎

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
# YourDLT: Distributed Ledger for You.
2+
3+
Tool that lets you connect to existing YourDLT and/or Symbol distributed ledger networks.
4+
5+
This tool suite is powered by [Using Blockchain Ltd](https://using-blockchain.org), [UBC Digital Magazine](https://ubc.digital), [dHealth Network](https://dhealth.network) and [Symbol from NEM](https://symbolplatform.com).
6+
7+
Note that we originally forked the [nemtech/symbol-bootstrap](https://github.com/nemtech/symbol-bootstrap) repository to provide with more presets and network configurations. Using Blockchain Ltd does *not* own the blockchain networks to which this tool lets you connect.
8+
9+
- [Requirements](#requirements)
10+
- [Public Networks](#public-networks)
11+
- [Usage](#usage)
12+
- [Sponsor Us](#sponsor-us)
13+
- [Disclaimer](#disclaimer)
14+
- [Licensing](#license)
15+
16+
## Requirements
17+
18+
- [Node 10+](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04)
19+
- [Docker 19.03.13](https://docs.docker.com/engine/install/ubuntu/)
20+
- [Docker Compose 1.27.4](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04)
21+
22+
Validate your environment by running:
23+
24+
```
25+
node -v
26+
docker -v
27+
docker-compose -v
28+
```
29+
30+
Make sure that your user can run docker without sudo:
31+
32+
```
33+
docker run hello-world
34+
```
35+
36+
## Public Networks
37+
38+
This tool is compatible with multiple blockchain projects which are listed below:
39+
40+
| Name | Preset Name | Link |
41+
| --- | --- | --- |
42+
| dHealth Public Network | `dhealth` | [dHealth Public Network](https://dhealth.network) |
43+
| Symbol from NEM | `mainnet` | [Symbol from NEM](https://symbolplatform.com) |
44+
| Symbol Testnet | `testnet` | [Symbol from NEM](https://symbolplatform.com) |
45+
| Custom private network | `bootstrap` | [Catapult](https://github.com/nemtech/catapult-server) |
46+
47+
Select one of the networks in the list above before you go on to setup your node.
48+
49+
## Usage
50+
51+
### Installing the software
52+
53+
```
54+
$ npm i -g yourdlt
55+
```
56+
57+
### Check your setup
58+
59+
Use the `-v` flag to print the `yourdlt` version.
60+
61+
```bash
62+
$ yourdlt -v
63+
yourdlt/1.1.1 linux-x64 node-v14.16.0
64+
```
65+
66+
### Customize the node
67+
68+
You can customize your node with a custom preset configuration, let's for example `touch ~/node_config.yml`.
69+
70+
Put the following in this configuration file we just created, and replace `your-awesome-node` by the friendly name you want to set to your node:
71+
72+
```bash
73+
nodes:
74+
-
75+
host: ''
76+
friendlyName: 'your-awesome-node'
77+
```
78+
79+
:white_check_mark: If you already have a domain name _DNS mapped_ to your server IP, you can specify it as the `host` of your node. This is optional and in case it is left empty, your node will be identified by its' IP address instead.
80+
81+
Useful configuration items among others:
82+
83+
- `beneficiaryAddress`: Define a _beneficiary address_ which will receive parts of the harvested fees on the node.
84+
- `mainPrivateKey`: Caution here, please only use this option if you want to use a specific account for this node.
85+
- `remotePrivateKey`: Caution here, please only use this option if you already linked your main account to a specific remote account.
86+
- `vrfPrivateKey`: Caution here, please only use this option if you already linked your main account to a specific VRF account.
87+
- `maxUnlockedAccounts`: Define the _number of harvesting slots_ that are available for remote harvesting.
88+
- `enableDelegatedHarvestersAutoDetection`: Define whether you want to allow _persistent_ delegated harvesting.
89+
- `enableAutoHarvesting`: Define whether you want your node to automatically start harvesting or not.
90+
91+
:warning: If you put sensitive information in this file, please remind yourself to *remove it* after the node is configured and is ready to be run. We will make sure to point out at which point you can *clean* the custom configuration preset.
92+
93+
### Setup your node
94+
95+
After you customized the node experience, you can now actually prepare the configuration of your network node. First we'll need to pick a so-called *network preset*, a *target* folder, an *assembly* and optionally specify a *custom configuration preset*.
96+
97+
```bash
98+
$ yourdlt config -p bootstrap|mainnet|testnet|dhealth -t node -a peer|api|dual -c ~/node_config.yml
99+
```
100+
101+
In the above, make sure to pick a network preset that is either `mainnet` for Symbol Mainnet, `testnet` for Symbol Testnet or `dhealth` for DHealth Public Network. Also choose one of the assemblies with the following descripions:
102+
103+
- `peer`: Harvesting node (Creates blocks)
104+
- `api`: REST-enabled node (Relays information through an API)
105+
- `dual`: Full node (Creates blocks and relays information)
106+
107+
Following console output is an example after a successful **yourdlt config** execution:
108+
109+
```bash
110+
$ yourdlt config -p dhealth -t node -a dual
111+
__ __ ____ _ _____
112+
\ \ / /___ _ _ _ __ | _ \ | | |_ _|
113+
\ V // _ \ | | | || '__| | | | || | | |
114+
| || (_) || |_| || | | |_| || |___ | |
115+
|_| \___/ \__,_||_| |____/ |_____||_|
116+
117+
? Enter password to use to encrypt and decrypt custom presets, addresses.yml, and preset.yml files. When providing a password, private keys will be encrypte
118+
d. Keep this password in a secure place! ******
119+
2021-03-24T01:51:52.069Z info Password has been provided
120+
2021-03-24T01:51:52.097Z info Generating config from preset dhealth
121+
2021-03-24T01:51:52.098Z info Assembly preset dual
122+
2021-03-24T01:51:52.178Z info Generating Main account...
123+
2021-03-24T01:51:52.198Z info Generating Transport account...
124+
2021-03-24T01:51:52.206Z info Generating Remote account...
125+
2021-03-24T01:51:52.216Z info Generating VRF account...
126+
2021-03-24T01:51:52.239Z info User for docker resolved: 501:20
127+
2021-03-24T01:51:52.239Z info Running image using Exec: symbolplatform/symbol-server:tools-gcc-1.0.0.0 bash createNodeCertificates.sh
128+
2021-03-24T01:52:24.647Z info Certificate for node node created
129+
2021-03-24T01:52:24.657Z info Generating node server configuration
130+
2021-03-24T01:52:24.817Z info Generating broker broker configuration
131+
2021-03-24T01:52:24.896Z info Running image using Exec: symbolplatform/symbol-server:tools-gcc-1.0.0.0 /usr/catapult/bin/catapult.tools.votingkey --secret=HIDDEN_KEY --startEpoch=1 --endEpoch=360 --output=/votingKeys/private_key_tree1.dat
132+
2021-03-24T01:52:26.914Z warn A new Voting File for the node node has been regenerated!
133+
2021-03-24T01:52:26.914Z warn Remember to send a Voting Key Link transaction from main NAHLG4HPLLFFM7F3WTMFXTW7RTSTYKFR7REQSLY using the Voting Public Key 9B8CACAD44534D4DB830BB18CDA34CD43E034EA1AAA942B5D6BE463B144E5CA4
134+
2021-03-24T01:52:26.914Z warn For linking, you can use yourdlt link command, the symbol cli, or the symbol desktop wallet.
135+
2021-03-24T01:52:26.914Z warn The voting public key is stored in the target`s addresses.yml for reference
136+
2021-03-24T01:52:26.937Z info Deleting folder dual-node/nemesis/seed
137+
2021-03-24T01:52:27.213Z info Configuration generated.
138+
```
139+
140+
### Setup your device
141+
142+
```
143+
$ yourdlt compose -t node
144+
```
145+
146+
In the above make sure to replace `node` by the folder name you created using the *config* command just before. If you copy/pasted the command name from above, you can leave `node` here.
147+
148+
Following console output is an example after a successful **yourdlt compose** execution:
149+
150+
```bash
151+
$ yourdlt compose -t node
152+
__ __ ____ _ _____
153+
\ \ / /___ _ _ _ __ | _ \ | | |_ _|
154+
\ V // _ \ | | | || '__| | | | || | | |
155+
| || (_) || |_| || | | |_| || |___ | |
156+
|_| \___/ \__,_||_| |____/ |_____||_|
157+
158+
? Enter password to use to encrypt and decrypt custom presets, addresses.yml, and preset.yml files. When providing a password, private keys will be encrypte
159+
d. Keep this password in a secure place! *******
160+
2021-03-24T02:03:17.656Z info Password has been provided
161+
2021-03-24T02:03:17.739Z info User for docker resolved: 501:20
162+
2021-03-24T02:03:17.740Z info Creating docker-compose.yml from last used profile.
163+
2021-03-24T02:03:17.748Z info The docker-compose.yml file created /.../node/docker/docker-compose.yml
164+
165+
```
166+
167+
### Start your node
168+
169+
Note that in the following command, we use the `-d` command line argument to denote a *detached* execution, this starts the node *in a background process*. To get information about your node, please use `docker ps` after running the following command:
170+
171+
```bash
172+
$ yourdlt run -t -d node
173+
__ __ ____ _ _____
174+
\ \ / /___ _ _ _ __ | _ \ | | |_ _|
175+
\ V // _ \ | | | || '__| | | | || | | |
176+
| || (_) || |_| || | | |_| || |___ | |
177+
|_| \___/ \__,_||_| |____/ |_____||_|
178+
179+
2021-03-24T02:05:51.950Z info Spawn command: docker-compose -f node/docker/docker-compose.yml up --remove-orphans
180+
Creating network "docker_default" with the default driver
181+
Pulling db (mongo:4.4.3-bionic)...
182+
4.4.3-bionic: Pulling from library/mongo
183+
Pulling broker (symbolplatform/symbol-server:gcc-1.0.0.0)...
184+
gcc-1.0.0.0: Pulling from symbolplatform/symbol-server
185+
Pulling rest-gateway (symbolplatform/symbol-rest:2.3.5)...
186+
2.3.5: Pulling from symbolplatform/symbol-rest
187+
```
188+
189+
## Donations / Pot de vin
190+
191+
Donations can also be made with cryptocurrencies and will be used for running the project!
192+
193+
NEM (XEM): NB72EM6TTSX72O47T3GQFL345AB5WYKIDODKPPYW
194+
Symbol (XYM): NDQALDK4XWLOUYKPE7RDEWUI25YNRQ7VCGXMPCI
195+
Ethereum (ETH): 0x7a846fd5Daa4b904caF7C59f866bb906153305D2
196+
Bitcoin (BTC): 3EVqgUqYFRYbf9RjhyjBgKXcEwAQxhaf6o
197+
198+
## Sponsor us
199+
200+
| Platform | Sponsor Link |
201+
| --- | --- |
202+
| Paypal | [https://paypal.me/usingblockchainltd](https://paypal.me/usingblockchainltd) |
203+
| Patreon | [https://patreon.com/usingblockchainltd](https://patreon.com/usingblockchainltd) |
204+
| Github | [https://github.com/sponsors/UsingBlockchain](https://github.com/sponsors/UsingBlockchain) |
205+
206+
## Disclaimer
207+
208+
*The author of this package cannot be held responsible for any loss of money or any malintentioned usage forms of this package. Please use this package with caution.*
209+
210+
*Our software contains links to the websites of third parties (“external links”). As the content of these websites is not under our control, we cannot assume any liability for such external content. In all cases, the provider of information of the linked websites is liable for the content and accuracy of the information provided. At the point in time when the links were placed, no infringements of the law were recognisable to us..*
211+
212+
## License
213+
214+
Copyright 2020 NEM.
215+
Copyright 2021-present Using Blockchain Ltd, All rights reserved.
216+
217+
Licensed under the [Apache License 2.0](LICENSE)

‎docs/link.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ EXAMPLES
3939
$ echo "$MY_ENV_VAR_PASSWORD" | yourdlt link --unlink --useKnownRestGateways
4040
```
4141

42-
_See code: [src/commands/link.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.0/src/commands/link.ts)_
42+
_See code: [src/commands/link.ts](https://github.com/usingblockchain/yourdlt/blob/v1.1.1/src/commands/link.ts)_

0 commit comments

Comments
 (0)