Documentation ¶
Index ¶
- Constants
- Variables
- func NewBadArg(msg string, arg interface{}) error
- func NewBadExResp(err error) error
- type BaseFutureSymbol
- type BaseMarket
- type BaseOptionSymbol
- type BaseSpotSymbol
- type BaseSwapSymbol
- type Channel
- type Client
- func (c *Client) Close() error
- func (c *Client) Done() <-chan struct{}
- func (c *Client) Error() error
- func (c *Client) Handle(_ context.Context, notify *rpc.Notify)
- func (c *Client) Index(sym Symbol) (*Index, error)
- func (c *Client) OrderBook(symbol Symbol) (*OrderBook, error)
- func (c *Client) Run(ctx context.Context) error
- type CodeC
- type ConnCB
- type ErrBadArg
- type ErrBadExResp
- type FuturesSymbol
- type Index
- type IndexNotify
- type IntID
- type OptionSymbol
- type OptionType
- type Order
- type OrderBook
- type OrderBookDS
- type OrderBookNotify
- type OrderElem
- type OrderID
- type OrderReqOption
- type OrderRequest
- type OrderSide
- type OrderStatus
- type OrderType
- type Position
- type PositionMode
- type PositionSide
- type PostOnlyOption
- type SpotSymbol
- type StrID
- type SubType
- type SwapSymbol
- type Symbol
- type TimeInForceFlag
- type TimeInForceOption
- type TradeFee
- type WSClient
- type WSNotify
Constants ¶
const ( OrderSideBuy = iota OrderSideSell OrderSideCloseLong OrderSideCloseShort OrderTypeLimit = iota OrderTypeMarket OrderTypeStopLimit OrderTypeStopMarket //OrderStatusUnknown means order info need check with api OrderStatusUnknown = iota OrderStatusOpen OrderStatusDone OrderStatusCancel OrderStatusFailed //TimeInForceGTC good_till_cancel TimeInForceGTC = "gtc" //TimeInForceFOK fill_or_kill TimeInForceFOK = "fok" //TimeInForceIOC immediate_or_cancel TimeInForceIOC = "ioc" )
const ( PositionSideLong = iota PositionSideShort PositionModeFixed PositionModeCross )
const ( OptionTypeCall = iota OptionTypePut )
Variables ¶
var (
TimeNoExpire = time.Time{}
)
Functions ¶
func NewBadExResp ¶
Types ¶
type BaseFutureSymbol ¶
type BaseFutureSymbol struct {
// contains filtered or unexported fields
}
BaseFutureSymbol define common property of future symbol
func NewBaseFutureSymbol ¶
func NewBaseFutureSymbol(index string, st time.Time) *BaseFutureSymbol
func (*BaseFutureSymbol) Index ¶
func (bfs *BaseFutureSymbol) Index() string
func (*BaseFutureSymbol) SettleTime ¶
func (bfs *BaseFutureSymbol) SettleTime() time.Time
type BaseMarket ¶
type BaseMarket struct {
// contains filtered or unexported fields
}
func (*BaseMarket) Expire ¶
func (m *BaseMarket) Expire() bool
func (*BaseMarket) Symbol ¶
func (m *BaseMarket) Symbol() Symbol
type BaseOptionSymbol ¶
type BaseOptionSymbol struct {
// contains filtered or unexported fields
}
BaseOptionSymbol define common property of option symbol
func NewBaseOptionSymbol ¶
func NewBaseOptionSymbol(index string, st time.Time, strike float64, typ OptionType) *BaseOptionSymbol
func (*BaseOptionSymbol) Index ¶
func (bos *BaseOptionSymbol) Index() string
func (*BaseOptionSymbol) SettleTime ¶
func (bos *BaseOptionSymbol) SettleTime() time.Time
func (*BaseOptionSymbol) Strike ¶
func (bos *BaseOptionSymbol) Strike() float64
func (*BaseOptionSymbol) Type ¶
func (bos *BaseOptionSymbol) Type() OptionType
type BaseSpotSymbol ¶
type BaseSpotSymbol struct {
// contains filtered or unexported fields
}
BaseSpotSymbol define common property of spot symbol
func NewBaseSpotSymbol ¶
func NewBaseSpotSymbol(base, quote string) *BaseSpotSymbol
func (*BaseSpotSymbol) Base ¶
func (bss *BaseSpotSymbol) Base() string
func (*BaseSpotSymbol) Quote ¶
func (bss *BaseSpotSymbol) Quote() string
type BaseSwapSymbol ¶
type BaseSwapSymbol struct {
// contains filtered or unexported fields
}
func NewBaseSwapSymbol ¶
func NewBaseSwapSymbol(index string) *BaseSwapSymbol
func (*BaseSwapSymbol) Index ¶
func (bsw *BaseSwapSymbol) Index() string
type Client ¶
type Client struct { NewConn ConnCB Conn rpc.Conn Addr string Key string Secret string Timeout time.Duration //subscribe struct will be updated via rpc Conn notify message Sub map[string]interface{} SubMu sync.Mutex }
func (*Client) Done ¶
func (c *Client) Done() <-chan struct{}
Done get notify if running loop closed
type ErrBadArg ¶
type ErrBadArg struct { Arg interface{} Msg string }
ErrBadArg means func argument is incorrect
type ErrBadExResp ¶
type ErrBadExResp struct {
Err error
}
ErrBadResp means exchange response message error
func (*ErrBadExResp) Error ¶
func (ebe *ErrBadExResp) Error() string
func (*ErrBadExResp) Is ¶
func (ebe *ErrBadExResp) Is(target error) bool
type IndexNotify ¶
type IndexNotify Index
func (*IndexNotify) Key ¶
func (i *IndexNotify) Key() string
func (*IndexNotify) Snapshot ¶
func (i *IndexNotify) Snapshot() *Index
type OptionSymbol ¶
type OptionType ¶
type OptionType int
func (OptionType) String ¶
func (ot OptionType) String() string
type Order ¶
type OrderBookDS ¶
type OrderBookDS struct {
// contains filtered or unexported fields
}
OrderBookDS is the ds which hold orderbook info
func NewOrderBookDS ¶
func NewOrderBookDS(notify *OrderBookNotify) *OrderBookDS
func (*OrderBookDS) Snapshot ¶
func (ds *OrderBookDS) Snapshot() *OrderBook
func (*OrderBookDS) Update ¶
func (ds *OrderBookDS) Update(notify *OrderBookNotify)
type OrderBookNotify ¶
OrderBookNotify change of current orderbook OrderElem.Amount == 0 means delete
func (*OrderBookNotify) Key ¶
func (notify *OrderBookNotify) Key() string
type OrderReqOption ¶
type OrderReqOption interface { }
OrderReqOption specific option to create order each exchange support different options.
func NewPostOnlyOption ¶
func NewPostOnlyOption(postOnly bool) OrderReqOption
func NewTimeInForceOption ¶
func NewTimeInForceOption(flag TimeInForceFlag) OrderReqOption
type OrderRequest ¶
type OrderRequest struct { Symbol Symbol ClientID OrderID Side OrderSide Type OrderType Price decimal.Decimal Amount decimal.Decimal }
OrderRequest carry field which used to create order
func NewOrderRequest ¶
type OrderStatus ¶
type OrderStatus int
type Position ¶
type Position struct { Symbol Symbol Mode PositionMode Side PositionSide LiquidationPrice decimal.Decimal AvgOpenPrice decimal.Decimal CreateTime time.Time Margin decimal.Decimal MarginMaintRatio decimal.Decimal Position decimal.Decimal AvailPosition decimal.Decimal RealizedPNL decimal.Decimal UNRealizedPNL decimal.Decimal Leverage decimal.Decimal Raw interface{} }
Position info
type PositionMode ¶
type PositionMode int
func (PositionMode) String ¶
func (pm PositionMode) String() string
type PositionSide ¶
type PositionSide int
func (PositionSide) String ¶
func (ps PositionSide) String() string
type PostOnlyOption ¶
type PostOnlyOption struct {
PostOnly bool
}
PostOnlyOption wether the order ensure maker
type SpotSymbol ¶
type SwapSymbol ¶
type Symbol ¶
type Symbol interface {
String() string
}
Symbol is used to unit different exchange markets symbol serialize
type TimeInForceOption ¶
type TimeInForceOption struct {
Flag TimeInForceFlag
}
TimeInForceOption specific how long the order remains in effect