Skip to content

Commit ee43f5c

Browse files
larscomlarscom
committed
update readme, enums
1 parent 1c45b85 commit ee43f5c

17 files changed

+157
-145
lines changed

‎README.md‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,16 @@ For each event on the Bitvavo platform there is a listener available. A listener
4848
- TradesListener
4949

5050
```go
51+
package main
52+
5153
import "github.com/larscom/bitvavo-go/pkg/bitvavo"
5254

5355
func main() {
5456
// listen for candle (public) events
5557
listener := bitvavo.NewCandlesListener()
5658
defer listener.Close()
5759

58-
chn, err := listener.Subscribe([]string{"ETH-EUR"}, []bitvavo.Interval{bitvavo.INTERVAL_1M})
60+
chn, err := listener.Subscribe([]string{"ETH-EUR"}, []bitvavo.Interval{bitvavo.Interval1m})
5961
if err != nil {
6062
panic(err)
6163
}
@@ -76,6 +78,8 @@ func main() {
7678
- FillListener
7779

7880
```go
81+
package main
82+
7983
import "github.com/larscom/bitvavo-go/pkg/bitvavo"
8084

8185
func main() {
@@ -103,17 +107,19 @@ func main() {
103107
It's possible to create your own wrapper arround the websocket and listen to multiple events at the same time.
104108

105109
```go
110+
package main
111+
106112
import "github.com/larscom/bitvavo-go/pkg/bitvavo"
107113

108114
func main() {
109115
onMessage := func(data bitvavo.WebSocketEventData, err error) {
110116
if err != nil {
111117
// oh no error!
112-
} else if data.Event == bitvavo.EVENT_BOOK {
118+
} else if data.Event == bitvavo.EventBook {
113119
// decode into Book
114120
var book bitvavo.Book
115121
data.Decode(&book)
116-
} else if data.Event == bitvavo.EVENT_CANDLE {
122+
} else if data.Event == bitvavo.EventCandle {
117123
// decode into Candle
118124
var candle bitvavo.Candle
119125
data.Decode(&candle)
@@ -139,6 +145,8 @@ If you need both private and public endpoints you can create a private http clie
139145
### Private and Public endpoints
140146

141147
```go
148+
package main
149+
142150
import "github.com/larscom/bitvavo-go/pkg/bitvavo"
143151

144152
func main() {
@@ -157,6 +165,8 @@ func main() {
157165
### Public endpoints only
158166

159167
```go
168+
package main
169+
160170
import "github.com/larscom/bitvavo-go/pkg/bitvavo"
161171

162172
func main() {
@@ -177,6 +187,8 @@ func main() {
177187
Some endpoints have additional params which you can provide.
178188

179189
```go
190+
package main
191+
180192
import "github.com/larscom/bitvavo-go/pkg/bitvavo"
181193

182194
func main() {

‎example/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func main() {
2626

2727
tradingMarkets := make([]string, 0)
2828
for _, market := range markets {
29-
if market.Status == bitvavo.MARKET_STATUS_TRADING {
29+
if market.Status == bitvavo.MarketStatusTrading {
3030
tradingMarkets = append(tradingMarkets, market.Market)
3131
}
3232
}

‎pkg/bitvavo/asset.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,21 @@ import (
99
type DepositStatus enum.Member[string]
1010

1111
var (
12-
depositStatus = enum.NewBuilder[string, DepositStatus]()
13-
DEPOSIT_STATUS_TRADING = depositStatus.Add(DepositStatus{"OK"})
14-
DEPOSIT_STATUS_HALTED = depositStatus.Add(DepositStatus{"MAINTENANCE"})
15-
DEPOSIT_STATUS_AUCTION = depositStatus.Add(DepositStatus{"DELISTED"})
16-
depositStatuses = depositStatus.Enum()
12+
depositStatus = enum.NewBuilder[string, DepositStatus]()
13+
DepositStatusTrading = depositStatus.Add(DepositStatus{"OK"})
14+
DepositStatusHalted = depositStatus.Add(DepositStatus{"MAINTENANCE"})
15+
DepositStatusAuction = depositStatus.Add(DepositStatus{"DELISTED"})
16+
depositStatuses = depositStatus.Enum()
1717
)
1818

1919
type WithdrawalStatus enum.Member[string]
2020

2121
var (
22-
withdrawalStatus = enum.NewBuilder[string, WithdrawalStatus]()
23-
WITHDRAWAL_STATUS_TRADING = withdrawalStatus.Add(WithdrawalStatus{"OK"})
24-
WITHDRAWAL_STATUS_HALTED = withdrawalStatus.Add(WithdrawalStatus{"MAINTENANCE"})
25-
WITHDRAWAL_STATUS_AUCTION = withdrawalStatus.Add(WithdrawalStatus{"DELISTED"})
26-
withdrawalStatuses = withdrawalStatus.Enum()
22+
withdrawalStatus = enum.NewBuilder[string, WithdrawalStatus]()
23+
WithdrawalStatusTrading = withdrawalStatus.Add(WithdrawalStatus{"OK"})
24+
WithdrawalStatusHalted = withdrawalStatus.Add(WithdrawalStatus{"MAINTENANCE"})
25+
WithdrawalStatusAuction = withdrawalStatus.Add(WithdrawalStatus{"DELISTED"})
26+
withdrawalStatuses = withdrawalStatus.Enum()
2727
)
2828

2929
type Asset struct {

‎pkg/bitvavo/book_listener.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ func NewBookListener() Listener[BookEvent] {
1717
chn: chn,
1818
rchn: rchn,
1919
once: new(sync.Once),
20-
channel: CHANNEL_BOOK,
20+
channel: ChannelBook,
2121
}
2222

2323
ctx, cancel := context.WithCancel(context.Background())
@@ -75,7 +75,7 @@ func (l *BookListener) Close() error {
7575
func (l *BookListener) onMessage(data WebSocketEventData, err error) {
7676
if err != nil {
7777
l.chn <- BookEvent{Error: err}
78-
} else if data.Event == EVENT_SUBSCRIBED || data.Event == EVENT_UNSUBSCRIBED {
78+
} else if data.Event == EventSubscribed || data.Event == EventUnsubscribed {
7979
var subscribed Subscribed
8080
if err := data.Decode(&subscribed); err != nil {
8181
l.chn <- BookEvent{Error: err}
@@ -87,7 +87,7 @@ func (l *BookListener) onMessage(data WebSocketEventData, err error) {
8787
l.chn <- BookEvent{Error: ErrExpectedChannel(l.channel)}
8888
}
8989
}
90-
} else if data.Event == EVENT_BOOK {
90+
} else if data.Event == EventBook {
9191
var book Book
9292
l.chn <- BookEvent{Value: book, Error: data.Decode(&book)}
9393
}

‎pkg/bitvavo/candles_listener.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ func NewCandlesListener() *CandlesListener {
1717
chn: chn,
1818
rchn: rchn,
1919
once: new(sync.Once),
20-
channel: CHANNEL_CANDLES,
20+
channel: ChannelCandles,
2121
}
2222

2323
ctx, cancel := context.WithCancel(context.Background())
@@ -78,7 +78,7 @@ func (l *CandlesListener) Close() error {
7878
func (l *CandlesListener) onMessage(data WebSocketEventData, err error) {
7979
if err != nil {
8080
l.chn <- CandleEvent{Error: err}
81-
} else if data.Event == EVENT_SUBSCRIBED || data.Event == EVENT_UNSUBSCRIBED {
81+
} else if data.Event == EventSubscribed || data.Event == EventUnsubscribed {
8282
var subscribed Subscribed
8383
if err := data.Decode(&subscribed); err != nil {
8484
l.chn <- CandleEvent{Error: err}
@@ -96,7 +96,7 @@ func (l *CandlesListener) onMessage(data WebSocketEventData, err error) {
9696
l.chn <- CandleEvent{Error: ErrExpectedChannel(l.channel)}
9797
}
9898
}
99-
} else if data.Event == EVENT_CANDLE {
99+
} else if data.Event == EventCandle {
100100
var candle Candle
101101
l.chn <- CandleEvent{Value: candle, Error: data.Decode(&candle)}
102102
}

‎pkg/bitvavo/fill_listener.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ func NewFillListener(apiKey, apiSecret string) Listener[FillEvent] {
2424
chn: chn,
2525
rchn: rchn,
2626
once: new(sync.Once),
27-
channel: CHANNEL_ACCOUNT,
27+
channel: ChannelAccount,
2828
},
2929
}
3030

@@ -90,14 +90,14 @@ func (l *FillListener) Close() error {
9090
func (l *FillListener) onMessage(data WebSocketEventData, err error) {
9191
if err != nil {
9292
l.chn <- FillEvent{Error: err}
93-
} else if data.Event == EVENT_AUTHENTICATE {
93+
} else if data.Event == EventAuthenticate {
9494
var auth Authenticate
9595
if err := data.Decode(&auth); err != nil {
9696
l.chn <- FillEvent{Error: err}
9797
} else {
9898
l.authchn <- auth.Authenticated
9999
}
100-
} else if data.Event == EVENT_SUBSCRIBED || data.Event == EVENT_UNSUBSCRIBED {
100+
} else if data.Event == EventSubscribed || data.Event == EventUnsubscribed {
101101
var subscribed Subscribed
102102
if err := data.Decode(&subscribed); err != nil {
103103
l.chn <- FillEvent{Error: err}
@@ -109,7 +109,7 @@ func (l *FillListener) onMessage(data WebSocketEventData, err error) {
109109
l.chn <- FillEvent{Error: ErrExpectedChannel(l.channel)}
110110
}
111111
}
112-
} else if data.Event == EVENT_FILL {
112+
} else if data.Event == EventFill {
113113
var fill Fill
114114
l.chn <- FillEvent{Value: fill, Error: data.Decode(&fill)}
115115
}

‎pkg/bitvavo/market.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import (
99
type MarketStatus enum.Member[string]
1010

1111
var (
12-
marketStatus = enum.NewBuilder[string, MarketStatus]()
13-
MARKET_STATUS_TRADING = marketStatus.Add(MarketStatus{"trading"})
14-
MARKET_STATUS_HALTED = marketStatus.Add(MarketStatus{"halted"})
15-
MARKET_STATUS_AUCTION = marketStatus.Add(MarketStatus{"auction"})
16-
marketStatuses = marketStatus.Enum()
12+
marketStatus = enum.NewBuilder[string, MarketStatus]()
13+
MarketStatusTrading = marketStatus.Add(MarketStatus{"trading"})
14+
MarketStatusHalted = marketStatus.Add(MarketStatus{"halted"})
15+
MarketStatusAuction = marketStatus.Add(MarketStatus{"auction"})
16+
marketStatuses = marketStatus.Enum()
1717
)
1818

1919
type Market struct {

‎pkg/bitvavo/order.go‎

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -53,77 +53,77 @@ func (o *OrderParams) Params() url.Values {
5353
type OrderStatus enum.Member[string]
5454

5555
var (
56-
orderStatus = enum.NewBuilder[string, OrderStatus]()
57-
ORDER_STATUS_NEW = orderStatus.Add(OrderStatus{"new"})
58-
ORDER_STATUS_AWAITING_TRIGGER = orderStatus.Add(OrderStatus{"awaitingTrigger"})
59-
ORDER_STATUS_CANCELED = orderStatus.Add(OrderStatus{"canceled"})
60-
ORDER_STATUS_CANCELED_AUCTION = orderStatus.Add(OrderStatus{"canceledAuction"})
61-
ORDER_STATUS_CANCELED_STP = orderStatus.Add(OrderStatus{"canceledSelfTradePrevention"})
62-
ORDER_STATUS_CANCELED_IOC = orderStatus.Add(OrderStatus{"canceledIOC"})
63-
ORDER_STATUS_CANCELED_FOK = orderStatus.Add(OrderStatus{"canceledFOK"})
64-
ORDER_STATUS_CANCELED_MP = orderStatus.Add(OrderStatus{"canceledMarketProtection"})
65-
ORDER_STATUS_CANCELED_PO = orderStatus.Add(OrderStatus{"canceledPostOnly"})
66-
ORDER_STATUS_FILLED = orderStatus.Add(OrderStatus{"filled"})
67-
ORDER_STATUS_PARTIALLY_FILLED = orderStatus.Add(OrderStatus{"partiallyFilled"})
68-
ORDER_STATUS_EXPIRED = orderStatus.Add(OrderStatus{"expired"})
69-
ORDER_STATUS_REJECTED = orderStatus.Add(OrderStatus{"rejected"})
70-
orderStatuses = orderStatus.Enum()
56+
orderStatus = enum.NewBuilder[string, OrderStatus]()
57+
OrderStatusNew = orderStatus.Add(OrderStatus{"new"})
58+
OrderStatusAwaitingTrigger = orderStatus.Add(OrderStatus{"awaitingTrigger"})
59+
OrderStatusCanceled = orderStatus.Add(OrderStatus{"canceled"})
60+
OrderStatusCanceledAuction = orderStatus.Add(OrderStatus{"canceledAuction"})
61+
OrderStatusCanceledStp = orderStatus.Add(OrderStatus{"canceledSelfTradePrevention"})
62+
OrderStatusCanceledIoc = orderStatus.Add(OrderStatus{"canceledIOC"})
63+
OrderStatusCanceledFok = orderStatus.Add(OrderStatus{"canceledFOK"})
64+
OrderStatusCanceledMp = orderStatus.Add(OrderStatus{"canceledMarketProtection"})
65+
OrderStatusCanceledPo = orderStatus.Add(OrderStatus{"canceledPostOnly"})
66+
OrderStatusFilled = orderStatus.Add(OrderStatus{"filled"})
67+
OrderStatusPartiallyFilled = orderStatus.Add(OrderStatus{"partiallyFilled"})
68+
OrderStatusExpired = orderStatus.Add(OrderStatus{"expired"})
69+
OrderStatusRejected = orderStatus.Add(OrderStatus{"rejected"})
70+
orderStatuses = orderStatus.Enum()
7171
)
7272

7373
type OrderType enum.Member[string]
7474

7575
var (
76-
orderType = enum.NewBuilder[string, OrderType]()
77-
ORDER_TYPE_MARKET = orderType.Add(OrderType{"market"})
78-
ORDER_TYPE_LIMIT = orderType.Add(OrderType{"limit"})
79-
ORDER_TYPE_STOP_LOSS = orderType.Add(OrderType{"stopLoss"})
80-
ORDER_TYPE_STOP_LOSS_LIMIT = orderType.Add(OrderType{"stopLossLimit"})
81-
ORDER_TYPE_TAKE_PROFIT = orderType.Add(OrderType{"takeProfit"})
82-
ORDER_TYPE_TAKE_PROFIT_LIMIT = orderType.Add(OrderType{"takeProfitLimit"})
83-
orderTypes = orderType.Enum()
76+
orderType = enum.NewBuilder[string, OrderType]()
77+
OrderTypeMarket = orderType.Add(OrderType{"market"})
78+
OrderTypeLimit = orderType.Add(OrderType{"limit"})
79+
OrderTypeStopLoss = orderType.Add(OrderType{"stopLoss"})
80+
OrderTypeStopLossLimit = orderType.Add(OrderType{"stopLossLimit"})
81+
OrderTypeTakeProfit = orderType.Add(OrderType{"takeProfit"})
82+
OrderTypeTakeProfitLimit = orderType.Add(OrderType{"takeProfitLimit"})
83+
orderTypes = orderType.Enum()
8484
)
8585

8686
type OrderTriggerType enum.Member[string]
8787

8888
var (
89-
orderTriggerType = enum.NewBuilder[string, OrderTriggerType]()
90-
ORDER_TRIGGER_TYPE_DEFAULT = ORDER_TRIGGER_TYPE_PRICE
91-
ORDER_TRIGGER_TYPE_PRICE = orderTriggerType.Add(OrderTriggerType{"price"})
92-
orderTriggerTypes = orderTriggerType.Enum()
89+
orderTriggerType = enum.NewBuilder[string, OrderTriggerType]()
90+
OrderTriggerTypeDefault = OrderTriggerTypePrice
91+
OrderTriggerTypePrice = orderTriggerType.Add(OrderTriggerType{"price"})
92+
orderTriggerTypes = orderTriggerType.Enum()
9393
)
9494

9595
type OrderTriggerRef enum.Member[string]
9696

9797
var (
98-
orderTriggerRef = enum.NewBuilder[string, OrderTriggerRef]()
99-
ORDER_TRIGGER_REF_LAST_TRADE = orderTriggerRef.Add(OrderTriggerRef{"lastTrade"})
100-
ORDER_TRIGGER_REF_BEST_BID = orderTriggerRef.Add(OrderTriggerRef{"bestBid"})
101-
ORDER_TRIGGER_REF_BEST_ASK = orderTriggerRef.Add(OrderTriggerRef{"bestAsk"})
102-
ORDER_TRIGGER_REF_MID_PRICE = orderTriggerRef.Add(OrderTriggerRef{"midPrice"})
103-
orderTriggerRefs = orderTriggerRef.Enum()
98+
orderTriggerRef = enum.NewBuilder[string, OrderTriggerRef]()
99+
OrderTriggerRefLastTrade = orderTriggerRef.Add(OrderTriggerRef{"lastTrade"})
100+
OrderTriggerRefBestBid = orderTriggerRef.Add(OrderTriggerRef{"bestBid"})
101+
OrderTriggerRefBestAsk = orderTriggerRef.Add(OrderTriggerRef{"bestAsk"})
102+
OrderTriggerRefMidPrice = orderTriggerRef.Add(OrderTriggerRef{"midPrice"})
103+
orderTriggerRefs = orderTriggerRef.Enum()
104104
)
105105

106106
type TimeInForce enum.Member[string]
107107

108108
var (
109-
timeInForce = enum.NewBuilder[string, TimeInForce]()
110-
TIME_IN_FORCE_DEFAULT = TIME_IN_FORCE_GTC
111-
TIME_IN_FORCE_GTC = timeInForce.Add(TimeInForce{"GTC"})
112-
TIME_IN_FORCE_IOC = timeInForce.Add(TimeInForce{"IOC"})
113-
TIME_IN_FORCE_FOK = timeInForce.Add(TimeInForce{"FOK"})
114-
timeInForces = timeInForce.Enum()
109+
timeInForce = enum.NewBuilder[string, TimeInForce]()
110+
TimeInForceDefault = TimeInForceGtc
111+
TimeInForceGtc = timeInForce.Add(TimeInForce{"GTC"})
112+
TimeInForceIoc = timeInForce.Add(TimeInForce{"IOC"})
113+
TimeInForceFok = timeInForce.Add(TimeInForce{"FOK"})
114+
timeInForces = timeInForce.Enum()
115115
)
116116

117117
type SelfTradePrevention enum.Member[string]
118118

119119
var (
120-
selfTradePrevention = enum.NewBuilder[string, SelfTradePrevention]()
121-
SELF_TRADE_PREVENTION_DEFAULT = SELF_TRADE_PREVENTION_DAC
122-
SELF_TRADE_PREVENTION_DAC = selfTradePrevention.Add(SelfTradePrevention{"decrementAndCancel"})
123-
SELF_TRADE_PREVENTION_CO = selfTradePrevention.Add(SelfTradePrevention{"cancelOldest"})
124-
SELF_TRADE_PREVENTION_CN = selfTradePrevention.Add(SelfTradePrevention{"cancelNewest"})
125-
SELF_TRADE_PREVENTION_CB = selfTradePrevention.Add(SelfTradePrevention{"cancelBoth"})
126-
selfTradePreventions = selfTradePrevention.Enum()
120+
selfTradePrevention = enum.NewBuilder[string, SelfTradePrevention]()
121+
SelfTradePreventionDefault = SelfTradePreventionDac
122+
SelfTradePreventionDac = selfTradePrevention.Add(SelfTradePrevention{"decrementAndCancel"})
123+
SelfTradePreventionCo = selfTradePrevention.Add(SelfTradePrevention{"cancelOldest"})
124+
SelfTradePreventionCn = selfTradePrevention.Add(SelfTradePrevention{"cancelNewest"})
125+
SelfTradePreventionCb = selfTradePrevention.Add(SelfTradePrevention{"cancelBoth"})
126+
selfTradePreventions = selfTradePrevention.Enum()
127127
)
128128

129129
type Order struct {

‎pkg/bitvavo/order_listener.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ func NewOrderListener(apiKey, apiSecret string) Listener[OrderEvent] {
2424
chn: chn,
2525
rchn: rchn,
2626
once: new(sync.Once),
27-
channel: CHANNEL_ACCOUNT,
27+
channel: ChannelAccount,
2828
},
2929
}
3030

@@ -90,14 +90,14 @@ func (l *OrderListener) Close() error {
9090
func (l *OrderListener) onMessage(data WebSocketEventData, err error) {
9191
if err != nil {
9292
l.chn <- OrderEvent{Error: err}
93-
} else if data.Event == EVENT_AUTHENTICATE {
93+
} else if data.Event == EventAuthenticate {
9494
var auth Authenticate
9595
if err := data.Decode(&auth); err != nil {
9696
l.chn <- OrderEvent{Error: err}
9797
} else {
9898
l.authchn <- auth.Authenticated
9999
}
100-
} else if data.Event == EVENT_SUBSCRIBED || data.Event == EVENT_UNSUBSCRIBED {
100+
} else if data.Event == EventSubscribed || data.Event == EventUnsubscribed {
101101
var subscribed Subscribed
102102
if err := data.Decode(&subscribed); err != nil {
103103
l.chn <- OrderEvent{Error: err}
@@ -109,7 +109,7 @@ func (l *OrderListener) onMessage(data WebSocketEventData, err error) {
109109
l.chn <- OrderEvent{Error: ErrExpectedChannel(l.channel)}
110110
}
111111
}
112-
} else if data.Event == EVENT_ORDER {
112+
} else if data.Event == EventOrder {
113113
var order Order
114114
l.chn <- OrderEvent{Value: order, Error: data.Decode(&order)}
115115
}

0 commit comments

Comments
 (0)