GitBook: [master] 46 pages and 88 assets modified

Mirror-Protocol · Jun 15, 2021 · 66435d2 · 66435d2
1 parent 586d64d
commit 66435d2
Show file tree

Hide file tree

Showing 122 changed files with 3,522 additions and 448 deletions.
diff --git a/.gitbook/assets/image (129).png b/.gitbook/assets/image (129).png
diff --git a/.gitbook/assets/image (130).png b/.gitbook/assets/image (130).png
diff --git a/.gitbook/assets/image (131).png b/.gitbook/assets/image (131).png
diff --git a/.gitbook/assets/image (132).png b/.gitbook/assets/image (132).png
diff --git a/.gitbook/assets/image (133).png b/.gitbook/assets/image (133).png
diff --git a/.gitbook/assets/image (134).png b/.gitbook/assets/image (134).png
diff --git a/.gitbook/assets/image (135).png b/.gitbook/assets/image (135).png
diff --git a/.gitbook/assets/image (136).png b/.gitbook/assets/image (136).png
diff --git a/.gitbook/assets/image (137).png b/.gitbook/assets/image (137).png
diff --git a/.gitbook/assets/image (138).png b/.gitbook/assets/image (138).png
diff --git a/.gitbook/assets/image (139).png b/.gitbook/assets/image (139).png
diff --git a/.gitbook/assets/image (140).png b/.gitbook/assets/image (140).png
diff --git a/.gitbook/assets/image (141).png b/.gitbook/assets/image (141).png
diff --git a/.gitbook/assets/image (142).png b/.gitbook/assets/image (142).png
diff --git a/.gitbook/assets/image (143).png b/.gitbook/assets/image (143).png
diff --git a/.gitbook/assets/image (144).png b/.gitbook/assets/image (144).png
diff --git a/.gitbook/assets/image (145).png b/.gitbook/assets/image (145).png
diff --git a/.gitbook/assets/image (146).png b/.gitbook/assets/image (146).png
diff --git a/.gitbook/assets/image (147).png b/.gitbook/assets/image (147).png
diff --git a/.gitbook/assets/image (148).png b/.gitbook/assets/image (148).png
diff --git a/.gitbook/assets/image (149).png b/.gitbook/assets/image (149).png
diff --git a/.gitbook/assets/image (150).png b/.gitbook/assets/image (150).png
diff --git a/.gitbook/assets/image (151).png b/.gitbook/assets/image (151).png
diff --git a/.gitbook/assets/image (152).png b/.gitbook/assets/image (152).png
diff --git a/.gitbook/assets/image (153).png b/.gitbook/assets/image (153).png
diff --git a/.gitbook/assets/image (154).png b/.gitbook/assets/image (154).png
diff --git a/.gitbook/assets/image (155).png b/.gitbook/assets/image (155).png
diff --git a/.gitbook/assets/image (156).png b/.gitbook/assets/image (156).png
diff --git a/.gitbook/assets/image (157).png b/.gitbook/assets/image (157).png
diff --git a/.gitbook/assets/image (158).png b/.gitbook/assets/image (158).png
diff --git a/.gitbook/assets/image (159).png b/.gitbook/assets/image (159).png
diff --git a/.gitbook/assets/image (160).png b/.gitbook/assets/image (160).png
diff --git a/.gitbook/assets/image (161).png b/.gitbook/assets/image (161).png
diff --git a/.gitbook/assets/image (162).png b/.gitbook/assets/image (162).png
diff --git a/.gitbook/assets/image (163).png b/.gitbook/assets/image (163).png
diff --git a/.gitbook/assets/image (164).png b/.gitbook/assets/image (164).png
diff --git a/.gitbook/assets/image (165).png b/.gitbook/assets/image (165).png
diff --git a/.gitbook/assets/image (166).png b/.gitbook/assets/image (166).png
diff --git a/.gitbook/assets/image (167).png b/.gitbook/assets/image (167).png
diff --git a/.gitbook/assets/image (168).png b/.gitbook/assets/image (168).png
diff --git a/.gitbook/assets/image (169).png b/.gitbook/assets/image (169).png
diff --git a/.gitbook/assets/image (170).png b/.gitbook/assets/image (170).png
diff --git a/.gitbook/assets/image (171).png b/.gitbook/assets/image (171).png
diff --git a/.gitbook/assets/image (172).png b/.gitbook/assets/image (172).png
diff --git a/.gitbook/assets/image (173).png b/.gitbook/assets/image (173).png
diff --git a/.gitbook/assets/image (174).png b/.gitbook/assets/image (174).png
diff --git a/.gitbook/assets/image (175).png b/.gitbook/assets/image (175).png
diff --git a/.gitbook/assets/image (176).png b/.gitbook/assets/image (176).png
diff --git a/.gitbook/assets/image (177).png b/.gitbook/assets/image (177).png
diff --git a/.gitbook/assets/image (178).png b/.gitbook/assets/image (178).png
diff --git a/.gitbook/assets/image (179).png b/.gitbook/assets/image (179).png
diff --git a/.gitbook/assets/image (180).png b/.gitbook/assets/image (180).png
diff --git a/.gitbook/assets/image (181).png b/.gitbook/assets/image (181).png
diff --git a/.gitbook/assets/image (182).png b/.gitbook/assets/image (182).png
diff --git a/.gitbook/assets/image (183).png b/.gitbook/assets/image (183).png
diff --git a/.gitbook/assets/image (184).png b/.gitbook/assets/image (184).png
diff --git a/.gitbook/assets/image (185).png b/.gitbook/assets/image (185).png
diff --git a/.gitbook/assets/image (186).png b/.gitbook/assets/image (186).png
diff --git a/.gitbook/assets/image (187).png b/.gitbook/assets/image (187).png
diff --git a/.gitbook/assets/image (188).png b/.gitbook/assets/image (188).png
diff --git a/.gitbook/assets/image (189).png b/.gitbook/assets/image (189).png
diff --git a/.gitbook/assets/image (190).png b/.gitbook/assets/image (190).png
diff --git a/.gitbook/assets/image (191).png b/.gitbook/assets/image (191).png
diff --git a/.gitbook/assets/image (192).png b/.gitbook/assets/image (192).png
diff --git a/.gitbook/assets/image (193).png b/.gitbook/assets/image (193).png
diff --git a/.gitbook/assets/image (194).png b/.gitbook/assets/image (194).png
diff --git a/.gitbook/assets/image (195).png b/.gitbook/assets/image (195).png
diff --git a/.gitbook/assets/image (196).png b/.gitbook/assets/image (196).png
diff --git a/.gitbook/assets/image (197).png b/.gitbook/assets/image (197).png
diff --git a/.gitbook/assets/image (198).png b/.gitbook/assets/image (198).png
diff --git a/.gitbook/assets/image (199).png b/.gitbook/assets/image (199).png
diff --git a/.gitbook/assets/image (200).png b/.gitbook/assets/image (200).png
diff --git a/.gitbook/assets/image (201).png b/.gitbook/assets/image (201).png
diff --git a/.gitbook/assets/image (202).png b/.gitbook/assets/image (202).png
diff --git a/.gitbook/assets/image (203).png b/.gitbook/assets/image (203).png
diff --git a/.gitbook/assets/image (204).png b/.gitbook/assets/image (204).png
diff --git a/.gitbook/assets/image (205).png b/.gitbook/assets/image (205).png
diff --git a/.gitbook/assets/image (206).png b/.gitbook/assets/image (206).png
diff --git a/.gitbook/assets/image (207).png b/.gitbook/assets/image (207).png
diff --git a/.gitbook/assets/image (208).png b/.gitbook/assets/image (208).png
diff --git a/.gitbook/assets/image (209).png b/.gitbook/assets/image (209).png
diff --git a/.gitbook/assets/image (210).png b/.gitbook/assets/image (210).png
diff --git a/.gitbook/assets/image (211).png b/.gitbook/assets/image (211).png
diff --git a/.gitbook/assets/image (212).png b/.gitbook/assets/image (212).png
diff --git a/.gitbook/assets/image (213).png b/.gitbook/assets/image (213).png
diff --git a/.gitbook/assets/image (214).png b/.gitbook/assets/image (214).png
diff --git a/.gitbook/assets/image (215).png b/.gitbook/assets/image (215).png
diff --git a/.gitbook/assets/image (216).png b/.gitbook/assets/image (216).png
diff --git a/README.md b/README.md
@@ -10,13 +10,15 @@ Welcome to the Mirror documentation site.
 
 The minting of mAssets is decentralized and is undertaken by users throughout the network by opening a position and depositing collateral. Mirror ensures that there is always sufficient collateral within the protocol to cover mAssets, and also manages markets for mAssets by listing them on [Terraswap](protocol/terraswap.md) against UST.
 
-The [Mirror Token \(MIR\)](protocol/mirror-token-mir.md) is minted by the protocol and distributed as a reward to reinforce behavior that secures the ecosystem. With it, Mirror ensures liquid mAsset markets by rewarding MIR to users who stake [LP Tokens](protocol/lp-token.md) obtained through providing liquidity. MIR is valuable as it is can be staked to receive voting privileges and to earn a share of the protocol's CDP withdrawal fees.
+The [Mirror Token \(MIR\)](protocol/mirror-token-mir.md) is minted by the protocol and distributed as a reward to reinforce behavior that secures the ecosystem. With it, Mirror ensures liquid mAsset markets by rewarding MIR to users who stake [LP Tokens](protocol/staking-tokens-lp-and-slp.md#lp-tokens) obtained through providing liquidity. Also to incentivize users to ensure mAssets to mimic the price behavior of real-world assets, users who stake sLP Tokens obtained through shorting mAssets are rewarded with MIR.MIR is valuable as it is can be staked to receive voting privileges and to earn a share of the protocol's CDP withdrawal fees.
 
 Mirror is a project developed and steered by its community: its markets are maintained by its own users through MIR incentives, and the protocol evolves with new ideas through democratic [governance](protocol/governance/).
 
 ## Learn More
 
-* Read the [whitepaper](https://docsend.com/view/kcsm42mqiyu5t6ej)
+* Read the whitepaper
+  * [Version 1](https://docsend.com/view/kcsm42mqiyu5t6ej)
+  * [Version 2](https://mirror.finance/Mirror_Protocol_v2.pdf)
 * Understand the [protocol](protocol/synopsis.md)
 * Read the[ core smart contracts](contracts/architecture.md)
 

diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,6 +1,7 @@
 # Table of contents
 
 * [Home](README.md)
+* [What's new for Mirror v2?](whats-new-for-mirror-v2.md)
 * [Interchain Access](networks.md)
 * [Security](security.md)
 * [FAQ](faq.md)
@@ -11,10 +12,12 @@
 * [Mirrored Assets \(mAssets\)](protocol/mirrored-assets-massets.md)
 * [Mirror Token \(MIR\)](protocol/mirror-token-mir.md)
 * [Terraswap](protocol/terraswap.md)
-* [LP Tokens](protocol/lp-token.md)
+* [Staking Tokens \(LP & sLP\)](protocol/staking-tokens-lp-and-slp.md)
 * [Governance](protocol/governance/README.md)
   * [Proposal Types](protocol/governance/proposal-types.md)
   * [Whitelist Procedure](protocol/governance/whitelist-procedure.md)
+  * [Delist Procedure](protocol/governance/delist-procedure.md)
+  * [Pre-IPO Procedure](protocol/governance/pre-ipo-procedure.md)
   * [Modify Mint Parameters](protocol/governance/modify-mint-parameters.md)
   * [Modify Gov Parameters](protocol/governance/modify-gov-parameters.md)
   * [Community Grants](protocol/governance/community-grants.md)
@@ -31,10 +34,10 @@
 * [Web App](user-guide/getting-started/README.md)
   * [Sending Tokens](user-guide/getting-started/sending-tokens.md)
   * [Trade](user-guide/getting-started/trade.md)
-  * [Mint](user-guide/getting-started/mint-and-burn.md)
-  * [Pool](user-guide/getting-started/pool.md)
-  * [Stake](user-guide/getting-started/stake.md)
+  * [Borrow](user-guide/getting-started/mint-and-burn.md)
+  * [Farm](user-guide/getting-started/pool.md)
   * [Governance](user-guide/getting-started/governance.md)
+  * [Claim MIR Reward](user-guide/getting-started/claim-mir-reward.md)
 * [Mirror on Ethereum](user-guide/meth-dual-yield/README.md)
   * [Sending Tokens](user-guide/meth-dual-yield/sending-tokens.md)
   * [Trade](user-guide/meth-dual-yield/trade.md)
@@ -49,7 +52,9 @@
 * [Factory](contracts/factory.md)
 * [Gov](contracts/gov.md)
 * [Mint](contracts/mint.md)
+* [Lock](contracts/lock.md)
 * [Oracle](contracts/oracle.md)
+* [Collateral Oracle](contracts/collateral-oracle.md)
 * [Staking](contracts/staking.md)
 * [Limit Order](contracts/limit-order.md)
 

diff --git a/contracts/architecture.md b/contracts/architecture.md
@@ -2,8 +2,8 @@
 
 This section describes provides a high-level overview regarding the technical implementation of Mirror Protocol.
 
-{% hint style="warning" %}
-Even with a thorough understanding of Mirror Protocol, it is highly recommended to interact with Mirror through client channels such as the Mirror Web App or Mirror.js.
+{% hint style="info" %}
+Even with a thorough understanding of Mirror Protocol, it is highly recommended to interact with Mirror through client channels such as the [Mirror Web App](../user-guide/getting-started/) or [Mirror.js.](../developer-tools/mirror.js.md)
 {% endhint %}
 
 ## Smart Contracts
@@ -22,7 +22,7 @@ The source code for Mirror smart contracts can be found on [GitHub](https://gith
       <td style="text-align:left"><a href="collector.md">Collector</a>
       </td>
       <td style="text-align:left">Gathers protocol fees incurred from CDP withdrawals and liquidations and
-        sends to Gov</td>
+        send to Gov</td>
     </tr>
     <tr>
       <td style="text-align:left"><a href="community.md">Community</a>
@@ -39,23 +39,39 @@ The source code for Mirror smart contracts can be found on [GitHub](https://gith
       </td>
       <td style="text-align:left">
         <p>Allows other Mirror contracts to be controlled by decentralized governance</p>
-        <p>Distributes MIR received from Collector to MIR stakers</p>
+        <p>Distributes MIR received from Collector to MIR stakers and voters</p>
       </td>
     </tr>
     <tr>
       <td style="text-align:left"><a href="mint.md">Mint</a>
       </td>
-      <td style="text-align:left">Handles CDP creation, management and liquidation</td>
+      <td style="text-align:left">Handles both long and short CDP creation, management, and liquidation</td>
+    </tr>
+    <tr>
+      <td style="text-align:left"><a href="lock.md">Lock</a>
+      </td>
+      <td style="text-align:left">Responsible for locking up UST from short CDP</td>
     </tr>
     <tr>
       <td style="text-align:left"><a href="oracle.md">Oracle</a>
       </td>
-      <td style="text-align:left">Provides interface for oracle feeders to post prices for mAssets</td>
+      <td style="text-align:left">Provides an interface for oracle feeders to post prices for mAssets</td>
+    </tr>
+    <tr>
+      <td style="text-align:left"><a href="collateral-oracle.md">Collateral Oracle</a>
+      </td>
+      <td style="text-align:left">Feeds price and collateral <code>multiplier</code> for each collateral asset
+        type</td>
     </tr>
     <tr>
       <td style="text-align:left"><a href="staking.md">Staking</a>
       </td>
-      <td style="text-align:left">Distributes MIR rewards from block reward to LP stakers</td>
+      <td style="text-align:left">Distributes MIR rewards from block reward to LP and sLP stakers</td>
+    </tr>
+    <tr>
+      <td style="text-align:left"><a href="limit-order.md">Limit Order</a>
+      </td>
+      <td style="text-align:left">Registers and executes swap orders at submitted limit price and amount</td>
     </tr>
   </tbody>
 </table>
@@ -67,4 +83,5 @@ When new mAssets are whitelisted, Mirror Protocol will create the following cont
 * Terraswap CW20 Token for the new mAsset
 * Terraswap Pair for the new mAsset against UST
 * Terraswap CW20 Token for the new mAsset's LP Token
+* Terraswap CW20 Token for the new mAsset's sLP Token