@spec get_deposit(GRPC.Channel.t(), Kujira.Ghost.Vault.t(), String.t()) ::
  {:ok, integer()} | {:error, GRPC.RPCError.t()}

Gets the total deposit value of an address in a Vault. Under the hood, this queries the addresses balance of the receipt token, and adjusts it by the deposit_ratio

Manually clear with Kujira.Ghost.invalidate(:get_deposit, vault, depositor)

@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. Manually clear with Kujira.Ghost.invalidate(:get_market, 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. Manually clear with Kujira.Ghost.invalidate(:get_vault, address)

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

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

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

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

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

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

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

Loads the current Status into the Market. Default Memoization to ~ block time / 2 = 2s

Manually clear with Kujira.Ghost.invalidate(:load_market, market)

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

Loads the Market into a format that Orca can consume for health reporting. Default Memoization to 10 mins

Manually clear with Kujira.Ghost.invalidate(:load_orca_market, market)

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

Loads a Position by borrower address. Default Memoization to ~ block time / 2 = 2s

Manually clear with Kujira.Ghost.invalidate(:load_position, market, borrower)

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

Loads the current Status into the Vault. Default Memoization to ~ block time / 2 = 2s

Manually clear with Kujira.Ghost.invalidate(:load_vault, 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