Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Orderbook: Add GetDepth to Base #1328

Merged
merged 3 commits into from
Aug 29, 2023
+34 −2
Merged

Orderbook: Add GetDepth to Base #1328

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de5e92f
Orderbook: Add GetDepth to Base
gbjk Aug 25, 2023
8561568
Orderbook: Reword GetDepth comment
gbjk Aug 28, 2023
0a1500a
Orderbook: Add test for Base.GetDepth
gbjk Aug 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions exchanges/orderbook/orderbook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ func Get(exchange string, p currency.Pair, a asset.Item) (*Base, error) {
return service.Retrieve(exchange, p, a)
}

// GetDepth returns a Depth pointer allowing the caller to stream orderbook
// changes
// GetDepth returns a Depth pointer allowing the caller to stream orderbook changes
func GetDepth(exchange string, p currency.Pair, a asset.Item) (*Depth, error) {
return service.GetDepth(exchange, p, a)
}
Expand Down Expand Up @@ -202,6 +201,13 @@ func (s *Service) Retrieve(exchange string, p currency.Pair, a asset.Item) (*Bas
return book.Retrieve()
}

// GetDepth returns the concrete book of which Base is a copy
// This is probably useful for immutably monitoring orderbook health and state
// whereas FetchOrderbook would trigger a refresh.
gbjk marked this conversation as resolved.
Show resolved Hide resolved
func (b *Base) GetDepth() (*Depth, error) {
gbjk marked this conversation as resolved.
Show resolved Hide resolved
return service.GetDepth(b.Exchange, b.Pair, b.Asset)
}

// TotalBidsAmount returns the total amount of bids and the total orderbook
// bids value
func (b *Base) TotalBidsAmount() (amountCollated, total float64) {
Expand Down