Skip to content

services.kupo

services.kupo.enable

Whether to enable Kupo Cardano chain-indexer.

Type: boolean

Default: false

Example: true

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.package

Kupo package.

Type: package

Default: null

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.extraArgs

Extra arguments to kupo command.

Type: list of string

Default: [ ]

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.group

Group to run kupo service as.

Type: non-empty string

Default: "kupo"

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.host

Host address or name to listen on.

Type: non-empty string

Default: "127.0.0.1"

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.hydraHost

Hydra host name. Optional.

Type: null or non-empty string

Default: null

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.hydraPort

Hydra port. Ignored if hydraHost is null.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.matches

The list of addresses to watch.

Type: list of non-empty string

Default:

1
2
3
[
  "*"
]

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.nodeConfigPath

Path to cardano-node config.json file. Ignored if ogmiosHost is not null

Type: path

Default: "/etc/cardano-node/config.json"

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.nodeSocketPath

Path to cardano-node IPC socket. Ignored if ogmiosHost is not null.

Type: null or path

Default: "/run/cardano-node/node.socket"

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.ogmiosHost

Ogmios host name. Optional, will connect to cardano-node if null.

Type: null or non-empty string

Default: null

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.ogmiosPort

Ogmios port. Ignored if ogmiosHost is null.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 1337

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.port

TCP port to listen on.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 1442

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.pruneUtxo

Automatically remove inputs that are spent on-chain.

Type: boolean

Default: false

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.since

Watching depth.

Type: non-empty string

Default: "origin"

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.user

User to run kupo service as.

Type: non-empty string

Default: "kupo"

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix

services.kupo.workDir

Directory to start the kupo and store its data. Must start with /var/lib/.

Type: path

Default: "/var/lib/kupo"

Declared by: - https://github.com/mlabs-haskell/cardano.nix/tree/main/modules/services/kupo.nix