controllers

Documentation

Index

• Variables
• func DisableLog()
• func NewGetTicketsCacheData(tfar *dcrjson.TicketsForAddressResult) *getTicketsCacheData
• func UseLogger(logger btclog.Logger)
• type ApiController
• type MainController
  • func NewMainController(params *chaincfg.Params, adminIPs []string, APISecret string, ...) (*MainController, error)
  • func (controller *MainController) API(c web.C, r *http.Request) *system.APIResponse
  • func (controller *MainController) APIAddress(c web.C, r *http.Request) ([]string, codes.Code, string, error)
  • func (controller *MainController) APIPurchaseInfo(c web.C, r *http.Request) (*poolapi.PurchaseInfo, codes.Code, string, error)
  • func (controller *MainController) APIStats(c web.C, r *http.Request) (*poolapi.Stats, codes.Code, string, error)
  • func (controller *MainController) Address(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) AddressPost(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) EmailUpdate(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) EmailVerify(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) Error(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) FeeAddressForUserID(uid int) (dcrutil.Address, error)
  • func (controller *MainController) Index(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) Logout(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) PasswordReset(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) PasswordResetPost(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) PasswordUpdate(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) PasswordUpdatePost(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) RPCIsStopped() bool
  • func (controller *MainController) RPCStart()
  • func (controller *MainController) RPCStop() error
  • func (controller *MainController) RPCSync(dbMap *gorp.DbMap, skipVoteBitsSync bool) error
  • func (controller *MainController) SendMail(emailaddress string, subject string, body string) error
  • func (controller *MainController) Settings(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) SettingsPost(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) SignIn(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) SignInPost(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) SignUp(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) SignUpPost(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) Stats(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) Status(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) Tickets(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) TicketsPost(c web.C, r *http.Request) (string, int)
  • func (controller *MainController) WalletStatus() ([]*dcrjson.WalletInfoResult, error)

Variables

var (
	// ErrSetVoteBitsCoolDown is returned by SetTicketVoteBits and
	// SetTicketsVoteBits the vote bits were set too recently.
	ErrSetVoteBitsCoolDown = fmt.Errorf("Cannot set the vote bits because " +
		"last call was too recent.")
)

Functions

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until either UseLogger or SetLogWriter are called.

func NewGetTicketsCacheData

func NewGetTicketsCacheData(tfar *dcrjson.TicketsForAddressResult) *getTicketsCacheData

NewGetTicketsCacheData is a contructor for getTicketsCacheData that sets the last get time to now.

func UseLogger

func UseLogger(logger btclog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using btclog.

Types

type ApiController

type ApiController struct {
	system.Controller
}

type MainController

type MainController struct {
	// embed type for c.Env[""] context and ExecuteTemplate helpers
	system.Controller

	APISecret            string
	APIVersionsSupported []int
	// contains filtered or unexported fields
}

MainController is the wallet RPC controller type. Its methods include the route handlers.

func NewMainController

func NewMainController(params *chaincfg.Params, adminIPs []string,
	APISecret string, APIVersionsSupported []int, baseURL string,
	closePool bool, closePoolMsg string, extPubStr string, poolEmail string,
	poolFees float64, poolLink string, recaptchaSecret string,
	recaptchaSiteKey string, smtpFrom string,
	smtpHost string, smtpUsername string, smtpPassword string, version string,
	walletHosts []string, walletCerts []string, walletUsers []string,
	walletPasswords []string, minServers int, realIPHeader string) (*MainController, error)

NewMainController is the constructor for the entire controller routing.

func (*MainController) API

func (controller *MainController) API(c web.C, r *http.Request) *system.APIResponse

API is the main frontend that handles all API requests.

func (*MainController) APIAddress

func (controller *MainController) APIAddress(c web.C, r *http.Request) ([]string, codes.Code, string, error)

APIAddress is the API version of AddressPost

func (*MainController) APIPurchaseInfo

func (controller *MainController) APIPurchaseInfo(c web.C,
	r *http.Request) (*poolapi.PurchaseInfo, codes.Code, string, error)

APIPurchaseInfo fetches and returns the user's info or an error

func (*MainController) APIStats

func (controller *MainController) APIStats(c web.C,
	r *http.Request) (*poolapi.Stats, codes.Code, string, error)

APIStats is an API version of the stats page

func (*MainController) Address

func (controller *MainController) Address(c web.C, r *http.Request) (string, int)

Address renders the address page.

func (*MainController) AddressPost

func (controller *MainController) AddressPost(c web.C, r *http.Request) (string, int)

AddressPost is address form submit route.

func (*MainController) EmailUpdate

func (controller *MainController) EmailUpdate(c web.C, r *http.Request) (string, int)

EmailUpdate validates the passed token and updates the user's email address.

func (*MainController) EmailVerify

func (controller *MainController) EmailVerify(c web.C, r *http.Request) (string,
	int)

EmailVerify renders the email verification page.

func (*MainController) Error

func (controller *MainController) Error(c web.C, r *http.Request) (string, int)

Error renders the error page.

func (*MainController) FeeAddressForUserID

func (controller *MainController) FeeAddressForUserID(uid int) (dcrutil.Address,
	error)

FeeAddressForUserID generates a unique payout address per used ID for fees for an individual pool user.

func (*MainController) Index

func (controller *MainController) Index(c web.C, r *http.Request) (string, int)

Index renders the home page.

func (*MainController) Logout

func (controller *MainController) Logout(c web.C, r *http.Request) (string, int)

Logout the user.

func (*MainController) PasswordReset

func (controller *MainController) PasswordReset(c web.C, r *http.Request) (string, int)

PasswordReset renders the password reset page.

func (*MainController) PasswordResetPost

func (controller *MainController) PasswordResetPost(c web.C, r *http.Request) (string, int)

PasswordResetPost handles the posted password reset form.

func (*MainController) PasswordUpdate

func (controller *MainController) PasswordUpdate(c web.C, r *http.Request) (string, int)

PasswordUpdate renders the password update page.

func (*MainController) PasswordUpdatePost

func (controller *MainController) PasswordUpdatePost(c web.C, r *http.Request) (string, int)

PasswordUpdatePost handles updating passwords.

func (*MainController) RPCIsStopped

func (controller *MainController) RPCIsStopped() bool

RPCIsStopped checks to see if w.shutdown is set or not.

func (*MainController) RPCStart

func (controller *MainController) RPCStart()

RPCStart starts the connected rpcServers.

func (*MainController) RPCStop

func (controller *MainController) RPCStop() error

RPCStop stops the connected rpcServers.

func (*MainController) RPCSync

func (controller *MainController) RPCSync(dbMap *gorp.DbMap, skipVoteBitsSync bool) error

RPCSync checks to ensure that the wallets are synced on startup.

func (*MainController) SendMail

func (controller *MainController) SendMail(emailaddress string, subject string, body string) error

SendMail sends an email with the passed data using the system's SMTP configuration.

func (*MainController) Settings

func (controller *MainController) Settings(c web.C, r *http.Request) (string, int)

Settings renders the settings page.

func (*MainController) SettingsPost

func (controller *MainController) SettingsPost(c web.C, r *http.Request) (string, int)

SettingsPost handles changing the user's email address or password.

func (*MainController) SignIn

func (controller *MainController) SignIn(c web.C, r *http.Request) (string, int)

SignIn renders the signin page.

func (*MainController) SignInPost

func (controller *MainController) SignInPost(c web.C, r *http.Request) (string, int)

SignInPost is the form submit route. Logs user in or sets an appropriate message in session if login was not successful.

func (*MainController) SignUp

func (controller *MainController) SignUp(c web.C, r *http.Request) (string, int)

SignUp renders the signup page.

func (*MainController) SignUpPost

func (controller *MainController) SignUpPost(c web.C, r *http.Request) (string, int)

SignUpPost form submit route. Registers new user or shows Sign Up route with appropriate messages set in session.

func (*MainController) Stats

func (controller *MainController) Stats(c web.C, r *http.Request) (string, int)

Stats renders the stats page.

func (*MainController) Status

func (controller *MainController) Status(c web.C, r *http.Request) (string, int)

Status renders the status page.

func (*MainController) Tickets

func (controller *MainController) Tickets(c web.C, r *http.Request) (string, int)

Tickets renders the tickets page.

func (*MainController) TicketsPost

func (controller *MainController) TicketsPost(c web.C, r *http.Request) (string, int)

TicketsPost form submit route.

func (*MainController) WalletStatus

func (controller *MainController) WalletStatus() ([]*dcrjson.WalletInfoResult, error)

WalletStatus returns current WalletInfo from all rpcServers.