Define and apply strategy overrides with an AutoConfig job

A core strength of Gunbot's AutoConfig feature is its ability to dynamically manage strategy parameters for your trading pairs. This is primarily achieved through the overrides object within AutoConfig job definitions, particularly for job types like manageOverrides (to modify existing pairs) and addPairs (to set initial parameters for new pairs). This allows for adaptive and context-aware trading strategies.

Use the AutoConfig wizard

Nearly every option that follows can be set without editing files by hand.
Click the ⋮ (three-dots) menu ➜ AutoConfig, step through the wizard, and press Save; it will write a correct autoconfig.json for you.

The Purpose of the overrides Object

In Gunbot, each trading pair is assigned a base strategy (e.g., "spotgrid"). This base strategy has default parameter values. However, you can customize the behavior for each specific pair by providing "overrides" – specific parameter values that take precedence over the base strategy's defaults for that pair only.

The overrides object in an AutoConfig job definition allows you to automate the process of setting or changing these pair-specific overrides.

• For manageOverrides job type: If a pair passes the job's filters, the parameters defined in the overrides object are applied to that existing pair's configuration in config.js. This can modify its current behavior.
• For addPairs job type: When a new pair is discovered and passes filters, it's added to config.js with the job's specified base strategy. The parameters in the overrides object are then immediately applied as initial custom settings for that new pair.

Configuring the overrides Object

The overrides object is a simple collection of key-value pairs, where each key is the name of a valid Gunbot strategy parameter (case-sensitive, matching those in config.js or strategy definitions) and the value is what you want to set it to.

Example with manageOverrides:

{
  "adaptiveRiskManager": {
    "enabled": true,
    "type": "manageOverrides2",
    "schedule": "*/15 * * * *",
    "pairs": {
      "exchange": "binance",
      "include": "USDT-"
    },
    "filters": {
      "highVolatilityDetected": { // Some filter to detect high volatility
        "filterType": "minVolatilityPct24h",
        "minVolatility": 5.0
      }
    },
    "overrides": { // User setting: Apply these if volatility is high
      "STOP_LIMIT": 2, // Example: Set a stop limit
      "BUY_ENABLED": false, // Temporarily disable new buys
      "SELL_ENABLED": true // Example: Ensure selling is enabled
    },
    "clearOverrides": false // Optional: if true, would wipe existing overrides first
  }
}

In adaptiveRiskManager:

• If a USDT pair on Binance has 24-hour volatility above 5.0%, the parameters STOP_LIMIT: 2.0, BUY_ENABLED: false, and SELL_ENABLED: true will be written to that specific pair's override section in config.js.

Example with addPairs:

{
  "cautiousPairAdder": {
    "enabled": true,
    "type": "addPairs",
    "schedule": "0 0 * * *",
    "strategy": "stepgrid", // Base strategy for new pairs
    "pairs": { /* ... */ },
    "filters": { /* ... */ },
    "overrides": { // User setting: Initial overrides for newly added pairs
      "STOP_LIMIT": 0.25, // Example: Start with a specific stop limit
      "GAIN": 1.0,
      "BUY_ENABLED": true // Example: Ensure buying is enabled
    }
  }
}

In cautiousPairAdder:

• Newly added pairs will get the stepgrid strategy, and immediately have their STOP_LIMIT set to 0.25, GAIN to 1.0, and BUY_ENABLED set to true.

Dynamic Override Values with JavaScript

A powerful feature is that the values within the overrides object can be strings that AutoConfig evaluates as JavaScript expressions at runtime. To trigger this evaluation, the string value must start with a space. This allows access to context variables like this.pair, this.variables, this.tickers, etc.

"overrides": {
  "GAIN": " this.variables.globalRiskFactor * 1.5 " // Example: Set GAIN based on a global variable
}

• " this.variables.globalRiskFactor * 1.5 ": Adjusts GAIN based on a global variable.

Key Considerations

1. Parameter Names: Ensure the keys in your overrides object are valid Gunbot strategy parameter names and are cased correctly.
2. clearOverrides Option: In manageOverrides jobs, the clearOverrides (boolean) parameter determines behavior:
   • false (default): The specified overrides are merged with any existing overrides for the pair. New values overwrite old ones for the same keys.
   • true: All existing overrides for the pair are wiped clean before the new overrides from this job are applied. Use with caution.
3. Data Types: Values for overrides should match the expected data type of the strategy parameter (number, boolean, string). If using dynamic JavaScript evaluation, ensure the expression results in the correct type.
4. Interaction with Base Strategy: Overrides modify the behavior of the pair's assigned base strategy. They don't replace the strategy itself.
5. Debugging: If overrides are not applying as expected, check Gunbot logs for errors. Enable debug: true in the AutoConfig job to see more detailed filter processing information. Verify parameter names and dynamic script logic carefully.

The overrides object is a cornerstone of AutoConfig's adaptability, allowing you to fine-tune strategy behavior for individual pairs or groups of pairs based on a wide range of conditions, making your Gunbot truly responsive to market dynamics and your evolving trading rules.