nixpkgs/nixos/modules/services/misc/ripple-data-api.nix
2024-11-28 19:08:32 +01:00

193 lines
5.4 KiB
Nix

{ config, lib, pkgs, ... }:
let
cfg = config.services.rippleDataApi;
deployment_env_config = builtins.toJSON {
production = {
port = toString cfg.port;
maxSockets = 150;
batchSize = 100;
startIndex = 32570;
rippleds = cfg.rippleds;
redis = {
enable = cfg.redis.enable;
host = cfg.redis.host;
port = cfg.redis.port;
options.auth_pass = null;
};
};
};
db_config = builtins.toJSON {
production = {
username = lib.optional (cfg.couchdb.pass != "") cfg.couchdb.user;
password = lib.optional (cfg.couchdb.pass != "") cfg.couchdb.pass;
host = cfg.couchdb.host;
port = cfg.couchdb.port;
database = cfg.couchdb.db;
protocol = "http";
};
};
in {
options = {
services.rippleDataApi = {
enable = lib.mkEnableOption "ripple data api";
port = lib.mkOption {
description = "Ripple data api port";
default = 5993;
type = lib.types.port;
};
importMode = lib.mkOption {
description = "Ripple data api import mode.";
default = "liveOnly";
type = lib.types.enum ["live" "liveOnly"];
};
minLedger = lib.mkOption {
description = "Ripple data api minimal ledger to fetch.";
default = null;
type = lib.types.nullOr lib.types.int;
};
maxLedger = lib.mkOption {
description = "Ripple data api maximal ledger to fetch.";
default = null;
type = lib.types.nullOr lib.types.int;
};
redis = {
enable = lib.mkOption {
description = "Whether to enable caching of ripple data to redis.";
default = true;
type = lib.types.bool;
};
host = lib.mkOption {
description = "Ripple data api redis host.";
default = "localhost";
type = lib.types.str;
};
port = lib.mkOption {
description = "Ripple data api redis port.";
default = 5984;
type = lib.types.port;
};
};
couchdb = {
host = lib.mkOption {
description = "Ripple data api couchdb host.";
default = "localhost";
type = lib.types.str;
};
port = lib.mkOption {
description = "Ripple data api couchdb port.";
default = 5984;
type = lib.types.port;
};
db = lib.mkOption {
description = "Ripple data api couchdb database.";
default = "rippled";
type = lib.types.str;
};
user = lib.mkOption {
description = "Ripple data api couchdb username.";
default = "rippled";
type = lib.types.str;
};
pass = lib.mkOption {
description = "Ripple data api couchdb password.";
default = "";
type = lib.types.str;
};
create = lib.mkOption {
description = "Whether to create couchdb database needed by ripple data api.";
type = lib.types.bool;
default = true;
};
};
rippleds = lib.mkOption {
description = "List of rippleds to be used by ripple data api.";
default = [
"http://s_east.ripple.com:51234"
"http://s_west.ripple.com:51234"
];
type = lib.types.listOf lib.types.str;
};
};
};
config = lib.mkIf (cfg.enable) {
services.couchdb.enable = lib.mkDefault true;
services.couchdb.bindAddress = lib.mkDefault "0.0.0.0";
services.redis.enable = lib.mkDefault true;
systemd.services.ripple-data-api = {
after = [ "couchdb.service" "redis.service" "ripple-data-api-importer.service" ];
wantedBy = [ "multi-user.target" ];
environment = {
NODE_ENV = "production";
DEPLOYMENT_ENVS_CONFIG = pkgs.writeText "deployment.environment.json" deployment_env_config;
DB_CONFIG = pkgs.writeText "db.config.json" db_config;
};
serviceConfig = {
ExecStart = "${pkgs.ripple-data-api}/bin/api";
Restart = "always";
User = "ripple-data-api";
};
};
systemd.services.ripple-data-importer = {
after = [ "couchdb.service" ];
wantedBy = [ "multi-user.target" ];
path = [ pkgs.curl ];
environment = {
NODE_ENV = "production";
DEPLOYMENT_ENVS_CONFIG = pkgs.writeText "deployment.environment.json" deployment_env_config;
DB_CONFIG = pkgs.writeText "db.config.json" db_config;
LOG_FILE = "/dev/null";
};
serviceConfig = let
importMode =
if cfg.minLedger != null && cfg.maxLedger != null then
"${toString cfg.minLedger} ${toString cfg.maxLedger}"
else
cfg.importMode;
in {
ExecStart = "${pkgs.ripple-data-api}/bin/importer ${importMode} debug";
Restart = "always";
User = "ripple-data-api";
};
preStart = lib.mkMerge [
(lib.mkIf (cfg.couchdb.create) ''
HOST="http://${lib.optionalString (cfg.couchdb.pass != "") "${cfg.couchdb.user}:${cfg.couchdb.pass}@"}${cfg.couchdb.host}:${toString cfg.couchdb.port}"
curl -X PUT $HOST/${cfg.couchdb.db} || true
'')
"${pkgs.ripple-data-api}/bin/update-views"
];
};
users.users.ripple-data-api =
{ description = "Ripple data api user";
isSystemUser = true;
group = "ripple-data-api";
};
users.groups.ripple-data-api = {};
};
}