NQS SDK

• Getting Started
  • Prerequisites
  • Installation
    • Environment Configuration
    • Verify Installation
  • Quick Start
    • Basic Use Case
    • Getting Involved
  • Known issues and roadmap
    • Useful environment variables
• Core Concepts
  • Architecture Components
  • Simulations
  • Protocol Factory
  • Agents
  • Agent Action
  • Data Flow
  • Generator
    • Historical Generator
    • Random Generator
  • Observer
  • Protocol
  • Spots
  • State
  • Transaction
• Build
• API Reference
  • nqs_sdk package
    • Subpackages
      • nqs_sdk.bindings package
      • nqs_sdk.coding_envs package
      • nqs_sdk.core package
      • nqs_sdk.interfaces package
      • nqs_sdk.protocols package
      • nqs_sdk.state package
      • nqs_sdk.utils package
    • Submodules
      • nqs_sdk.nqs_sdk module
      • nqs_sdk.tools module
      • nqs_sdk.version module
    • Module contents
      • Simulation
      • BlockNumberOrTimestamp
      • LPTokenUniv3
      • MetricName
      • Metrics
      • MutBuilderSharedState
      • MutSharedState
      • ObservableDescription
      • Parameters
      • ProtocolFactoryAdapter
      • RefSharedState
      • SealedParameters
      • SimulationClock
      • SimulationTime
      • Simulator
      • SimulatorBuilder
      • TokenMetadata
      • TxRequest
      • Wallet
  • Protocols metrics
    • Uniswap V3
      • Metrics
      • Components
  • Config file schema
    • Overall Structure
    • Common Configuration
      • Common Configuration Parameters
    • UniswapV3 Protocol Configuration
      • Pool Configuration
    • UniswapV3 Actions
      • Python Actions
      • Raw Actions
    • Spot Configuration
      • Spot Process Types
    • Conditions and Expressions
    • Comprehensive JSON schemas
  • Micro-Language Expression Guide
    • Overview
    • Usage in Configuration Files
      • Examples from Configuration Files
    • Basic Syntax
      • Metrics Structure
    • Expression Types
      • Numerical Expressions
      • Boolean Expressions
    • Aggregation Operations
    • Built-in Functions
    • Custom Functions
    • Practical Examples
      • Basic Conditions
      • Time-Based Analysis
      • Combined Conditions
      • Complex Calculations
      • Real-World Use Cases
    • Troubleshooting
      • Common Errors
      • Best Practices
  • Environment variables