parameters

Documentation

Index

• Constants
• Variables
• func Dump() map[string]interface{}
• func GetBool(name string) bool
• func GetInt(name string) int
• func GetString(name string) string
• func GetStringSlice(name string) []string
• func GetStringToString(name string) map[string]string
• func GetStruct(path string, object interface{}) error
• func GetStructWithConf(path string, object interface{}, uc koanf.UnmarshalConf) error
• func Init() *configuration.Configuration
• func InitL1(l1 *L1Params)
• func InitL1Lazy(f func())
• func IsLoaded() bool
• type BaseToken
• type L1Params
  • func L1() *L1Params

Constants

const (
	UserList           = "users"
	NodeOwnerAddresses = "node.ownerAddresses"

	LoggerLevel             = "logger.level"
	LoggerDisableCaller     = "logger.disableCaller"
	LoggerDisableStacktrace = "logger.disableStacktrace"
	LoggerEncoding          = "logger.encoding"
	LoggerOutputPaths       = "logger.outputPaths"
	LoggerDisableEvents     = "logger.disableEvents"

	DatabaseDir      = "database.directory"
	DatabaseInMemory = "database.inMemory"

	WebAPIBindAddress            = "webapi.bindAddress"
	WebAPIAdminWhitelist         = "webapi.adminWhitelist"
	WebAPIAdminWhitelistDisabled = "webapi.adminWhitelistDisabled"
	WebAPIAuth                   = "webapi.auth"

	DashboardBindAddress       = "dashboard.bindAddress"
	DashboardExploreAddressURL = "dashboard.exploreAddressUrl"
	DashboardAuth              = "dashboard.auth"

	L1INXAddress = "l1.inxAddress"

	PeeringMyNetID                   = "peering.netid"
	PeeringPort                      = "peering.port"
	PullMissingRequestsFromCommittee = "peering.pullMissingRequests"

	NanomsgPublisherPort = "nanomsg.port"

	IpfsGatewayAddress = "ipfs.gatewayAddress"

	OffledgerBroadcastUpToNPeers = "offledger.broadcastUpToNPeers"
	OffledgerBroadcastInterval   = "offledger.broadcastInterval"
	OffledgerAPICacheTTL         = "offledger.apiCacheTTL"

	ProfilingBindAddress   = "profiling.bindAddress"
	ProfilingEnabled       = "profiling.enabled"
	ProfilingWriteProfiles = "profiling.writeProfiles"

	MetricsBindAddress = "metrics.bindAddress"
	MetricsEnabled     = "metrics.enabled"

	WALEnabled   = "wal.enabled"
	WALDirectory = "wal.directory"

	RawBlocksEnabled = "debug.rawblocksEnabled"
	RawBlocksDir     = "debug.rawblocksDirectory"
	RegistryUseText  = "registry.useText"
	RegistryFile     = "registry.file"
)

const (
	PriorityDatabase = iota

	PriorityChains
	PriorityPeering
	PriorityNodeConnection
	PriorityWebAPI
	PriorityDBGarbageCollection
	PriorityMetrics
)

const MaxPayloadSize = iotago.BlockBinSerializedMaxSize -
	serializer.OneByte -
	serializer.OneByte -
	(iotago.BlockMaxParents * iotago.BlockIDLength) -
	serializer.UInt32ByteSize -

	serializer.UInt64ByteSize // Nonce

Variables

var (
	L1ForTesting = &L1Params{

		MaxPayloadSize: MaxPayloadSize,
		Protocol: &iotago.ProtocolParameters{
			Version:     tpkg.TestProtoParas.Version,
			NetworkName: tpkg.TestProtoParas.NetworkName,
			Bech32HRP:   tpkg.TestProtoParas.Bech32HRP,
			MinPoWScore: tpkg.TestProtoParas.MinPoWScore,
			RentStructure: iotago.RentStructure{
				VByteCost:    10,
				VBFactorData: 1,
				VBFactorKey:  1,
			},
			TokenSupply: tpkg.TestProtoParas.TokenSupply,
		},
		BaseToken: &BaseToken{
			Name:            "Iota",
			TickerSymbol:    "MIOTA",
			Unit:            "MIOTA",
			Subunit:         "IOTA",
			Decimals:        6,
			UseMetricPrefix: false,
		},
	}
)

Functions

func Dump

func Dump() map[string]interface{}

func GetBool

func GetBool(name string) bool

func GetInt

func GetInt(name string) int

func GetString

func GetString(name string) string

func GetStringSlice

func GetStringSlice(name string) []string

func GetStringToString

func GetStringToString(name string) map[string]string

func GetStruct

func GetStruct(path string, object interface{}) error

func GetStructWithConf

func GetStructWithConf(path string, object interface{}, uc koanf.UnmarshalConf) error

func Init

func Init() *configuration.Configuration

func InitL1

func InitL1(l1 *L1Params)

func InitL1Lazy

func InitL1Lazy(f func())

InitL1Lazy sets a function to be called the first time L1() is called. The function must call InitL1().

func IsLoaded

func IsLoaded() bool

Types

type BaseToken

type BaseToken struct {
	Name            string
	TickerSymbol    string
	Unit            string
	Subunit         string
	Decimals        uint32
	UseMetricPrefix bool
}

type L1Params

type L1Params struct {
	MaxPayloadSize int
	Protocol       *iotago.ProtocolParameters
	BaseToken      *BaseToken
}

L1Params describes parameters coming from the L1Params node

func L1

func L1() *L1Params