payouts

Documentation

Index

• Variables
• type Expectations
• type HeldAmount
• type HeldAmountHistory
• type HeldAmountSummary
• type NodeSummary
• type Paystub
• type SatelliteSummary
• type Service
  • func NewService(log *zap.Logger, dialer rpc.Dialer, nodes nodes.DB) *Service
  • func (service *Service) Earned(ctx context.Context) (earned int64, err error)
  • func (service *Service) EarnedSatellite(ctx context.Context) (earned []SatelliteSummary, err error)
  • func (service *Service) Expectations(ctx context.Context) (_ Expectations, err error)
  • func (service *Service) HeldAmountSummary(ctx context.Context, nodeID storj.NodeID) (_ []HeldAmountSummary, err error)
  • func (service *Service) NodeExpectations(ctx context.Context, nodeID storj.NodeID) (_ Expectations, err error)
  • func (service *Service) Paystub(ctx context.Context, nodeID storj.NodeID) (_ Paystub, err error)
  • func (service *Service) PaystubPeriod(ctx context.Context, period string, nodeID storj.NodeID) (_ Paystub, err error)
  • func (service *Service) PaystubSatellite(ctx context.Context, nodeID, satelliteID storj.NodeID) (_ Paystub, err error)
  • func (service *Service) PaystubSatellitePeriod(ctx context.Context, period string, nodeID, satelliteID storj.NodeID) (_ Paystub, err error)
  • func (service *Service) Summary(ctx context.Context) (_ Summary, err error)
  • func (service *Service) SummaryPeriod(ctx context.Context, period string) (_ Summary, err error)
  • func (service *Service) SummarySatellite(ctx context.Context, satelliteID storj.NodeID) (_ Summary, err error)
  • func (service *Service) SummarySatellitePeriod(ctx context.Context, satelliteID storj.NodeID, period string) (_ Summary, err error)
• type Summary
  • func (summary *Summary) Add(held, paid int64, id storj.NodeID, name string)

Variables

var (

	// Error is an error class for payouts service error.
	Error = errs.Class("payouts")
)

Types

type Expectations

type Expectations struct {
	CurrentMonthEstimation int64 `json:"currentMonthEstimation"`
	Undistributed          int64 `json:"undistributed"`
}

Expectations contains estimated and undistributed payouts.

type HeldAmount

type HeldAmount struct {
	Period string `json:"period"`
	Amount int64  `json:"amount"`
}

HeldAmount contains amount held for period.

type HeldAmountHistory

type HeldAmountHistory struct {
	SatelliteID storj.NodeID `json:"satelliteId"`
	HeldAmounts []HeldAmount `json:"heldAmounts"`
}

HeldAmountHistory contains held amount history of particular satellite.

type HeldAmountSummary

type HeldAmountSummary struct {
	SatelliteID      storj.NodeID `json:"satelliteId"`
	SatelliteAddress string       `json:"satelliteAddress"`
	FirstQuarter     int64        `json:"firstQuarter"`
	SecondQuarter    int64        `json:"secondQuarter"`
	ThirdQuarter     int64        `json:"thirdQuarter"`
	PeriodCount      int          `json:"periodCount"`
}

HeldAmountSummary contains held amount summary for first 3 quarters.

type NodeSummary

type NodeSummary struct {
	NodeID   storj.NodeID `json:"nodeId"`
	NodeName string       `json:"nodeName"`
	Held     int64        `json:"held"`
	Paid     int64        `json:"paid"`
}

NodeSummary contains node's payout information.

type Paystub

type Paystub struct {
	UsageAtRest    float64 `json:"usageAtRest"`
	UsageGet       int64   `json:"usageGet"`
	UsageGetRepair int64   `json:"usageGetRepair"`
	UsageGetAudit  int64   `json:"usageGetAudit"`
	CompAtRest     int64   `json:"compAtRest"`
	CompGet        int64   `json:"compGet"`
	CompGetRepair  int64   `json:"compGetRepair"`
	CompGetAudit   int64   `json:"compGetAudit"`
	Held           int64   `json:"held"`
	Paid           int64   `json:"paid"`
	Distributed    int64   `json:"distributed"`
	Disposed       int64   `json:"disposed"`
}

Paystub is node payouts data for satellite by specific period.

type SatelliteSummary

type SatelliteSummary struct {
	SatelliteID storj.NodeID `json:"satelliteID"`
	Earned      int64        `json:"earned"`
}

SatelliteSummary contains satellite id and earned amount.

type Service

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

Service exposes all payouts related logic.

architecture: Service

func NewService

func NewService(log *zap.Logger, dialer rpc.Dialer, nodes nodes.DB) *Service

NewService creates new instance of Service.

func (*Service) Earned

func (service *Service) Earned(ctx context.Context) (earned int64, err error)

Earned retrieves all nodes earned amount for all time.

func (*Service) EarnedSatellite

func (service *Service) EarnedSatellite(ctx context.Context) (earned []SatelliteSummary, err error)

EarnedSatellite retrieves all nodes earned amount for all time per satellite.

func (*Service) Expectations

func (service *Service) Expectations(ctx context.Context) (_ Expectations, err error)

Expectations returns all nodes estimated and undistributed earnings.

func (*Service) HeldAmountSummary

func (service *Service) HeldAmountSummary(ctx context.Context, nodeID storj.NodeID) (_ []HeldAmountSummary, err error)

HeldAmountSummary retrieves held amount history summary for a particular node.

func (*Service) NodeExpectations

func (service *Service) NodeExpectations(ctx context.Context, nodeID storj.NodeID) (_ Expectations, err error)

NodeExpectations returns node's estimated and undistributed earnings.

func (*Service) Paystub

func (service *Service) Paystub(ctx context.Context, nodeID storj.NodeID) (_ Paystub, err error)

Paystub returns summed all paystubs.

func (*Service) PaystubPeriod

func (service *Service) PaystubPeriod(ctx context.Context, period string, nodeID storj.NodeID) (_ Paystub, err error)

PaystubPeriod returns all satellites paystub for specific period.

func (*Service) PaystubSatellite

func (service *Service) PaystubSatellite(ctx context.Context, nodeID, satelliteID storj.NodeID) (_ Paystub, err error)

PaystubSatellite returns specific satellite summed paystubs.

func (*Service) PaystubSatellitePeriod

func (service *Service) PaystubSatellitePeriod(ctx context.Context, period string, nodeID, satelliteID storj.NodeID) (_ Paystub, err error)

PaystubSatellitePeriod returns specific satellite paystub for specific period.

func (*Service) Summary

func (service *Service) Summary(ctx context.Context) (_ Summary, err error)

Summary returns all satellites all time stats.

func (*Service) SummaryPeriod

func (service *Service) SummaryPeriod(ctx context.Context, period string) (_ Summary, err error)

SummaryPeriod returns all satellites stats for specific period.

func (*Service) SummarySatellite

func (service *Service) SummarySatellite(ctx context.Context, satelliteID storj.NodeID) (_ Summary, err error)

SummarySatellite returns specific satellite all time stats.

func (*Service) SummarySatellitePeriod

func (service *Service) SummarySatellitePeriod(ctx context.Context, satelliteID storj.NodeID, period string) (_ Summary, err error)

SummarySatellitePeriod returns specific satellite stats for specific period.

type Summary

type Summary struct {
	TotalEarned int64         `json:"totalEarned"`
	TotalHeld   int64         `json:"totalHeld"`
	TotalPaid   int64         `json:"totalPaid"`
	NodeSummary []NodeSummary `json:"nodeSummary"`
}

Summary contains payouts page data.

func (*Summary) Add

func (summary *Summary) Add(held, paid int64, id storj.NodeID, name string)

Add appends node payout data to summary.