Skip to content

Erigon

services.ethereum.erigon

Specification of one or more erigon instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.enable

Whether to enable Erigon Ethereum Node…

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.package

Package to use as Erigon node.

Type: package

Default: pkgs.erigon

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.addr

HTTP-RPC server listening interface for the Engine API.

Type: string

Default: "127.0.0.1"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.jwtsecret

Path to the token that ensures safe connection between CL and EL.

Type: null or string

Default: null

Example: "/var/run/erigon/jwtsecret"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.port

HTTP-RPC server listening port for the Engine API

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

Default: 8551

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

Type: string

Default: "2m0s"

Example: "30s"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: string

Default: "30s"

Example: "30s"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

Type: string

Default: "30m0s"

Example: "30m0s"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.vhosts

Comma separated list of virtual hostnames from which to accept Engine API requests (server enforced). Accepts ‘*’ wildcard."

Type: list of string

Default:

1
2
3
[
  "localhost"
]

Example:

1
2
3
4
[
  "localhost"
  "erigon.example.org"
]

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.chain

Name of the network to join. If null the network is mainnet.

Type: one of “mainnet”, “rinkeby”, “goerli”, “holesky”, “sokol”, “fermion”, “mumbai”, “bor-mainnet”, “bor-devnet”, “sepolia”, “gnosis”, “chiado”

Default: "mainnet"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.externalcl

Whether to enable enables external consensus.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.enable

Enable HTTP-RPC server

Type: boolean

Default: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.addr

HTTP-RPC server listening interface.

Type: string

Default: "127.0.0.1"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.api

API’s offered over the HTTP-RPC interface.

Type: null or (list of string)

Example:

1
2
3
4
[
  "net"
  "eth"
]

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.compression

Whether to enable Enable compression over HTTP-RPC…

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.corsdomain

List of domains from which to accept cross origin requests.

Type: null or (list of string)

Default: null

Example:

1
2
3
[
  "*"
]

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.port

HTTP-RPC server listening port.

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

Default: 8545

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

Type: string

Default: "2m0s"

Example: "30s"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: string

Default: "30s"

Example: "30s"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

Type: string

Default: "30m0s"

Example: "30m0s"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.trace

Whether to enable Trace HTTP requests with INFO level.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts ‘*’ wildcard.

Type: list of string

Default:

1
2
3
[
  "localhost"
]

Example:

1
2
3
4
[
  "localhost"
  "erigon.example.org"
]

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.metrics.enable

Whether to enable Enable metrics collection and reporting…

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.metrics.addr

Enable stand-alone metrics HTTP server listening interface.

Type: string

Default: "127.0.0.1"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.metrics.port

Metrics HTTP server listening port

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

Default: 6060

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.port

Network listening port.

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

Default: 30303

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.private.api.addr

Private api network address, for example: 127.0.0.1:9090, empty string means not to start the listener. Do not expose to public network. Serves remote database interface.

Type: string

Default: "127.0.0.1:9090"

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.private.api.ratelimit

Amount of requests server handle simultaneously - requests over this limit will wait. Increase it - if clients see ‘request timeout’ while server load is low - it means your ‘hot data’ is small or have much RAM.

Type: signed integer

Default: 31872

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.snapshots

Default: use snapshots “true” for BSC, Mainnet and Goerli. use snapshots “false” in all other cases.

Type: boolean

Default: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.torrent.port

Port to listen and serve BitTorrent protocol .

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

Default: 42069

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.ws.enable

Whether to enable Erigon WebSocket API.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.ws.compression

Whether to enable Enable compression over HTTP-RPC…

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.extraArgs

Additional arguments to pass to Erigon.

Type: list of string

Default: [ ]

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.service.supplementaryGroups

Additional groups for the systemd service e.g. sops-nix group for secret access

Type: list of string

Default: [ ]

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix

services.ethereum.erigon.\.subVolume

Whether to enable Use a subvolume for the state directory if the underlying filesystem supports it e.g. btrfs.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/m5xa4j3b7zlgc8d720v54xhr039fc9ri-source/modules/erigon/options.nix