storj/storagenode/payout/estimatedpayout/estimatedpayout.go

// Copyright (C) 2020 Storj Labs, Inc.
// See LICENSE for copying information.

package estimatedpayout

import (
	"math"
)

// EstimatedPayout contains usage and estimated payout data for current and previous months.
type EstimatedPayout struct {
	CurrentMonth  PayoutMonthly `json:"currentMonth"`
	PreviousMonth PayoutMonthly `json:"previousMonth"`
}

// PayoutMonthly contains usage and estimated payout date.
type PayoutMonthly struct {
	EgressBandwidth         int64   `json:"egressBandwidth"`
	EgressBandwidthPayout   float64 `json:"egressBandwidthPayout"`
	EgressRepairAudit       int64   `json:"egressRepairAudit"`
	EgressRepairAuditPayout float64 `json:"egressRepairAuditPayout"`
	DiskSpace               float64 `json:"diskSpace"`
	DiskSpacePayout         float64 `json:"diskSpacePayout"`
	HeldRate                int64   `json:"heldRate"`
	Payout                  float64 `json:"payout"`
	Held                    float64 `json:"held"`
}

// SetEgressBandwidthPayout counts egress bandwidth payout for PayoutMonthly object.
func (pm *PayoutMonthly) SetEgressBandwidthPayout(egressPrice int64) {
	amount := float64(pm.EgressBandwidth*egressPrice) / math.Pow10(12)
	pm.EgressBandwidthPayout += RoundFloat(amount)
}

// SetEgressRepairAuditPayout counts audit and repair payout for PayoutMonthly object.
func (pm *PayoutMonthly) SetEgressRepairAuditPayout(auditRepairPrice int64) {
	amount := float64(pm.EgressRepairAudit*auditRepairPrice) / math.Pow10(12)
	pm.EgressRepairAuditPayout += RoundFloat(amount)
}

// SetDiskSpacePayout counts disk space payout for PayoutMonthly object.
func (pm *PayoutMonthly) SetDiskSpacePayout(diskSpacePrice int64) {
	amount := pm.DiskSpace * float64(diskSpacePrice) / math.Pow10(12)
	pm.DiskSpacePayout += RoundFloat(amount)
}

// SetHeldAmount counts held amount for PayoutMonthly object.
func (pm *PayoutMonthly) SetHeldAmount() {
	amount := (pm.DiskSpacePayout + pm.EgressBandwidthPayout + pm.EgressRepairAuditPayout) * float64(pm.HeldRate/100)
	pm.Held = RoundFloat(amount)
}

// SetPayout counts payout amount for PayoutMonthly object.
func (pm *PayoutMonthly) SetPayout() {
	amount := pm.DiskSpacePayout + pm.EgressBandwidthPayout + pm.EgressRepairAuditPayout - pm.Held
	pm.Payout = RoundFloat(amount)
}

// RoundFloat rounds float value till 2 signs after dot.
func RoundFloat(value float64) float64 {
	return math.Round(value*100) / 100
}