alex

type Account interface {
	AccountDescription
	AccountEngine
	AccountSmart
}

type AccountDescription interface {
	GetId() string
	GetType() proto.AccountType
	GetEngineType() EngineType
	GetName() string
	GetStatus() proto.AccountStatus
	GetAccessLevel() proto.AccessLevel
	GetClosedDate() time.Time
	GetOpenedDate() time.Time
}

type AccountEngine interface {
	GetPositions(ctx context.Context) (*Positions, error)
	GetOrders(ctx context.Context) ([]Order, error)
	GetBalance(ctx context.Context, i Instrument) int64
	GetBlocked(ctx context.Context, i Instrument) int64
	PostOrder(ctx context.Context, instrument Instrument, quantity int64, price big.Decimal, direction proto.OrderDirection, orderType proto.OrderType, orderId string) (Order, error)
	CancelOrder(ctx context.Context, orderId string) (time.Time, error)
	GetClient() Client // возвращает интерфейс Client, в рамках которого создан данный счёт
}

type AccountSmart interface {
	// стремиться достичь требуемую позицию используя лимитированные заявки с ценой на минимальный шаг лучше текущей лучшей цены
	DoPosition(ctx context.Context, bot Bot, instrument Instrument, targetPosition int64) TargetPosition
	// стремиться достичь требуемую позицию используя лимитированные заявки с ценой на priceIncriment лучше текущей лучшей цены
	DoPositionExtended(ctx context.Context, bot Bot, instrument Instrument, targetPosition int64, priceIncriment big.Decimal) TargetPosition
	// отправляет лимитированную заявку с ценой на priceIncriment лучше текущей лучшей цены
	PostOrderWithBestPrice(ctx context.Context, instrument Instrument, quantity int64, priceIncriment big.Decimal) (Order, error)
}

type Bot interface {
	Start() error             // вызывается при старте робота. Отличное место чтобы подписатсья на рыночную информацию
	Stop() error              // вызывается при остановки робота. Отличное место чтобы отписаться от рыночной информации, закрыть позиции.
	Context() context.Context // контекст робота, именно от него происходит взаимодействие с tinkoff api
	Name() string             // имя робота, желательно читаемое и уникальное. Активно используется в качестве меток метрик
}

type BotConfig struct {
	Name       string         // имя робота
	Account    Account        // счёт, на котором робот будет торгавать
	Instrument Instrument     // инструмент, которым робот будет торгавать
	Values     map[string]any // произвольные параметры робота
}

type Bots []Bot

type CandleChan chan *techan.Candle

type Candles interface {
	GetFigi() string
	GetPeriod() time.Duration
	GetSeries() *techan.TimeSeries
	Load(ctx context.Context, from time.Time, to time.Time) error
	Subscribe() (candleChan CandleChan, err error)
	Unsubscribe(candleChan CandleChan) error
}

type Client interface {
	// получить параметры инструмента и рыночные данные о торгах
	// на каждый вызов, для одного и того же figi будет возвращён один и тот же объект
	GetInstrument(figi string) Instrument
	// текущее время
	// например, если считаем свечку закрытой, через 10 секунд после наступления нового периода,
	// или если заявку по плохой цене держим ещё в течении минуты
	// то, оринтироваться надо именно на это время, т.к. в режиме тестирования на истории время time.Now() будет возвращять не то, что ожидает робот
	Now() time.Time
	// если в процессе торговли робот выводи сообщения, то их выводить следует через данную функцию,
	// т.к. в зависимости от режима торгов, назначение вывода может меняться. Например, при тестировании на истории, вывод робота игнорируется
	Printf(format string, arg ...any) (n int, err error)
}

type EngineType int32

type Instrument interface {
	GetCandles(period time.Duration) Candles                           // Получить интерфейс дл работы со свечами указанного периода
	GetFigi() string                                                   // Figi-идентификатор инструмента.
	GetExchange() string                                               // Торговая площадка.
	GetClassCode() string                                              // Класс-код (секция торгов).
	GetIsin() string                                                   // Isin-идентификатор инструмента.
	GetLot() int32                                                     //Количество в лоте
	GetTicker() string                                                 // Тикер  инструмента.
	GetCurrency() string                                               // Валюта расчётов.
	GetName() string                                                   // Название инструмента.
	GetLastPrices(ctx context.Context) ([]*LastPrice, error)           // Получить массив последних цен инструмента
	GetOrderBook(ctx context.Context, depth int32) (*OrderBook, error) // Получить стакан инструмента
	GetMinPriceIncrement() big.Decimal                                 // Шаг цены.
	IsStatus(tradingStatus ...proto.SecurityTradingStatus) bool        // Проверяет, является ли статус инструмента, любым из указанных в аргументах
	IsLimitOrderAvailable() bool                                       // Можно ли выставлять лимитные заявки по данному инструменту
	IsMarketOrderAvailable() bool                                      // Можно ли выставлять рыночные заявки по данному инструменту
	Now() time.Time                                                    // Текущее (для тестирования на истории)
}

type LastPrice struct {
	Figi  string      //Идентификатор инструмента.
	Price big.Decimal //Последняя цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
	Time  time.Time   //Время получения последней цены в часовом поясе UTC по времени биржи.
}

type Money struct {
	Currency string      // строковый ISO-код валюты
	Value    big.Decimal // сумма
}

type Order interface {
	GetFigi() string                                            //Идентификатор инструмента.
	GetExecutionReportStatus() proto.OrderExecutionReportStatus //Текущий статус заявки.
	GetDirection() proto.OrderDirection                         //Направление сделки.
	GetLotsRequested() int64                                    //Запрошено лотов.
	GetLotsExecuted() int64                                     //Исполнено лотов.
	GetOrderId() string                                         // Идентификатор заявки
	GetOrderDate() time.Time                                    //Дата и время выставления заявки в часовом поясе UTC.
	GetInitialOrderPrice() *Money                               //Начальная цена заявки. Произведение количества запрошенных лотов на цену.
	Cancel(ctx context.Context) (time.Time, error)              // Отменить заявку
	IsActive() bool                                             // Является ли заявка активной
	IsBestInOrderBook(ctx context.Context) bool                 // Является ли заявка лучшей в стакане
}

type OrderBook struct {
	Figi       string           //Figi-идентификатор инструмента.
	Depth      int32            //Глубина стакана.
	Bids       []OrderBookOrder //Множество пар значений на покупку.
	Asks       []OrderBookOrder //Множество пар значений на продажу.
	LastPrice  big.Decimal      //Цена последней сделки за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
	ClosePrice big.Decimal      //Цена закрытия за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
	LimitUp    big.Decimal      //Верхний лимит цены за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
	LimitDown  big.Decimal      //Нижний лимит цены за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
}

type OrderBookOrder struct {
	Price    big.Decimal //Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
	Quantity int64       //Количество в лотах.
}

type Position interface {
	GetFigi() string   //Figi-идентификатор.
	GetBlocked() int64 //Заблокировано.
	GetBalance() int64 //Текущий незаблокированный баланс.
}

type Positions struct {
	Money                   []*Money            //Массив валютных позиций портфеля.
	Blocked                 []*Money            //Массив заблокированных валютных позиций портфеля.
	Positions               map[string]Position //Список позиций портфеля (обединяет ценно-бумажные и фьючерсы). Ключ figi.
	LimitsLoadingInProgress bool                //Признак идущей в данный момент выгрузки лимитов.
}

type TargetPosition interface {
	Error() string
	GetError() error
	IsLimitError() bool
}