size

README

GoCryptoTrader Backtester: Size package

This size package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Size package overview

The sizing package ensures that all potential orders raised are within both the CurrencySettings limits as well as the portfolio manager's limits.

• In the event that the order is to large, the sizing package will reduce the order until it fits that limit, inclusive of fees.
• When an order is sized under the limits, an order event cannot be raised an no order will be submitted by the exchange
• The portfolio manager's sizing rules override any CurrencySettings' rules if the sizing is outside the portfolio manager's

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

• Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
• Code must be documented adhering to the official Go commentary guidelines.
• Code must adhere to our coding style.
• Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc

Documentation

Index

• type Size
  • func (s *Size) SizeOrder(o order.Event, amountAvailable decimal.Decimal, cs *exchange.Settings) (*order.Order, decimal.Decimal, error)

Types

type Size

type Size struct {
	BuySide  exchange.MinMax
	SellSide exchange.MinMax
}

Size contains buy and sell side rules

func (*Size) SizeOrder

func (s *Size) SizeOrder(o order.Event, amountAvailable decimal.Decimal, cs *exchange.Settings) (*order.Order, decimal.Decimal, error)

SizeOrder is responsible for ensuring that the order size is within config limits