Instance Constructors

1.  new LedgerApiServerConfig(address: String = "127.0.0.1", internalPort: Option[Port] = None, maxEventCacheWeight: Long = 0L, maxContractCacheWeight: Long = 0L, tls: Option[TlsServerConfig] = None, configurationLoadTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultConfigurationLoadTimeout, bufferedEventsProcessingParallelism: Int = LedgerApiServerConfig.DefaultEventsProcessingParallelism, bufferedStreamsPageSize: Int = LedgerIndexServiceConfig.DefaultBufferedStreamsPageSize, activeContractsService: ActiveContractsServiceConfig = ActiveContractsServiceConfig(), transactionTreeStreams: TreeTransactionStreamsConfig = TreeTransactionStreamsConfig(), transactionFlatStreams: FlatTransactionStreamsConfig = FlatTransactionStreamsConfig(), globalMaxEventIdQueries: Int = LedgerIndexServiceConfig().globalMaxEventIdQueries, globalMaxEventPayloadQueries: Int = LedgerIndexServiceConfig().globalMaxEventPayloadQueries, commandService: CommandServiceConfig = CommandServiceConfig(), userManagementService: UserManagementServiceConfig = UserManagementServiceConfig(), managementServiceTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultManagementServiceTimeout, postgresDataSource: PostgresDataSourceConfigCanton = PostgresDataSourceConfigCanton(), authServices: Seq[AuthServiceConfig] = Seq.empty, keepAliveServer: Option[KeepAliveServerConfig] = Some(KeepAliveServerConfig()), maxContractStateCacheSize: Long = LedgerApiServerConfig.DefaultMaxContractStateCacheSize, maxContractKeyStateCacheSize: Long = LedgerApiServerConfig.DefaultMaxContractKeyStateCacheSize, maxInboundMessageSize: NonNegativeInt = ServerConfig.defaultMaxInboundMessageSize, databaseConnectionTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultDatabaseConnectionTimeout, apiStreamShutdownTimeout: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultApiStreamShutdownTimeout, maxTransactionsInMemoryFanOutBufferSize: Int = LedgerApiServerConfig.DefaultMaxTransactionsInMemoryFanOutBufferSize, enableInMemoryFanOutForLedgerApi: Boolean = false, additionalMigrationPaths: Seq[String] = Seq.empty, inMemoryStateUpdaterParallelism: Int = LedgerApiServerConfig.DefaultInMemoryStateUpdaterParallelism, inMemoryFanOutThreadPoolSize: Option[Int] = None, rateLimit: Option[RateLimitingConfig] = Some(DefaultRateLimit), preparePackageMetadataTimeOutWarning: NonNegativeFiniteDuration = LedgerApiServerConfig.DefaultPreparePackageMetadataTimeOutWarning, completionsPageSize: Int = LedgerApiServerConfig.DefaultCompletionsPageSize, explicitDisclosureUnsafe: Boolean = false)
   address

   ledger api server host name.

   internalPort

   ledger api server port.

   maxEventCacheWeight

   ledger api server event cache maximum weight (caffeine cache size)

   maxContractCacheWeight

   ledger api server contract cache maximum weight (caffeine cache size)

   tls

   tls configuration setting from ledger api server.

   configurationLoadTimeout

   ledger api server startup delay if no timemodel has been sent by canton via ReadService

   bufferedEventsProcessingParallelism

   parallelism for loading and decoding ledger events for populating Ledger API internal buffers

   activeContractsService

   configurations pertaining to the ledger api server's "active contracts service"

   transactionTreeStreams

   configurations pertaining to the ledger api server's streams of flat transactions

   transactionFlatStreams

   configurations pertaining to the ledger api server's streams of transaction trees

   commandService

   configurations pertaining to the ledger api server's "command service"

   managementServiceTimeout

   ledger api server management service maximum duration. Duration has to be finite as the ledger api server uses java.time.duration that does not support infinite scala durations.

   postgresDataSource

   config for ledger api server when using postgres

   authServices

   type of authentication services used by ledger-api server. If empty, we use a wildcard. Otherwise, the first service response that does not say "unauthenticated" will be used.

   keepAliveServer

   keep-alive configuration for ledger api requests

   maxContractStateCacheSize

   maximum caffeine cache size of mutable state cache of contracts

   maxContractKeyStateCacheSize

   maximum caffeine cache size of mutable state cache of contract keys

   maxInboundMessageSize

   maximum inbound message size on the ledger api

   databaseConnectionTimeout

   database connection timeout

   maxTransactionsInMemoryFanOutBufferSize

   maximum number of transactions to hold in the "in-memory fanout" (if enabled)

   enableInMemoryFanOutForLedgerApi

   enable the "in-memory fan-out" performance optimization (default false; not tested for production yet)

   additionalMigrationPaths

   Optional extra paths for the database migrations

   inMemoryStateUpdaterParallelism

   The processing parallelism of the Ledger API server in-memory state updater

   inMemoryFanOutThreadPoolSize

   Size of the thread-pool backing the Ledger API in-memory fan-out. If not set, defaults to ((number of thread)/4 + 1)

   rateLimit

   limit the ledger api server request rates based on system metrics

   preparePackageMetadataTimeOutWarning

   Timeout for package metadata preparation after which a warning will be logged

   completionsPageSize

   database / akka page size for batching of ledger api server index ledger completion queries

   explicitDisclosureUnsafe

   enable usage of explicitly disclosed contracts in command submission and transaction validation. This feature is deemed unstable and unsafe. Should NOT be enabled in production!