Class GhostExchange

Ghost exchange implementation for simulated/paper trading

This exchange doesn't place real orders - instead it:

Fetches real prices from Binance public API (no auth needed)
Simulates order execution at current market prices
Returns fake order data with realistic fill information

Used for "education" trading mode (ghost trading)

Example

const ghost = new GhostExchange();
ghost.initialize({}); // No credentials needed
ghost.setVirtualBalances([{ asset: "USDT", free: "10000", locked: "0", total: "10000" }]);
const order = await ghost.marketBuy("BTCUSDT", 100, true);
// Returns simulated order at real BTC price

Hierarchy (View Summary)

Exchange
- GhostExchange

Constructors

constructor

new GhostExchange(): GhostExchange
Returns GhostExchange
Overrides Exchange.constructor
- Defined in packages/trading/src/exchanges/ghost.ts:42

Properties

`Readonly`name

name: "binance" = ...

The name of the exchange

`Readonly`testnet

testnet: false

Whether the exchange is connected to testnet

Methods

formatSymbol

formatSymbol(asset: string, quoteAsset?: string): string
Format an asset to a trading symbol
Parameters
- asset: string
  The base asset (e.g., "ETH")
- quoteAsset: string = "USDT"
  The quote asset (default: "USDT")
Returns string
Formatted symbol (e.g., "ETHUSDT")
Inherited from Exchange.formatSymbol
- Defined in packages/trading/src/exchanges/base.ts:151

parseSymbol

parseSymbol(symbol: string): { base: string; quote: string }
Parse a symbol into base and quote assets
Parameters
- symbol: string
  The trading pair symbol
Returns { base: string; quote: string }
Object with base and quote assets
Inherited from Exchange.parseSymbol
- Defined in packages/trading/src/exchanges/base.ts:160

initialize

initialize(_credentials: ExchangeCredentials): void
Initialize the ghost exchange (no-op since we don't need credentials)
Parameters
- _credentials: ExchangeCredentials
  Ignored for ghost exchange
Returns void
Overrides Exchange.initialize
- Defined in packages/trading/src/exchanges/ghost.ts:52

verifyCredentials

verifyCredentials(): Promise<boolean>
Verify credentials always returns true for ghost exchange

Returns Promise<boolean>
Always true
Overrides Exchange.verifyCredentials
- Defined in packages/trading/src/exchanges/ghost.ts:60

setVirtualBalances

setVirtualBalances(balances: ExchangeBalance[]): void
Set virtual balances for simulated trading This should be called before executing trades to provide the ghost exchange with the user's current virtual portfolio balances from the database.
Parameters
- balances: ExchangeBalance[]
  Array of virtual balances from VirtualPortfolio
Returns void
- Defined in packages/trading/src/exchanges/ghost.ts:70

clearVirtualBalances

clearVirtualBalances(): void
Clear virtual balances (useful when switching users or resetting)

Returns void
- Defined in packages/trading/src/exchanges/ghost.ts:77

getBalances

getBalances(asset?: string): Promise<ExchangeBalance[]>
Get account balances from the stored virtual balances
Parameters
- Optionalasset: string
  Optional asset to filter by
Returns Promise<ExchangeBalance[]>
Virtual balances (must be set via setVirtualBalances first)
Overrides Exchange.getBalances
- Defined in packages/trading/src/exchanges/ghost.ts:86

getPrice

getPrice(symbol: string): Promise<ExchangePrice>
Get current price for a trading pair from Binance public API
Parameters
- symbol: string
  Trading pair symbol (e.g., "BTCUSDT")
Returns Promise<ExchangePrice>
Current price information
Overrides Exchange.getPrice
- Defined in packages/trading/src/exchanges/ghost.ts:98

getSymbols

getSymbols(): Promise<string[]>
Get all available trading pairs from Binance

Returns Promise<string[]>
Array of trading pair symbols
Overrides Exchange.getSymbols
- Defined in packages/trading/src/exchanges/ghost.ts:119

getKlines

getKlines(
    symbol: string,
    interval: KlineInterval,
    limit?: number,
): Promise<Kline[]>
Get candlestick/OHLCV data for technical analysis from Binance public API
Parameters
- symbol: string
  Trading pair symbol (e.g., "BTCUSDT")
- interval: KlineInterval
  Candle interval (e.g., "1h", "4h", "1d")
- limit: number = 200
  Number of candles to fetch (default: 200)
Returns Promise<Kline[]>
Array of kline data
- Defined in packages/trading/src/exchanges/ghost.ts:131

get24hrTicker

get24hrTicker(symbol: string): Promise<Ticker24hr>
Get 24-hour ticker statistics from Binance public API
Parameters
- symbol: string
  Trading pair symbol (e.g., "BTCUSDT")
Returns Promise<Ticker24hr>
24-hour ticker statistics
- Defined in packages/trading/src/exchanges/ghost.ts:156

marketBuy

marketBuy(
    symbol: string,
    quantity: number,
    quantityIsQuote?: boolean,
): Promise<ExchangeOrder>
Simulate a market buy order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to buy
- quantityIsQuote: boolean = false
  If true, quantity is in quote currency (e.g., USDT)
Returns Promise<ExchangeOrder>
Simulated order with real price data
Overrides Exchange.marketBuy
- Defined in packages/trading/src/exchanges/ghost.ts:186

marketSell

marketSell(symbol: string, quantity: number): Promise<ExchangeOrder>
Simulate a market sell order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell in base currency
Returns Promise<ExchangeOrder>
Simulated order with real price data
Overrides Exchange.marketSell
- Defined in packages/trading/src/exchanges/ghost.ts:221

limitBuy

limitBuy(
    symbol: string,
    quantity: number,
    price: number,
): Promise<ExchangeOrder>
Simulate a limit buy order (executes immediately at limit price for simplicity)
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to buy
- price: number
  Limit price
Returns Promise<ExchangeOrder>
Simulated order
Overrides Exchange.limitBuy
- Defined in packages/trading/src/exchanges/ghost.ts:245

limitSell

limitSell(
    symbol: string,
    quantity: number,
    price: number,
): Promise<ExchangeOrder>
Simulate a limit sell order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell
- price: number
  Limit price
Returns Promise<ExchangeOrder>
Simulated order
Overrides Exchange.limitSell
- Defined in packages/trading/src/exchanges/ghost.ts:268

stopLoss

stopLoss(
    symbol: string,
    quantity: number,
    stopPrice: number,
    limitPrice?: number,
): Promise<ExchangeOrder>
Simulate a stop loss order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell
- stopPrice: number
  Stop trigger price
- OptionallimitPrice: number
  Optional limit price
Returns Promise<ExchangeOrder>
Simulated order
Overrides Exchange.stopLoss
- Defined in packages/trading/src/exchanges/ghost.ts:292

takeProfit

takeProfit(
    symbol: string,
    quantity: number,
    price: number,
    limitPrice?: number,
): Promise<ExchangeOrder>
Simulate a take profit order
Parameters
- symbol: string
  Trading pair symbol
- quantity: number
  Amount to sell
- price: number
  Take profit trigger price
- OptionallimitPrice: number
  Optional limit price
Returns Promise<ExchangeOrder>
Simulated order
Overrides Exchange.takeProfit
- Defined in packages/trading/src/exchanges/ghost.ts:318

cancelOrder

cancelOrder(_orderId: string, _symbol: string): Promise<boolean>
Cancel order (always succeeds for ghost exchange)
Parameters
- _orderId: string
  Order ID to cancel
- _symbol: string
  Trading pair symbol
Returns Promise<boolean>
Always true
Overrides Exchange.cancelOrder
- Defined in packages/trading/src/exchanges/ghost.ts:342

getOrder

getOrder(orderId: string, symbol: string): Promise<ExchangeOrder>
Get order - returns a mock filled order
Parameters
- orderId: string
  Order ID
- symbol: string
  Trading pair symbol
Returns Promise<ExchangeOrder>
Mock order data
Overrides Exchange.getOrder
- Defined in packages/trading/src/exchanges/ghost.ts:352

getOpenOrders

getOpenOrders(_symbol?: string): Promise<ExchangeOrder[]>
Get open orders - always empty for ghost exchange (orders fill instantly)
Parameters
- Optional_symbol: string
  Trading pair symbol
Returns Promise<ExchangeOrder[]>
Empty array
Overrides Exchange.getOpenOrders
- Defined in packages/trading/src/exchanges/ghost.ts:374

Class GhostExchange

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns GhostExchange

Properties

Readonlyname

Readonlytestnet

Methods

formatSymbol

Parameters

Returns string

parseSymbol

Parameters

Returns { base: string; quote: string }

initialize

Parameters

Returns void

verifyCredentials

Returns Promise<boolean>

setVirtualBalances

Parameters

Returns void

clearVirtualBalances

Returns void

getBalances

Parameters

Returns Promise<ExchangeBalance[]>

getPrice

Parameters

Returns Promise<ExchangePrice>

getSymbols

Returns Promise<string[]>

getKlines

Parameters

Returns Promise<Kline[]>

get24hrTicker

Parameters

Returns Promise<Ticker24hr>

marketBuy

Parameters

Returns Promise<ExchangeOrder>

marketSell

Parameters

Returns Promise<ExchangeOrder>

limitBuy

Parameters

Returns Promise<ExchangeOrder>

limitSell

Parameters

Returns Promise<ExchangeOrder>

stopLoss

Parameters

Returns Promise<ExchangeOrder>

takeProfit

Parameters

Returns Promise<ExchangeOrder>

cancelOrder

Parameters

Returns Promise<boolean>

getOrder

Parameters

Returns Promise<ExchangeOrder>

getOpenOrders

Parameters

Returns Promise<ExchangeOrder[]>

Settings

On This Page

`Readonly`name

`Readonly`testnet