Class default

This class is the base class for all bot states. It contains the most basic functionality that all states need.

Hierarchy

default

Constructors

constructor

new default(trade, systemConfig, database, order): default
Initialize the bot state. This is the base class for all bot states, and run on every tick, whenever a State is created.
Parameters
- trade: any
  
  Trade information represented as a JSON object
- systemConfig: any
  
  System configuration
- database: default
  
  Database object
- order: Order
  
  Order object
Returns default
- Defined in fsm/BotState.ts:74

Properties

config

config: any

Same as "System configuration (systemConfig)"

database

database: default

Database object. Used to store and retrieve trade information.

notifications

notifications: default

Notifications object. Used to send notifications to Telegram, Slack, Discord, etc.

order

order: Order

Order object. Used to place and cancel orders.

systemConfig

systemConfig: any

Contains the concatinated configuration from the config.yml and strategy.yml files

taapi

taapi: default

Taapi object. Used to retrieve indicators and other information from the Taapi API.

trade

trade: any

Trade information represented as a JSON object

utilities

utilities: default

Utilities object. Used to perform various utility functions.

Methods

addCalculation

addCalculation(indicator, interval, id, params, symbol?): void
Adds a calculation to the bulk construct. As standard, you may add 20 calculations to a construct, but if your plan supports multiple constructs, you can fetch data accross multiple assets pairs / timeframes in one request.

See
- https://taapi.io/documentation/integration/direct/
- https://taapi.io/documentation/multiple-constructs/
Example
```
this.addCalculation("rsi", "BTC/USDT", "1h", "rsi_1h"); // Construct 1
this.addCalculation("ema", "BTC/USDT", "1h", "ema_1h", { period: 20 }); // Construct 1
this.addCalculation("macd", "BTC/USDT", "4h", "macd_4h"); // Construct 2
this.addCalculation("ema", "ETH/USDT", "1d", "ema_1d", { period: 200 }, "bybit"); // Construct 3 + Override default exchange
```
Parameters
- indicator: string
  
  Name of the indicator to calculate. See https://taapi.io/indicators/ for a list of indicators.
- interval: string
  
  Timeframe to calculate the indicator on. A list of available timeframes can be found at https://taapi.io/exchanges/ for your exchange.
- id: string
  
  Your own unique ID for this calculation. This is used to retrieve the result later.
- params: object
  
  Parameters to pass to the indicator. Please see the above link for the indicator you're using to see what parameters are available.
- symbol: string = ...
  
  Defaults to the symbol of the current trade, but can be overridden, say if you're trading an altcoin but want to compare it to BTC.
Returns void
- Defined in fsm/BotState.ts:794

addExecuteBulkLog

addExecuteBulkLog(ta): Promise<void>
Adds a trade log of type TAAPI_EXECUTE_BULK to the trade.
Parameters
- ta: {}
  
  The TAAPI.IO response to store
Returns Promise<void>
- Defined in fsm/BotState.ts:816

addTradeLog

addTradeLog(title, type, data?): Promise<void>
Adds a log entry to the trade.
Parameters
- title: string
  
  Title of the log entry
- type: TradeLogType
  
  Type of the log entry
- data: any = {}
  
  Data to store with the log entry, defaults to an empty object
Returns Promise<void>
- Defined in fsm/BotState.ts:806

archiveTrade

archiveTrade(): Promise<void>
Helper function which first records the trade to the historical trades collection, then deletes it from the active trades collection.

If live trading is enabled, this function will check if in a position.

Todo
Finish up this function with live trading enabled.

Returns Promise<void>
- Defined in fsm/BotState.ts:564

calculateProfit

calculateProfit(direction?, trade?): number
Calculates the profit of a trade in percent.
Parameters
- direction: string = "long"
  
  'long' or 'short', defaults to 'long'
- trade: any = null
  
  The trade object to calculate the profit for, defaults to the current trade
Returns number
- Defined in fsm/BotState.ts:712

calculateStoplossPercent

calculateStoplossPercent(stoplossPrice, currentPrice): number
Helper function for utilities.calculateStoplossPercent()
Parameters
- stoplossPrice: number
  
  The stoploss price
- currentPrice: number
  
  The current price
Returns number
- Defined in fsm/BotState.ts:747

calculateTargetPercent

calculateTargetPercent(targetPrice, currentPrice): number
Helper function for utilities.calculateTargetPercent()
Parameters
- targetPrice: number
  
  The target price
- currentPrice: number
  
  The current price
Returns number
- Defined in fsm/BotState.ts:736

chainTrade

chainTrade(startState?): Promise<any>
Archives the trade, then creates a new trade with the same exchangeId, symbol and interval.

The start state can be overridden by passing a state name to the startState parameter.
Parameters
- startState: string = "start"
Returns Promise<any>
- Defined in fsm/BotState.ts:606

changeState

changeState(newState, addLog?, message?): Promise<void>
Changes the state of the trade.
Parameters
- newState: string
  
  The new state to change to. Must be a valid state matching the filename of a state class, ie. State_state-name.js
- addLog: boolean = true
  
  Whether or not to add a log entry for this state change
- message: string = ""
  
  Optional message to include in the log entry
Returns Promise<void>
- Defined in fsm/BotState.ts:499

deleteMe

deleteMe(): Promise<void>
Helper function for the database.deleteTrade() function

Returns Promise<void>
- Defined in fsm/BotState.ts:550

enterPosition

enterPosition(side, currentPrice, exitPrice?, stopPrice?): Promise<any>
Enters a position on the exchange. The order type, slippage, leverage and time in force are all configurable in the config file.

If live trading is disabled, a trade simulation will be performed instead, simply assuming the order was filled at the current price, and all other orders placed succecssfully.
Parameters
- side: string
  
  'LONG', 'SHORT', 'BUY' or 'SELL' in any case
- currentPrice: number
  
  The current price of the asset
- exitPrice: number = 0
  
  The price to exit the position at
- stopPrice: number = 0
  
  The stoploss price
Returns Promise<any>
- Defined in fsm/BotState.ts:651

executeBulk

executeBulk(storeResults?): Promise<any>
Fetches the TAAPI.IO data for the calculations added to the bulk construct.
Parameters
- storeResults: boolean = false
  
  Whether or not to store the results in the database. Good for debugging, but can result in a lot of data being stored.
Returns Promise<any>
- Defined in fsm/BotState.ts:826

exitPosition

exitPosition(): Promise<any>
Exits the position on the exchange.

If live trading is disabled, a trade simulation will be performed instead, simply assuming the order was filled at the current price, and all other orders placed succecssfully.

Returns Promise<any>
- Defined in fsm/BotState.ts:690

getAllocationStats

getAllocationStats(): Promise<any>
Fetches the current allocation stats from the database.

Returns Promise<any>
- Defined in fsm/BotState.ts:487

isEntryHit

isEntryHit(candles): boolean
Checks if the entry price has been hit.

If live trading is enabled, it will check if the ENTRY order has been FILLED. Otherwise, it will check if the entry price has been hit using the provided candles.
Parameters
- candles: Candle[]
  
  Array of candles in descending order (aka newest first)
Returns boolean
- Defined in fsm/BotState.ts:284

isStoplossHit

isStoplossHit(candles, ignoreCandlesCount?): boolean
Checks if the stoploss price has been hit.

If live trading is enabled, it will check if the STOPLOSS order has been FILLED. Otherwise, it will check if the stoploss price has been hit using the provided candles.
Parameters
- candles: Candle[]
  
  Array of candles in descending order (aka newest first)
- ignoreCandlesCount: number = 0
  
  Number of candles to ignore from the beginning of the candles array. Sometimes useful with HFT simulations.
Returns boolean
- Defined in fsm/BotState.ts:410

isTargetHit

isTargetHit(candles): boolean
Checks if the target price has been hit.

If live trading is enabled, it will check if the TAKE_PROFIT order has been FILLED. Otherwise, it will check if the target price has been hit using the provided candles.
Parameters
- candles: Candle[]
  
  Array of candles in descending order (aka newest first)
Returns boolean
- Defined in fsm/BotState.ts:336

persistTradeData

persistTradeData(): Promise<void>
Persists the trade data to the database.

Returns Promise<void>
- Defined in fsm/BotState.ts:532

recordHistoricalTrade

recordHistoricalTrade(): Promise<void>
Helper function for the database.recordHistoricalTrade() function

Returns Promise<void>
- Defined in fsm/BotState.ts:541

resetBulkConstructs

resetBulkConstructs(): void
Helper function for the taapi.resetBulkConstructs() function.

Returns void
- Defined in fsm/BotState.ts:766

setEntryDetails

setEntryDetails(price, targetPrice, stoplossPrice, direction?): Promise<void>
Sets the entry details for the trade.

Deprecated
- Replaced by enterPosition() and exitPosition()
Parameters
- price: number
  
  Entry price
- targetPrice: number
  
  Target price
- stoplossPrice: number
  
  Stoploss price
- direction: string = "auto"
  
  Direction of the trade (long or short, default: auto)
Returns Promise<void>
- Defined in fsm/BotState.ts:174

setExitDetails

setExitDetails(price, reason): Promise<void>
Sets the exit details for the trade.

Deprecated
- Replaced by enterPosition() and exitPosition()
Parameters
- price: number
  
  Exit price
- reason: string
  
  Exit reason
Returns Promise<void>
- Defined in fsm/BotState.ts:220

setStoploss

setStoploss(price, persist?): Promise<void>
Sets the stoploss price for the trade.
Parameters
- price: number
- persist: boolean = true
Returns Promise<void>
- Defined in fsm/BotState.ts:237

updateTrade

updateTrade(data): Promise<void>
Updates the trade with the provided data.
Parameters
- data: {}
  
  Data to update the trade with
Returns Promise<void>
- Defined in fsm/BotState.ts:523

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

trade: any

systemConfig: any

database: default

order: Order

Returns default

Properties

config

database

notifications

order

systemConfig

taapi

trade

utilities

Methods

addCalculation

See

Example

Parameters

indicator: string

interval: string

id: string

params: object

symbol: string = ...

Returns void

addExecuteBulkLog

Parameters

ta: {}

Returns Promise<void>

addTradeLog

Parameters

title: string

type: TradeLogType

data: any = {}

Returns Promise<void>

archiveTrade

Todo

Returns Promise<void>

calculateProfit

Parameters

direction: string = "long"

trade: any = null

Returns number

calculateStoplossPercent

Parameters

stoplossPrice: number

currentPrice: number

Returns number

calculateTargetPercent

Parameters

targetPrice: number

currentPrice: number

Returns number

chainTrade

Parameters

startState: string = "start"

Returns Promise<any>

changeState

Parameters

newState: string

addLog: boolean = true

message: string = ""

Returns Promise<void>

deleteMe

Returns Promise<void>

enterPosition

Parameters

side: string

currentPrice: number

exitPrice: number = 0

stopPrice: number = 0