Packages
kujira
0.1.80
0.1.80
0.1.79
0.1.78
0.1.77
0.1.76
0.1.75
0.1.74
0.1.73
0.1.72
0.1.71
0.1.70
0.1.69
0.1.68
0.1.67
0.1.66
0.1.65
0.1.64
0.1.63
0.1.62
0.1.61
0.1.60
0.1.59
0.1.58
0.1.57
0.1.56
0.1.55
0.1.54
0.1.53
0.1.52
0.1.51
0.1.50
0.1.49
0.1.48
0.1.47
0.1.46
0.1.45
0.1.44
0.1.43
0.1.42
0.1.41
0.1.40
0.1.39
0.1.38
0.1.37
0.1.36
0.1.35
0.1.34
0.1.33
0.1.32
0.1.31
0.1.30
0.1.29
0.1.28
0.1.27
0.1.25
0.1.24
0.1.23
0.1.22
0.1.21
0.1.20
0.1.19
0.1.18
0.1.17
0.1.16
0.1.15
0.1.14
0.1.13
0.1.12
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Elixir interfaces to Kujira dApps, for building indexers, APIs and bots
Current section
Files
Jump to
Current section
Files
lib/kujira/ghost/position.ex
defmodule Kujira.Ghost.Position do
@moduledoc """
An item representing the collateral deposit vs debt position of a particular address for a particular market
## Fields
* `:market` - The market where the position is held
* `:holder` - The address that owns the position
* `:collateral_amount` - The amount of collateral_token that has been deposited
* `:debt_shares` - The amount of debt_token minted and owned by this position
* `:debt_amount` - The resultant amount of debt owed, based on the `debt_ratio`
"""
alias Kujira.Ghost.Market
alias Kujira.Ghost.Vault
alias Tendermint.Abci.Event
alias Tendermint.Abci.EventAttribute
alias Cosmos.Base.Abci.V1beta1.TxResponse
defstruct [:market, :holder, :collateral_amount, :debt_shares, :debt_amount]
@type t :: %__MODULE__{
market: {Kujira.Ghost.Market, String.t()},
holder: String.t(),
collateral_amount: integer(),
debt_shares: integer(),
debt_amount: integer()
}
@typedoc """
The direction of the adjustment to the Position: collateral deposit, collateral withdrawal, debt borrow, debt repay
TODO: Add :liquidation
"""
@type adjustment :: :deposit | :withdrawal | :borrow | :repay
@spec from_query(Kujira.Ghost.Market.t(), Kujira.Ghost.Vault.t(), map()) ::
:error | {:ok, __MODULE__.t()}
def from_query(
%Market{address: market},
%Vault{status: %Vault.Status{debt_ratio: debt_ratio}},
%{
"holder" => holder,
"collateral_amount" => collateral_amount,
"debt_shares" => debt_shares
}
) do
with {collateral_amount, ""} <- Integer.parse(collateral_amount),
{debt_shares, ""} <- Integer.parse(debt_shares) do
{:ok,
%__MODULE__{
market: {Market, market},
holder: holder,
collateral_amount: collateral_amount,
debt_shares: debt_shares,
debt_amount:
debt_shares
|> Decimal.new()
|> Decimal.mult(debt_ratio)
# Debt is always rounded up
|> Decimal.round(0, :ceiling)
|> Decimal.to_integer()
}}
else
_ ->
:error
end
end
def from_query(%Market{}, %Vault{}, _), do: :error
@spec liquidation_price(Position.t(), Market.t(), Vault.t()) :: Decimal.t()
@doc """
Calculates a liquidation price for a given position. Quoted in terms of the underlying token decimals
Token where decimals are similar - eg a loan of 1.2 USDC against 1 KUJI where max ltv is 0.6
iex> Kujira.Ghost.Position.liquidation_price(
...> %Kujira.Ghost.Position{debt_shares: 1_000_000, collateral_amount: 1_000_000},
...> %Kujira.Ghost.Market{max_ltv: Decimal.from_float(0.6)},
...> %Kujira.Ghost.Vault{status: %{debt_ratio: Decimal.from_float(1.2)}}
...>)
Decimal.new(2)
And eg 1 wETH with 1000 USDC debt. Liq price should be 1666, which with a 12 dp decimal delta is 0.000000001666
iex> Kujira.Ghost.Position.liquidation_price(
...> %Kujira.Ghost.Position{debt_shares: 1_000_000_000, collateral_amount: 1_000_000_000_000_000_000},
...> %Kujira.Ghost.Market{max_ltv: Decimal.from_float(0.6)},
...> %Kujira.Ghost.Vault{status: %{debt_ratio: Decimal.from_float(1.0)}}
...>)
Decimal.new("1.666666666666666666666666667E-9")
"""
def liquidation_price(%__MODULE__{debt_shares: debt_shares}, _, _)
when debt_shares == 0 do
Decimal.new(0)
end
def liquidation_price(
%__MODULE__{
debt_shares: debt_shares,
collateral_amount: collateral_amount
},
%Market{max_ltv: max_ltv},
%Vault{status: %{debt_ratio: debt_ratio}}
) do
debt_shares
|> Decimal.new()
|> Decimal.mult(debt_ratio)
|> Decimal.div(collateral_amount |> Decimal.new() |> Decimal.mult(max_ltv))
end
@doc """
Returns all adjustments to positions found in the tx response
"""
@spec from_tx_response(TxResponse.t()) ::
list({{Market, String.t()}, String.t(), adjustment}) | nil
def from_tx_response(response) do
case scan_events(response.events) do
[] ->
nil
xs ->
xs
end
end
defp scan_events(events, collection \\ [])
defp scan_events([], collection), do: collection
defp scan_events(
[
%Event{
type: "wasm-ghost/deposit",
attributes: [
%EventAttribute{key: "_contract_address", value: market_address},
%EventAttribute{key: "depositor", value: borrower},
%EventAttribute{key: "collateral_added", value: _},
%EventAttribute{key: "position_total", value: _}
]
}
| rest
],
collection
) do
scan_events(rest, [
{{Market, market_address}, borrower, :deposit}
| collection
])
end
defp scan_events(
[
%Event{
type: "wasm-ghost/withdraw",
attributes: [
%EventAttribute{key: "_contract_address", value: market_address},
%EventAttribute{key: "destination", value: _},
%EventAttribute{key: "depositor", value: borrower},
%EventAttribute{key: "amount", value: _},
%EventAttribute{key: "position_total", value: _}
]
}
| rest
],
collection
) do
scan_events(rest, [
{{Market, market_address}, borrower, :withdraw}
| collection
])
end
defp scan_events(
[
%Event{
type: "wasm-ghost/borrow",
attributes: [
%EventAttribute{key: "_contract_address", value: market_address},
%EventAttribute{key: "borrower", value: borrower},
%EventAttribute{key: "borrowed", value: _},
%EventAttribute{key: "position_total", value: _}
]
}
| rest
],
collection
) do
scan_events(rest, [
{{Market, market_address}, borrower, :borrow}
| collection
])
end
defp scan_events(
[
%Event{
type: "wasm-ghost/repay",
attributes: [
%EventAttribute{key: "_contract_address", value: market_address},
%EventAttribute{key: "borrower", value: borrower},
%EventAttribute{key: "repaid", value: _},
%EventAttribute{key: "position_total", value: _}
]
}
| rest
],
collection
) do
scan_events(rest, [
{{Market, market_address}, borrower, :repay}
| collection
])
end
defp scan_events([_ | rest], collection), do: scan_events(rest, collection)
end