Kujira.Ghost (kujira v0.1.13)

Kujira's lending platform.

It has a vault-market architecture, where multiple Market can draw down from a single Vault. A Market must be whitelisted, as the repayment is guaranteed by its own execution logic, e.g. being over-collateralised and having a connection to Orca to liquidate collateral when needed

Summary

Functions

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

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

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

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

Loads the current Status into the Market

Loads the Market into a format that Orca can consume for health reporting. It's Memoized due to the call to Contract.query_state_all, clearing every 10m.

Loads a Position by borrower address

Loads the current Status into the Vault

Creates a lazy stream for fetching all positions for a Market

Functions

Link to this function

get_market(channel, address)

@spec get_market(GRPC.Channel.t(), String.t()) ::
  {:ok, Kujira.Ghost.Market.t()} | {:error, :not_found}

Fetches the Market 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.Ghost, :get_market, [address])

Link to this function

get_vault(channel, address)

@spec get_vault(GRPC.Channel.t(), String.t()) ::
  {:ok, Kujira.Ghost.Vault.t()} | {:error, :not_found}

Fetches the Vault 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.Ghost, :get_vault, [address])

Link to this function

list_markets(channel, code_ids \\ [136, 186])

@spec list_markets(GRPC.Channel.t(), [integer()]) ::
  {:ok, [Kujira.Ghost.Market.t()]} | :error

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

Manually clear with Memoize.invalidate(Kujira.Ghost, :list_markets)

Link to this function

list_vaults(channel, code_ids \\ [140])

@spec list_vaults(GRPC.Channel.t(), [integer()]) ::
  {:ok, [Kujira.Ghost.Vault.t()]} | :error

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

Manually clear with Memoize.invalidate(Kujira.Ghost, :list_vaults)

Link to this function

load_market(channel, market)

@spec load_market(GRPC.Channel.t(), Kujira.Ghost.Market.t()) ::
  {:ok, Kujira.Ghost.Market.t()} | :error

Loads the current Status into the Market

Link to this function

load_orca_market(channel, market, precision \\ 3)

@spec load_orca_market(GRPC.Channel.t(), Kujira.Ghost.Market.t(), integer() | nil) ::
  {:ok, Kujira.Orca.Market.t()} | :error

Loads the Market into a format that Orca can consume for health reporting. It's Memoized due to the call to Contract.query_state_all, clearing every 10m.

Manually clear with Memoize.invalidate(Kujira.Contract, :query_state_all, [market.address])

Link to this function

load_position(channel, market, borrower)

@spec load_position(GRPC.Channel.t(), Kujira.Ghost.Market.t(), String.t()) ::
  {:ok, Kujira.Ghost.Position.t()} | :error

Loads a Position by borrower address

Link to this function

load_vault(channel, vault)

@spec load_vault(GRPC.Channel.t(), Kujira.Ghost.Vault.t()) ::
  {:ok, Kujira.Ghost.Vault.t()} | :error

Loads the current Status into the Vault

Link to this function

load_vault_oracle_price(channel, vault)

Link to this function

stream_positions(channel, market, vault)

@spec stream_positions(
  GRPC.Channel.t(),
  Kujira.Ghost.Market.t(),
  Kujira.Ghost.Vault.t()
) :: %Stream{
  accs: term(),
  done: term(),
  enum: term(),
  funs: term()
}

Creates a lazy stream for fetching all positions for a Market