Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
384 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,3 +46,6 @@ hie.yaml | |
|
|
||
| ### Docs build | ||
| /_build/ | ||
|
|
||
| ### databases of scripts | ||
| /db-cardano-wallet-* | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| { config, lib, pkgs, ... }: | ||
| let | ||
| cfg = config.services.cardano-wallet; | ||
| inherit (lib) mkIf mkEnableOption mkOption types; | ||
| logLevels = types.enum [ "debug" "info" "notice" "warning" "error" "critical" "alert" "emergency" "off" ]; | ||
| in | ||
| { | ||
| options.services.cardano-wallet = { | ||
|
|
||
| enable = mkEnableOption "Cardano Wallet service"; | ||
|
|
||
| serverArgs = mkOption { | ||
| description = "Command-line to launch cardano-wallet server."; | ||
| type = types.separatedString " "; | ||
| default = lib.concatStringsSep " " ([ | ||
| "--listen-address" | ||
| (lib.escapeShellArg cfg.listenAddress) | ||
| "--port" | ||
| (toString cfg.port) | ||
| "--node-socket" | ||
| (lib.escapeShellArg "$CARDANO_NODE_SOCKET_PATH") | ||
| "--sync-tolerance" | ||
| "${toString cfg.syncTolerance}s" | ||
| "--log-level" | ||
| cfg.logLevel | ||
| "--pool-metadata-fetching" | ||
| (if (cfg.poolMetadataFetching.enable) | ||
| then | ||
| (if cfg.poolMetadataFetching.smashUrl != null | ||
| then cfg.poolMetadataFetching.smashUrl else "direct") | ||
| else "none") | ||
| "--${cfg.walletMode}" | ||
| ] ++ lib.optional (cfg.walletMode != "mainnet") | ||
| (lib.escapeShellArg cfg.genesisFile) | ||
| ++ lib.optionals (cfg.tokenMetadataServer != null) | ||
| [ "--token-metadata-server" cfg.tokenMetadataServer ] | ||
| ++ lib.optionals (cfg.database != null) | ||
| [ "--database" (lib.escapeShellArg cfg.database) ] | ||
| ++ lib.mapAttrsToList | ||
| (name: level: "--trace-${name}=${level}") | ||
| cfg.trace | ||
| ); | ||
| }; | ||
|
|
||
| command = mkOption { | ||
| type = types.str; | ||
| internal = true; | ||
| default = lib.concatStringsSep " " ([ | ||
| "${cfg.package}/bin/${cfg.package.exeName}" | ||
| "serve" | ||
| cfg.serverArgs | ||
| ] ++ lib.optionals (cfg.rtsOpts != "") [ "+RTS" cfg.rtsOpts "-RTS" ]); | ||
| }; | ||
|
|
||
| package = mkOption { | ||
| type = types.package; | ||
| default = ((import ../.. { }).legacyPackages.${pkgs.system}).hsPkgs.cardano-wallet.components.exes.cardano-wallet; | ||
| description = "Package for the cardano wallet executable."; | ||
| }; | ||
|
|
||
| genesisFile = mkOption { | ||
| type = types.nullOr (types.either types.str types.path); | ||
| default = null; | ||
| description = "Path to genesis file, if not running on mainnet."; | ||
| }; | ||
|
|
||
| listenAddress = mkOption { | ||
| type = types.str; | ||
| default = "127.0.0.1"; | ||
| description = "Which host to bind the API server to."; | ||
| }; | ||
|
|
||
| port = mkOption { | ||
| type = types.port; | ||
| default = 8090; | ||
| description = "The port on which the cardano-wallet HTTP API server will listen."; | ||
| }; | ||
|
|
||
| nodeSocket = mkOption { | ||
| type = types.str; | ||
| default = "/run/cardano-node/node.socket"; | ||
| description = ''Cardano-Node local communication socket path.''; | ||
| }; | ||
|
|
||
| walletMode = mkOption { | ||
| type = types.enum [ "mainnet" "staging" "testnet" ]; | ||
| default = "mainnet"; | ||
| description = "Which mode to start wallet in: --mainnet, --staging or --testnet"; | ||
| }; | ||
|
|
||
| database = mkOption { | ||
| type = types.nullOr types.str; | ||
| default = "$STATE_DIRECTORY"; | ||
| description = ''Directory for storing wallets. | ||
| Run in-memory if null. | ||
| Default to '/var/lib/cardano-wallet'. | ||
| ''; | ||
| }; | ||
|
|
||
| syncTolerance = mkOption { | ||
| type = types.ints.positive; | ||
| default = 300; | ||
| description = "Time duration within which we consider being synced with the network. Expressed in seconds."; | ||
| }; | ||
|
|
||
| poolMetadataFetching = mkOption { | ||
| type = types.submodule { | ||
| options = { | ||
| enable = mkEnableOption "Stake pool metadata fetching."; | ||
| smashUrl = mkOption { | ||
| description = '' | ||
| URL of SMASH metadata proxy to use. | ||
| If null, metadata will be fetched directly from the | ||
| stake pool's URL. | ||
| ''; | ||
| type = types.nullOr types.str; | ||
| default = null; | ||
| }; | ||
| }; | ||
| }; | ||
| default = { enable = false; }; | ||
| example = { | ||
| enable = true; | ||
| smashUrl = "https://smash.cardano-mainnet.iohk.io"; | ||
| }; | ||
| }; | ||
|
|
||
| tokenMetadataServer = mkOption { | ||
| type = types.nullOr types.str; | ||
| default = null; | ||
| description = '' | ||
| Sets the URL of the token metadata server, | ||
| default to 'metadataUrl' of the 'environnement' attribute, if exists. | ||
| If unset, metadata will not be fetched. By using this | ||
| option, you are fully trusting the operator of the | ||
| metadata server to provide authentic token metadata. | ||
| ''; | ||
| }; | ||
|
|
||
| logLevel = mkOption { | ||
| type = logLevels; | ||
| default = "info"; | ||
| description = "Global minimum severity for a message to be logged."; | ||
| }; | ||
|
|
||
| trace = mkOption { | ||
| type = types.attrsOf logLevels; | ||
| default = { }; | ||
| description = '' | ||
| For each tracer, minimum severity for a message to be logged, or | ||
| "off" to disable the tracer". | ||
| ''; | ||
| }; | ||
|
|
||
| rtsOpts = mkOption { | ||
| type = types.separatedString " "; | ||
| default = "-N2"; | ||
| example = "-M2G -N4"; | ||
| description = '' | ||
| GHC runtime-system options for the cardano-wallet process. | ||
| See https://downloads.haskell.org/ghc/8.10.7/docs/html/users_guide/runtime_control.html#setting-rts-options-on-the-command-line for documentation. | ||
| ''; | ||
| }; | ||
|
|
||
| }; | ||
|
|
||
| config = mkIf cfg.enable { | ||
|
|
||
| assertions = [ | ||
| { | ||
| assertion = (cfg.walletMode == "mainnet") == (cfg.genesisFile == null); | ||
| message = ''The option services.cardano-wallet.genesisFile must be set | ||
| if, and only if, services.cardano-wallet.walletMode is not \"mainnet\". | ||
| ''; | ||
| } | ||
| { | ||
| assertion = !(lib.hasPrefix "/" cfg.database || lib.hasPrefix ".." cfg.database); | ||
| message = "The option services.cardano-node.database should be a relative path (of /var/lib/)."; | ||
| } | ||
| ]; | ||
|
|
||
| systemd.services.cardano-wallet = { | ||
| description = "cardano-wallet daemon"; | ||
| wantedBy = [ "multi-user.target" ]; | ||
|
|
||
| serviceConfig = { | ||
| DynamicUser = true; | ||
| ExecStart = cfg.command; | ||
| StateDirectory = if cfg.database == "$STATE_DIRECTORY" then "cardano-wallet" else cfg.database; | ||
| }; | ||
|
|
||
| environment = { | ||
| CARDANO_NODE_SOCKET_PATH = cfg.nodeSocket; | ||
| }; | ||
| }; | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| { imports = import ./module-list.nix; } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [ | ||
| ./cardano-wallet-service.nix | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { pkgs | ||
| , project | ||
| }: | ||
| let | ||
| importTest = fn: args: | ||
| let | ||
| imported = import fn; | ||
| test = import (pkgs.path + "/nixos/tests/make-test-python.nix") imported; | ||
| in | ||
| test ({ | ||
| inherit pkgs project; | ||
| inherit (pkgs) system config; | ||
| } // args); | ||
| in | ||
| { | ||
| basicTest = importTest ./service-basic-test.nix { }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| { pkgs, project, lib, ... }: with pkgs; | ||
| let | ||
| inherit (project.hsPkgs.cardano-wallet.components.exes) cardano-wallet; | ||
| inherit (pkgs) cardanoLib; | ||
| in | ||
| { | ||
| name = "wallet-nixos-test"; | ||
| nodes = { | ||
| machine = { config, ... }: { | ||
| nixpkgs.pkgs = pkgs; | ||
| imports = [ | ||
| ../. | ||
| (project.pkg-set.config.packages.cardano-node.src + "/nix/nixos") | ||
| ]; | ||
| services.cardano-wallet = { | ||
| enable = true; | ||
| package = cardano-wallet; | ||
| walletMode = "mainnet"; | ||
| nodeSocket = config.services.cardano-node.socketPath; | ||
| poolMetadataFetching = { | ||
| enable = true; | ||
| smashUrl = cardanoLib.environments.mainnet.smashUrl; | ||
| }; | ||
| tokenMetadataServer = cardanoLib.environments.mainnet.metadataUrl; | ||
| }; | ||
| services.cardano-node = { | ||
| enable = true; | ||
| environment = "mainnet"; | ||
| environments = { mainnet = { }; }; | ||
| package = project.hsPkgs.cardano-node.components.exes.cardano-node; | ||
| inherit (cardanoLib.environments.mainnet) nodeConfig; | ||
| topology = cardanoLib.mkEdgeTopology { | ||
| port = 3001; | ||
| edgeNodes = [ "127.0.0.1" ]; | ||
| }; | ||
| systemdSocketActivation = true; | ||
| }; | ||
| systemd.services.cardano-node.serviceConfig.Restart = lib.mkForce "no"; | ||
| systemd.services.cardano-wallet = { | ||
| after = [ "cardano-node.service" ]; | ||
| serviceConfig = { | ||
| Restart = "no"; | ||
| SupplementaryGroups = "cardano-node"; | ||
| }; | ||
| }; | ||
| }; | ||
| }; | ||
| testScript = '' | ||
| start_all() | ||
| machine.wait_for_unit("cardano-node.service") | ||
| machine.wait_for_open_port(3001) | ||
| machine.wait_for_unit("cardano-wallet.service") | ||
| machine.wait_for_open_port(8090) | ||
| machine.succeed( | ||
| "${cardano-wallet}/bin/cardano-wallet network information" | ||
| ) | ||
| ''; | ||
|
|
||
| } |
Oops, something went wrong.