@statechannels/server-wallet

server-wallet package

Classes

ClassDescription
DBAdminA collection of static utility methods for db admin
EngineA single- or multi-threaded Nitro Engine
MultiThreadedEngineA multi-threaded Nitro engine
SingleThreadedEngineA single-threaded Nitro engine
Wallet

Functions

FunctionDescription
defaultTestEngineConfig(partialConfig)
defaultTestWalletConfig(partialConfig)
extractDBConfigFromWalletConfig(walletConfig)
getDatabaseConnectionConfig(config)
hasNewObjective(response)
isMultipleChannelOutput(output)
overwriteConfigWithDatabaseConnection(config, databaseConnectionConfig)
validateEngineConfig(config)

Interfaces

InterfaceDescription
EngineInterface
OptionalWalletConfigAdditional configuration options for the wallet that are not required.
WalletEvents

Variables

VariableDescription
DEFAULT_DB_NAME
DEFAULT_DB_USER
defaultChainServiceConfiguration
defaultConfigThese are the default values that will be used by the server wallet if not overidden in the provided config
defaultDatabaseConfiguration
defaultLoggingConfigurationLogging and Metrics config
defaultMetricsConfiguration
defaultSyncConfiguration
defaultTestNetworkConfiguration

Type Aliases

Type AliasDescription
ChainServiceConfigurationChain service configuration options
CreateLedgerChannelParams
DatabaseConfigurationThe fully defined database configuration
DatabaseConnectionConfigurationEither a connection string or a config object with the dbName specified
DatabasePoolConfigurationDatabase pool size options
DeepPartial
EngineConfig
IncomingWalletConfigThis is the config accepted by the engine create method. It is the required config properties plus additional optional properties
InternalErrorThis is the catch-all error that will be returned if some error is thrown and not handled.
LoggingConfigurationLogging configuration options
MetricsConfigurationMetrics configuration options
MultipleChannelOutput
NetworkConfigurationVarious network configuration options
ObjectiveDoneResult
ObjectiveError
ObjectiveResultThis is what is returned for any objective related API call
ObjectiveSuccessThe objective suceeded.
ObjectiveTimedOutErrorThe objective timed out without being completed.
OptionalConnectionConfigurationOptional database config properties.
OptionalDatabaseConfiguration
Outgoing
Output
RequiredConnectionConfigurationEither a database connection string or a config object specifying the database name
RequiredDatabaseConfigurationThe minimum required database configuration that must be provided
RequiredWalletConfigThe minimum required configuration to use the wallet.
SingleChannelOutput
SyncConfiguration
UpdateChannelErrorThis is returned when an unhandled error occurs when trying to update a channel
UpdateChannelResult
UpdateChannelSuccessThis is returned when a channel is sucessfully updated
WalletConfigThis is a fully filled out config. All Required and Optional fields are defined.