diff --git a/.gitbook/assets/image (2).png b/.gitbook/assets/image (2).png new file mode 100644 index 0000000..9dfef39 Binary files /dev/null and b/.gitbook/assets/image (2).png differ diff --git a/SUMMARY.md b/SUMMARY.md index 4f7541d..38ba7be 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -5,6 +5,8 @@ * [Unique Oracle Design](unique-oracle-design.md) * [Trading](execution.md) * [Liquidity Pool](liquidity-pool.md) +* [Security](security/README.md) + * [Early Warning and TimeLock](security/early-warning-and-timelock.md) * [Tokenomics](tokenomics/README.md) * [ULP - The Liquidity Pool Token](tokenomics/ulp-the-liquidity-pool-token.md) * [UNW - The Utility Token](tokenomics/unw-the-utility-token.md) diff --git a/developers/smart-contracts.md b/developers/smart-contracts.md index 2e2305a..3178194 100644 --- a/developers/smart-contracts.md +++ b/developers/smart-contracts.md @@ -1,13 +1,4 @@ # Smart Contracts -| Contract | Address (BNB) | -| ------------------------ | -------------------------------------------------------------------------------------------------------------------- | -| Trading Core | [0x2926710DCB5c3e046285755410979D1DE5fCc1Ea](https://bscscan.com/address/0x2926710dcb5c3e046285755410979d1de5fcc1ea) | -| Trading Core with Router | [0xdAF311cd286bC7094487AFC306F6Ff3681cfF129](https://bscscan.com/address/0xdaf311cd286bc7094487afc306f6ff3681cff129) | -| Limit Book | [0x656aC046304446C5802849FCfD5F5DDb090A8ea7](https://bscscan.com/address/0x656aC046304446C5802849FCfD5F5DDb090A8ea7) | -| Liquidity Pool | [0xBdeCAFd9096D43616a8E0eB8F3fa0865fD4769E7](https://bscscan.com/address/0xbdecafd9096d43616a8e0eb8f3fa0865fd4769e7) | -| Margin Pool | [0xBB1B941aB76fAE4e9F552B860eFaC1F367AC9bCc](https://bscscan.com/address/0xbb1b941ab76fae4e9f552b860efac1f367ac9bcc) | -| Registry Core | [0xae0C4a3432b18d9C65e1544a7669d9De44927ff9](https://bscscan.com/address/0xae0c4a3432b18d9c65e1544a7669d9de44927ff9) | -| Oracle Aggregator | [0x0b56a61d817E215d6F6dC7B461BE2e5b0ca3716b](https://bscscan.com/address/0x0b56a61d817e215d6f6dc7b461be2e5b0ca3716b) | -| Uniwhale Genesis Pass | [0x3D8cE31601b8ED4Db5eEB921FCF7f178bABE7C2E](https://bscscan.com/token/0x3d8ce31601b8ed4db5eeb921fcf7f178babe7c2e) | +
ContractAddress (BNB)
Trading Core0x2926710DCB5c3e046285755410979D1DE5fCc1Ea
Trading Core with Router0xdAF311cd286bC7094487AFC306F6Ff3681cfF129
Limit Book0x656aC046304446C5802849FCfD5F5DDb090A8ea7
Liquidity Pool0xBdeCAFd9096D43616a8E0eB8F3fa0865fD4769E7
Margin Pool0xBB1B941aB76fAE4e9F552B860eFaC1F367AC9bCc
Registry Core0xae0C4a3432b18d9C65e1544a7669d9De44927ff9
Oracle Aggregator0x0b56a61d817E215d6F6dC7B461BE2e5b0ca3716b
Uniwhale Genesis Pass0x3D8cE31601b8ED4Db5eEB921FCF7f178bABE7C2E
diff --git a/execution.md b/execution.md index d2067cf..3b2c784 100644 --- a/execution.md +++ b/execution.md @@ -22,13 +22,13 @@ You can add and remove margins to outstanding positions. When margins are update ## Order type supported -You can trade either Market Order or (coming soon) Market Limit Order. Both order types can also have either Stop Loss, Profit Target, or both. +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). -### (coming soon) Market Limit Order +### Market Limit Order Market limit orders are filled when the limit prices match the best price offered by the [Liquidity Pool](liquidity-pool.md). @@ -126,7 +126,7 @@ Closing a position will calculate the PnL based on the best price offered by the You can not lose more than the margin posted. -### (coming soon) Limit Price or Market Price +### Limit Price or Market Price Your execution price is deterministically calculated (see [Fee and Market Impact](execution.md#fee-and-market-impact)) based on the latest oracle price, but, especially during a fast moving market, there can be a gap between the screen price and the actual execution price (primarily due to changes in oracle price and outstanding positions on the platform). diff --git a/security/README.md b/security/README.md new file mode 100644 index 0000000..b176180 --- /dev/null +++ b/security/README.md @@ -0,0 +1,13 @@ +# Security + +Our Smart Contracts have been audited by the following security audit firms + +## Secure3 + +* [https://cdn.uniwhale.co/pdf/UniWhale\_final\_Secure3\_Audit\_Report.pdf](https://cdn.uniwhale.co/pdf/UniWhale\_final\_Secure3\_Audit\_Report.pdf) +* [https://cdn.uniwhale.co/pdf/UniWhaleP2\_final\_Secure3\_Audit\_Report.pdf](https://cdn.uniwhale.co/pdf/UniWhaleP2\_final\_Secure3\_Audit\_Report.pdf) + +## MetaTrust + +* [https://cdn.uniwhale.co/pdf/MetaScan\_Report\_Uniwhale.pdf](https://cdn.uniwhale.co/pdf/MetaScan\_Report\_Uniwhale.pdf) +* [https://cdn.uniwhale.co/pdf/MetaScan\_Report\_Uniwhale\_202303272132.pdf](https://cdn.uniwhale.co/pdf/MetaScan\_Report\_Uniwhale\_202303272132.pdf) diff --git a/security/early-warning-and-timelock.md b/security/early-warning-and-timelock.md new file mode 100644 index 0000000..0bdbc33 --- /dev/null +++ b/security/early-warning-and-timelock.md @@ -0,0 +1,11 @@ +# Early Warning and TimeLock + +
+ +Uniwhale formed a strategic security partnership with [Ancilia, Inc.](https://www.ancilia.ai/), a Web3 cybersecurity company, whereby both sides work closely to protect our assets and community from various known and unknown threats, using Ancilia's SaaS platform that provides web3 early-warning intelligence and preventive solutions to protocols like Uniwhale. + +Under the terms of the partnership, Ancilia monitors and provides early warning for any suspicious activities on all transactions on BNB Smart Chain and Arbitrum by any smart contracts owned and operated by Uniwhale. + +This will be combined with a TimeLock smart contract which prevents a potential attacker from withdrawing from the protocol. + +The combination of the early warning intelligence and the TimeLock smart contract thus protects our community from substantial unauthorized or exploit-driven withdrawals from the protocol. diff --git a/tokenomics/comparison-of-unw-and-esunw.md b/tokenomics/comparison-of-unw-and-esunw.md index 42db3c9..c46c2de 100644 --- a/tokenomics/comparison-of-unw-and-esunw.md +++ b/tokenomics/comparison-of-unw-and-esunw.md @@ -2,13 +2,7 @@ Given the nature of [esUNW](esunw-the-governance-token.md), its holders are subject to a higher percentage of the value accrued and the token emission, compared to [UNW](unw-the-utility-token.md). -| | esUNW | UNW | -| --------------------------------------------------- | --------------------------------------------------- | ---------------------------------- | -|

Platform Revenue Share
(Staking Required)

| 40% | - | -|

Emission Share
(Staking Required)

| 15% | 5% | -| Governance | Yes | No | -| Transferrable / Tradable | No | Yes | -| Note | Can be locked to vest to UNW over 6 months linearly | Can be converted to esUNW any time | +
esUNWUNW
Platform Revenue Share
(Staking Required)		40%-
Emission Share
(Staking Required)		15%5%
GovernanceYesNo
Transferrable / TradableNoYes
NoteCan be locked to vest to UNW over 6 months linearlyCan be converted to esUNW any time
## How to convert esUNW to UNW? diff --git a/tokenomics/platform-revenue-distribution.md b/tokenomics/platform-revenue-distribution.md index 573b780..88a9a12 100644 --- a/tokenomics/platform-revenue-distribution.md +++ b/tokenomics/platform-revenue-distribution.md @@ -4,22 +4,13 @@ Subject to governance, 100% of the revenue generated on the platform may be distributed to our community. The current distribution percentage is as follows. -| | % of Distribution | -| -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -| Staked ULP ([Reinvested](https://snapshot.org/#/uniwhaleex.eth/proposal/0xc6feb05327d484ee9f6917be3ef77a96d9a234d53c76b88106886d2b2d03a47e)) | 50% | -| Staked esUNW | 40% | -| Reserve Fund | 10% | +
% of Distribution
Staked ULP (Reinvested)50%
Staked esUNW40%
Reserve Fund10%
### Token Emission All emissions are in esUNW, with a few exceptions including rewards provided to external partners. -| | Daily Emission (approx.) | % of Emission | -| -------------- | ------------------------ | ------------- | -| Trade and Earn | 36,140 esUNW | 65% | -| Staked ULP | 8,340 esUNW | 15% | -| Staked esUNW | 8,340 esUNW | 15% | -| Staked UNW | 2,780 esUNW | 5% | +
Daily Emission (approx.)% of Emission
Trade and Earn36,140 esUNW65%
Staked ULP8,340 esUNW15%
Staked esUNW8,340 esUNW15%
Staked UNW2,780 esUNW5%
#### APR diff --git a/tokenomics/token-distribution.md b/tokenomics/token-distribution.md index 6330191..420d202 100644 --- a/tokenomics/token-distribution.md +++ b/tokenomics/token-distribution.md @@ -1,9 +1,3 @@ # Token Distribution -| | Amount | % of Max Supply | -| ---------------------------- | ---------- | --------------- | -| Airdrop | 10,000,000 | 10% | -| Emission Rewards | 40,000,000 | 40% | -| Liquidity | 10,000,000 | 10% | -| Reserve Fund | 20,000,000 | 20% | -| Team, advisor, and marketing | 20,000,000 | 20% | +
Amount% of Max Supply
Airdrop10,000,00010%
Emission Rewards40,000,00040%
Liquidity10,000,00010%
Reserve Fund20,000,00020%
Team, advisor, and marketing20,000,00020%
diff --git a/unique-oracle-design.md b/unique-oracle-design.md index cc250da..9186ac0 100644 --- a/unique-oracle-design.md +++ b/unique-oracle-design.md @@ -20,8 +20,8 @@ Uniwhale uses [Pyth Network](https://pyth.network) for its oracle prices. Pyth N Pyth Network is different from many other oracles in that it uses ["on-demand" price update model](https://docs.pyth.network/consume-data/on-demand), whose advantages over the more traditional "push" model, among many, we like are: -* Gas efficiency: **** On-chain prices are only updated when they are needed. -* High update frequency: **** Pyth Network price feeds update once per second, which is faster than the blocktime of most blockchains. +* Gas efficiency: On-chain prices are only updated when they are needed. +* High update frequency: Pyth Network price feeds update once per second, which is faster than the blocktime of most blockchains. * Low latency: Every transaction can use a recent off-chain price, instead of relying on the last on-chain update pushed by the oracle itself. * Reliable in volatile conditions: On-demand model does not fail to land price updates in volatile market conditions, because price updates are incorporated into the valuable transactions themselves (and therefore can compete for bandwidth).