consoleapi

Documentation

Index

• Variables
• type Notifications
  • func NewNotifications(log *zap.Logger, service *notifications.Service) *Notifications
  • func (notification *Notifications) ListNotifications(w http.ResponseWriter, r *http.Request)
  • func (notification *Notifications) ReadAllNotifications(w http.ResponseWriter, r *http.Request)
  • func (notification *Notifications) ReadNotification(w http.ResponseWriter, r *http.Request)
• type Page
• type Payout
  • func NewPayout(log *zap.Logger, service *payouts.Service) *Payout
  • func (payout *Payout) HeldAmountPeriods(w http.ResponseWriter, r *http.Request)
  • func (payout *Payout) HeldHistory(w http.ResponseWriter, r *http.Request)
  • func (payout *Payout) PayStubMonthly(w http.ResponseWriter, r *http.Request)
  • func (payout *Payout) PayStubPeriod(w http.ResponseWriter, r *http.Request)
  • func (payout *Payout) PayoutHistory(w http.ResponseWriter, r *http.Request)
• type StorageNode
  • func NewStorageNode(log *zap.Logger, service *console.Service) *StorageNode
  • func (dashboard *StorageNode) EstimatedPayout(w http.ResponseWriter, r *http.Request)
  • func (dashboard *StorageNode) Satellite(w http.ResponseWriter, r *http.Request)
  • func (dashboard *StorageNode) Satellites(w http.ResponseWriter, r *http.Request)
  • func (dashboard *StorageNode) StorageNode(w http.ResponseWriter, r *http.Request)

Variables

var ErrNotificationsAPI = errs.Class("consoleapi notifications")

ErrNotificationsAPI - console notifications api error type.

var ErrPayoutAPI = errs.Class("consoleapi payouts")

ErrPayoutAPI - console payouts api error type.

var ErrStorageNodeAPI = errs.Class("consoleapi storagenode")

ErrStorageNodeAPI - console storagenode api error type.

Types

type Notifications

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

Notifications is an api controller that exposes all notifications related api.

func NewNotifications

func NewNotifications(log *zap.Logger, service *notifications.Service) *Notifications

NewNotifications is a constructor for notifications controller.

func (*Notifications) ListNotifications

func (notification *Notifications) ListNotifications(w http.ResponseWriter, r *http.Request)

ListNotifications returns listed page of notifications from database.

func (*Notifications) ReadAllNotifications

func (notification *Notifications) ReadAllNotifications(w http.ResponseWriter, r *http.Request)

ReadAllNotifications updates all notifications in database as read.

func (*Notifications) ReadNotification

func (notification *Notifications) ReadNotification(w http.ResponseWriter, r *http.Request)

ReadNotification updates specific notification in database as read.

type Page

type Page struct {
	Notifications []notifications.Notification `json:"notifications"`

	Offset      uint64 `json:"offset"`
	Limit       uint   `json:"limit"`
	CurrentPage uint   `json:"currentPage"`
	PageCount   uint   `json:"pageCount"`
}

Page contains notifications and related information.

type Payout

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

Payout is an api controller that exposes all payouts related api.

func NewPayout

func NewPayout(log *zap.Logger, service *payouts.Service) *Payout

NewPayout is a constructor for payouts controller.

func (*Payout) HeldAmountPeriods

func (payout *Payout) HeldAmountPeriods(w http.ResponseWriter, r *http.Request)

HeldAmountPeriods retrieves all periods in which we have some payouts data. Have optional parameter - satelliteID. If satelliteID specified - will retrieve periods only for concrete satellite.

func (*Payout) HeldHistory

func (payout *Payout) HeldHistory(w http.ResponseWriter, r *http.Request)

HeldHistory returns held amount for each % period for all satellites.

func (*Payout) PayStubMonthly

func (payout *Payout) PayStubMonthly(w http.ResponseWriter, r *http.Request)

PayStubMonthly returns payouts, storage holding and prices data for specific month from all satellites or specified satellite by query parameter id.

func (*Payout) PayStubPeriod

func (payout *Payout) PayStubPeriod(w http.ResponseWriter, r *http.Request)

PayStubPeriod retrieves paystubs for selected range of months from storagenode database for all satellites or specified satellite by query parameter id.

func (*Payout) PayoutHistory

func (payout *Payout) PayoutHistory(w http.ResponseWriter, r *http.Request)

PayoutHistory retrieves paystubs for specific period from all satellites and transaction receipts if exists.

type StorageNode

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

StorageNode is an api controller that exposes all dashboard related api.

func NewStorageNode

func NewStorageNode(log *zap.Logger, service *console.Service) *StorageNode

NewStorageNode is a constructor for sno controller.

func (*StorageNode) EstimatedPayout

func (dashboard *StorageNode) EstimatedPayout(w http.ResponseWriter, r *http.Request)

EstimatedPayout returns estimated payouts from specific satellite or all satellites if current traffic level remains same.

func (*StorageNode) Satellite

func (dashboard *StorageNode) Satellite(w http.ResponseWriter, r *http.Request)

Satellite handles satellite API requests.

func (*StorageNode) Satellites

func (dashboard *StorageNode) Satellites(w http.ResponseWriter, r *http.Request)

Satellites handles satellites API request.

func (*StorageNode) StorageNode

func (dashboard *StorageNode) StorageNode(w http.ResponseWriter, r *http.Request)

StorageNode handles StorageNode API requests.