Skip to content

Rippled

services.rippled.databasePath

Path to the ripple database.

Type: path

Default

"/var/lib/rippled"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.enable

Whether to enable rippled, a decentralized cryptocurrency blockchain daemon implementing the XRP Ledger protocol in C++. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.extraConfig

Extra lines to be added verbatim to the rippled.cfg configuration file.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.fetchDepth

The number of past ledgers to serve to other peers that request historical ledger data (or "full" for no limit).

Type: signed integer or value "full" (singular enum)

Default

"full"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.importDb

Settings for performing a one-time import. Type: null or (submodule)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.importDb.advisoryDelete

If set, then require administrative RPC call "can_delete" to enable online deletion of ledger records.

Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.importDb.compression

Whether to enable snappy compression. Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.importDb.extraOpts

Extra database options. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.importDb.onlineDelete

Enable automatic purging of older ledger information. Type: null or signed integer

Default

config.services.rippled.ledgerHistory

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.importDb.path

Location to store the database. Type: path

Default

config.services.rippled.databasePath

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.importDb.type

Rippled database type. Type: one of "rocksdb", "nudb"

Default

"rocksdb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ips

List of hostnames or ips where the Ripple protocol is served. For a starter list, you can either copy entries from: https://ripple.com/ripple.txt or if you prefer you can let it default to r.ripple.com 51235

A port may optionally be specified after adding a space to the address. By convention, if known, IPs are listed in from most to least trusted.

Type: list of string

Default

["r.ripple.com 51235"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ipsFixed

List of IP addresses or hostnames to which rippled should always attempt to maintain peer connections with. This is useful for manually forming private networks, for example to configure a validation server that connects to the Ripple network through a public-facing server, or for building a set of cluster peers.

A port may optionally be specified after adding a space to the address

Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ledgerHistory

The number of past ledgers to acquire on server startup and the minimum to maintain while running.

Type: signed integer or value "full" (singular enum)

Default

1296000

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.logLevel

Logging verbosity. Type: one of "debug", "error", "info"

Default

"error"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeDb

Rippled main database options. Type: null or (submodule)

Default

{extraOpts = '' open_files=2000 filter_bits=12 cache_mb=256 file_size_pb=8 file_size_mult=2; '';type = "rocksdb";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeDb.advisoryDelete

If set, then require administrative RPC call "can_delete" to enable online deletion of ledger records.

Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeDb.compression

Whether to enable snappy compression. Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeDb.extraOpts

Extra database options. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeDb.onlineDelete

Enable automatic purging of older ledger information. Type: null or signed integer

Default

config.services.rippled.ledgerHistory

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeDb.path

Location to store the database. Type: path

Default

config.services.rippled.databasePath

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeDb.type

Rippled database type. Type: one of "rocksdb", "nudb"

Default

"rocksdb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.nodeSize

Rippled size of the node you are running. "tiny", "small", "medium", "large", and "huge"

Type: one of "tiny", "small", "medium", "large", "huge"

Default

"small"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.package

The rippled package to use. Type: package

Default

pkgs.rippled

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports

Ports exposed by rippled Type: attribute set of (submodule)

Default

{peer = {ip = "0.0.0.0";port = 51235;protocol = ["peer"];};rpc = {admin = ["127.0.0.1"];port = 5005;protocol = ["http"];};ws_public = {ip = "0.0.0.0";port = 5006;protocol = ["ws""wss"];};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.admin

A comma-separated list of admin IP addresses. Type: list of string

Default

["127.0.0.1"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.ip

Ip where rippled listens. Type: string

Default

"127.0.0.1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.password

When set, these credentials will be required on HTTP/S requests. Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.port

Port where rippled listens. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.protocol

Protocols expose by rippled. Type: list of (one of "http", "https", "ws", "wss", "peer")

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.ssl.cert

Specifies the path to the SSL certificate file in PEM format. This is not needed if the chain includes it.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.ssl.chain

If you need a certificate chain, specify the path to the certificate chain here. The chain may include the end certificate.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.ssl.key

Specifies the filename holding the SSL key in PEM format.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.ports.<name>.user

When set, these credentials will be required on HTTP/S requests. Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.sntpServers

IP address or domain of NTP servers to use for time synchronization.;

Type: list of string

Default

["time.windows.com""time.apple.com""time.nist.gov""pool.ntp.org"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.statsd.address

The UDP address and port of the listening StatsD server. Type: string

Default

"127.0.0.1:8125"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.statsd.enable

Whether to enable statsd monitoring for rippled. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.statsd.prefix

A string prepended to each collected metric. Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.tempDb

Rippled temporary database options. Type: null or (submodule)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.tempDb.advisoryDelete

If set, then require administrative RPC call "can_delete" to enable online deletion of ledger records.

Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.tempDb.compression

Whether to enable snappy compression. Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.tempDb.extraOpts

Extra database options. Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.tempDb.onlineDelete

Enable automatic purging of older ledger information. Type: null or signed integer

Default

config.services.rippled.ledgerHistory

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.tempDb.path

Location to store the database. Type: path

Default

config.services.rippled.databasePath

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.tempDb.type

Rippled database type. Type: one of "rocksdb", "nudb"

Default

"rocksdb"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.validationQuorum

The minimum number of trusted validations a ledger must have before the server considers it fully validated.

Type: signed integer

Default

3

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix

services.rippled.validators

List of nodes to always accept as validators. Nodes are specified by domain or public key.

Type: list of string

Default

["n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7 RL1""n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj RL2""n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C RL3""n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS RL4""n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA RL5"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/rippled.nix