package
1.3.2-rc.1
Repository: https://github.com/hyperledger/firefly.git
Documentation: pkg.go.dev

# Functions

No description provided by the author

# Constants

NamespaceAssetKeyNormalization mechanism to normalize keys before using them.
NamespaceDefaultKey is the default signing key for blockchain transactions within this namespace.
NamespaceName is the long description for a pre-defined namespace.
NamespaceMultiparty contains the multiparty configuration for a namespace.
NamespaceMultipartyContract is a list of firefly contract configurations for this namespace.
NamespaceMultipartyContractFirstEvent is the first event to process for this contract.
NamespaceMultipartyContractLocation is an object specifying the blockchain-specific location of the contract.
NamespaceMultipartyContractOptions is an object of additional blockchain-specific configuration.
NamespaceMultipartyEnabled specifies if multi-party mode is enabled for a namespace.
NamespaceMultipartyNetworkNamespace is the shared namespace name to be used in off-chain messaging.
NamespaceMultipartyNodeName is a description for the local node within a namespace.
NamespaceMultipartyNodeName is the name for the local node within a namespace.
NamespaceMultipartyOrgDescription is a description for the local root org within a namespace.
NamespaceMultipartyOrgKey is the signing key allocated to the local root org within a namespace.
NamespaceMultipartyOrgName is a short name for the local root org within a namespace.
NamespaceName is the short name for a pre-defined namespace.
NamespacePlugins is the list of namespace plugins.
NamespaceTLSConfigName is the user-supplied name for the TLS Config.
NamespaceTLSConfigs is the list of tls configs.
NamespaceTLSConfigTLSSection is the section to provide the paths to CA , cert and key files.
PluginBroadcastName is the plugin name to be sent in multi-party broadcasts, if it differs from the local plugin name.
PluginConfigName is the user-supplied name for this plugin type.
PluginConfigType is the type of the plugin to be loaded.

# Variables

APIDefaultFilterLimit is the default limit that will be applied to filtered queries on the API.
APIDynamicPublicURLHeader is a header that can be used on requests to generate Swagger to influence the PublicURL on a per-request basis.
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.
APIOASPanicOnMissingDescription controls whether the OpenAPI Spec generator will strongly enforce descriptions on every field or not.
APIPassThroughHeaders is a list of HTTP request headers to pass through to requests made to dependency microservices.
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.
AssetManagerKeyNormalization mechanism to normalize keys before using them.
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.
BlobReceiverRetryFactor is the backoff factor to use for retries.
BlobReceiverRetryInitDelay is the initial retry delay.
BlobReceiverRetryMaxDelay is the maximum retry delay.
BlobReceiverWorkerBatchMaxInserts.
BlobReceiverWorkerBatchTimeout.
BlobReceiverWorkerCount.
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.
AddressResolver cache config.
The following keys can be access from the root configuration.
Batch cache config.
The following keys can be access from the root configuration.
Transaction - BlockchainEvent cache config.
The following keys can be access from the root configuration.
The following keys can be access from the root configuration.
Blockchain cache config.
CacheEnabled determines whether cache will be enabled or not, default to true.
EventListenerTopic cache config.
The following keys can be access from the root configuration.
Group cache config.
The following keys can be access from the root configuration.
IdentityManager identity cache config.
The following keys can be access from the root configuration.
DataManager Message cache config.
The following keys can be access from the root configuration.
Invoke methods cache config.
The following keys can be access from the root configuration.
Operations cache config.
The following keys can be access from the root configuration.
The following keys can be access from the root configuration.
Token pool cache config.
Transaction cache config.
The following keys can be access from the root configuration.
DataManager Validator cache config.
The following keys can be access from the root configuration.
ConfigAutoReload starts a filesystem listener against the config file, and if it changes analyzes the config file for changes that require individual namespaces to restart.
DebugAddress the HTTP interface for the debugger to listen on.
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.
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.
EventAggregatorRewindQueryLimit safety limit on the maximum number of records to search when performing queries to search for rewinds.
EventAggregatorRewindQueueLength the size of the queue into the rewind dispatcher.
EventAggregatorRewindTimeout the minimum time to wait for rewinds to accumulate before resolving them.
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.
EventTransportsDefault the default event transport for new subscriptions.
EventTransportsEnabled which event interface plugins are enabled.
DatabaseType the type of the database interface plugin to use.
LegacyAdminEnabled is the deprecated key that pre-dates spi.enabled.
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.
NamespacesRetryFactor is the retry backoff factor for starting/restarting individual namespaces.
NamespacesRetryInitDelay is the retry initial delay for starting/restarting individual namespaces.
NamespacesRetryMaxDelay is the maximum delay between retry attempts.
NodeDescription is a description for the node.
NodeName is the short name for the node.
OpUpdateRetryFactor is the backoff factor to use for retries.
OpUpdateRetryInitDelay is the initial retry delay.
OpUpdatedRetryMaxDelay is the maximum retry delay.
OpUpdateWorkerBatchMaxInserts.
OpUpdateWorkerBatchTimeout.
OpUpdateWorkerCount.
OpUpdateWorkerQueueLength.
OrchestratorStartupAttempts is how many time to attempt to connect to core infrastructure on startup.
OrgDescription is a description for the org.
OrgKey is the signing identity allocated to the organization (can be the same as the nodes).
OrgName is the short name for the org.
PluginsAuthList is the key containing a list of supported auth plugins.
PluginsBlockchainList is the key containing a list of configured blockchain plugins.
PluginsDatabaseList is the key containing a list of configured database plugins.
PluginsDataExchangeList is the key containing a list of configured database plugins.
PluginsIdentityList is the key containing a list of configured identity plugins.
PluginsSharedStorageList is the key containing a list of configured shared storage plugins.
PluginsTokensList is the key containing a list of supported tokens plugins.
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.
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.
SPIEnabled determines whether the admin interface will be enabled or not.
SPIWebSocketBlockedWarnInterval how often to emit a warning if an admin.ws is blocked and not receiving events.
SPIWebSocketEventQueueLength is the maximum number of events that will queue up on the server side of each WebSocket connection before events start being dropped.
SPIWebSocketReadBufferSize is the WebSocket read buffer size for the admin change-event WebSocket.
SPIWebSocketWriteBufferSize is the WebSocket write buffer size for the admin change-event WebSocket.
SubscriptionDefaultsBatchSize default read ahead to enable for subscriptions that do not explicitly configure readahead.
SubscriptionDefaultsBatchTimeout default batch timeout.
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).
SubscriptionMaxHistoricalEventScanLength the maximum amount of historical events we scan for in the DB when indexing through old events against a subscription.
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.
TransactionWriterBatchMaxTransactions.
TransactionWriterBatchTimeout.
TransactionWriterCount.
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.