Documentation
¶
Index ¶
Constants ¶
const ( // DUSK is one whole unit of DUSK. DUSK = uint64(1_000_000_000) // Default Block Gas limit. BlockGasLimit = 1000 * DUSK // MaxTxSetSize defines the maximum amount of transactions. // It is TBD along with block size and processing.MaxFrameSize. MaxTxSetSize = 825000 // Maximum number of blocks to be requested/delivered on a single syncing session with a peer. MaxInvBlocks = 500 // Protocol-based consensus step time. ConsensusTimeOut = 5 * time.Second // ConsensusTimeThreshold consensus time in seconds above which we don't throttle it. ConsensusTimeThreshold = 10 MaxBlockTime = 360 // maximum block time in seconds // KadcastInitialHeight sets the default initial height for Kadcast broadcast algorithm. KadcastInitialHeight byte = 128 // The dusk-blockchain executable version. NodeVersion = "0.5.0" // The shared API version (between dusk-blockchain and rusk). InteropVersion = "0.1.0" )
A single point of constants definition.
Variables ¶
var KadcastInitHeader = []byte{KadcastInitialHeight}
KadcastInitHeader is used as default initial kadcast message header.
Functions ¶
func Load ¶
Load makes an attempt to read and unmarshal any configs from flag, env and dusk config file.
It uses the following precedence order. Each item takes precedence over the item below it:
- flag
- env
- config
- key/value store (not used yet)
- default
Dusk configuration file can be in form of TOML, JSON, YAML, HCL or Java properties config files.
Types ¶
type Base ¶ added in v0.2.0
type Base struct {
// UsedConfigFile points at the loaded config file.
UsedConfigFile string
// FixedConfigFile fixes the config file to be loaded. If not set,
// the default search-for-config procedure is used.
FixedConfigFile string
// name for the config file. Does not include extension.
ConfigFileName string
// contains filtered or unexported fields
}
Base configurations structure.
type Registry ¶
type Registry struct {
Base
// All configuration groups.
General generalConfiguration
Timeout timeoutConfiguration
Database databaseConfiguration
Wallet walletConfiguration
Network networkConfiguration
Kadcast kadcastConfiguration
Mempool mempoolConfiguration
Consensus consensusConfiguration
State stateConfiguration
RPC rpcConfiguration
Gql gqlConfiguration
API apiConfiguration
Performance performanceConfiguration
Logger loggerConfiguration
Profile []profileConfiguration
// contains filtered or unexported fields
}
Registry stores all loaded configurations according to the config order NB It should be cheap to be copied by value.
func Get ¶
func Get() Registry
Get returns registry by value in order to avoid further modifications after initial configuration loading.
func LoadFromFile ¶ added in v0.2.0
LoadFromFile unmarshalls configPath file into a new Registry instance NB. It does not overwrite the global Registry.
Source Files
Directories