mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-12-03 01:55:51 +00:00
Add validator docs
This commit is contained in:
84
content/rippled-stock-node.md
Normal file
84
content/rippled-stock-node.md
Normal file
@@ -0,0 +1,84 @@
|
||||
The purpose of this document is to describe the steps one must perform to run a rippled node.
|
||||
|
||||
# Vocabulary
|
||||
|
||||
- rippled node - A single running instance of rippled
|
||||
|
||||
# Binary installation
|
||||
|
||||
This document assumes that you are using Ubuntu 14.04.
|
||||
|
||||
1. Install the ripple apt archive
|
||||
|
||||
$ sudo apt-get install software-properties-common
|
||||
$ sudo apt-add-repository 'deb http://mirrors.ripple.com/ubuntu/ trusty stable contrib'
|
||||
$ sudo apt-get update
|
||||
|
||||
2. Install rippled:
|
||||
|
||||
$ sudo apt-get install rippled
|
||||
|
||||
3. Configure rippled in `/etc/rippled/rippled.cfg`
|
||||
|
||||
[server]
|
||||
port_peer
|
||||
port_rpc
|
||||
port_ws
|
||||
|
||||
[port_peer]
|
||||
port = 51235
|
||||
ip = 0.0.0.0
|
||||
protocol = peer
|
||||
|
||||
[port_rpc]
|
||||
port = 51234
|
||||
ip = 0.0.0.0
|
||||
admin = allow
|
||||
protocol = http
|
||||
|
||||
[port_ws]
|
||||
port = 51233
|
||||
ip = 0.0.0.0
|
||||
admin = allow
|
||||
protocol = ws
|
||||
|
||||
[peer_private]
|
||||
1
|
||||
|
||||
[ledger_history]
|
||||
full
|
||||
|
||||
[ssl_verify]
|
||||
0
|
||||
|
||||
[sntp_servers]
|
||||
time.windows.com
|
||||
time.apple.com
|
||||
time.nist.gov
|
||||
pool.ntp.org
|
||||
|
||||
[rpc_allow_remote]
|
||||
1
|
||||
|
||||
[node_db]
|
||||
type=nudb
|
||||
path=/mnt/rippled/db/nudb
|
||||
|
||||
[database_path]
|
||||
/mnt/rippled/db
|
||||
|
||||
[rpc_startup]
|
||||
{"command": "log_level", "severity": "warning"}
|
||||
|
||||
See [here](https://github.com/ripple/rippled/blob/develop/doc/rippled-example.cfg) for additional configuration options.
|
||||
|
||||
4. Give rippled permission to mount
|
||||
|
||||
$ sudo mkdir /mnt/rippled
|
||||
$ sudo chown rippled:rippled -R /mnt/rippled
|
||||
|
||||
5. Start rippled node
|
||||
|
||||
$ sudo service rippled start
|
||||
|
||||
See [Configuring rippled to validate ledgers](rippled-validator.html) to learn how to turn your node into a validator.
|
||||
23
content/rippled-trusted-validator.md
Normal file
23
content/rippled-trusted-validator.md
Normal file
@@ -0,0 +1,23 @@
|
||||
The purpose of this document is to describe the steps one must perform to become
|
||||
a trusted validator on Ripple Altnet.
|
||||
|
||||
# Vocabulary
|
||||
|
||||
- rippled node - A single running instance of rippled
|
||||
- Validator - A rippled node that validates transactions
|
||||
- Untrusted validator - A validator that is not included in the UNL of other validators on the network
|
||||
- Trusted validator - A validator that is included in the UNL of other validators on the network
|
||||
|
||||
# Binary installation
|
||||
|
||||
This document assumes that you are using Ubuntu 14.04.
|
||||
|
||||
1. [Add an untrusted rippled validator to the Altnet](rippled-untrusted-validator.html)
|
||||
|
||||
2. ???
|
||||
|
||||
Be monitor for trustworthiness?
|
||||
|
||||
Add validator's ip and validation public key to core validators
|
||||
|
||||
Increase `[validation_quorum]`
|
||||
71
content/rippled-untrusted-validator.md
Normal file
71
content/rippled-untrusted-validator.md
Normal file
@@ -0,0 +1,71 @@
|
||||
The purpose of this document is to describe the steps one must perform to run
|
||||
an "untrusted" rippled validator on an existing network.
|
||||
|
||||
# Vocabulary
|
||||
|
||||
- rippled node - A single running instance of rippled
|
||||
- Validator - A rippled node that validates transactions
|
||||
- Untrusted validator - A validator that is not included in the UNL of other validators on the network
|
||||
|
||||
# Binary installation
|
||||
|
||||
This document assumes that you are using Ubuntu 14.04.
|
||||
|
||||
1. [Install & configure a rippled validator](rippled-validator.html)
|
||||
|
||||
2. Stop rippled if it is currently running
|
||||
|
||||
$ sudo service rippled stop
|
||||
|
||||
3. Add core validator IP addresses of the network you want to connect to to rippled.cfg
|
||||
|
||||
For example the following IP addresses are the current Altnet core validators:
|
||||
|
||||
[ips_fixed]
|
||||
54.92.66.122 51235
|
||||
54.67.72.173 51235
|
||||
52.16.66.76 51235
|
||||
54.93.66.235 51235
|
||||
52.74.67.18 51235
|
||||
52.64.9.71 51235
|
||||
54.207.20.165 51235
|
||||
54.172.212.33 51235
|
||||
52.11.28.194 51235
|
||||
54.94.245.104 51235
|
||||
54.65.200.22 51235
|
||||
52.1.205.132 51235
|
||||
|
||||
4. Add core validator validation public keys to rippled.cfg.
|
||||
|
||||
For example the following keys are the current Altnet core validators' validation public keys:
|
||||
|
||||
[validators]
|
||||
n9LnZ1AiyHmytkhLUr89dmL76uxZLzzyregvQVZFkVfqEQTCpg7B
|
||||
n9LJWexXc9wxzUKWZe4faTS4N9DUba3jNsByERZSa8MJc2bhCF7c
|
||||
n9MnXUt5Qcx3BuBYKJfS4fqSohgkT79NGjXnZeD9joKvP3A5RNGm
|
||||
n9LxyXSSrTZ482ceep9WGQnT2nknfzFMFgNL4wMjTUn3SfF3rhtS
|
||||
n9MTPLhEEjxcWHfqsXQhFoSUKaqYvU4E7B4yke39EMFm2DhFr43F
|
||||
n9Lw3j7THPhKLz2uDqBBWwyxHQC1Foyr3M6JeWCVyu7uhnhL6HA5
|
||||
n9L2XLFvcdriK34bCNXexzKMVcsZ9i4UG9J4pykR5c3J8gvBB6fw
|
||||
n9JCK3M4ci7b1XRq2wr1Ckd1HNq3Cg7NWrWiKyzJa4R5J489QGer
|
||||
n9LXZBs2aBiNsgBkhVJJjDX4xA4DoEBLycF6q8zRhXD1Zu3Kwbe4
|
||||
n9Kk6U5nSF8EggfmTpMdna96UuXWAVwSsDSXRkXeZ5vLcAFk77tr
|
||||
n9J1voqeu6iZQiLXaMofLeMbv8mbPskJWGYRtjdo8rmpvNdQRyEn
|
||||
n9KuCFBLq2GD4vJtoL3tebQJbhcHSd7tMqFM1x9bPK9wSagPJdd1
|
||||
|
||||
5. Adjust the validation quorum value in rippled.cfg
|
||||
|
||||
This sets the minimum of trusted validations a ledger must have before the server considers it fully validated. Note that if you are validating, your validation counts.
|
||||
|
||||
For example a validation quorum for a new Altnet validator could be set to
|
||||
|
||||
[validation_quorum]
|
||||
10
|
||||
|
||||
6. Start rippled untrusted validator
|
||||
|
||||
$ sudo service rippled start
|
||||
|
||||
The new untrusted validator will first sync with the existing network then start proposing and validating new transactions.
|
||||
|
||||
See [Creating a Trusted Rippled Validator](rippled-trusted-validator.html) on how to become a trusted validator on the network.
|
||||
47
content/rippled-validator.md
Normal file
47
content/rippled-validator.md
Normal file
@@ -0,0 +1,47 @@
|
||||
The purpose of this document is to describe the steps one must perform to run
|
||||
a rippled validator that starts from a fresh ledger and is not connected to any existing network.
|
||||
|
||||
# Vocabulary
|
||||
|
||||
- rippled node - A single running instance of rippled
|
||||
- Validator - A rippled node that validates transactions
|
||||
|
||||
# Binary installation
|
||||
|
||||
This document assumes that you are using Ubuntu 14.04.
|
||||
|
||||
1. [Install & configure a rippled node](rippled-stock-node.html)
|
||||
|
||||
2. Start rippled
|
||||
|
||||
$ sudo service rippled start
|
||||
|
||||
3. Generate a validator key and save the output
|
||||
|
||||
$ rippled --conf /etc/rippled/rippled.cfg -q validation_create
|
||||
{
|
||||
"status" : "success",
|
||||
"validation_key" : "FOLD WERE CHOW WIT SWIM RANK WED DAN LAIN TRIO MURK NELL",
|
||||
"validation_public_key" : "n9KHn8NfbBsZV5q8bLfS72XyGqwFt5mgoPbcTV4c6qKiuPTAtXYk",
|
||||
"validation_seed" : "ssdecohJMDPFuUPDkmG1w4objZyp4"
|
||||
}
|
||||
|
||||
4. Stop rippled
|
||||
|
||||
$ sudo service rippled stop
|
||||
|
||||
5. Add the generated validator signing key from above to rippled.cfg
|
||||
|
||||
[validation_seed]
|
||||
ssdecohJMDPFuUPDkmG1w4objZyp4
|
||||
|
||||
6. Add validation quorum value to rippled.cfg
|
||||
|
||||
[validation_quorum]
|
||||
0
|
||||
|
||||
7. Start rippled validator as the first node starting at a fresh ledger
|
||||
|
||||
$ sudo start-stop-daemon --start --quiet --background -m --pidfile /var/run/rippled.pid --exec /usr/sbin/rippled --chuid rippled --group rippled -- --start --conf /etc/rippled/rippled.cfg
|
||||
|
||||
See [Configuring rippled to trust other validators](rippled-untrusted-validator.html) to learn how additional nodes can be added to the new network.
|
||||
@@ -2,7 +2,9 @@
|
||||
|
||||
The core peer-to-peer server that operates the Ripple Network is called `rippled`. Each `rippled` server connects to the Ripple Network, relays cryptographically signed transactions, and maintains a local copy of the complete shared global ledger. The source code for `rippled` is written in C++, and is [available on GitHub under an open-source license](https://github.com/ripple/rippled).
|
||||
|
||||
* [Building and Installing](https://wiki.ripple.com/Rippled_build_instructions)
|
||||
* [Building from source](https://wiki.ripple.com/Rippled_build_instructions)
|
||||
* [Installing from precompiled binaries](rippled-stock-node.html)
|
||||
* [Setting up a validator](rippled-validator.html)
|
||||
* [API Reference](#api-methods)
|
||||
* [Transaction Reference](transactions.html)
|
||||
* Client Library - [Javascript](https://github.com/ripple/ripple-lib)
|
||||
|
||||
Reference in New Issue
Block a user