rocketpool

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 5, 2020 License: GPL-3.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	InstallerURL = "https://github.com/rocket-pool/smartnode-install/releases/latest/download/install.sh"

	RocketPoolPath   = "~/.rocketpool"
	GlobalConfigFile = "config.yml"
	UserConfigFile   = "settings.yml"
	ComposeFile      = "docker-compose.yml"

	APIContainerName = "rocketpool_api"
	APIBinPath       = "/go/bin/rocketpool"

	DebugColor = color.FgYellow
)

Config

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Rocket Pool client

func NewClient 

func NewClient(hostAddress, user, keyPath string) (*Client, error)

Create new Rocket Pool client

func NewClientFromCtx 

func NewClientFromCtx(c *cli.Context) (*Client, error)

Create new Rocket Pool client from CLI context

func (*Client) CanCloseMinipool 

func (c *Client) CanCloseMinipool(address common.Address) (api.CanCloseMinipoolResponse, error)

Check whether a minipool can be closed

func (*Client) CanDissolveMinipool 

func (c *Client) CanDissolveMinipool(address common.Address) (api.CanDissolveMinipoolResponse, error)

Check whether a minipool can be dissolved

func (*Client) CanExitMinipool 

func (c *Client) CanExitMinipool(address common.Address) (api.CanExitMinipoolResponse, error)

Check whether a minipool can be exited

func (*Client) CanNodeBurn 

func (c *Client) CanNodeBurn(amountWei *big.Int, token string) (api.CanNodeBurnResponse, error)

Check whether the node can burn tokens

func (*Client) CanNodeDeposit 

func (c *Client) CanNodeDeposit(amountWei *big.Int) (api.CanNodeDepositResponse, error)

Check whether the node can make a deposit

func (*Client) CanNodeSend 

func (c *Client) CanNodeSend(amountWei *big.Int, token string) (api.CanNodeSendResponse, error)

Check whether the node can send tokens

func (*Client) CanProcessQueue 

func (c *Client) CanProcessQueue() (api.CanProcessQueueResponse, error)

Check whether the queue can be processed

func (*Client) CanRefundMinipool 

func (c *Client) CanRefundMinipool(address common.Address) (api.CanRefundMinipoolResponse, error)

Check whether a minipool is eligible for a refund

func (*Client) CanRegisterNode 

func (c *Client) CanRegisterNode() (api.CanRegisterNodeResponse, error)

Check whether the node can be registered

func (*Client) CanWithdrawMinipool 

func (c *Client) CanWithdrawMinipool(address common.Address) (api.CanWithdrawMinipoolResponse, error)

Check whether a minipool can be withdrawn

func (*Client) Close 

func (c *Client) Close()

Close client remote connection

func (*Client) CloseMinipool 

func (c *Client) CloseMinipool(address common.Address) (api.CloseMinipoolResponse, error)

Close a minipool

func (*Client) DissolveMinipool 

func (c *Client) DissolveMinipool(address common.Address) (api.DissolveMinipoolResponse, error)

Dissolve a minipool

func (*Client) ExitMinipool 

func (c *Client) ExitMinipool(address common.Address) (api.ExitMinipoolResponse, error)

Exit a minipool

func (*Client) ExportWallet 

func (c *Client) ExportWallet() (api.ExportWalletResponse, error)

Export wallet

func (*Client) FaucetWithdraw 

func (c *Client) FaucetWithdraw(token string) (api.FaucetWithdrawResponse, error)

Withdraw from faucet

func (*Client) InitWallet 

func (c *Client) InitWallet() (api.InitWalletResponse, error)

Initialize wallet

func (*Client) InstallService 

func (c *Client) InstallService(verbose, noDeps bool, network, version string) error

Install the Rocket Pool service

func (*Client) LoadGlobalConfig 

func (c *Client) LoadGlobalConfig() (config.RocketPoolConfig, error)

Load the global config

func (*Client) MinipoolStatus 

func (c *Client) MinipoolStatus() (api.MinipoolStatusResponse, error)

Get minipool status

func (*Client) NodeBurn 

func (c *Client) NodeBurn(amountWei *big.Int, token string) (api.NodeBurnResponse, error)

Burn tokens owned by the node for ETH

func (*Client) NodeDeposit 

func (c *Client) NodeDeposit(amountWei *big.Int, minFee float64) (api.NodeDepositResponse, error)

Make a node deposit

func (*Client) NodeFee 

func (c *Client) NodeFee() (api.NodeFeeResponse, error)

Get network node fee

func (*Client) NodeSend 

func (c *Client) NodeSend(amountWei *big.Int, token string, toAddress common.Address) (api.NodeSendResponse, error)

Send tokens from the node to an address

func (*Client) NodeStatus 

func (c *Client) NodeStatus() (api.NodeStatusResponse, error)

Get node status

func (*Client) PauseService 

func (c *Client) PauseService() error

Pause the Rocket Pool service

func (*Client) PrintServiceLogs 

func (c *Client) PrintServiceLogs(tail string, serviceNames ...string) error

Print the Rocket Pool service logs

func (*Client) PrintServiceStats 

func (c *Client) PrintServiceStats() error

Print the Rocket Pool service stats

func (*Client) PrintServiceStatus 

func (c *Client) PrintServiceStatus() error

Print the Rocket Pool service status

func (*Client) ProcessQueue 

func (c *Client) ProcessQueue() (api.ProcessQueueResponse, error)

Process the queue

func (*Client) QueueStatus 

func (c *Client) QueueStatus() (api.QueueStatusResponse, error)

Get queue status

func (*Client) RecoverWallet 

func (c *Client) RecoverWallet(mnemonic string) (api.RecoverWalletResponse, error)

Recover wallet

func (*Client) RefundMinipool 

func (c *Client) RefundMinipool(address common.Address) (api.RefundMinipoolResponse, error)

Refund ETH from a minipool

func (*Client) RegisterNode 

func (c *Client) RegisterNode(timezoneLocation string) (api.RegisterNodeResponse, error)

Register the node

func (*Client) SaveUserConfig 

func (c *Client) SaveUserConfig(cfg config.RocketPoolConfig) error

Save the user config

func (*Client) SetNodeTimezone 

func (c *Client) SetNodeTimezone(timezoneLocation string) (api.SetNodeTimezoneResponse, error)

Set the node's timezone location

func (*Client) SetPassword 

func (c *Client) SetPassword(password string) (api.SetPasswordResponse, error)

Set wallet password

func (*Client) StartService 

func (c *Client) StartService() error

Start the Rocket Pool service

func (*Client) StopService 

func (c *Client) StopService() error

Stop the Rocket Pool service

func (*Client) WalletStatus 

func (c *Client) WalletStatus() (api.WalletStatusResponse, error)

Get wallet status

func (*Client) WithdrawMinipool 

func (c *Client) WithdrawMinipool(address common.Address) (api.WithdrawMinipoolResponse, error)

Withdraw a minipool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.