parameter

README

Parameter

This directory contains the parameters affecting the behavior of the Node.

The parameters must NOT be changed manually.

Documentation

Index

• Constants
• Variables
• func CheckParamsTask(ctx context.Context, redisClient rueidis.Client, ...) error
• func GetCurrentEpoch(ctx context.Context, redisClient rueidis.Client) (int64, error)
• func GetCurrentEpochFromVSL(settlement *vsl.SettlementCaller) (int64, error)
• func GetNetworkBlockStart(ctx context.Context, redisClient rueidis.Client, network string) (uint64, error)
• func InitVSLClient() (ethereum.Client, error)
• func PullNetworkParamsFromVSL(networkParams *vsl.NetworkParamsCaller, epoch uint64) (string, error)
• func UpdateBlockStart(ctx context.Context, redisClient rueidis.Client, network string, ...) error
• func UpdateCurrentEpoch(ctx context.Context, redisClient rueidis.Client, epoch int64) error
• type NetworkCoreWorkerDiskSpacePerMonth
• type NetworkParamsData
  • func (npd *NetworkParamsData) UnmarshalJSON(data []byte) error
• type NetworkStartBlock
• type NetworkTolerance
• type StartBlock

Constants

const NumberOfMonthsToCover = 4

NumberOfMonthsToCover the number of months that a Node should cover data for

Variables

var CurrentNetworkCoreWorkerDiskSpacePerMonth = NetworkCoreWorkerDiskSpacePerMonth{}

CurrentNetworkCoreWorkerDiskSpacePerMonth the disk space required for the network's core worker to store a month worth of data The data is calculated based on the average disk space usage during 2024 Q1. Actually usage may vary depending on the network's activity.

var CurrentNetworkStartBlock = NetworkStartBlock{}

CurrentNetworkStartBlock should be updated each epoch from vsl

var CurrentNetworkTolerance = NetworkTolerance{}

CurrentNetworkTolerance should be updated each epoch from vsl

Functions

func CheckParamsTask

func CheckParamsTask(ctx context.Context, redisClient rueidis.Client, networkParamsCaller *vsl.NetworkParamsCaller) error

func GetCurrentEpoch

func GetCurrentEpoch(ctx context.Context, redisClient rueidis.Client) (int64, error)

GetCurrentEpoch Get the current epoch from redis cache

func GetCurrentEpochFromVSL

func GetCurrentEpochFromVSL(settlement *vsl.SettlementCaller) (int64, error)

GetCurrentEpochFromVSL Get the current epoch from VSL blockchain

func GetNetworkBlockStart

func GetNetworkBlockStart(ctx context.Context, redisClient rueidis.Client, network string) (uint64, error)

GetNetworkBlockStart Get the current network block start from redis cache

func InitVSLClient

func InitVSLClient() (ethereum.Client, error)

InitVSLClient initializes the VSL client

func PullNetworkParamsFromVSL

func PullNetworkParamsFromVSL(networkParams *vsl.NetworkParamsCaller, epoch uint64) (string, error)

PullNetworkParamsFromVSL pulls the network parameters from the VSL

func UpdateBlockStart

func UpdateBlockStart(ctx context.Context, redisClient rueidis.Client, network string, blockStart int64) error

UpdateBlockStart updates the current start block in redis cache

func UpdateCurrentEpoch

func UpdateCurrentEpoch(ctx context.Context, redisClient rueidis.Client, epoch int64) error

UpdateCurrentEpoch updates the current epoch in redis cache

Types

type NetworkCoreWorkerDiskSpacePerMonth

type NetworkCoreWorkerDiskSpacePerMonth map[network.Network]uint

type NetworkParamsData

type NetworkParamsData struct {
	NetworkTolerance                   NetworkTolerance                   `json:"network_tolerance"`
	NetworkStartBlock                  NetworkStartBlock                  `json:"network_start_block"`
	NetworkCoreWorkerDiskSpacePerMonth NetworkCoreWorkerDiskSpacePerMonth `json:"network_core_worker_disk_space_per_month"`
}

NetworkParamsData contains the network parameters

func (*NetworkParamsData) UnmarshalJSON

func (npd *NetworkParamsData) UnmarshalJSON(data []byte) error

UnmarshalJSON defines a custom UnmarshalJSON method for NetworkParamsData

type NetworkStartBlock

type NetworkStartBlock map[network.Network]*StartBlock

type NetworkTolerance

type NetworkTolerance map[network.Network]uint64

type StartBlock

type StartBlock struct {
	Block     *big.Int `json:"block"`
	Timestamp int64    `json:"timestamp"`
}