funder

Documentation

Index

• Variables
• func Fund(ctx context.Context, cfg Config, nl NodeLister, fundingWallet *wallet.Wallet, ...) error
• func Stake(ctx context.Context, cfg Config, nl NodeLister, options ...FunderOptions) error
• type Config
• type FunderOptions
  • func WithLoggerOption(log logging.Logger) FunderOptions
• type MinAmounts
• type NamespaceNodes
• type NodeInfo
• type NodeLister
• type Options
  • func DefaultOptions() *Options
• type WalletInfo
  • func NewWalletInfo(name, address string, chainID int64) WalletInfo

Variables

var (
	ErrFailedFunding                = errors.New("failed funding")
	ErrFailedFundingWithSwarmToken  = errors.New("failed funding with swarm token")
	ErrFailedFundingWithNativeToken = errors.New("failed funding with native token")
)

Functions

func Fund

func Fund(
	ctx context.Context,
	cfg Config,
	nl NodeLister,
	fundingWallet *wallet.Wallet,
	options ...FunderOptions,
) error

func Stake

func Stake(ctx context.Context, cfg Config, nl NodeLister, options ...FunderOptions) error

Types

type Config

type Config struct {
	Namespace         string
	Addresses         []string
	ChainNodeEndpoint string
	WalletKey         string // Hex encoded key
	MinAmounts        MinAmounts
}

type FunderOptions

type FunderOptions func(*Options)

func WithLoggerOption

func WithLoggerOption(log logging.Logger) FunderOptions

WithLoggerOption sets the logger to be used by the funder

type MinAmounts

type MinAmounts struct {
	NativeCoin float64 // on mainnet this is xDAI
	SwarmToken float64 // on mainnet this is xBZZ
}

type NamespaceNodes

type NamespaceNodes struct {
	Name        string
	NodeWallets []WalletInfo
}

type NodeInfo

type NodeInfo struct {
	Name    string
	Address string
}

type NodeLister

type NodeLister interface {
	List(ctx context.Context, namespace string) ([]NodeInfo, error)
}

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options represents funder options

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns default options

type WalletInfo

type WalletInfo struct {
	Name    string
	Address string
	ChainID int64
}

func NewWalletInfo

func NewWalletInfo(name, address string, chainID int64) WalletInfo