config.json

Overview

The `config.json` file is a configuration file used to define runtime parameters and operational settings for a Polygon (MATIC) blockchain node or related service component. It primarily configures how the system interacts with external data sources (e.g., fiat currency exchange rates), blockchain RPC endpoints, mempool transaction handling, and coin metadata.

This file does **not** contain executable code but serves as a structured JSON-based configuration that other system components consume at startup or runtime to tailor behavior according to the specified parameters.

Detailed Explanation of Configuration Fields

Usage Example

This file is usually loaded by the blockchain node service or a related component at startup. Here is a pseudocode example of how this configuration might be used in a Node.js service:

const fs = require('fs');

const config = JSON.parse(fs.readFileSync('config.json', 'utf-8'));

// Connect to RPC endpoint
const rpcClient = new RpcClient({
  url: config.rpc_url,
  user: config.rpc_user,
  pass: config.rpc_pass,
  timeout: config.rpc_timeout,
});

// Setup fiat rates polling
const fiatParams = JSON.parse(config.fiat_rates_params);
const fiatRatesProvider = new FiatRatesProvider(config.fiat_rates, fiatParams, config.fiat_rates_vs_currencies);

// Initialize mempool workers
const mempoolManager = new MempoolManager(config.mempool_workers, config.mempool_sub_workers, config.mempoolTxTimeoutHours);

// Other logic...

Important Implementation Details

• Fiat Rates Integration:
  The fiat_rates_params field is a serialized JSON string that must be parsed before use. It contains critical details such as the API URL, coin identifier, platform, and polling interval in seconds (periodSeconds). The system uses these to query fiat exchange rates periodically, updating internal rate caches for currency conversions.

• Mempool Transaction Handling:

  • Mempool timeout (mempoolTxTimeoutHours) defines how long pending transactions remain valid in the mempool before being dropped or flagged for resync.

  • Workers (mempool_workers) and sub-workers (mempool_sub_workers) allow parallel processing of mempool transactions, improving throughput and responsiveness.

  • The option to query the backend database on mempool resync (queryBackendOnMempoolResync) helps maintain data consistency but is disabled by default for performance.

• RPC Configuration:
  The RPC URL supports WebSocket (ws://) connections, facilitating real-time event subscriptions or notifications. Authentication fields (rpc_user, rpc_pass) are optional and left empty here, suggesting either no authentication or environment-based overrides.

• Parsing Flag:
  The parse boolean toggles whether incoming blockchain data should be parsed immediately or handled in raw form. This can affect performance and data handling strategies.

Interaction With Other System Components

• Blockchain Node / RPC Client:
  The rpc_url, rpc_user, rpc_pass, and rpc_timeout fields are consumed by the blockchain RPC client module to establish and maintain communication with the Polygon node.

• Fiat Rates Module:
  The fiat rates configuration parameters are used by the fiat currency rate fetcher module (likely interacting with the CoinGecko API) to obtain live exchange rates for MATIC against a wide range of fiat and crypto currencies.

• Mempool Manager:
  The mempool-related fields configure how the mempool manager handles transactions, including concurrency settings and timeout policies.

• Message Queue / Event Bus:
  The message_queue_binding field indicates potential integration with a messaging system for event-driven processing or notifications, though it is empty here.

• UI / Display Layer:
  Coin metadata fields like coin_name, coin_shortcut, and coin_label are useful for user interfaces or reporting components that display coin information.

Visual Diagram: Configuration Structure Flowchart

flowchart TD
    A[config.json] --> B[Fiat Rates Config]
    A --> C[Mempool Config]
    A --> D[RPC Config]
    A --> E[Coin Metadata]
    A --> F[Misc Settings]

    B --> B1["fiat_rates"]
    B --> B2["fiat_rates_params"]
    B --> B3["fiat_rates_vs_currencies"]

    C --> C1["mempoolTxTimeoutHours"]
    C --> C2["queryBackendOnMempoolResync"]
    C --> C3["mempool_workers"]
    C --> C4["mempool_sub_workers"]
    C --> C5["block_addresses_to_keep"]

    D --> D1["rpc_url"]
    D --> D2["rpc_user"]
    D --> D3["rpc_pass"]
    D --> D4["rpc_timeout"]

    E --> E1["coin_name"]
    E --> E2["coin_shortcut"]
    E --> E3["coin_label"]

    F --> F1["parse"]
    F --> F2["message_queue_binding"]
    F --> F3["subversion"]
    F --> F4["address_format"]

Summary

The `config.json` file serves as a centralized configuration hub for the Polygon blockchain node or service, defining essential parameters for fiat rate fetching, RPC connectivity, mempool transaction management, and coin metadata. Proper configuration ensures smooth operation, efficient data processing, and accurate currency conversions within the system. It interacts closely with network communication modules, data parsers, and external APIs, enabling a modular and scalable blockchain infrastructure.