options

Documentation

Overview

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• type Layer1Options
• type OptionSettings
• type OverwriteSettings
• type SedgeOptions
  • func CreateSedgeOptions(sedgeSetup string) SedgeOptions

Constants

const (
	EthereumNode = "ethereum-node"
	LidoNode     = "lido-node"
)

Variables

var ErrInvalidNetwork = func(network []string, option string) error {
	return fmt.Errorf("invalid network: Choose valid network for %s: %v", option, network)
}

var ErrInvalidNetworkMevBoost = func(network []string, option string) error {
	return fmt.Errorf("invalid network: Choose valid network for %s with MEV-Boost: %v", option, network)
}

Types

type Layer1Options

type Layer1Options interface {
	WithdrawalAddress(network string) string
	FeeRecipient(network string) string
	RelayURLs(network string) ([]string, error)
	MEVBoostEnabled(network string) bool
}

Layer1Options is an interface for creating Layer 1 setup options

type OptionSettings

type OptionSettings struct {
	Network         string
	MEVBoostEnabled bool
}

OptionSettings is a struct for setting up options for Sedge Node

type OverwriteSettings

type OverwriteSettings struct {
	FeeRecipient      bool
	RelayURLs         bool
	MevBoost          bool
	WithdrawalAddress bool
}

OverwriteSettings is a struct for defining what settings should be overwritten

type SedgeOptions

type SedgeOptions interface {
	Layer1Options
	SupportedNetworks() []string
	OverwriteSettings() OverwriteSettings
	// ValidateSettings can be used to validate the settings for the Sedge Option
	ValidateSettings(settings OptionSettings) error
}

SedgeOptions is an interface for creating Sedge setup options

func CreateSedgeOptions

func CreateSedgeOptions(sedgeSetup string) SedgeOptions

CreateSedgeOptions returns the appropriate SedgeOptions based on the Sedge Node Setup kind.