commit 1e04dc200001a782a756ffde8c76224db221865e · pyrox.dev/nixpkgs

doc/release-notes/rl-2505.section.md

···

       4
       4
        
       

     

       5
       5
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

     

       6
       6
        
       

     

       7
       7
       +
       - `services.rippled` has been removed, as `rippled` was broken and had not been updated since 2022.

     

       8
       8
       +
       

     

       9
       9
       +
       - `services.rippleDataApi` has been removed, as `ripple-data-api` was broken and had not been updated since 2022.

     

       10
       10
       +
       

     

       7
       11
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

     

       8
       12
        
       

     

       9
       13
        
       ### Titanium removed {#sec-nixpkgs-release-25.05-incompatibilities-titanium-removed}

-2

nixos/modules/module-list.nix

···

       864
       864
        
         ./services/misc/redlib.nix

     

       865
       865
        
         ./services/misc/redmine.nix

     

       866
       866
        
         ./services/misc/renovate.nix

     

       867
       867
       -
         ./services/misc/ripple-data-api.nix

     

       868
       868
       -
         ./services/misc/rippled.nix

     

       869
       867
        
         ./services/misc/rmfakecloud.nix

     

       870
       868
        
         ./services/misc/rkvm.nix

     

       871
       869
        
         ./services/misc/rshim.nix

nixos/modules/rename.nix

···

       295
       295
        
           (mkRemovedOptionModule [ "services" "tedicross" ] ''

     

       296
       296
        
             The corresponding package was broken and removed from nixpkgs.

     

       297
       297
        
           '')

     

       298
       298
       +
           (mkRemovedOptionModule [ "services" "rippled" ] ''

     

       299
       299
       +
             The corresponding package was broken, abandoned upstream and thus removed from nixpkgs.

     

       300
       300
       +
           '')

     

       301
       301
       +
           (mkRemovedOptionModule [ "services" "rippleDataApi" ] ''

     

       302
       302
       +
             The corresponding package was broken, abandoned upstream and thus removed from nixpkgs.

     

       303
       303
       +
           '')

     

       298
       304
        
       

     

       299
       305
        
           # Do NOT add any option renames here, see top of the file

     

       300
       306
        
         ];

-209

nixos/modules/services/misc/ripple-data-api.nix

···

       1
       1
       -
       {

     

       2
       2
       -
         config,

     

       3
       3
       -
         lib,

     

       4
       4
       -
         pkgs,

     

       5
       5
       -
         ...

     

       6
       6
       -
       }:

     

       7
       7
       -
       let

     

       8
       8
       -
         cfg = config.services.rippleDataApi;

     

       9
       9
       -
       

     

       10
       10
       -
         deployment_env_config = builtins.toJSON {

     

       11
       11
       -
           production = {

     

       12
       12
       -
             port = toString cfg.port;

     

       13
       13
       -
             maxSockets = 150;

     

       14
       14
       -
             batchSize = 100;

     

       15
       15
       -
             startIndex = 32570;

     

       16
       16
       -
             rippleds = cfg.rippleds;

     

       17
       17
       -
             redis = {

     

       18
       18
       -
               enable = cfg.redis.enable;

     

       19
       19
       -
               host = cfg.redis.host;

     

       20
       20
       -
               port = cfg.redis.port;

     

       21
       21
       -
               options.auth_pass = null;

     

       22
       22
       -
             };

     

       23
       23
       -
           };

     

       24
       24
       -
         };

     

       25
       25
       -
       

     

       26
       26
       -
         db_config = builtins.toJSON {

     

       27
       27
       -
           production = {

     

       28
       28
       -
             username = lib.optional (cfg.couchdb.pass != "") cfg.couchdb.user;

     

       29
       29
       -
             password = lib.optional (cfg.couchdb.pass != "") cfg.couchdb.pass;

     

       30
       30
       -
             host = cfg.couchdb.host;

     

       31
       31
       -
             port = cfg.couchdb.port;

     

       32
       32
       -
             database = cfg.couchdb.db;

     

       33
       33
       -
             protocol = "http";

     

       34
       34
       -
           };

     

       35
       35
       -
         };

     

       36
       36
       -
       

     

       37
       37
       -
       in

     

       38
       38
       -
       {

     

       39
       39
       -
         options = {

     

       40
       40
       -
           services.rippleDataApi = {

     

       41
       41
       -
             enable = lib.mkEnableOption "ripple data api";

     

       42
       42
       -
       

     

       43
       43
       -
             port = lib.mkOption {

     

       44
       44
       -
               description = "Ripple data api port";

     

       45
       45
       -
               default = 5993;

     

       46
       46
       -
               type = lib.types.port;

     

       47
       47
       -
             };

     

       48
       48
       -
       

     

       49
       49
       -
             importMode = lib.mkOption {

     

       50
       50
       -
               description = "Ripple data api import mode.";

     

       51
       51
       -
               default = "liveOnly";

     

       52
       52
       -
               type = lib.types.enum [

     

       53
       53
       -
                 "live"

     

       54
       54
       -
                 "liveOnly"

     

       55
       55
       -
               ];

     

       56
       56
       -
             };

     

       57
       57
       -
       

     

       58
       58
       -
             minLedger = lib.mkOption {

     

       59
       59
       -
               description = "Ripple data api minimal ledger to fetch.";

     

       60
       60
       -
               default = null;

     

       61
       61
       -
               type = lib.types.nullOr lib.types.int;

     

       62
       62
       -
             };

     

       63
       63
       -
       

     

       64
       64
       -
             maxLedger = lib.mkOption {

     

       65
       65
       -
               description = "Ripple data api maximal ledger to fetch.";

     

       66
       66
       -
               default = null;

     

       67
       67
       -
               type = lib.types.nullOr lib.types.int;

     

       68
       68
       -
             };

     

       69
       69
       -
       

     

       70
       70
       -
             redis = {

     

       71
       71
       -
               enable = lib.mkOption {

     

       72
       72
       -
                 description = "Whether to enable caching of ripple data to redis.";

     

       73
       73
       -
                 default = true;

     

       74
       74
       -
                 type = lib.types.bool;

     

       75
       75
       -
               };

     

       76
       76
       -
       

     

       77
       77
       -
               host = lib.mkOption {

     

       78
       78
       -
                 description = "Ripple data api redis host.";

     

       79
       79
       -
                 default = "localhost";

     

       80
       80
       -
                 type = lib.types.str;

     

       81
       81
       -
               };

     

       82
       82
       -
       

     

       83
       83
       -
               port = lib.mkOption {

     

       84
       84
       -
                 description = "Ripple data api redis port.";

     

       85
       85
       -
                 default = 5984;

     

       86
       86
       -
                 type = lib.types.port;

     

       87
       87
       -
               };

     

       88
       88
       -
             };

     

       89
       89
       -
       

     

       90
       90
       -
             couchdb = {

     

       91
       91
       -
               host = lib.mkOption {

     

       92
       92
       -
                 description = "Ripple data api couchdb host.";

     

       93
       93
       -
                 default = "localhost";

     

       94
       94
       -
                 type = lib.types.str;

     

       95
       95
       -
               };

     

       96
       96
       -
       

     

       97
       97
       -
               port = lib.mkOption {

     

       98
       98
       -
                 description = "Ripple data api couchdb port.";

     

       99
       99
       -
                 default = 5984;

     

       100
       100
       -
                 type = lib.types.port;

     

       101
       101
       -
               };

     

       102
       102
       -
       

     

       103
       103
       -
               db = lib.mkOption {

     

       104
       104
       -
                 description = "Ripple data api couchdb database.";

     

       105
       105
       -
                 default = "rippled";

     

       106
       106
       -
                 type = lib.types.str;

     

       107
       107
       -
               };

     

       108
       108
       -
       

     

       109
       109
       -
               user = lib.mkOption {

     

       110
       110
       -
                 description = "Ripple data api couchdb username.";

     

       111
       111
       -
                 default = "rippled";

     

       112
       112
       -
                 type = lib.types.str;

     

       113
       113
       -
               };

     

       114
       114
       -
       

     

       115
       115
       -
               pass = lib.mkOption {

     

       116
       116
       -
                 description = "Ripple data api couchdb password.";

     

       117
       117
       -
                 default = "";

     

       118
       118
       -
                 type = lib.types.str;

     

       119
       119
       -
               };

     

       120
       120
       -
       

     

       121
       121
       -
               create = lib.mkOption {

     

       122
       122
       -
                 description = "Whether to create couchdb database needed by ripple data api.";

     

       123
       123
       -
                 type = lib.types.bool;

     

       124
       124
       -
                 default = true;

     

       125
       125
       -
               };

     

       126
       126
       -
             };

     

       127
       127
       -
       

     

       128
       128
       -
             rippleds = lib.mkOption {

     

       129
       129
       -
               description = "List of rippleds to be used by ripple data api.";

     

       130
       130
       -
               default = [

     

       131
       131
       -
                 "http://s_east.ripple.com:51234"

     

       132
       132
       -
                 "http://s_west.ripple.com:51234"

     

       133
       133
       -
               ];

     

       134
       134
       -
               type = lib.types.listOf lib.types.str;

     

       135
       135
       -
             };

     

       136
       136
       -
           };

     

       137
       137
       -
         };

     

       138
       138
       -
       

     

       139
       139
       -
         config = lib.mkIf (cfg.enable) {

     

       140
       140
       -
           services.couchdb.enable = lib.mkDefault true;

     

       141
       141
       -
           services.couchdb.bindAddress = lib.mkDefault "0.0.0.0";

     

       142
       142
       -
           services.redis.enable = lib.mkDefault true;

     

       143
       143
       -
       

     

       144
       144
       -
           systemd.services.ripple-data-api = {

     

       145
       145
       -
             after = [

     

       146
       146
       -
               "couchdb.service"

     

       147
       147
       -
               "redis.service"

     

       148
       148
       -
               "ripple-data-api-importer.service"

     

       149
       149
       -
             ];

     

       150
       150
       -
             wantedBy = [ "multi-user.target" ];

     

       151
       151
       -
       

     

       152
       152
       -
             environment = {

     

       153
       153
       -
               NODE_ENV = "production";

     

       154
       154
       -
               DEPLOYMENT_ENVS_CONFIG = pkgs.writeText "deployment.environment.json" deployment_env_config;

     

       155
       155
       -
               DB_CONFIG = pkgs.writeText "db.config.json" db_config;

     

       156
       156
       -
             };

     

       157
       157
       -
       

     

       158
       158
       -
             serviceConfig = {

     

       159
       159
       -
               ExecStart = "${pkgs.ripple-data-api}/bin/api";

     

       160
       160
       -
               Restart = "always";

     

       161
       161
       -
               User = "ripple-data-api";

     

       162
       162
       -
             };

     

       163
       163
       -
           };

     

       164
       164
       -
       

     

       165
       165
       -
           systemd.services.ripple-data-importer = {

     

       166
       166
       -
             after = [ "couchdb.service" ];

     

       167
       167
       -
             wantedBy = [ "multi-user.target" ];

     

       168
       168
       -
             path = [ pkgs.curl ];

     

       169
       169
       -
       

     

       170
       170
       -
             environment = {

     

       171
       171
       -
               NODE_ENV = "production";

     

       172
       172
       -
               DEPLOYMENT_ENVS_CONFIG = pkgs.writeText "deployment.environment.json" deployment_env_config;

     

       173
       173
       -
               DB_CONFIG = pkgs.writeText "db.config.json" db_config;

     

       174
       174
       -
               LOG_FILE = "/dev/null";

     

       175
       175
       -
             };

     

       176
       176
       -
       

     

       177
       177
       -
             serviceConfig =

     

       178
       178
       -
               let

     

       179
       179
       -
                 importMode =

     

       180
       180
       -
                   if cfg.minLedger != null && cfg.maxLedger != null then

     

       181
       181
       -
                     "${toString cfg.minLedger} ${toString cfg.maxLedger}"

     

       182
       182
       -
                   else

     

       183
       183
       -
                     cfg.importMode;

     

       184
       184
       -
               in

     

       185
       185
       -
               {

     

       186
       186
       -
                 ExecStart = "${pkgs.ripple-data-api}/bin/importer ${importMode} debug";

     

       187
       187
       -
                 Restart = "always";

     

       188
       188
       -
                 User = "ripple-data-api";

     

       189
       189
       -
               };

     

       190
       190
       -
       

     

       191
       191
       -
             preStart = lib.mkMerge [

     

       192
       192
       -
               (lib.mkIf (cfg.couchdb.create) ''

     

       193
       193
       -
                 HOST="http://${

     

       194
       194
       -
                   lib.optionalString (cfg.couchdb.pass != "") "${cfg.couchdb.user}:${cfg.couchdb.pass}@"

     

       195
       195
       -
                 }${cfg.couchdb.host}:${toString cfg.couchdb.port}"

     

       196
       196
       -
                 curl -X PUT $HOST/${cfg.couchdb.db} || true

     

       197
       197
       -
               '')

     

       198
       198
       -
               "${pkgs.ripple-data-api}/bin/update-views"

     

       199
       199
       -
             ];

     

       200
       200
       -
           };

     

       201
       201
       -
       

     

       202
       202
       -
           users.users.ripple-data-api = {

     

       203
       203
       -
             description = "Ripple data api user";

     

       204
       204
       -
             isSystemUser = true;

     

       205
       205
       -
             group = "ripple-data-api";

     

       206
       206
       -
           };

     

       207
       207
       -
           users.groups.ripple-data-api = { };

     

       208
       208
       -
         };

     

       209
       209
       -
       }

-463

nixos/modules/services/misc/rippled.nix

···

       1
       1
       -
       {

     

       2
       2
       -
         config,

     

       3
       3
       -
         lib,

     

       4
       4
       -
         options,

     

       5
       5
       -
         pkgs,

     

       6
       6
       -
         ...

     

       7
       7
       -
       }:

     

       8
       8
       -
       let

     

       9
       9
       -
         cfg = config.services.rippled;

     

       10
       10
       -
         opt = options.services.rippled;

     

       11
       11
       -
       

     

       12
       12
       -
         b2i = val: if val then "1" else "0";

     

       13
       13
       -
       

     

       14
       14
       -
         dbCfg = db: ''

     

       15
       15
       -
           type=${db.type}

     

       16
       16
       -
           path=${db.path}

     

       17
       17
       -
           ${lib.optionalString (db.compression != null) ("compression=${b2i db.compression}")}

     

       18
       18
       -
           ${lib.optionalString (db.onlineDelete != null) ("online_delete=${toString db.onlineDelete}")}

     

       19
       19
       -
           ${lib.optionalString (db.advisoryDelete != null) ("advisory_delete=${b2i db.advisoryDelete}")}

     

       20
       20
       -
           ${db.extraOpts}

     

       21
       21
       -
         '';

     

       22
       22
       -
       

     

       23
       23
       -
         rippledCfg =

     

       24
       24
       -
           ''

     

       25
       25
       -
             [server]

     

       26
       26
       -
             ${lib.concatMapStringsSep "\n" (n: "port_${n}") (lib.attrNames cfg.ports)}

     

       27
       27
       -
       

     

       28
       28
       -
             ${lib.concatMapStrings (p: ''

     

       29
       29
       -
               [port_${p.name}]

     

       30
       30
       -
               ip=${p.ip}

     

       31
       31
       -
               port=${toString p.port}

     

       32
       32
       -
               protocol=${lib.concatStringsSep "," p.protocol}

     

       33
       33
       -
               ${lib.optionalString (p.user != "") "user=${p.user}"}

     

       34
       34
       -
               ${lib.optionalString (p.password != "") "user=${p.password}"}

     

       35
       35
       -
               admin=${lib.concatStringsSep "," p.admin}

     

       36
       36
       -
               ${lib.optionalString (p.ssl.key != null) "ssl_key=${p.ssl.key}"}

     

       37
       37
       -
               ${lib.optionalString (p.ssl.cert != null) "ssl_cert=${p.ssl.cert}"}

     

       38
       38
       -
               ${lib.optionalString (p.ssl.chain != null) "ssl_chain=${p.ssl.chain}"}

     

       39
       39
       -
             '') (lib.attrValues cfg.ports)}

     

       40
       40
       -
       

     

       41
       41
       -
             [database_path]

     

       42
       42
       -
             ${cfg.databasePath}

     

       43
       43
       -
       

     

       44
       44
       -
             [node_db]

     

       45
       45
       -
             ${dbCfg cfg.nodeDb}

     

       46
       46
       -
       

     

       47
       47
       -
             ${lib.optionalString (cfg.tempDb != null) ''

     

       48
       48
       -
               [temp_db]

     

       49
       49
       -
               ${dbCfg cfg.tempDb}''}

     

       50
       50
       -
       

     

       51
       51
       -
             ${lib.optionalString (cfg.importDb != null) ''

     

       52
       52
       -
               [import_db]

     

       53
       53
       -
               ${dbCfg cfg.importDb}''}

     

       54
       54
       -
       

     

       55
       55
       -
             [ips]

     

       56
       56
       -
             ${lib.concatStringsSep "\n" cfg.ips}

     

       57
       57
       -
       

     

       58
       58
       -
             [ips_fixed]

     

       59
       59
       -
             ${lib.concatStringsSep "\n" cfg.ipsFixed}

     

       60
       60
       -
       

     

       61
       61
       -
             [validators]

     

       62
       62
       -
             ${lib.concatStringsSep "\n" cfg.validators}

     

       63
       63
       -
       

     

       64
       64
       -
             [node_size]

     

       65
       65
       -
             ${cfg.nodeSize}

     

       66
       66
       -
       

     

       67
       67
       -
             [ledger_history]

     

       68
       68
       -
             ${toString cfg.ledgerHistory}

     

       69
       69
       -
       

     

       70
       70
       -
             [fetch_depth]

     

       71
       71
       -
             ${toString cfg.fetchDepth}

     

       72
       72
       -
       

     

       73
       73
       -
             [validation_quorum]

     

       74
       74
       -
             ${toString cfg.validationQuorum}

     

       75
       75
       -
       

     

       76
       76
       -
             [sntp_servers]

     

       77
       77
       -
             ${lib.concatStringsSep "\n" cfg.sntpServers}

     

       78
       78
       -
       

     

       79
       79
       -
             ${lib.optionalString cfg.statsd.enable ''

     

       80
       80
       -
               [insight]

     

       81
       81
       -
               server=statsd

     

       82
       82
       -
               address=${cfg.statsd.address}

     

       83
       83
       -
               prefix=${cfg.statsd.prefix}

     

       84
       84
       -
             ''}

     

       85
       85
       -
       

     

       86
       86
       -
             [rpc_startup]

     

       87
       87
       -
             { "command": "log_level", "severity": "${cfg.logLevel}" }

     

       88
       88
       -
           ''

     

       89
       89
       -
           + cfg.extraConfig;

     

       90
       90
       -
       

     

       91
       91
       -
         portOptions =

     

       92
       92
       -
           { name, ... }:

     

       93
       93
       -
           {

     

       94
       94
       -
             options = {

     

       95
       95
       -
               name = lib.mkOption {

     

       96
       96
       -
                 internal = true;

     

       97
       97
       -
                 default = name;

     

       98
       98
       -
               };

     

       99
       99
       -
       

     

       100
       100
       -
               ip = lib.mkOption {

     

       101
       101
       -
                 default = "127.0.0.1";

     

       102
       102
       -
                 description = "Ip where rippled listens.";

     

       103
       103
       -
                 type = lib.types.str;

     

       104
       104
       -
               };

     

       105
       105
       -
       

     

       106
       106
       -
               port = lib.mkOption {

     

       107
       107
       -
                 description = "Port where rippled listens.";

     

       108
       108
       -
                 type = lib.types.port;

     

       109
       109
       -
               };

     

       110
       110
       -
       

     

       111
       111
       -
               protocol = lib.mkOption {

     

       112
       112
       -
                 description = "Protocols expose by rippled.";

     

       113
       113
       -
                 type = lib.types.listOf (

     

       114
       114
       -
                   lib.types.enum [

     

       115
       115
       -
                     "http"

     

       116
       116
       -
                     "https"

     

       117
       117
       -
                     "ws"

     

       118
       118
       -
                     "wss"

     

       119
       119
       -
                     "peer"

     

       120
       120
       -
                   ]

     

       121
       121
       -
                 );

     

       122
       122
       -
               };

     

       123
       123
       -
       

     

       124
       124
       -
               user = lib.mkOption {

     

       125
       125
       -
                 description = "When set, these credentials will be required on HTTP/S requests.";

     

       126
       126
       -
                 type = lib.types.str;

     

       127
       127
       -
                 default = "";

     

       128
       128
       -
               };

     

       129
       129
       -
       

     

       130
       130
       -
               password = lib.mkOption {

     

       131
       131
       -
                 description = "When set, these credentials will be required on HTTP/S requests.";

     

       132
       132
       -
                 type = lib.types.str;

     

       133
       133
       -
                 default = "";

     

       134
       134
       -
               };

     

       135
       135
       -
       

     

       136
       136
       -
               admin = lib.mkOption {

     

       137
       137
       -
                 description = "A comma-separated list of admin IP addresses.";

     

       138
       138
       -
                 type = lib.types.listOf lib.types.str;

     

       139
       139
       -
                 default = [ "127.0.0.1" ];

     

       140
       140
       -
               };

     

       141
       141
       -
       

     

       142
       142
       -
               ssl = {

     

       143
       143
       -
                 key = lib.mkOption {

     

       144
       144
       -
                   description = ''

     

       145
       145
       -
                     Specifies the filename holding the SSL key in PEM format.

     

       146
       146
       -
                   '';

     

       147
       147
       -
                   default = null;

     

       148
       148
       -
                   type = lib.types.nullOr lib.types.path;

     

       149
       149
       -
                 };

     

       150
       150
       -
       

     

       151
       151
       -
                 cert = lib.mkOption {

     

       152
       152
       -
                   description = ''

     

       153
       153
       -
                     Specifies the path to the SSL certificate file in PEM format.

     

       154
       154
       -
                     This is not needed if the chain includes it.

     

       155
       155
       -
                   '';

     

       156
       156
       -
                   default = null;

     

       157
       157
       -
                   type = lib.types.nullOr lib.types.path;

     

       158
       158
       -
                 };

     

       159
       159
       -
       

     

       160
       160
       -
                 chain = lib.mkOption {

     

       161
       161
       -
                   description = ''

     

       162
       162
       -
                     If you need a certificate chain, specify the path to the

     

       163
       163
       -
                     certificate chain here. The chain may include the end certificate.

     

       164
       164
       -
                   '';

     

       165
       165
       -
                   default = null;

     

       166
       166
       -
                   type = lib.types.nullOr lib.types.path;

     

       167
       167
       -
                 };

     

       168
       168
       -
               };

     

       169
       169
       -
             };

     

       170
       170
       -
           };

     

       171
       171
       -
       

     

       172
       172
       -
         dbOptions = {

     

       173
       173
       -
           options = {

     

       174
       174
       -
             type = lib.mkOption {

     

       175
       175
       -
               description = "Rippled database type.";

     

       176
       176
       -
               type = lib.types.enum [

     

       177
       177
       -
                 "rocksdb"

     

       178
       178
       -
                 "nudb"

     

       179
       179
       -
               ];

     

       180
       180
       -
               default = "rocksdb";

     

       181
       181
       -
             };

     

       182
       182
       -
       

     

       183
       183
       -
             path = lib.mkOption {

     

       184
       184
       -
               description = "Location to store the database.";

     

       185
       185
       -
               type = lib.types.path;

     

       186
       186
       -
               default = cfg.databasePath;

     

       187
       187
       -
               defaultText = lib.literalExpression "config.${opt.databasePath}";

     

       188
       188
       -
             };

     

       189
       189
       -
       

     

       190
       190
       -
             compression = lib.mkOption {

     

       191
       191
       -
               description = "Whether to enable snappy compression.";

     

       192
       192
       -
               type = lib.types.nullOr lib.types.bool;

     

       193
       193
       -
               default = null;

     

       194
       194
       -
             };

     

       195
       195
       -
       

     

       196
       196
       -
             onlineDelete = lib.mkOption {

     

       197
       197
       -
               description = "Enable automatic purging of older ledger information.";

     

       198
       198
       -
               type = lib.types.nullOr (lib.types.addCheck lib.types.int (v: v > 256));

     

       199
       199
       -
               default = cfg.ledgerHistory;

     

       200
       200
       -
               defaultText = lib.literalExpression "config.${opt.ledgerHistory}";

     

       201
       201
       -
             };

     

       202
       202
       -
       

     

       203
       203
       -
             advisoryDelete = lib.mkOption {

     

       204
       204
       -
               description = ''

     

       205
       205
       -
                 If set, then require administrative RPC call "can_delete"

     

       206
       206
       -
                 to enable online deletion of ledger records.

     

       207
       207
       -
               '';

     

       208
       208
       -
               type = lib.types.nullOr lib.types.bool;

     

       209
       209
       -
               default = null;

     

       210
       210
       -
             };

     

       211
       211
       -
       

     

       212
       212
       -
             extraOpts = lib.mkOption {

     

       213
       213
       -
               description = "Extra database options.";

     

       214
       214
       -
               type = lib.types.lines;

     

       215
       215
       -
               default = "";

     

       216
       216
       -
             };

     

       217
       217
       -
           };

     

       218
       218
       -
         };

     

       219
       219
       -
       

     

       220
       220
       -
       in

     

       221
       221
       -
       

     

       222
       222
       -
       {

     

       223
       223
       -
       

     

       224
       224
       -
         ###### interface

     

       225
       225
       -
       

     

       226
       226
       -
         options = {

     

       227
       227
       -
           services.rippled = {

     

       228
       228
       -
             enable = lib.mkEnableOption "rippled, a decentralized cryptocurrency blockchain daemon implementing the XRP Ledger protocol in C++";

     

       229
       229
       -
       

     

       230
       230
       -
             package = lib.mkPackageOption pkgs "rippled" { };

     

       231
       231
       -
       

     

       232
       232
       -
             ports = lib.mkOption {

     

       233
       233
       -
               description = "Ports exposed by rippled";

     

       234
       234
       -
               type = with lib.types; attrsOf (submodule portOptions);

     

       235
       235
       -
               default = {

     

       236
       236
       -
                 rpc = {

     

       237
       237
       -
                   port = 5005;

     

       238
       238
       -
                   admin = [ "127.0.0.1" ];

     

       239
       239
       -
                   protocol = [ "http" ];

     

       240
       240
       -
                 };

     

       241
       241
       -
       

     

       242
       242
       -
                 peer = {

     

       243
       243
       -
                   port = 51235;

     

       244
       244
       -
                   ip = "0.0.0.0";

     

       245
       245
       -
                   protocol = [ "peer" ];

     

       246
       246
       -
                 };

     

       247
       247
       -
       

     

       248
       248
       -
                 ws_public = {

     

       249
       249
       -
                   port = 5006;

     

       250
       250
       -
                   ip = "0.0.0.0";

     

       251
       251
       -
                   protocol = [

     

       252
       252
       -
                     "ws"

     

       253
       253
       -
                     "wss"

     

       254
       254
       -
                   ];

     

       255
       255
       -
                 };

     

       256
       256
       -
               };

     

       257
       257
       -
             };

     

       258
       258
       -
       

     

       259
       259
       -
             nodeDb = lib.mkOption {

     

       260
       260
       -
               description = "Rippled main database options.";

     

       261
       261
       -
               type = with lib.types; nullOr (submodule dbOptions);

     

       262
       262
       -
               default = {

     

       263
       263
       -
                 type = "rocksdb";

     

       264
       264
       -
                 extraOpts = ''

     

       265
       265
       -
                   open_files=2000

     

       266
       266
       -
                   filter_bits=12

     

       267
       267
       -
                   cache_mb=256

     

       268
       268
       -
                   file_size_pb=8

     

       269
       269
       -
                   file_size_mult=2;

     

       270
       270
       -
                 '';

     

       271
       271
       -
               };

     

       272
       272
       -
             };

     

       273
       273
       -
       

     

       274
       274
       -
             tempDb = lib.mkOption {

     

       275
       275
       -
               description = "Rippled temporary database options.";

     

       276
       276
       -
               type = with lib.types; nullOr (submodule dbOptions);

     

       277
       277
       -
               default = null;

     

       278
       278
       -
             };

     

       279
       279
       -
       

     

       280
       280
       -
             importDb = lib.mkOption {

     

       281
       281
       -
               description = "Settings for performing a one-time import.";

     

       282
       282
       -
               type = with lib.types; nullOr (submodule dbOptions);

     

       283
       283
       -
               default = null;

     

       284
       284
       -
             };

     

       285
       285
       -
       

     

       286
       286
       -
             nodeSize = lib.mkOption {

     

       287
       287
       -
               description = ''

     

       288
       288
       -
                 Rippled size of the node you are running.

     

       289
       289
       -
                 "tiny", "small", "medium", "large", and "huge"

     

       290
       290
       -
               '';

     

       291
       291
       -
               type = lib.types.enum [

     

       292
       292
       -
                 "tiny"

     

       293
       293
       -
                 "small"

     

       294
       294
       -
                 "medium"

     

       295
       295
       -
                 "large"

     

       296
       296
       -
                 "huge"

     

       297
       297
       -
               ];

     

       298
       298
       -
               default = "small";

     

       299
       299
       -
             };

     

       300
       300
       -
       

     

       301
       301
       -
             ips = lib.mkOption {

     

       302
       302
       -
               description = ''

     

       303
       303
       -
                 List of hostnames or ips where the Ripple protocol is served.

     

       304
       304
       -
                 For a starter list, you can either copy entries from:

     

       305
       305
       -
                 https://ripple.com/ripple.txt or if you prefer you can let it

     

       306
       306
       -
                  default to r.ripple.com 51235

     

       307
       307
       -
       

     

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

     

       309
       309
       -
                 address. By convention, if known, IPs are listed in from most

     

       310
       310
       -
                 to least trusted.

     

       311
       311
       -
               '';

     

       312
       312
       -
               type = lib.types.listOf lib.types.str;

     

       313
       313
       -
               default = [ "r.ripple.com 51235" ];

     

       314
       314
       -
             };

     

       315
       315
       -
       

     

       316
       316
       -
             ipsFixed = lib.mkOption {

     

       317
       317
       -
               description = ''

     

       318
       318
       -
                 List of IP addresses or hostnames to which rippled should always

     

       319
       319
       -
                 attempt to maintain peer connections with. This is useful for

     

       320
       320
       -
                 manually forming private networks, for example to configure a

     

       321
       321
       -
                 validation server that connects to the Ripple network through a

     

       322
       322
       -
                 public-facing server, or for building a set of cluster peers.

     

       323
       323
       -
       

     

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

     

       325
       325
       -
               '';

     

       326
       326
       -
               type = lib.types.listOf lib.types.str;

     

       327
       327
       -
               default = [ ];

     

       328
       328
       -
             };

     

       329
       329
       -
       

     

       330
       330
       -
             validators = lib.mkOption {

     

       331
       331
       -
               description = ''

     

       332
       332
       -
                 List of nodes to always accept as validators. Nodes are specified by domain

     

       333
       333
       -
                 or public key.

     

       334
       334
       -
               '';

     

       335
       335
       -
               type = lib.types.listOf lib.types.str;

     

       336
       336
       -
               default = [

     

       337
       337
       -
                 "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7  RL1"

     

       338
       338
       -
                 "n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj  RL2"

     

       339
       339
       -
                 "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C  RL3"

     

       340
       340
       -
                 "n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS  RL4"

     

       341
       341
       -
                 "n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA  RL5"

     

       342
       342
       -
               ];

     

       343
       343
       -
             };

     

       344
       344
       -
       

     

       345
       345
       -
             databasePath = lib.mkOption {

     

       346
       346
       -
               description = ''

     

       347
       347
       -
                 Path to the ripple database.

     

       348
       348
       -
               '';

     

       349
       349
       -
               type = lib.types.path;

     

       350
       350
       -
               default = "/var/lib/rippled";

     

       351
       351
       -
             };

     

       352
       352
       -
       

     

       353
       353
       -
             validationQuorum = lib.mkOption {

     

       354
       354
       -
               description = ''

     

       355
       355
       -
                 The minimum number of trusted validations a ledger must have before

     

       356
       356
       -
                 the server considers it fully validated.

     

       357
       357
       -
               '';

     

       358
       358
       -
               type = lib.types.int;

     

       359
       359
       -
               default = 3;

     

       360
       360
       -
             };

     

       361
       361
       -
       

     

       362
       362
       -
             ledgerHistory = lib.mkOption {

     

       363
       363
       -
               description = ''

     

       364
       364
       -
                 The number of past ledgers to acquire on server startup and the minimum

     

       365
       365
       -
                 to maintain while running.

     

       366
       366
       -
               '';

     

       367
       367
       -
               type = lib.types.either lib.types.int (lib.types.enum [ "full" ]);

     

       368
       368
       -
               default = 1296000; # 1 month

     

       369
       369
       -
             };

     

       370
       370
       -
       

     

       371
       371
       -
             fetchDepth = lib.mkOption {

     

       372
       372
       -
               description = ''

     

       373
       373
       -
                 The number of past ledgers to serve to other peers that request historical

     

       374
       374
       -
                 ledger data (or "full" for no limit).

     

       375
       375
       -
               '';

     

       376
       376
       -
               type = lib.types.either lib.types.int (lib.types.enum [ "full" ]);

     

       377
       377
       -
               default = "full";

     

       378
       378
       -
             };

     

       379
       379
       -
       

     

       380
       380
       -
             sntpServers = lib.mkOption {

     

       381
       381
       -
               description = ''

     

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

     

       383
       383
       -
               '';

     

       384
       384
       -
               type = lib.types.listOf lib.types.str;

     

       385
       385
       -
               default = [

     

       386
       386
       -
                 "time.windows.com"

     

       387
       387
       -
                 "time.apple.com"

     

       388
       388
       -
                 "time.nist.gov"

     

       389
       389
       -
                 "pool.ntp.org"

     

       390
       390
       -
               ];

     

       391
       391
       -
             };

     

       392
       392
       -
       

     

       393
       393
       -
             logLevel = lib.mkOption {

     

       394
       394
       -
               description = "Logging verbosity.";

     

       395
       395
       -
               type = lib.types.enum [

     

       396
       396
       -
                 "debug"

     

       397
       397
       -
                 "error"

     

       398
       398
       -
                 "info"

     

       399
       399
       -
               ];

     

       400
       400
       -
               default = "error";

     

       401
       401
       -
             };

     

       402
       402
       -
       

     

       403
       403
       -
             statsd = {

     

       404
       404
       -
               enable = lib.mkEnableOption "statsd monitoring for rippled";

     

       405
       405
       -
       

     

       406
       406
       -
               address = lib.mkOption {

     

       407
       407
       -
                 description = "The UDP address and port of the listening StatsD server.";

     

       408
       408
       -
                 default = "127.0.0.1:8125";

     

       409
       409
       -
                 type = lib.types.str;

     

       410
       410
       -
               };

     

       411
       411
       -
       

     

       412
       412
       -
               prefix = lib.mkOption {

     

       413
       413
       -
                 description = "A string prepended to each collected metric.";

     

       414
       414
       -
                 default = "";

     

       415
       415
       -
                 type = lib.types.str;

     

       416
       416
       -
               };

     

       417
       417
       -
             };

     

       418
       418
       -
       

     

       419
       419
       -
             extraConfig = lib.mkOption {

     

       420
       420
       -
               default = "";

     

       421
       421
       -
               type = lib.types.lines;

     

       422
       422
       -
               description = ''

     

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

     

       424
       424
       -
               '';

     

       425
       425
       -
             };

     

       426
       426
       -
       

     

       427
       427
       -
             config = lib.mkOption {

     

       428
       428
       -
               internal = true;

     

       429
       429
       -
               default = pkgs.writeText "rippled.conf" rippledCfg;

     

       430
       430
       -
               defaultText = lib.literalMD "generated config file";

     

       431
       431
       -
             };

     

       432
       432
       -
           };

     

       433
       433
       -
         };

     

       434
       434
       -
       

     

       435
       435
       -
         ###### implementation

     

       436
       436
       -
       

     

       437
       437
       -
         config = lib.mkIf cfg.enable {

     

       438
       438
       -
       

     

       439
       439
       -
           users.users.rippled = {

     

       440
       440
       -
             description = "Ripple server user";

     

       441
       441
       -
             isSystemUser = true;

     

       442
       442
       -
             group = "rippled";

     

       443
       443
       -
             home = cfg.databasePath;

     

       444
       444
       -
             createHome = true;

     

       445
       445
       -
           };

     

       446
       446
       -
           users.groups.rippled = { };

     

       447
       447
       -
       

     

       448
       448
       -
           systemd.services.rippled = {

     

       449
       449
       -
             after = [ "network.target" ];

     

       450
       450
       -
             wantedBy = [ "multi-user.target" ];

     

       451
       451
       -
       

     

       452
       452
       -
             serviceConfig = {

     

       453
       453
       -
               ExecStart = "${cfg.package}/bin/rippled --fg --conf ${cfg.config}";

     

       454
       454
       -
               User = "rippled";

     

       455
       455
       -
               Restart = "on-failure";

     

       456
       456
       -
               LimitNOFILE = 10000;

     

       457
       457
       -
             };

     

       458
       458
       -
           };

     

       459
       459
       -
       

     

       460
       460
       -
           environment.systemPackages = [ cfg.package ];

     

       461
       461
       -
       

     

       462
       462
       -
         };

     

       463
       463
       -
       }