accountfreeze

Documentation

Index

• Variables
• type Chore
  • func NewChore(log *zap.Logger, accounts stripe.DB, payments payments.Accounts, ...) *Chore
  • func (chore *Chore) Close() error
  • func (chore *Chore) Run(ctx context.Context) (err error)
  • func (chore *Chore) TestSetFreezeService(service *console.AccountFreezeService)
  • func (chore *Chore) TestSetNow(f func() time.Time)
• type Config
• type EmailIntervals
  • func (e *EmailIntervals) Set(s string) error
  • func (e *EmailIntervals) String() string
  • func (e *EmailIntervals) Type() string

Variables

var (
	// Error is the standard error class for automatic freeze errors.
	Error = errs.Class("account-freeze-chore")
)

Types

type Chore

type Chore struct {
	Loop *sync2.Cycle
	// contains filtered or unexported fields
}

Chore is a chore that checks for unpaid invoices and potentially freezes corresponding accounts.

func NewChore

func NewChore(log *zap.Logger, accounts stripe.DB, payments payments.Accounts, usersDB console.Users, walletsDB storjscan.WalletsDB, paymentsDB storjscan.PaymentsDB, freezeService *console.AccountFreezeService, analytics *analytics.Service, mailService *mailservice.Service, freezeConfig console.AccountFreezeConfig, config Config, flagBots bool, externalAddress, generalRequestURL string) *Chore

NewChore is a constructor for Chore.

func (*Chore) Close

func (chore *Chore) Close() error

Close closes the chore.

func (*Chore) Run

func (chore *Chore) Run(ctx context.Context) (err error)

Run runs the chore.

func (*Chore) TestSetFreezeService

func (chore *Chore) TestSetFreezeService(service *console.AccountFreezeService)

TestSetFreezeService changes the freeze service for tests.

func (*Chore) TestSetNow

func (chore *Chore) TestSetNow(f func() time.Time)

TestSetNow sets nowFn on chore for testing.

type Config

type Config struct {
	Enabled          bool          `help:"whether to run this chore." default:"false"`
	Interval         time.Duration `help:"How often to run this chore, which is how often unpaid invoices are checked." default:"24h"`
	PriceThreshold   int64         `help:"The failed invoice amount (in cents) beyond which an account will not be frozen" default:"100000"`
	ExcludeStorjscan bool          `help:"whether to exclude storjscan-paying users from automatic warn/freeze" default:"false"`

	EmailsEnabled                bool           `help:"whether to freeze event emails from this chore" default:"false"`
	BillingWarningEmailIntervals EmailIntervals `help:"how long to wait between the billing freeze warning emails" default:"240h,96h"`
	BillingFreezeEmailIntervals  EmailIntervals `help:"how long to wait between the billing freeze emails" default:"720h,480h,216h"`
}

Config contains configurable values for account freeze chore.

type EmailIntervals

type EmailIntervals []time.Duration

EmailIntervals is a list of durations representing how often freeze emails are sent for a freeze event.

func (*EmailIntervals) Set

func (e *EmailIntervals) Set(s string) error

Set parses a comma-separated list of durations.

func (*EmailIntervals) String

func (e *EmailIntervals) String() string

String returns a comma-separated list of durations. e.g.: 24h,32m.

func (*EmailIntervals) Type

func (e *EmailIntervals) Type() string

Type returns the type of the pflag.Value.