Skip to content

Commit 396d639

Browse files
committed
Review pass
Removes all references to Quote denoms, Superfluid and Internal Incentives. Some updated text around tokenomics
1 parent 656768b commit 396d639

File tree

12 files changed

+24
-347
lines changed

12 files changed

+24
-347
lines changed

docs/osmosis-core/modules/concentrated-liquidity/README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1523,19 +1523,11 @@ the use of these hooks.
15231523

15241524
- `AuthorizedQuoteDenoms` []string
15251525

1526-
This is a list of quote denoms that can be used as token1 when creating a pool.
1527-
We limit the quote assets to a small set for the purposes of having convenient
1528-
price increments stemming from tick to price conversion. These increments are
1529-
in a human readable magnitude only for token1 as a quote. For limit orders in
1530-
the future, this will be a desirable property in terms of UX as to allow users
1531-
to set limit orders at prices in terms of token1 (quote asset) that are easy
1532-
to reason about.
1533-
1534-
This goes in-hand with centralized exchanges that limit the quote asset set
1535-
to only a few denoms.
1536-
1537-
Our list at launch is expected to consist of OSMO, DAI and USDC. These are set
1538-
in the v16 upgrade handler.
1526+
This was a list of quote denoms that can be used as token1 when creating a pool.
1527+
Quote assets were limited to a small set for the purposes of having convenient
1528+
price increments stemming from tick to price conversion.
1529+
1530+
This is no longer an active parameter as of v30 although it remains visible on chain.
15391531

15401532
- `IsPermisionlessPoolCreationEnabled` bool
15411533

docs/overview/educate/getting-started.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,6 @@ Click Start Earning and choose a bonding length.
8181
![](../../assets/start-earning.png)
8282

8383

84-
85-
### Internal Incentives
86-
8784
### External Incentives
8885

8986
Osmosis not only allows the community to add incentives to gauges. Anyone can deposit tokens into a gauge to be distributed. This feature allows outside parties to augment Osmosis’ own liquidity incentive program.
@@ -92,10 +89,5 @@ For example, there may be an ATOM< >FOOCOIN pool that has a one-day gauge incent
9289

9390
These external incentive providers can also set up long-lasting incentive programs that distribute rewards over an extended time period. For example, the Foo Foundation can deposit 30,000 Foocoins to be distributed over a one-month liquidity program. The program will automatically distribute 1000 Foocoins per day to the gauge.
9491

95-
## Go Superfluid!
96-
97-
## Unbonding LP Tokens
98-
When a user wants to stop bonding an LP token, they submit a transaction that begins the unbonding period. After the end of the timer, they can submit another transaction to withdraw the tokens.
99-
10092

10193

docs/overview/educate/osmo.mdx

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,28 +22,23 @@ _the token must have reasonable liquidity, paired with $OSMO as a minimum requir
2222

2323
:::
2424

25-
## ProtoRev
26-
The ProtoRev module mints and burns tokens in order to perform privileged arbitrage transactions onchain, ensuring prices are balanced across all liquidity sources. This happens within the same transaction and results in a net gain after the mint and burn from the arbitrage performed.
27-
28-
If a non-OSMO asset is recovered from this arbitrage, it is sent to the Community Pool as specified in [Proposal 709](https://daodao.zone/dao/osmosis/proposals/709).
29-
30-
If OSMO is recovered from this arbitrage, it is burned as specified in [Proposal 710](https://daodao.zone/dao/osmosis/proposals/710), permanently decreasing the Maximum Supply of 1 billion.
31-
All permanent burns can be tracked by viewing the [Null Address](https://www.mintscan.io/osmosis/address/osmo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqmcn030).
32-
3325
## Taker Fees
3426
Osmosis charges a small taker fee on all trades with a 0.1% default.
3527
Several routes have reductions or exemptions, which are managed by the [Protocol Fee Controller](https://daodao.zone/dao/osmo162wk8qc3w5s9hfs8dm76wrqnk6fjmsez2t4kk6zyugmrlzgds8sqfesmlm) subDAO.
3628

37-
Taker fees are collected in the Quote asset involved in the trade.
29+
Taker fees are initially collected in the asset provided as the entry point to the trade.
3830

39-
All OSMO collected is distributed to stakers.
31+
Non-OSMO collected is divided, with 25% going to the Community Pool and 75% used to buyback OSMO before further distribution.
4032

41-
Non-OSMO collected is divided, with 33% going to the Community Pool and 67% being converted to OSMO before being distributed to stakers.
33+
OSMO collected is distributed partially to stakers (30%) and partially burned (70%) to reduce the maximum supply of OSMO.
4234

43-
## Superfluid Staking
44-
The OSMO token is also minted and burned in the context of Superfluid Staking. As a Osmosis-specific feature, Superfluid Staking provides the consensus layer more security with a sort of "Proof of Useful Stake". Each person gets an amount of OSMO representative of the value of their share of liquidity pool tokens staked and delegated to validators, resulting in the security guarantee of the consensus layer to also be based on GAMM LP shares. This is available in pools that contain OSMO in the pairing and have had this feature enabled by governance.
35+
## ProtoRev
36+
The ProtoRev module mints and burns tokens in order to perform privileged arbitrage transactions onchain, ensuring prices are balanced across all liquidity sources. This happens within the same transaction and results in a net gain after the mint and burn from the arbitrage performed.
4537

46-
Further details can be seen in the [Superfluid module specifications](/osmosis-core/modules/superfluid/)
38+
If a non-OSMO asset is recovered from this arbitrage, it is sent to the Community Pool as specified in [Proposal 709](https://daodao.zone/dao/osmosis/proposals/709).
39+
40+
If OSMO is recovered from this arbitrage, it is burned as specified in [Proposal 710](https://daodao.zone/dao/osmosis/proposals/710), permanently decreasing the Maximum Supply of 1 billion.
41+
All permanent burns can be tracked by viewing the [Null Address](https://www.mintscan.io/osmosis/address/osmo1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqmcn030).
4742

4843
## Other Fees
4944
The OSMO token is required as fees for several tasks on chain to prevent spam and encourage considered usage of features. All fees paid go to the Community Pool.

docs/overview/features/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ This page serves as an informative gateway to explore the innovative and distinc
1515
- [Fee Abstraction](/overview/features/fee-abstraction)
1616
- [IBC Hooks](/overview/features/ibc-hooks)
1717
- [IBC Rate Limit](/overview/features/ibc-rate-limit)
18-
- [Superfluid Staking](/overview/features/superfluid)
1918
- [Token Factory](/overview/features/tokenfactory)
2019
- [Protorev](/overview/features/protorev)
2120

docs/overview/features/protorev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 9
2+
sidebar_position: 8
33
---
44

55
# Protorev

docs/overview/features/superfluid.md

Lines changed: 0 additions & 217 deletions
This file was deleted.

docs/overview/features/tokenfactory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 7
33
---
44

55
# Token Factory

docs/overview/integrate/apr.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,4 @@ Where:
2929
- `Exponent` is a factor related to the coin denomination.
3030
- `Liquidity` is the total liquidity in USD for the pool, adjusted by the percentage bonded (if applicable).
3131
- `Coin Price` is the current price of the coin.
32-
- The multiplier \(36500\) annualizes the rate.
33-
34-
2. **Superfluid APR Calculation** (if applicable):
35-
- The Superfluid APR is calculated additionally for pools where it's relevant, using the formula:
36-
![](../../assets/apr-superfluid.png)
37-
- Where:
38-
- \(\text{Staking APR}\) is the APR from staking.
39-
- `Superfluid Percentage` is the percentage of the pool that is superfluid.
40-
- `Superfluid Risk Factor` is a risk adjustment factor.
41-
- `APR_14d` is the 14-day APR calculated as above.
32+
- The multiplier \(36500\) annualizes the rate.

docs/overview/integrate/frontend.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 8
66

77
## List onto the Osmosis Frontend
88

9-
As long as the asset has been properly registered according to the [registration documentation](https://docs.osmosis.zone/overview/integrate/registration) and there is a pool with USD $1000 of [initial liquidity](https://docs.osmosis.zone/overview/integrate/liquidity) then the pool will be visible on this frontend.
9+
As long as the asset has been properly registered according to the [registration documentation](https://docs.osmosis.zone/overview/integrate/registration) and there is a pool with USD $1,000 of [initial liquidity](https://docs.osmosis.zone/overview/integrate/liquidity) then the pool will be visible on this frontend.
1010

1111
## Verify Assets
1212

@@ -18,4 +18,4 @@ Approval requires meeting the requirements in the assetlist repo that can be see
1818

1919
## Swap Page
2020

21-
Although any asset in a liquidity pool can be traded when a user specifies the pool, an asset will only be listed on the Swap page if it is has a pool containing liquidity of USD $10,000.
21+
Although any asset in a liquidity pool can be traded when a user specifies the pool, an asset will only be listed on the Swap page if it is has a pool containing liquidity of USD $1,000.

0 commit comments

Comments
 (0)