Kujira.Orca (kujira v0.1.13)

Methods for querying the Orca Liquidation Queues, and related data

Summary

Functions

Fetches the Queue contract and its current config from the chain.

Fetches all Liquidation Queues. This will only change when config changes or new Queues are added. It's Memoized, clearing every 24h.

Loads a bid for a specific Queue

Loads a user's bids for a specific Queue

Loads the current contract state into the Queue; the totals of each bid pool

Functions

Link to this function

get_queue(channel, address)

@spec get_queue(GRPC.Channel.t(), String.t()) ::
  {:ok, Kujira.Orca.Queue.t()} | {:error, :not_found}

Fetches the Queue contract and its current config from the chain.

Config is very very rarely changed, if ever, and so this function is Memoized by default. Clear with Memoize.invalidate(Kujira.Orca, :get_queue, [address])

Link to this function

list_queues(channel, code_ids \\ [108, 122, 216, 220])

@spec list_queues(GRPC.Channel.t(), [integer()]) ::
  {:ok, [Kujira.Orca.Queue.t()]} | :error

Fetches all Liquidation Queues. This will only change when config changes or new Queues are added. It's Memoized, clearing every 24h.

Manually clear with Memoize.invalidate(Kujira.Orca, :list_queues)

Link to this function

load_bid(channel, queue, idx)

@spec load_bid(GRPC.Channel.t(), Kujira.Orca.Queue.t(), String.t()) ::
  {:ok, Kujira.Orca.Bid.t()} | :error

Loads a bid for a specific Queue

Link to this function

load_bids(channel, queue, address, start_after \\ nil)

Loads a user's bids for a specific Queue

Link to this function

load_queue(channel, queue)

@spec load_queue(GRPC.Channel.t(), Kujira.Orca.Queue.t()) ::
  {:ok, Kujira.Orca.Queue.t()} | :error

Loads the current contract state into the Queue; the totals of each bid pool