package
0.14.1
Repository: https://github.com/hyperledger/firefly.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

Get gets a configuration in raw form.
GetBool gets a configuration bool.
GetByteSize get a size in bytes.
No description provided by the author
GetDuration gets a configuration time duration with consistent semantics.
GetFloat64 gets a configuration uint.
GetInt gets a configuration uint.
GetInt64 gets a configuration uint.
GetKnownKeys gets the known keys.
GetObject gets a configuration map.
GetObjectArray gets an array of configuration maps.
GetString gets a configuration string.
GetStringSlice gets a configuration string array.
GetUint gets a configuration uint.
No description provided by the author
NewPluginConfig creates a new plugin configuration object, at the specified prefix.
ReadConfig initializes the config.
No description provided by the author
Set allows runtime setting of config (used in unit tests).
SetupLogging initializes logging.

# Variables

AdminEnabled determines whether the admin interface will be enabled or not.
AdminPreinit waits for at least one ConfigREcord to be posted to the server before it starts (the database must be available on startup).
APIDefaultFilterLimit is the default limit that will be applied to filtered queries on the API.
APIMaxFilterLimit is the maximum limit that can be specified by an API call.
APIMaxFilterSkip is the maximum skip value that can be specified on the API.
APIRequestMaxTimeout is the maximum timeout an application can set using a Request-Timeout header.
APIRequestTimeout is the server side timeout for API calls (context timeout), to avoid the server continuing processing when the client gives up.
APIShutdownTimeout is the amount of time to wait for any in-flight requests to finish before killing the HTTP server.
AssetManagerKeyNormalization mechanism to normalize keys before using them.
BatchCacheSize.
BatchCacheSize.
BatchManagerMinimumPollDelay is the minimum time the batch manager waits between polls on the DB - to prevent thrashing.
BatchManagerReadPageSize is the size of each page of messages read from the database into memory when assembling batches.
BatchManagerReadPollTimeout is how long without any notifications of new messages to wait, before doing a page query.
BatchRetryFactor is the retry backoff factor for database operations performed by the batch manager.
BatchRetryInitDelay is the retry initial delay for database operations.
BatchRetryMaxDelay is the maximum delay between retry attempts.
BlockchainType is the name of the blockchain interface plugin being used by this firefly node.
BroadcastBatchAgentTimeout how long to keep around a batching agent for a sending identity before disposal.
BroadcastBatchPayloadLimit is the maximum payload size of a batch for broadcast messages.
BroadcastBatchSize is the maximum number of messages that can be packed into a batch.
BroadcastBatchTimeout is the timeout to wait for a batch to fill, before sending.
CorsAllowCredentials CORS setting to control whether a browser allows credentials to be sent to this API.
CorsAllowedHeaders CORS setting to control the allowed headers.
CorsAllowedMethods CORS setting to control the allowed methods.
CorsAllowedOrigins CORS setting to control the allowed origins.
CorsDebug is whether debug is enabled for the CORS implementation.
CorsEnabled is whether cors is enabled.
CorsMaxAge is the maximum age a browser should rely on CORS checks.
DatabaseType the type of the database interface plugin to use.
DataexchangeType is the name of the data exchange plugin being used by this firefly node.
DebugPort a HTTP port on which to enable the go debugger.
DownloadRetryFactor is the backoff factor to use for retries.
DownloadRetryInitDelay is the initial retry delay.
DownloadRetryMaxAttempts is the maximum number of automatic attempts to make for each shared storage download before failing the operation.
DownloadRetryMaxDelay is the maximum retry delay.
DownloadWorkerCount is the number of download workers created to pull data from shared storage to the local DX.
DownloadWorkerQueueLength is the length of the work queue in the channel to the workers - defaults to 2x the worker count.
EventAggregatorBatchSize the maximum number of records to read from the DB before performing an aggregation run.
EventAggregatorBatchTimeout how long to wait for new events to arrive before performing aggregation on a page of events.
EventAggregatorFirstEvent the first event the aggregator should process, if no previous offest is stored in the DB.
EventAggregatorOpCorrelationRetries how many times to correlate an event for an operation (such as tx submission) back to an operation.
EventAggregatorPollTimeout the time to wait without a notification of new events, before trying a select on the table.
EventAggregatorRetryFactor the backoff factor to use for retry of database operations.
EventAggregatorRetryInitDelay the initial delay to use for retry of data base operations.
EventAggregatorRetryMaxDelay the maximum delay to use for retry of data base operations.
EventDBEventsBufferSize the size of the buffer of change events.
EventDispatcherBatchTimeout a short time to wait for new events to arrive before re-polling for new events.
EventDispatcherBufferLength the number of events + attachments an individual dispatcher should hold in memory ready for delivery to the subscription.
EventDispatcherPollTimeout the time to wait without a notification of new events, before trying a select on the table.
EventDispatcherRetryFactor the backoff factor to use for retry of database operations.
EventDispatcherRetryInitDelay he initial delay to use for retry of data base operations.
EventDispatcherRetryMaxDelay he maximum delay to use for retry of data base operations.
EventListenerTopicCacheSize cache size for blockchain listeners addresses.
EventListenerTopicCacheTTL cache time-to-live for private group addresses.
EventTransportsDefault the default event transport for new subscriptions.
EventTransportsEnabled which event interface plugins are enabled.
GroupCacheSize cache size for private group addresses.
GroupCacheTTL cache time-to-live for private group addresses.
IdentityManagerCacheLimit the identity manager cache limit in count of items.
IdentityManagerCacheTTL the identity manager cache time to live.
IdentityType the type of the identity plugin in use.
Lang is the language to use for translation.
LogCompress sets whether to compress backups.
LogFilename sets logging to file.
LogFilesize sets the size to roll logs at.
LogForceColor forces color to be enabled, even if we do not detect a TTY.
LogLevel is the logging level.
LogMaxAge sets the maximum age at which to roll.
LogMaxBackups sets the maximum number of old files to keep.
LogNoColor forces color to be disabled, even if we detect a TTY.
LogTimeFormat is a string format for timestamps.
LogUTC sets log timestamps to the UTC timezone.
MessageCacheSize.
MessageCacheTTL.
MessageWriterBatchMaxInserts.
MessageWriterBatchTimeout.
MessageWriterCount.
MetricsEnabled determines whether metrics will be instrumented and if the metrics server will be enabled or not.
MetricsPath determines what path to serve the Prometheus metrics from.
NamespacesDefault is the default namespace - must be in the predefines list.
NamespacesPredefined is a list of namespaces to ensure exists, without requiring a broadcast from the network.
NodeDescription is a description for the node.
NodeName is a description for the node.
OrchestratorStartupAttempts is how many time to attempt to connect to core infrastructure on startup.
OrgDescription is a description for the org.
OrgIdentityDeprecated deprecated synonym to org.key.
OrgKey is the signing identity allocated to the organization (can be the same as the nodes).
OrgName is the short name o the org.
PrivateMessagingBatchAgentTimeout how long to keep around a batching agent for a sending identity before disposal.
PrivateMessagingBatchPayloadLimit is the maximum payload size of a private message data exchange payload.
PrivateMessagingBatchSize is the maximum size of a batch for broadcast messages.
PrivateMessagingBatchTimeout is the timeout to wait for a batch to fill, before sending.
PrivateMessagingOpCorrelationRetries how many times to correlate an event for an operation (such as tx submission) back to an operation.
PrivateMessagingRetryFactor the backoff factor to use for retry of database operations.
PrivateMessagingRetryInitDelay the initial delay to use for retry of data base operations.
PrivateMessagingRetryMaxDelay the maximum delay to use for retry of data base operations.
PublicStorageType specifies which shared storage interface plugin to use - deprecated in favor of SharedStorageType.
SharedStorageType specifies which shared storage interface plugin to use.
SubscriptionDefaultsReadAhead default read ahead to enable for subscriptions that do not explicitly configure readahead.
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).
SubscriptionsRetryFactor the backoff factor to use for retry of database operations.
SubscriptionsRetryInitialDelay is the initial retry delay.
SubscriptionsRetryMaxDelay is the initial retry delay.
TokensList is the root key containing a list of supported token connectors.
TransactionCacheSize.
TransactionCacheTTL.
UIEnabled set to false to disable the UI (default is true, so UI will be enabled if ui.path is valid).
UIPath the path on which to serve the UI.
ValidatorCacheSize.
ValidatorCacheTTL.

# Interfaces

No description provided by the author
Prefix represents the global configuration, at a nested point in the config hierarchy.
PrefixArray represents an array of options at a particular layer in the config.

# Type aliases

RootKey key are the known configuration keys.