Exchange_Gateway_Integration_EGI_.md

graph LR
    ExchangePyBase["ExchangePyBase"]
    PerpetualDerivativePyBase["PerpetualDerivativePyBase"]
    GatewayBase["GatewayBase"]
    GatewayHttpClient["GatewayHttpClient"]
    WebAssistantsFactory["WebAssistantsFactory"]
    RESTAssistant["RESTAssistant"]
    WSAssistant["WSAssistant"]
    AsyncThrottler["AsyncThrottler"]
    AuthBase["AuthBase"]
    TimeSynchronizer["TimeSynchronizer"]
    NetworkBase["NetworkBase"]
    ExchangePyBase -- "inherits from" --> NetworkBase
    ExchangePyBase -- "utilizes" --> WebAssistantsFactory
    PerpetualDerivativePyBase -- "inherits from" --> ExchangePyBase
    PerpetualDerivativePyBase -- "utilizes" --> WebAssistantsFactory
    ExchangePyBase -- "utilizes" --> AsyncThrottler
    PerpetualDerivativePyBase -- "utilizes" --> AsyncThrottler
    ExchangePyBase -- "utilizes" --> AuthBase
    PerpetualDerivativePyBase -- "utilizes" --> AuthBase
    ExchangePyBase -- "utilizes" --> TimeSynchronizer
    PerpetualDerivativePyBase -- "utilizes" --> TimeSynchronizer
    GatewayBase -- "utilizes" --> GatewayHttpClient
    WebAssistantsFactory -- "creates instances of" --> RESTAssistant
    WebAssistantsFactory -- "creates instances of" --> WSAssistant
    RESTAssistant -- "depends on" --> AuthBase
    WSAssistant -- "depends on" --> AuthBase
    RESTAssistant -- "depends on" --> AsyncThrottler

Loading

Details

One paragraph explaining the functionality which is represented by this graph. What the main flow is and what is its purpose.

ExchangePyBase

Serves as the abstract base class for all centralized exchange (CEX) spot connectors. It defines the common interface and fundamental functionalities that every spot exchange connector must implement, such as order placement, cancellation, balance tracking, and market data handling.

Related Classes/Methods:

• hummingbot.connector.exchange_py_base.ExchangePyBase (39:1096)

PerpetualDerivativePyBase

Serves as the abstract base class for all perpetual derivative exchange connectors. It extends ExchangePyBase and defines functionalities specific to perpetual markets, including position management, funding rates, and leverage.

Related Classes/Methods:

• hummingbot.connector.perpetual_derivative_py_base.PerpetualDerivativePyBase (27:437)

GatewayBase

Serves as the abstract base class for all decentralized exchange (DEX) and gateway connectors. It defines the interface for interacting with the Hummingbot Gateway, which mediates communication with various blockchain networks and DEX protocols.

Related Classes/Methods:

• hummingbot.connector.gateway.gateway_base.GatewayBase (31:569)

GatewayHttpClient

Handles HTTP communication with the Hummingbot Gateway. It is responsible for sending requests to the Gateway and receiving responses, forming the direct communication layer for DEX interactions.

Related Classes/Methods:

• hummingbot.core.gateway.gateway_http_client.GatewayHttpClient (44:781)

WebAssistantsFactory

A factory class responsible for creating and managing instances of RESTAssistant and WSAssistant. It ensures that web communication components are properly initialized and configured for each connector.

Related Classes/Methods:

• hummingbot.core.web_assistant.web_assistants_factory.WebAssistantsFactory (13:80)

RESTAssistant

Provides a standardized way to make REST API calls to exchanges. It encapsulates logic for request signing, error handling, and response parsing for RESTful interactions.

Related Classes/Methods:

• hummingbot.core.web_assistant.rest_assistant.RESTAssistant (13:124)

WSAssistant

Provides a standardized way to manage WebSocket connections with exchanges for real-time market data and user stream updates. It handles connection establishment, message sending/receiving, and error handling for WebSocket interactions.

Related Classes/Methods:

• hummingbot.core.web_assistant.ws_assistant.WSAssistant (10:95)

AsyncThrottler

Manages and enforces API rate limits for all outgoing requests to exchanges. It prevents the bot from exceeding exchange-specific request limits, which could lead to temporary bans or degraded performance.

Related Classes/Methods:

• hummingbot.core.api_throttler.async_throttler.AsyncThrottler (53:80)

AuthBase

An abstract base class defining the interface for authentication mechanisms. Concrete authentication classes for each exchange (e.g., BinanceAuth) inherit from this.

Related Classes/Methods:

• hummingbot.core.web_assistant.auth.AuthBase (5:19)

TimeSynchronizer

Synchronizes the bot's local time with the exchange's server time. This is critical for many exchange APIs that require requests to be timestamped accurately to prevent replay attacks and ensure order validity.

Related Classes/Methods:

• hummingbot.connector.time_synchronizer.TimeSynchronizer (11:95)

NetworkBase

Provides a foundational base for network-related functionalities, likely including common methods for managing network state and interactions.

Related Classes/Methods:

• hummingbot.core.network_base.NetworkBase (12:118)

FAQ