worker

Documentation

Index

• Variables
• type Account
  • func (a *Account) ID() rhpv3.Account
  • func (a *Account) Key() types.PrivateKey
  • func (a *Account) ScheduleSync()
  • func (a *Account) WithDeposit(amtFn func(types.Currency) (types.Currency, error)) error
  • func (a *Account) WithSync(balanceFn func() (types.Currency, error)) error
  • func (a *Account) WithWithdrawal(amtFn func() (types.Currency, error)) error
• type AccountFunder
• type AccountMgr
  • func NewAccountManager(key utils.AccountsKey, owner string, alerter alerts.Alerter, ...) (*AccountMgr, error)
  • func (a *AccountMgr) Account(hostKey types.PublicKey) api.Account
  • func (a *AccountMgr) Accounts() []api.Account
  • func (a *AccountMgr) ForHost(hk types.PublicKey) *Account
  • func (a *AccountMgr) ResetDrift(id rhpv3.Account) error
  • func (a *AccountMgr) Shutdown(ctx context.Context) error
• type AccountStore
• type AccountSyncer
• type Bus
• type ConsensusState
• type DownloadContracts
• type EventHandler
• type EventSubscriber
  • func NewEventSubscriber(a alerts.Alerter, w WebhookManager, l *zap.Logger, ...) EventSubscriber
• type WebhookManager
• type WorkerCache
  • func NewCache(b Bus, logger *zap.Logger) WorkerCache

Variables

var (
	ErrAccountNotFound = errors.New("account doesn't exist")
)

Types

type Account

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

func (*Account) ID

func (a *Account) ID() rhpv3.Account

func (*Account) Key

func (a *Account) Key() types.PrivateKey

func (*Account) ScheduleSync

func (a *Account) ScheduleSync()

scheduleSync sets the requiresSync flag of an account.

func (*Account) WithDeposit

func (a *Account) WithDeposit(amtFn func(types.Currency) (types.Currency, error)) error

WithDeposit increases the balance of an account by the amount returned by amtFn if amtFn doesn't return an error.

func (*Account) WithSync

func (a *Account) WithSync(balanceFn func() (types.Currency, error)) error

WithSync syncs an accounts balance with the bus. To do so, the account is locked while the balance is fetched through balanceFn.

func (*Account) WithWithdrawal

func (a *Account) WithWithdrawal(amtFn func() (types.Currency, error)) error

WithWithdrawal decreases the balance of an account by the amount returned by amtFn. The amount is still withdrawn if amtFn returns an error since some costs are non-refundable.

type AccountFunder

type AccountFunder interface {
	FundAccount(ctx context.Context, fcid types.FileContractID, hk types.PublicKey, desired types.Currency) error
}

type AccountMgr

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

func NewAccountManager

func NewAccountManager(key utils.AccountsKey, owner string, alerter alerts.Alerter, funder AccountFunder, syncer AccountSyncer, cs ConsensusState, dc DownloadContracts, s AccountStore, refillInterval time.Duration, l *zap.Logger) (*AccountMgr, error)

NewAccountManager creates a new account manager. It will load all accounts from the given store and mark the shutdown as unclean. When Shutdown is called it will save all accounts.

func (*AccountMgr) Account

func (a *AccountMgr) Account(hostKey types.PublicKey) api.Account

Account returns the account with the given id.

func (*AccountMgr) Accounts

func (a *AccountMgr) Accounts() []api.Account

Accounts returns all accounts.

func (*AccountMgr) ForHost

func (a *AccountMgr) ForHost(hk types.PublicKey) *Account

ForHost returns an account to use for a given host. If the account doesn't exist, a new one is created.

func (*AccountMgr) ResetDrift

func (a *AccountMgr) ResetDrift(id rhpv3.Account) error

ResetDrift resets the drift on an account.

func (*AccountMgr) Shutdown

func (a *AccountMgr) Shutdown(ctx context.Context) error

type AccountStore

type AccountStore interface {
	Accounts(context.Context, string) ([]api.Account, error)
	UpdateAccounts(context.Context, []api.Account) error
}

type AccountSyncer

type AccountSyncer interface {
	SyncAccount(ctx context.Context, fcid types.FileContractID, hk types.PublicKey, siamuxAddr string) error
}

type Bus

type Bus interface {
	Contracts(ctx context.Context, opts api.ContractsOpts) ([]api.ContractMetadata, error)
	GougingParams(ctx context.Context) (api.GougingParams, error)
}

type ConsensusState

type ConsensusState interface {
	ConsensusState(ctx context.Context) (api.ConsensusState, error)
}

type DownloadContracts

type DownloadContracts interface {
	DownloadContracts(ctx context.Context) ([]api.ContractMetadata, error)
}

type EventHandler

type EventHandler interface {
	HandleEvent(event webhooks.Event) error
	Subscribe(e EventSubscriber) error
}

type EventSubscriber

type EventSubscriber interface {
	AddEventHandler(id string, h EventHandler) (chan struct{}, error)
	ProcessEvent(event webhooks.Event)
	Register(ctx context.Context, eventURL string, opts ...webhooks.HeaderOption) error
	Shutdown(context.Context) error
}

func NewEventSubscriber

func NewEventSubscriber(a alerts.Alerter, w WebhookManager, l *zap.Logger, registerInterval time.Duration) EventSubscriber

type WebhookManager

type WebhookManager interface {
	RegisterWebhook(ctx context.Context, wh webhooks.Webhook) error
	UnregisterWebhook(ctx context.Context, wh webhooks.Webhook) error
}

type WorkerCache

type WorkerCache interface {
	DownloadContracts(ctx context.Context) ([]api.ContractMetadata, error)
	GougingParams(ctx context.Context) (api.GougingParams, error)
	HandleEvent(event webhooks.Event) error
	Subscribe(e EventSubscriber) error
}

func NewCache

func NewCache(b Bus, logger *zap.Logger) WorkerCache