hydra-node.package

The hydra-node package to use.

Type: package

Default: pkgs.hydra-node

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.apiPort

Listen port for incoming client API connections.

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

Default: 4001

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.cardanoSigningKey

Cardano signing key of our hydra-node. This will be used to authorize Hydra protocol transactions for heads the node takes part in and any funds owned by this key will be used as ‘fuel’.

Type: absolute path

Example: ./wallets/dev-1.sk

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.devnetName

Name of the devnet this Hydra node is connecting to. This is required to configure dependencies between processes in process-compose.

Type: string

Default: "cardano-devnet"

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.hydraScriptsTxId

The transactions which are expected to have published Hydra scripts as reference scripts in their outputs. You can use the ‘publish-scripts’ sub-command to publish scripts yourself.

Type: null or string

Default: null

Example: "f8161e0e4d80774277616d627582fdb622920973f39d2c6488324af98ef75269,9111793e561b8f689cfe8541ef1adefa4893171983cde9fe431e7d12451113e8,b1cc50e1f591ba5d6a6a1f2d6befe9b7951735b75dee35a0e4f5def87d984f75"

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.hydraScriptsTxIdFile

The transactions which are expected to have published Hydra scripts as reference scripts in their outputs.

Type: string

Default: "data/hydra-scripts/tx-id"

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.hydraSigningKey

Hydra signing key used by our hydra-node.

Type: absolute path

Example: ./wallets/hydra-key-2.sk

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.ledgerProtocolParameters

Path to protocol parameters used in the Hydra Head. See Hydra manual how to configure this.

Type: absolute path

Default: ${config.src}/protocol-params.json

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.listen

Address and port to listen for Hydra network connections.

Type: string

Default: "127.0.0.1:5001"

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.networkMagic

Network identifier for a testnet to connect to. We only need to provide the magic number here. For example: ‘2’ is the ‘preview’ network. See https://book.world.dev.cardano.org/environments.html

Type: signed integer

Default: 24

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.nodeId

The Hydra node identifier used on the Hydra network. It is important to have a unique identifier in order to be able to distinguish between connected peers. Defaults to the process-compose name of the node.

Type: string

Default: "$\\{name\\}"

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.nodeSocket

Filepath to local unix domain socket used to communicate with the cardano node.

Type: string

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.peers

Peer addresses and keys. Each list item contains a port, a cardano-verification-key and a hydra-verification-key (current maximum limit is 7 peers).

Type: list of (submodule)

Default: [ ]

Example:

[
  {
    port = 5002;
    cardanoVerificationKey = ./wallets/dev-1.vk;
    hydraVerificationKey = ./wallets/hydra-key-1.vk;
  }
]

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.peers.*.cardanoVerificationKey

Cardano verification key file path.

Type: absolute path

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.peers.*.hydraVerificationKey

Hydra verification key file path.

Type: absolute path

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.peers.*.port

Localhost port of the peer node.

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

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.publishScripts

Initialise Hydra head by publishing the scripts to the devnet and storing the result to a file defined by hydraScriptTxdFile.

Type: boolean

Default: false

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.src

Directory where verification keys are located.

Type: absolute path

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix

hydra-node.walletDir

Directory where verification keys are located.

Type: absolute path

Default: ${config.src}/wallets

Declared by: - /nix/store/dya29fp77h7xzvn6ggxpgkxdiaw6pihy-source/modules/hydra-node/options.nix