components

Documentation

Index

• Constants
• Variables
• func InitClientConfig() (string, interface{})
• func ProvideClientContext(appCodec codec.Codec, interfaceRegistry codectypes.InterfaceRegistry, ...) client.Context
• func ProvideKeyring(clientCtx client.Context, _ address.Codec) (clientv2keyring.Keyring, error)
• type BlsSignerInput
• type BlsSignerOutput
  • func ProvideBlsSigner(in BlsSignerInput) BlsSignerOutput
• type JWTSecretInput
• type JWTSecretOutput
  • func ProvideJWTSecret(in JWTSecretInput) JWTSecretOutput
• type RuntimeInjectInput
• type RuntimeInjectOutput
  • func ProvideRuntime(in RuntimeInjectInput) RuntimeInjectOutput
• type TrustedSetupInput
• type TrustedSetupOutput
  • func ProvideTrustedSetup(in BlsSignerInput) TrustedSetupOutput

Constants

const TermsOfServiceURL = "https://github.com/berachain/beacon-kit/blob/main/TERMS_OF_SERVICE.md"

Variables

var DefaultNodeHome string

Functions

func InitClientConfig

func InitClientConfig() (string, interface{})

InitClientConfig sets up the default client configuration, allowing for overrides.

func ProvideClientContext

func ProvideClientContext(
	appCodec codec.Codec,
	interfaceRegistry codectypes.InterfaceRegistry,
	txConfigOpts tx.ConfigOptions,
	legacyAmino *codec.LegacyAmino,
	addressCodec address.Codec,
	validatorAddressCodec address.ValidatorAddressCodec,
	consensusAddressCodec address.ConsensusAddressCodec,
) client.Context

ProvideClientContext returns a new client context with the given options.

func ProvideKeyring

func ProvideKeyring(
	clientCtx client.Context,
	_ address.Codec,
) (clientv2keyring.Keyring, error)

ProvideKeyring provides a keyring for the client.

Types

type BlsSignerInput

type BlsSignerInput struct {
	depinject.In
	AppOpts servertypes.AppOptions
}

BlsSignerInput is the input for the dep inject framework.

type BlsSignerOutput

type BlsSignerOutput struct {
	depinject.Out
	BlsSigner *signer.BLSSigner
}

BlsSignerOutput is the output for the dep inject framework.

func ProvideBlsSigner

func ProvideBlsSigner(in BlsSignerInput) BlsSignerOutput

ProvideBlsSigner is a function that provides the module to the application.

type JWTSecretInput

type JWTSecretInput struct {
	depinject.In
	AppOpts servertypes.AppOptions
}

TrustedSetupInput is the input for the dep inject framework.

type JWTSecretOutput

type JWTSecretOutput struct {
	depinject.Out
	JWTSecret *jwt.Secret
}

TrustedSetupOutput is the output for the dep inject framework.

func ProvideJWTSecret

func ProvideJWTSecret(in JWTSecretInput) JWTSecretOutput

ProvideJWTSecret is a function that provides the module to the application.

type RuntimeInjectInput

type RuntimeInjectInput struct {
	depinject.In

	BeaconCfg       *config.Config
	Logger          log.Logger
	JWTSecret       *jwt.Secret
	Signer          core.BLSSigner
	KZGTrustedSetup *gokzg4844.JSONTrustedSetup
	Bsp             runtime.BeaconStorageBackend
}

RuntimeInjectInput is the input for the dep inject framework.

type RuntimeInjectOutput

type RuntimeInjectOutput struct {
	depinject.Out
	Runtime *runtime.BeaconKitRuntime
}

RuntimeInjectOutput is the output for the dep inject framework.

func ProvideRuntime

func ProvideRuntime(in RuntimeInjectInput) RuntimeInjectOutput

ProvideRuntime is a function that provides the module to the application.

type TrustedSetupInput

type TrustedSetupInput struct {
	depinject.In
	AppOpts servertypes.AppOptions
}

TrustedSetupInput is the input for the dep inject framework.

type TrustedSetupOutput

type TrustedSetupOutput struct {
	depinject.Out
	TrustedSetup *gokzg4844.JSONTrustedSetup
}

TrustedSetupOutput is the output for the dep inject framework.

func ProvideTrustedSetup

func ProvideTrustedSetup(in BlsSignerInput) TrustedSetupOutput

ProvideBlsSigner is a function that provides the module to the application.