On this page
Class: ClientConfiguration
Defined in: @nimiq/core/types/wasm/web.d.ts:961
Use this to provide initialization-time configuration to the Client. This is a simplified version of the configuration that is used for regular nodes, since not all configuration knobs are available when running inside a browser.
Constructors
new ClientConfiguration()
new ClientConfiguration():
ClientConfiguration
Defined in: @nimiq/core/types/wasm/web.d.ts:968
Creates a default client configuration that can be used to change the client's configuration.
Use its instantiateClient() method to launch the client and connect to the network.
Returns
Methods
build()
build():
PlainClientConfiguration
Defined in: @nimiq/core/types/wasm/web.d.ts:1017
Returns a plain configuration object to be passed to Client.create.
Returns
desiredPeerCount()
desiredPeerCount(
desired_peer_count):void
Defined in: @nimiq/core/types/wasm/web.d.ts:998
Sets the desired number of peers the client should try to connect to. Default is 12.
Parameters
desired_peer_count
number
Returns
void
free()
free():
void
Defined in: @nimiq/core/types/wasm/web.d.ts:962
Returns
void
logLevel()
logLevel(
log_level):void
Defined in: @nimiq/core/types/wasm/web.d.ts:988
Sets the log level that is used when logging to the console.
Possible values are 'trace' | 'debug' | 'info' | 'warn' | 'error'. Default is 'info'.
Parameters
log_level
string
Returns
void
network()
network(
network):void
Defined in: @nimiq/core/types/wasm/web.d.ts:975
Sets the network ID the client should use. Input is case-insensitive.
Possible values are 'MainAlbatross' | 'TestAlbatross' | 'DevAlbatross'. Default is 'MainAlbatross'.
Parameters
network
string
Returns
void
onlySecureWsConnections()
onlySecureWsConnections(
only_secure_ws_connections):void
Defined in: @nimiq/core/types/wasm/web.d.ts:993
Sets whether the client should only connect to secure WebSocket connections. Default is true.
Parameters
only_secure_ws_connections
boolean
Returns
void
peerCountMax()
peerCountMax(
peer_count_max):void
Defined in: @nimiq/core/types/wasm/web.d.ts:1003
Sets the maximum number of peers the client should connect to. Default is 50.
Parameters
peer_count_max
number
Returns
void
peerCountPerIpMax()
peerCountPerIpMax(
peer_count_per_ip_max):void
Defined in: @nimiq/core/types/wasm/web.d.ts:1008
Sets the maximum number of peers the client should connect to per IP address. Default is 10.
Parameters
peer_count_per_ip_max
number
Returns
void
peerCountPerSubnetMax()
peerCountPerSubnetMax(
peer_count_per_subnet_max):void
Defined in: @nimiq/core/types/wasm/web.d.ts:1013
Sets the maximum number of peers the client should connect to per subnet. Default is 10.
Parameters
peer_count_per_subnet_max
number
Returns
void
seedNodes()
seedNodes(
seeds):void
Defined in: @nimiq/core/types/wasm/web.d.ts:981
Sets the list of seed nodes that are used to connect to the Nimiq Albatross network.
Each array entry must be a proper Multiaddr format string.
Parameters
seeds
any[]
Returns
void