Skip to main content

Configuration Reference

This guide details the configuration parameters for the Log Store Node. The configuration file is essential for setting up your Node's operation, defining its mode, client details, HTTP server setup, and plugins.

Configuration Propertiesโ€‹

Object.PropertyDescriptionDefault Behavior
clientClient authentication method. This wallet will be used for executing subscriptions and publishing messages.Required
client.auth.privateKeyPrivate key for authentication, in string format.
client.auth.ethereumEthereum object for Web3 provider-based authentication.
pluginsDefines additional plugin configurations. See below its specific table for it.
modeSpecific configuration for each mode
httpServer.portPort number for the HTTP server.7171
httpServer.sslCertificate.certFileNamePath to the certificate file for SSL.
httpServer.sslCertificate.privateKeyFileNamePath to the private key file for SSL.

Mode-Specific Configurationโ€‹

The Node's functionality is influenced by its operating mode. The following tables describe specific configurations for Standalone and Network modes.

Standalone Mode Configurationโ€‹

Object.PropertyDescription
mode.typeSet to 'standalone' for Standalone Mode.
mode.trackedStreamsArray of objects defining streams to track and the number of partitions they have.
mode.topicsStreamStream ID for validation results from predefined processes.
mode.validationErrorsStreamStream ID for schema validation errors.

Network Mode Configurationโ€‹

Object.PropertyDescriptionDefault Behavior
mode.typeSet to 'network' for integration into the decentralized Log Store Network.
plugins.logStore.logStoreConfig.refreshIntervalInterval in milliseconds to refresh set of data streams to store from Smart Contracts. Set to 0 to disable.600000 (10 minutes)
plugins.logStore.programs.chainRpcUrls(Deprecated) Mapping of ChainId to its corresponding RPC URL for "programs" usage{"137": "https://polygon-rpc.com"}

Database Configurationโ€‹

The following properties are applied to the plugins.logStore object of the configuration. eg. plugins.logStore.db.type.

SQLiteโ€‹

Object.PropertyDescriptionDefault Behavior
db.typeType of database to use. Options are 'sqlite'.sqlite
db.dataPathPath to SQLite database file, absolute or relative to cwd..data/logstore-data.db

CassandraDBโ€‹

Object.PropertyDescriptionDefault Behavior
db.typeType of database to use. Options are 'cassandra'.
db.hostsArray of hostnames for the Apache Cassandra cluster.
db.usernameUsername for Apache Cassandra authentication.
db.passwordPassword for Apache Cassandra authentication.
db.keyspaceKeyspace name in Apache Cassandra.
db.datacenterName of the datacenter in Apache Cassandra.
cluster.clusterAddressAddress of the LogStore node cluster.
cluster.clusterSizeTotal number of nodes in the LogStore cluster.1
cluster.myIndexInClusterIndex of the current node within the LogStore cluster.0

Learn more by reviewing the JSON schema for the Plugin Configuraton.

Examplesโ€‹

For more information on usage, check out our set of configuration examples available on the repository.