Interface: IClientOptions
Options for the client builder
Table of contents
Properties
- primaryNode
- primaryPowNode
- nodes
- permanodes
- ignoreNodeHealth
- nodeSyncInterval
- quorum
- minQuorumSize
- quorumThreshold
- networkInfo
- brokerOptions
- apiTimeout
- remotePowTimeout
- powWorkerCount
- localPow
- maxParallelApiRequests
Properties
primaryNode
• Optional
primaryNode: string
| INode
Node which will be tried first for all requests
primaryPowNode
• Optional
primaryPowNode: string
| INode
Node which will be tried first when using remote PoW, even before the primary_node
nodes
• Optional
nodes: (string
| INode
)[]
A list of nodes.
permanodes
• Optional
permanodes: (string
| INode
)[]
A list of permanodes.
ignoreNodeHealth
• Optional
ignoreNodeHealth: boolean
If the node health status should be ignored
nodeSyncInterval
• Optional
nodeSyncInterval: IDuration
Interval in which nodes will be checked for their sync status and the NetworkInfo gets updated
quorum
• Optional
quorum: boolean
If node quorum is enabled. Will compare the responses from multiple nodes and only returns the response if quorum_threshold of the nodes return the same one
minQuorumSize
• Optional
minQuorumSize: number
Minimum amount of nodes required for request when quorum is enabled
quorumThreshold
• Optional
quorumThreshold: number
% of nodes that have to return the same response so it gets accepted
networkInfo
• Optional
networkInfo: INetworkInfo
Data related to the used network
brokerOptions
• Optional
brokerOptions: IMqttBrokerOptions
Options for the MQTT broker
apiTimeout
• Optional
apiTimeout: IDuration
Timeout for API requests
remotePowTimeout
• Optional
remotePowTimeout: IDuration
Timeout when sending a block that requires remote proof of work
powWorkerCount
• Optional
powWorkerCount: number
The amount of threads to be used for proof of work
localPow
• Optional
localPow: boolean
Whether the PoW should be done locally or remotely.
maxParallelApiRequests
• Optional
maxParallelApiRequests: number
The maximum parallel API requests.