mirror of
https://github.com/uniwhale-io/docs.git
synced 2026-01-12 22:54:45 +08:00
GitBook: [#36] No subject
This commit is contained in:
Good Sanai
BIN
.gitbook/assets/image.png
Normal file
BIN
.gitbook/assets/image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 183 KiB |
@@ -16,7 +16,7 @@ coverY: 0
|
||||
* <mark style="color:green;">Single-sided stablecoin liquidity means zero impermanent loss.</mark>
|
||||
* <mark style="color:green;">Decentralized on-chain trading experience means zero credit risk.</mark>
|
||||
|
||||
### Uniwhale infrastructure is fully decentralised
|
||||
## Uniwhale infrastructure is fully decentralised
|
||||
|
||||
* We provide fully decentralized web links. You can run locally if you like.
|
||||
* Connect through [https://uniwhale.co](https://uniwhale.co) for speed and convenience.
|
||||
|
||||
@@ -3,10 +3,8 @@
|
||||
* [Introduction](README.md)
|
||||
* [Our Vision](overview/our-vision.md)
|
||||
* [Unique Oracle Design](unique-oracle-design.md)
|
||||
* [Trading](trading.md)
|
||||
* [Trading](execution.md)
|
||||
* [Liquidity Pool](liquidity-pool.md)
|
||||
* [Tokenomics](tokenomics.md)
|
||||
* [Roadmap](roadmap.md)
|
||||
* [Social Media](social-media.md)
|
||||
* [Wallet Control](wallet-control.md)
|
||||
* [Overview](overview.md)
|
||||
|
||||
75
execution.md
Normal file
75
execution.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# Trading
|
||||
|
||||
## Trade up to 200X
|
||||
|
||||
We offer perpetual futures with up to 200X leverage on BTC, ETH, and many mainstream crypto assets.
|
||||
|
||||
## Keep your assets safe
|
||||
|
||||
We do not custody your assets. Your assets stay with you and the margin posted are locked in a dedicated smart contract.
|
||||
|
||||
## Margining
|
||||
|
||||
All positions are margined in USDC. Both isolated and portfolio margining will be supported. 
|
||||
|
||||
You can add margins to ourstanding positions, but cannot withdraw partially posted margin. When margins are added to an outstanding position, the relevant liquidation price is adjusted.
|
||||
|
||||
Multiple stablecoins are accepted as eligible margins. These will be swapped automatically to USDC.
|
||||
|
||||
## Order type supported
|
||||
|
||||
At uniwhale, you can trade either Market Order or Market Limit Order. Both order types can also have either Stop Loss, Profit Target or both.
|
||||
|
||||
### Market Order
|
||||
|
||||
Market orders are filled at the best price offered by the [Liquidity Pool](liquidity-pool.md).
|
||||
|
||||
### Market Limit Order
|
||||
|
||||
Market limit orders are filled when the limit prices matches the best price offered by the [Liquidity Pool](liquidity-pool.md).
|
||||
|
||||
### Stop Loss
|
||||
|
||||
Stop Loss price can be added to Market Order or Market Limit Order, which will trigger an automatic close of the position if the condition is satisfied.
|
||||
|
||||
### Profit Target
|
||||
|
||||
Profit Target price can be added to Market Order or Market Limit Order, which will trigger an automatic close of the position if the condition is satisfied.
|
||||
|
||||
## Initiating a position
|
||||
|
||||
Initiating a position will transfer the required margin to a dedicated on-chain contract, whose sole purpose is to hold trader margins.
|
||||
|
||||
Liquidity Pool which acts as the central counterparty and clearinghouse to all positions.
|
||||
|
||||
The initial margin is calculated based on the matched prices ("Mark Price").
|
||||
|
||||
You can post margin in many stablecoins, which will then been automatically swapped into USDC.
|
||||
|
||||
## Closing a position
|
||||
|
||||
Closing a position will calculate the PnL based on the best price offered by the Liquidity Pool and transfer to the trader, together with the margin posted. 
|
||||
|
||||
A trader may request the PnL to be transferred in a stablecoin other than USDC, in which case the PnL (together with the margin) will be swapped into the requested stablecoin and transferred to the trader.
|
||||
|
||||
A trader can not lose more than the margin posted. 
|
||||
|
||||
## Liquidation
|
||||
|
||||
Outstanding positions are subject to liquidation if the relevant liquidation price is breached according to the price oracle ("Index Price").
|
||||
|
||||
Outstanding positions eligible for liquidation are liquidated at the earliest chance, to protect the users and the platform.
|
||||
|
||||
Liquidation closes the relevant position. It is subject to a liquidation penalty. In order to avoid liquidation penalty, traders are advised to close a position before liquidation is triggered.
|
||||
|
||||
## Risk management
|
||||
|
||||
Trading at uniwhale is subject to the following constraints:
|
||||
|
||||
* Leverage cannot exceed 200x.
|
||||
* A trader can carry at most \[. ] open positions for each pair.
|
||||
* A trader can carry at most \[. ] open positions across pairs.
|
||||
* A trader can carry at most $\[. ] of margin across pairs.
|
||||
* Minimum position (after leverage) is $\[. ].
|
||||
* A position has the maximum percentage PnL of \[. ].
|
||||
|
||||
37
overview.md
37
overview.md
@@ -1,37 +0,0 @@
|
||||
---
|
||||
cover: .gitbook/assets/Uniwhale_Gitbook_Cover_1900x400.png
|
||||
coverY: 0
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
<mark style="color:green;">Uniwhale is an oracle-based decentralized on-chain perpetual trading protocol that allows users to provide liquidity by using multi-stable coins(USDC/USDT/DAI).</mark> 
|
||||
|
||||
Trade at a low transaction fee, with zero slippage.
|
||||
|
||||
### Lower Risk of Liquidation
|
||||
|
||||
<mark style="color:green;">Uniwhale provides high-leverage perpetual trading up to 200x leverage.</mark> 
|
||||
|
||||
The unique oracle design aggregates multiple oracle sources to protect traders from harmful candle wicks.
|
||||
|
||||
You have full ownership and control of the assets.
|
||||
|
||||
<mark style="color:green;">With the beauty of accurate price oracle and single-sided liquidity, Uniwhale protocol will make sure a fantastic trading experience for traders with Zero credit risk, and liquidity providers to get away from unnecessary impermanent loss.</mark>
|
||||
|
||||
* <mark style="color:green;">Oracle-based liquidity pool to enable zero slippage</mark> 
|
||||
* <mark style="color:green;">Single-sided liquidity enables 0 impermanent loss.</mark>
|
||||
|
||||
#### Oracle-based mid-price calculation
|
||||
|
||||
### Real-Yield Earning
|
||||
|
||||
Uniwhale uses aggregated oracle to determine trading prices, which provides fast and accurate prices for on-chain contracts.
|
||||
|
||||
Keepers constantly refresh the oracle prices and update the Liquidity Pool.
|
||||
|
||||
Liquidity Pool uses the trailing average and percentile of the oracle prices to determine its mid-price.
|
||||
|
||||
## Architectural Sneak Peak
|
||||
|
||||
Providing stablecoin liquidity to Uniwhale is hassle-free and impermanent-loss-free. Everyone is encouraged to be a liquidity provider and earn a passive market-making yield.
|
||||
@@ -1,24 +1,24 @@
|
||||
# Our Vision
|
||||
|
||||
### In Code We Trust
|
||||
## In Code We Trust
|
||||
|
||||
Back to where it started: Satoshi created the vision and practical path of a trustless solution - Bitcoin. Code never lies, and saves us from having to trust a centralised authority.  
|
||||
|
||||
DeFi, as an alternative to CeFi, provides full on-chain transparency and strict limit on use of user funds. With code, credit risk can be made minimal.
|
||||
|
||||
### Permisionless, Trustless, Transparency
|
||||
## Permisionless, Trustless, Transparency
|
||||
|
||||
Not we, but our community decides who has the right to use and benefit from the platform. We believe in the power of full decentralization and permissionless, trustless, transparency.
|
||||
|
||||
Uniwhale team is committed to contributing and bringing this vision of the platform to our community, incentivising everyone to participate in the DAO to BUILD together.
|
||||
|
||||
### Best User Experience
|
||||
## Best User Experience
|
||||
|
||||
Unknown slippage, uncontrolled impermanent loss, complicated UX, inflated farming yield - we see many issues in the current DeFi protocols. We are a team of web3 developers / builders, joining the efforts to address these issues. 
|
||||
|
||||
We aim to bring the best trading experience to traders, and the most intuitive liquidity provision to liquidity providers, but without harmful token price volatility.  
|
||||
|
||||
### Who We Are
|
||||
## Who We Are
|
||||
|
||||
Goodsanai - Chief Architect | Smart Contract Builder | Risk Management | ex-Wallstreet Quant
|
||||
|
||||
|
||||
@@ -4,6 +4,6 @@ Twitter: [https://twitter.com/UniwhaleEx](https://twitter.com/UniwhaleEx)
|
||||
|
||||
Discord: [https://discord.gg/AAW3FpBHRU](https://discord.gg/AAW3FpBHRU)
|
||||
|
||||
GitHub:
|
||||
GitHub: [https://github.com/uniwhale-io](https://github.com/uniwhale-io)
|
||||
|
||||
Medium: [https://uniwhale.medium.com](https://uniwhale.medium.com/)
|
||||
|
||||
41
trading.md
41
trading.md
@@ -1,41 +0,0 @@
|
||||
# Trading
|
||||
|
||||
## Trade up to 200X
|
||||
|
||||
We offer perpetual futures with up to 200X leverage on BTC, ETH, and more mainstream crypto assets directly from your wallet.
|
||||
|
||||
All positions are margined in USD. Both <mark style="color:red;">**Isolated Margining**</mark> and <mark style="color:red;">**Portfolio Margining**</mark> will be supported.
|
||||
|
||||
Initiating positions will transfer the required margin to Exchange on-chain contract, which acts as the central counterparty and clearing house to all positions.
|
||||
|
||||
The initial margin is calculated based on the matched prices ("Mark Price").
|
||||
|
||||
Outstanding positions are subject to liquidation which may be triggered if the relevant liquidation price is breached according to the Price Oracle ("Index Price").
|
||||
|
||||
Keepers constantly monitor the positions to ensure positions eligible for liquidation are liquidated at the earliest chance, to protect the users and the platform.
|
||||
|
||||
If the position is liquidated and you close out the position, the settlement amount is determined based on the matched prices and is transferred by the Exchange to you.
|
||||
|
||||
## Best Price Oracles
|
||||
|
||||
<mark style="color:green;">We, at the core, are about signed off-chain messages settled on-chain, which allows the CeFi-like orderbook experience for both traders and market makers.</mark>
|
||||
|
||||
<mark style="color:green;">Built as a classic central limit order book, signed orders are queued and matched for on-chain settlement.</mark>
|
||||
|
||||
<mark style="color:green;">Because these orders are created and signed off-chain, they require no gas fee.</mark>
|
||||
|
||||
<mark style="color:green;">The speed and latency of the order-matching engine are also not constrained by the settlement blockchain, allowing horizontal scalability.</mark>
|
||||
|
||||
## Keep your assets safe
|
||||
|
||||
The orders matched by the order matching engine are sent to the Exchange on-chain contract, which validates these orders and settles them on-chain.
|
||||
|
||||
By building on EVM, which boasts horizontally scalable, instant, finality with low fees, the settlement of trades is cost-efficient and lightning-quick.
|
||||
|
||||
 Market Limit Order
|
||||
|
||||
Market limit orders are filled by Keepers when the matching price reaches the limit price.
|
||||
|
||||
#### Market Order
|
||||
|
||||
Market orders are filled by Keepers at the best price offered by the Liquidity Pool.
|
||||
@@ -1,6 +1,8 @@
|
||||
# Unique Oracle Design
|
||||
|
||||
### Fast and accurate prices for on-chain contracts 
|
||||
## Fast and accurate prices for on-chain contracts 
|
||||
|
||||
Uniwhale is building an oracle aggregator based on multiple service providers to determine trading prices, which provides fast and accurate prices for on-chain contracts.
|
||||
|
||||
<figure><img src=".gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
# Wallet Control
|
||||
|
||||
## Keep your assets safe
|
||||
|
||||
You have full ownership and control of your assets on our platform. Zero credit risk.
|
||||
|
||||
A wallet is an on-chain contract that holds trading funds on your behalf.
|
||||
|
||||
When you register, funds are deposited into the wallet, owned and controlled by yourself. 
|
||||
|
||||
Segregation of trading funds at Wallet from the funds in your own wallet is essential to eliminate credit risk between the trade confirmation and settlement time.
|
||||
|
||||
You can withdraw the available balance anytime by making an on-chain request.
|
||||
Reference in New Issue
Block a user