.png%3Falt%3Dmedia%26token%3Dbac8f114-f7a7-4e88-8396-75aa9cbef3e2){kind=spacer}
.png%3Falt%3Dmedia%26token%3Dbac8f114-f7a7-4e88-8396-75aa9cbef3e2){kind=spacer}
Klaytn Docs
Search…
Setting up a 4-node Service Chain
This section covers how to set up a multi-node ServiceChain. We will set up a 4-consensus-node ServiceChain with
chainID 1002, as you can see in the blue border box in the figure below.
Prerequisites
- 4 Linux or MacOS servers
- Minimum hardware requirements
- CPU: 4-core (Intel Xeon or equivalent), RAM: 16GB, HDD: 50GB
Step 0: Install SCN on all nodes
The installation is the uncompression of the downloaded package. Extract the SCN archive on each server.
1
$ tar xvf kscn-vX.X.X-XXXXX-amd64.tar.gz
2
x kscn-XXXXX-amd64/
3
x kscn-XXXXX-amd64/conf/
4
x kscn-XXXXX-amd64/conf/kscnd.conf
5
x kscn-XXXXX-amd64/bin/
6
x kscn-XXXXX-amd64/bin/kscnd
7
x kscn-XXXXX-amd64/bin/kscn
Copied!
For the convenience, we will add the binary path to $PATH. Use the actual path on your node.
1
$ export PATH=$PATH:~/path/to/kscn-XXXXX-amd64/bin
Copied!
SCN also provides various RPM distributions like RHEL, CentOS, and Fedora. For more information, please refer to Installation.
1
$ curl -o /etc/yum.repos.d/klaytn.repo https://packages.klaytn.net/config/rhel/7/prod.repo
2
% Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed
3
100 118 100 118 0 0 1113 0 --:--:-- --:--:-- --:--:-- 1102
4
​
5
$ yum list | grep klaytn
6
packages-klaytn-prod 31 kB/s | 2.9 kB 00:00
7
homi.x86_64 v1.8.0-0.el7 packages-klaytn-prod
8
kbnd.x86_64 v1.8.0-0.el7 packages-klaytn-prod
9
kcnd.x86_64 v1.8.0-0.el7 packages-klaytn-prod
10
kcnd-baobab.x86_64 v1.8.0-0.el7 packages-klaytn-prod
11
kend.x86_64 v1.8.0-0.el7 packages-klaytn-prod
12
kend-baobab.x86_64 v1.8.0-0.el7 packages-klaytn-prod
13
kgen.x86_64 v1.8.0-0.el7 packages-klaytn-prod
14
kpnd.x86_64 v1.8.0-0.el7 packages-klaytn-prod
15
kpnd-baobab.x86_64 v1.8.0-0.el7 packages-klaytn-prod
16
kscnd.x86_64 v1.8.0-0.el7 packages-klaytn-prod
17
ksend.x86_64 v1.8.0-0.el7 packages-klaytn-prod
18
kspnd.x86_64 v1.8.0-0.el7 packages-klaytn-prod
19
​
20
$ yum install kscnd
Copied!
Step 1: Create genesis.json and nodekeys
We will use homi utility to generate the needful files.
homi is a utility that automatically generates scripts, configuration files, and private keys necessary to configure the Klaytn blockchain. You can execute homi from any Linux/Mac PC.First, extract the homi archive you downloaded.
1
$ tar xvf homi-vX.X.X-XXXXX-amd64.tar.gz
2
x homi-XXXXX-amd64/
3
x homi-XXXXX-amd64/bin/
4
x homi-XXXXX-amd64/bin/homi
Copied!
Go to the
bin folder and execute homi with following options to generate the files. homi setup local --cn-num 4 --test-num 1 --servicechain --chainID 1002 --p2p-port 22323 -o homi-output Since Baobab's chainID is 1001, for convenience, the chainID of the ServiceChain constructed in this example is set to 1002. When operating a blockchain by launching an actual service, it is recommended to use it after registering a new chainID value at https://chainlist.defillama.com/ so that chainID does not overlap with other ServiceChains. The ServiceChain port is set to 22323, which is the default port.1
$ ./homi setup local --cn-num 4 --test-num 1 --servicechain --chainID 1002 --p2p-port 22323 -o homi-output
2
Created : homi-output/keys/passwd1
3
Created : homi-output/keys/passwd2
4
Created : homi-output/keys/passwd3
5
Created : homi-output/keys/passwd4
6
Created : homi-output/scripts/genesis.json
7
Created : homi-output/keys/nodekey1
8
Created : homi-output/keys/validator1
9
Created : homi-output/keys/nodekey2
10
Created : homi-output/keys/validator2
11
Created : homi-output/keys/nodekey3
12
Created : homi-output/keys/validator3
13
Created : homi-output/keys/nodekey4
14
Created : homi-output/keys/validator4
15
Created : homi-output/scripts/static-nodes.json
16
Created : homi-output/keys_test/testkey1
17
Created : homi-output/keys_test/keystore1/0xdC7218621513f71d609653d22C39d79d558d9CDC
18
Created : homi-output/Klaytn.json
19
Created : homi-output/Klaytn_txpool.json
Copied!
Among the outputs, we will use
nodekey*, genesis.json and static-nodes.json in the subsequent steps.Step 2: Customize static-nodes.json
Open
homi-output/scripts/static-nodes.json in a text editor then update the IP addresses and ports with the actual values of your nodes. In this example, it is assumed that the IP of each SCN node in the ServiceChain is as shown in the figure below. Remember the port you assigned here, as it will be used later in step 4.
1
[
2
"kni://[email protected]:22323?discport=0\u0026ntype=cn",
3
"kni://[email protected]:22323?discport=0\u0026ntype=cn",
4
"kni://[email protected]:22323?discport=0\u0026ntype=cn",
5
"kni://[email protected]:22323?discport=0\u0026ntype=cn"
6
]
Copied!
After you update
static-nodes.json, upload the output folders(homi-output) to all SCNs, i.e. SCN-L2-01, SCN-L2-02, SCN-L2-03, SCN-L2-04 nodes in this example.1
$ scp -r path/to/homi-output/ [email protected]:~/
2
$ scp -r path/to/homi-output/ [email protected]:~/
3
$ scp -r path/to/homi-output/ [email protected]:~/
4
$ scp -r path/to/homi-output/ [email protected]:~/
Copied!
Step 3: Node initialization
Now, we will initialize each node using the genesis file. On each node, execute the following command. It will create the data folder storing the chain data and logs on your home directory. You can change the data folder using the
--datadir directive. In this example, we set the data folder to \~/data.1
$ kscn --datadir ~/data init ~/homi-output/scripts/genesis.json
2
​
3
$ ls ~/data
4
keystore klay kscn
Copied!
Step 4: Install nodekey and static-nodes.json
nodekey and static-nodes.jsonOn every SCNs, copy
static-nodes.json to the data folder.1
$ cp ~/homi-output/scripts/static-nodes.json ~/data/
Copied!
In step 1, we generated 4 nodekeys. Assign each node key to the SCN and copy the matching
nodekey to each SCN's data folder. For example, use nodekey1 for SCN-L2-01(192.168.0.1) node and use nodekey2, nodekey3 and nodekey4 for SCN-L2-02(192.168.0.2), SCN-L2-03(192.168.0.3) and SCN-L2-04(192.168.0.4) respectively.1
$ cp ~/homi-output/keys/nodekey{1..4} ~/data/klay/nodekey
Copied!
Step 5: Configure nodes
On every SCNs, go to the kscn installation folder and edit
conf/kscnd.conf as follows. PORT is the port used to set up homi, and SC_SUB_BRIDGE is required for connecting bridges in the next section. For now, just set it to 0. In DATA_DIR, enter the data folder used in step 3.1
...
2
PORT=22323
3
...
4
SC_SUB_BRIDGE=0
5
...
6
DATA_DIR=~/data
7
...
Copied!
Step 6: Start nodes
Execute the following command on all SCN nodes.
1
$ kscnd start
2
Starting kscnd: OK
Copied!
You can check block generation status by watching
klay.blockNumber. If this number is not 0, the node is working fine.1
$ kscn attach --datadir ~/data
2
> klay.blockNumber
3
10
Copied!
If you want to stop a node, you can use the command
kscnd stop(Example) Creation and confirmation of a value transfer transaction
Now the 4-node ServiceChain is up and running. We will execute a value transfer transaction in the ServiceChain to confirm the installation.
Step 1: Import the test account
testkey1 was automatically generated by homi in step 1. KLAY is allocated to the test account as described in the genesis.json which was also generated by homi.1
$ kscn account import --datadir ~/data ~/homi-output/keys_test/testkey1
2
Your new account is locked with a password. Please give a password. Do not forget this password.
3
Passphrase:
4
Repeat passphrase:
5
Address: {80119c31cdae67c42c8296929bb4f89b2a52cec4}
Copied!
Step 2: Unlock the account
Unlocking the account is possible only through the console of the SCN node that imported
testkey1.1
$ kscn attach --datadir ~/data
2
> personal.unlockAccount("80119c31cdae67c42c8296929bb4f89b2a52cec4")
3
Unlock account 80119c31cdae67c42c8296929bb4f89b2a52cec4
4
Passphrase:
5
true
Copied!
Step 3: Send a transaction and check the balance
1
> klay.sendTransaction({from: "80119c31cdae67c42c8296929bb4f89b2a52cec4", to: "305c6cc464d5fe1e624679695a20d641a01688e1", value: 10})
2
"0xa0e7102e8f14200cec8d964aacc1c9ed7c22271078b2b213170c64333cbca8a3"
3
> klay.getBalance("305c6cc464d5fe1e624679695a20d641a01688e1")
4
10
Copied!
The simplest form of ServiceChain is having one SCN. The ServiceChain illustrated in this tutorial is a 4-node ServiceChain. You can, however, set up a single-node ServiceChain if you wish. Simply pass
--cn-num 1 instead of --cn-num 4 to homi in 'Step 1:Create genesis.json and nodekeys'.At least 4 nodes are required to tolerate byzantine faults. Therefore, the minimum number of SCNs to achieve high availability under the BFT algorithm is 4. Having 2 SCN nodes is not enough, because if one SCN fails, the other one cannot reach a consensus on its own.
Last modified 1mo ago
Copy link
Edit on GitHub
Contents
Prerequisites
Step 0: Install SCN on all nodes
Step 1: Create genesis.json and nodekeys
Step 2: Customize static-nodes.json
Step 3: Node initialization
Step 4: Install nodekey and static-nodes.json
Step 5: Configure nodes
Step 6: Start nodes
(Example) Creation and confirmation of a value transfer transaction