coreconfig

Documentation

Index

• Variables
• func Reset()

Variables

var (
	// APIDefaultFilterLimit is the default limit that will be applied to filtered queries on the API
	APIDefaultFilterLimit = ffc("api.defaultFilterLimit")
	// APIMaxFilterLimit is the maximum limit that can be specified by an API call
	APIMaxFilterLimit = ffc("api.maxFilterLimit")
	// APIMaxFilterSkip is the maximum skip value that can be specified on the API
	APIMaxFilterSkip = ffc("api.maxFilterLimit")
	// APIRequestTimeout is the server side timeout for API calls (context timeout), to avoid the server continuing processing when the client gives up
	APIRequestTimeout = ffc("api.requestTimeout")
	// APIRequestMaxTimeout is the maximum timeout an application can set using a Request-Timeout header
	APIRequestMaxTimeout = ffc("api.requestMaxTimeout")
	// APIShutdownTimeout is the amount of time to wait for any in-flight requests to finish before killing the HTTP server
	APIShutdownTimeout = ffc("api.shutdownTimeout")
	// APIOASPanicOnMissingDescription controls whether the OpenAPI Spec generator will strongly enforce descriptions on every field or not
	APIOASPanicOnMissingDescription = ffc("api.oas.panicOnMissingDescription")
	// BatchCacheSize
	BatchCacheSize = ffc("batch.cache.size")
	// BatchCacheSize
	BatchCacheTTL = ffc("batch.cache.ttl")
	// BatchManagerReadPageSize is the size of each page of messages read from the database into memory when assembling batches
	BatchManagerReadPageSize = ffc("batch.manager.readPageSize")
	// BatchManagerReadPollTimeout is how long without any notifications of new messages to wait, before doing a page query
	BatchManagerReadPollTimeout = ffc("batch.manager.pollTimeout")
	// BatchManagerMinimumPollDelay is the minimum time the batch manager waits between polls on the DB - to prevent thrashing
	BatchManagerMinimumPollDelay = ffc("batch.manager.minimumPollDelay")
	// BatchRetryFactor is the retry backoff factor for database operations performed by the batch manager
	BatchRetryFactor = ffc("batch.retry.factor")
	// BatchRetryInitDelay is the retry initial delay for database operations
	BatchRetryInitDelay = ffc("batch.retry.initDelay")
	// BatchRetryMaxDelay is the maximum delay between retry attempts
	BatchRetryMaxDelay = ffc("batch.retry.maxDelay")
	// BlobReceiverRetryInitDelay is the initial retry delay
	BlobReceiverRetryInitDelay = ffc("blobreceiver.retry.initialDelay")
	// BlobReceiverRetryMaxDelay is the maximum retry delay
	BlobReceiverRetryMaxDelay = ffc("blobreceiver.retry.maxDelay")
	// BlobReceiverRetryFactor is the backoff factor to use for retries
	BlobReceiverRetryFactor = ffc("blobreceiver.retry.factor")
	// BlobReceiverWorkerCount
	BlobReceiverWorkerCount = ffc("blobreceiver.worker.count")
	// BlobReceiverWorkerBatchTimeout
	BlobReceiverWorkerBatchTimeout = ffc("blobreceiver.worker.batchTimeout")
	// BlobReceiverWorkerBatchMaxInserts
	BlobReceiverWorkerBatchMaxInserts = ffc("blobreceiver.worker.batchMaxInserts")
	// BlockchainEventCacheSize size of cache for blockchain events
	BlockchainEventCacheSize = ffc("blockchainevent.cache.size")
	// BlockchainEventCacheTTL time to live of cache for blockchain events
	BlockchainEventCacheTTL = ffc("blockchainevent.cache.ttl")
	// BlockchainType is the name of the blockchain interface plugin being used by this firefly node
	BlockchainType = ffc("blockchain.type")
	// BroadcastBatchAgentTimeout how long to keep around a batching agent for a sending identity before disposal
	BroadcastBatchAgentTimeout = ffc("broadcast.batch.agentTimeout")
	// BroadcastBatchSize is the maximum number of messages that can be packed into a batch
	BroadcastBatchSize = ffc("broadcast.batch.size")
	// BroadcastBatchPayloadLimit is the maximum payload size of a batch for broadcast messages
	BroadcastBatchPayloadLimit = ffc("broadcast.batch.payloadLimit")
	// BroadcastBatchTimeout is the timeout to wait for a batch to fill, before sending
	BroadcastBatchTimeout = ffc("broadcast.batch.timeout")
	// DownloadWorkerCount is the number of download workers created to pull data from shared storage to the local DX
	DownloadWorkerCount = ffc("download.worker.count")
	// DownloadWorkerQueueLength is the length of the work queue in the channel to the workers - defaults to 2x the worker count
	DownloadWorkerQueueLength = ffc("download.worker.queueLength")
	// DownloadRetryMaxAttempts is the maximum number of automatic attempts to make for each shared storage download before failing the operation
	DownloadRetryMaxAttempts = ffc("download.retry.maxAttempts")
	// DownloadRetryInitDelay is the initial retry delay
	DownloadRetryInitDelay = ffc("download.retry.initialDelay")
	// DownloadRetryMaxDelay is the maximum retry delay
	DownloadRetryMaxDelay = ffc("download.retry.maxDelay")
	// DownloadRetryFactor is the backoff factor to use for retries
	DownloadRetryFactor = ffc("download.retry.factor")
	// PrivateMessagingBatchAgentTimeout how long to keep around a batching agent for a sending identity before disposal
	PrivateMessagingBatchAgentTimeout = ffc("privatemessaging.batch.agentTimeout")
	// PrivateMessagingBatchSize is the maximum size of a batch for broadcast messages
	PrivateMessagingBatchSize = ffc("privatemessaging.batch.size")
	// PrivateMessagingBatchPayloadLimit is the maximum payload size of a private message data exchange payload
	PrivateMessagingBatchPayloadLimit = ffc("privatemessaging.batch.payloadLimit")
	// PrivateMessagingBatchTimeout is the timeout to wait for a batch to fill, before sending
	PrivateMessagingBatchTimeout = ffc("privatemessaging.batch.timeout")
	// PrivateMessagingRetryFactor the backoff factor to use for retry of database operations
	PrivateMessagingRetryFactor = ffc("privatemessaging.retry.factor")
	// PrivateMessagingRetryInitDelay the initial delay to use for retry of data base operations
	PrivateMessagingRetryInitDelay = ffc("privatemessaging.retry.initDelay")
	// PrivateMessagingRetryMaxDelay the maximum delay to use for retry of data base operations
	PrivateMessagingRetryMaxDelay = ffc("privatemessaging.retry.maxDelay")
	// CorsAllowCredentials CORS setting to control whether a browser allows credentials to be sent to this API
	CorsAllowCredentials = ffc("cors.credentials")
	// CorsAllowedHeaders CORS setting to control the allowed headers
	CorsAllowedHeaders = ffc("cors.headers")
	// CorsAllowedMethods CORS setting to control the allowed methods
	CorsAllowedMethods = ffc("cors.methods")
	// CorsAllowedOrigins CORS setting to control the allowed origins
	CorsAllowedOrigins = ffc("cors.origins")
	// CorsDebug is whether debug is enabled for the CORS implementation
	CorsDebug = ffc("cors.debug")
	// CorsEnabled is whether cors is enabled
	CorsEnabled = ffc("cors.enabled")
	// CorsMaxAge is the maximum age a browser should rely on CORS checks
	CorsMaxAge = ffc("cors.maxAge")
	// DataexchangeType is the name of the data exchange plugin being used by this firefly node
	DataexchangeType = ffc("dataexchange.type")
	// DatabaseType the type of the database interface plugin to use
	DatabaseType = ffc("database.type")
	// HistogramsMaxChartRows the maximum rows to fetch for each histogram bucket
	HistogramsMaxChartRows = ffc("histograms.maxChartRows")
	// TokensList is the root key containing a list of supported token connectors
	TokensList = ffc("tokens")
	// DebugPort a HTTP port on which to enable the go debugger
	DebugPort = ffc("debug.port")
	// EventTransportsDefault the default event transport for new subscriptions
	EventTransportsDefault = ffc("event.transports.default")
	// EventTransportsEnabled which event interface plugins are enabled
	EventTransportsEnabled = ffc("event.transports.enabled")
	// EventAggregatorFirstEvent the first event the aggregator should process, if no previous offest is stored in the DB
	EventAggregatorFirstEvent = ffc("event.aggregator.firstEvent")
	// EventAggregatorBatchSize the maximum number of records to read from the DB before performing an aggregation run
	EventAggregatorBatchSize = ffc("event.aggregator.batchSize")
	// EventAggregatorBatchTimeout how long to wait for new events to arrive before performing aggregation on a page of events
	EventAggregatorBatchTimeout = ffc("event.aggregator.batchTimeout")
	// EventAggregatorPollTimeout the time to wait without a notification of new events, before trying a select on the table
	EventAggregatorPollTimeout = ffc("event.aggregator.pollTimeout")
	// EventAggregatorRewindTimeout the minimum time to wait for rewinds to accumulate before resolving them
	EventAggregatorRewindTimeout = ffc("event.aggregator.rewindTimeout")
	// EventAggregatorRewindQueueLength the size of the queue into the rewind dispatcher
	EventAggregatorRewindQueueLength = ffc("event.aggregator.rewindQueueLength")
	// EventAggregatorRewindQueryLimit safety limit on the maximum number of records to search when performing queries to search for rewinds
	EventAggregatorRewindQueryLimit = ffc("event.aggregator.rewindQueryLimit")
	// EventAggregatorRetryFactor the backoff factor to use for retry of database operations
	EventAggregatorRetryFactor = ffc("event.aggregator.retry.factor")
	// EventAggregatorRetryInitDelay the initial delay to use for retry of data base operations
	EventAggregatorRetryInitDelay = ffc("event.aggregator.retry.initDelay")
	// EventAggregatorRetryMaxDelay the maximum delay to use for retry of data base operations
	EventAggregatorRetryMaxDelay = ffc("event.aggregator.retry.maxDelay")
	// EventDispatcherPollTimeout the time to wait without a notification of new events, before trying a select on the table
	EventDispatcherPollTimeout = ffc("event.dispatcher.pollTimeout")
	// EventDispatcherBufferLength the number of events + attachments an individual dispatcher should hold in memory ready for delivery to the subscription
	EventDispatcherBufferLength = ffc("event.dispatcher.bufferLength")
	// EventDispatcherBatchTimeout a short time to wait for new events to arrive before re-polling for new events
	EventDispatcherBatchTimeout = ffc("event.dispatcher.batchTimeout")
	// EventDispatcherRetryFactor the backoff factor to use for retry of database operations
	EventDispatcherRetryFactor = ffc("event.dispatcher.retry.factor")
	// EventDispatcherRetryInitDelay he initial delay to use for retry of data base operations
	EventDispatcherRetryInitDelay = ffc("event.dispatcher.retry.initDelay")
	// EventDispatcherRetryMaxDelay he maximum delay to use for retry of data base operations
	EventDispatcherRetryMaxDelay = ffc("event.dispatcher.retry.maxDelay")
	// EventDBEventsBufferSize the size of the buffer of change events
	EventDBEventsBufferSize = ffc("event.dbevents.bufferSize")
	// EventListenerTopicCacheSize cache size for blockchain listeners addresses
	EventListenerTopicCacheSize = ffc("event.listenerTopic.cache.size")
	// EventListenerTopicCacheTTL cache time-to-live for private group addresses
	EventListenerTopicCacheTTL = ffc("event.listenerTopic.cache.ttl")
	// GroupCacheSize cache size for private group addresses
	GroupCacheSize = ffc("group.cache.size")
	// GroupCacheTTL cache time-to-live for private group addresses
	GroupCacheTTL = ffc("group.cache.ttl")
	// AdminEnabled determines whether the admin interface will be enabled or not
	AdminEnabled = ffc("admin.enabled")
	// AdminPreinit waits for at least one ConfigREcord to be posted to the server before it starts (the database must be available on startup)
	AdminPreinit = ffc("admin.preinit")
	// AdminWebSocketEventQueueLength is the maximum number of events that will queue up on the server side of each WebSocket connection before events start being dropped
	AdminWebSocketEventQueueLength = ffc("admin.ws.eventQueueLength")
	// AdminWebSocketBlockedWarnInterval how often to emit a warning if an admin.ws is blocked and not receiving events
	AdminWebSocketBlockedWarnInterval = ffc("admin.ws.blockedWarnInterval")
	// AdminWebSocketReadBufferSize is the WebSocket read buffer size for the admin change-event WebSocket
	AdminWebSocketReadBufferSize = ffc("admin.ws.readBufferSize")
	// AdminWebSocketWriteBufferSize is the WebSocket write buffer size for the admin change-event WebSocket
	AdminWebSocketWriteBufferSize = ffc("admin.ws.writeBufferSize")
	// IdentityType the type of the identity plugin in use
	IdentityType = ffc("identity.type")
	// IdentityManagerCacheTTL the identity manager cache time to live
	IdentityManagerCacheTTL = ffc("identity.manager.cache.ttl")
	// IdentityManagerCacheLimit the identity manager cache limit in count of items
	IdentityManagerCacheLimit = ffc("identity.manager.cache.limit")
	// MessageCacheSize
	MessageCacheSize = ffc("message.cache.size")
	// MessageCacheTTL
	MessageCacheTTL = ffc("message.cache.ttl")
	// MessageWriterCount
	MessageWriterCount = ffc("message.writer.count")
	// MessageWriterBatchTimeout
	MessageWriterBatchTimeout = ffc("message.writer.batchTimeout")
	// MessageWriterBatchMaxInserts
	MessageWriterBatchMaxInserts = ffc("message.writer.batchMaxInserts")
	// MetricsEnabled determines whether metrics will be instrumented and if the metrics server will be enabled or not
	MetricsEnabled = ffc("metrics.enabled")
	// MetricsPath determines what path to serve the Prometheus metrics from
	MetricsPath = ffc("metrics.path")
	// NamespacesDefault is the default namespace - must be in the predefines list
	NamespacesDefault = ffc("namespaces.default")
	// NamespacesPredefined is a list of namespaces to ensure exists, without requiring a broadcast from the network
	NamespacesPredefined = ffc("namespaces.predefined")
	// NodeName is a description for the node
	NodeName = ffc("node.name")
	// NodeDescription is a description for the node
	NodeDescription = ffc("node.description")
	// OpUpdateRetryInitDelay is the initial retry delay
	OpUpdateRetryInitDelay = ffc("opupdate.retry.initialDelay")
	// OpUpdatedRetryMaxDelay is the maximum retry delay
	OpUpdateRetryMaxDelay = ffc("opupdate.retry.maxDelay")
	// OpUpdateRetryFactor is the backoff factor to use for retries
	OpUpdateRetryFactor = ffc("opupdate.retry.factor")
	// OpUpdateWorkerCount
	OpUpdateWorkerCount = ffc("opupdate.worker.count")
	// OpUpdateWorkerBatchTimeout
	OpUpdateWorkerBatchTimeout = ffc("opupdate.worker.batchTimeout")
	// OpUpdateWorkerBatchMaxInserts
	OpUpdateWorkerBatchMaxInserts = ffc("opupdate.worker.batchMaxInserts")
	// OpUpdateWorkerQueueLength
	OpUpdateWorkerQueueLength = ffc("opupdate.worker.queueLength")
	// OrgName is the short name o the org
	OrgName = ffc("org.name")
	// OrgIdentityDeprecated deprecated synonym to org.key
	OrgIdentityDeprecated = ffc("org.identity")
	// OrgKey is the signing identity allocated to the organization (can be the same as the nodes)
	OrgKey = ffc("org.key")
	// OrgDescription is a description for the org
	OrgDescription = ffc("org.description")
	// OrchestratorStartupAttempts is how many time to attempt to connect to core infrastructure on startup
	OrchestratorStartupAttempts = ffc("orchestrator.startupAttempts")
	// SharedStorageType specifies which shared storage interface plugin to use
	SharedStorageType = ffc("sharedstorage.type")
	// PublicStorageType specifies which shared storage interface plugin to use - deprecated in favor of SharedStorageType
	PublicStorageType = ffc("publicstorage.type")
	// SubscriptionDefaultsReadAhead default read ahead to enable for subscriptions that do not explicitly configure readahead
	SubscriptionDefaultsReadAhead = ffc("subscription.defaults.batchSize")
	// SubscriptionMax maximum number of pre-defined subscriptions that can exist (note for high fan-out consider connecting a dedicated pub/sub broker to the dispatcher)
	SubscriptionMax = ffc("subscription.max")
	// SubscriptionsRetryInitialDelay is the initial retry delay
	SubscriptionsRetryInitialDelay = ffc("subscription.retry.initDelay")
	// SubscriptionsRetryMaxDelay is the initial retry delay
	SubscriptionsRetryMaxDelay = ffc("subscription.retry.maxDelay")
	// SubscriptionsRetryFactor the backoff factor to use for retry of database operations
	SubscriptionsRetryFactor = ffc("subscription.retry.factor")
	// TransactionCacheSize
	TransactionCacheSize = ffc("transaction.cache.size")
	// TransactionCacheTTL
	TransactionCacheTTL = ffc("transaction.cache.ttl")
	// AssetManagerKeyNormalization mechanism to normalize keys before using them. Valid options: "blockchain_plugin" - use blockchain plugin (default), "none" - do not attempt normalization
	AssetManagerKeyNormalization = ffc("asset.manager.keyNormalization")
	// UIEnabled set to false to disable the UI (default is true, so UI will be enabled if ui.path is valid)
	UIEnabled = ffc("ui.enabled")
	// UIPath the path on which to serve the UI
	UIPath = ffc("ui.path")
	// ValidatorCacheSize
	ValidatorCacheSize = ffc("validator.cache.size")
	// ValidatorCacheTTL
	ValidatorCacheTTL = ffc("validator.cache.ttl")
)

The following keys can be access from the root configuration. Plugins are responsible for defining their own keys using the Config interface

Functions

func Reset

func Reset()