consensusClient

Documentation

Index

• Constants
• type ConsensusClientComponent
  • func NewConsensusClientComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, ...) (*ConsensusClientComponent, error)
  • func NewLighthouseComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, ...) (*ConsensusClientComponent, error)
  • func NewLodestarComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, ...) (*ConsensusClientComponent, error)
  • func NewNimbusComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, ...) (*ConsensusClientComponent, error)
  • func NewPrysmComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, ...) (*ConsensusClientComponent, error)
  • func NewTekuComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, ...) (*ConsensusClientComponent, error)
• type ConsensusClientComponentArgs

Constants

const (
	Teku       = "teku"
	Prysm      = "prysm"
	Lighthouse = "lighthouse"
	Lodestar   = "lodestar"
	Nimbus     = "nimbus"
	Source     = "source"
	Binary     = "binary"
	Docker     = "docker"
	Kubernetes = "kubernetes"
)

Types

type ConsensusClientComponent

type ConsensusClientComponent struct {
	pulumi.ResourceState
}

func NewConsensusClientComponent

func NewConsensusClientComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, opts ...pulumi.ResourceOption) (*ConsensusClientComponent, error)

NewConsensusClientComponent creates a new instance of the ConsensusClientComponent and calls the appropriate component constructor based on the client being requested. It returns a pointer to the ConsensusClientComponent and an error

Example usage:

client, err := consensusClient.NewConsensusClientComponent(ctx, "testLighthouseConsensusClient", &consensusClient.ConsensusClientComponentArgs{
	Connection:     &remote.ConnectionArgs{
		User:       cfg.Require("sshUser"),
		Host:       cfg.Require("sshHost"),
		PrivateKey: cfg.RequireSecret("sshPrivateKey"),
	},
	Client:         "lighthouse",
	Network:        "mainnet",
	DeploymentType: "source",
	DataDir:        "/data/lighthouse",
})

func NewLighthouseComponent

func NewLighthouseComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, opts ...pulumi.ResourceOption) (*ConsensusClientComponent, error)

NewLighthouseComponent creates a new consensus client component for Lighthouse and returns a pointer to the component

Example usage:

client, err := consensusClient.NewLighthouseComponent(ctx, "testLighthouseConsensusClient", &consensusClient.ConsensusClientComponentArgs{
	Connection:     &remote.ConnectionArgs{
		User:       cfg.Require("sshUser"),             // username for the ssh connection
		Host:       cfg.Require("sshHost"),             // ip address of the host
		PrivateKey: cfg.RequireSecret("sshPrivateKey"), // must be a secret, RequireSecret is critical for security
	},
	Client:         "lighthouse",         // must be "lighthouse"
	Network:        "mainnet",            // mainnet, sepolia, or holesky
	DeploymentType: "source",             // source, binary, docker
	DataDir:        "/data/lighthouse",	  // path to the data directory
})

func NewLodestarComponent

func NewLodestarComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, opts ...pulumi.ResourceOption) (*ConsensusClientComponent, error)

NewLodestarComponent creates a new consensus client component for lodestar and returns a pointer to the component

Example usage:

client, err := consensusClient.NewLodestarComponent(ctx, "testLodestarConsensusClient", &consensusClient.ConsensusClientComponentArgs{
	Connection:     &remote.ConnectionArgs{
		User:       cfg.Require("sshUser"),             // username for the ssh connection
		Host:       cfg.Require("sshHost"),             // ip address of the host
		PrivateKey: cfg.RequireSecret("sshPrivateKey"), // must be a secret, RequireSecret is critical for security
	},
	Client:         "lodestar",           // must be "lodestar"
	Network:        "mainnet",            // mainnet, sepolia, or holesky
	DeploymentType: "source",             // source, binary, docker
	DataDir:        "/data/lodestar",	  // path to the data directory
})

func NewNimbusComponent

func NewNimbusComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, opts ...pulumi.ResourceOption) (*ConsensusClientComponent, error)

NewNimbusComponent creates a new consensus client component for Nimbus and returns a pointer to the component

Example usage:

client, err := consensusClient.NewNimbusComponent(ctx, "testNimbusConsensusClient", &consensusClient.ConsensusClientComponentArgs{
	Connection:     &remote.ConnectionArgs{
		User:       cfg.Require("sshUser"),             // username for the ssh connection
		Host:       cfg.Require("sshHost"),             // ip address of the host
		PrivateKey: cfg.RequireSecret("sshPrivateKey"), // must be a secret, RequireSecret is critical for security
	},
	Client:         "nimbus",             // must be "nimbus"
	Network:        "mainnet",            // mainnet, sepolia, or holesky
	DeploymentType: "source",             // source, binary, docker
	DataDir:        "/data/nimbus",	  // path to the data directory
})

func NewPrysmComponent

func NewPrysmComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, opts ...pulumi.ResourceOption) (*ConsensusClientComponent, error)

func NewTekuComponent

func NewTekuComponent(ctx *pulumi.Context, name string, args *ConsensusClientComponentArgs, opts ...pulumi.ResourceOption) (*ConsensusClientComponent, error)

NewTekuComponent creates a new consensus client component for teku and returns a pointer to the component

Example usage:

client, err := consensusClient.NewTekuComponent(ctx, "testTekuConsensusClient", &consensusClient.ConsensusClientComponentArgs{
	Connection:     &remote.ConnectionArgs{
		User:       cfg.Require("sshUser"),             // username for the ssh connection
		Host:       cfg.Require("sshHost"),             // ip address of the host
		PrivateKey: cfg.RequireSecret("sshPrivateKey"), // must be a secret, RequireSecret is critical for security
	},
	Client:         "teku",               // must be "teku"
	Network:        "mainnet",            // mainnet, sepolia, or holesky
	DeploymentType: "source",             // source, binary, docker
	DataDir:        "/data/teku",	  // path to the data directory
})

type ConsensusClientComponentArgs

type ConsensusClientComponentArgs struct {
	Connection                       *remote.ConnectionArgs
	Client                           string
	Network                          string
	DeploymentType                   string
	DataDir                          string
	ConsensusClientConfigPath        string
	ConsensusClientImage             string
	ConsensusClientContainerCommands []string
	InstanceNumber                   int
	EnableRpcIngress                 bool
	PodStorageClass                  string
	PodStorageSize                   string
	ExecutionJwt                     string
	Name                             string
	SnapshotName                     string
	CpuLimit                         string
	MemoryLimit                      string
	CpuRequest                       string
	MemoryRequest                    string
}