PoS: Edit Staking doc and move out of "modules"

nadimkobeissi · nadimkobeissi · commit d5f558f7570e · 2023-12-05T11:31:12.000+01:00
diff --git a/docs/img/pos/stake-management-flow.svg b/docs/img/pos/stake-management-flow.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="601px" height="415px" viewBox="-0.5 -0.5 601 415" content="&lt;mxfile host=&quot;app.diagrams.net&quot; modified=&quot;2020-04-02T11:15:48.384Z&quot; agent=&quot;5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36&quot; etag=&quot;FClCnyLufyAuNvoFMSjE&quot; version=&quot;12.9.6&quot; type=&quot;google&quot;&gt;&lt;diagram id=&quot;-wkQukztVd70p-urQbr5&quot; name=&quot;Page-1&quot;&gt;3Vpbc+MmFP41ntk+NCMjS7Ye48Td7czuTGbSaeu+YQtLJEioCMd2f30PElgXFF8SX5L1S+CAAH3fuXGUnnuXrL8KnMU/eEhYDznhuufe9xDqo2AEf5RkU0qGIy2IBA31pErwSP8jWuho6ZKGJG9MlJwzSbOmcM7TlMxlQ4aF4KvmtAVnzV0zHBFL8DjHzJb+RUMZl9IRGlbyb4RGsdm57wflSILNZP0meYxDvqqJ3EnPvROcy7KVrO8IU+AZXMrnfntldHswQVJ5yAOTp+n0Xy94nhLvH7zOKBovgl8NzC+YLfUb69PKjYEgEnyZ2bvpA7wQIcm6iws8MytUrwt6QnhCpNjAPPOUp1VCqwga6EOtKsAHgZbFNbBHWoY1x9F26QoGaGgkjkGl/2ZUdqP8dqyuhwXajwVAkYZEreL03PEqppI8ZniuRlfgFkAWywR2ve9D81DMXtOvj4SN24GNz2Db8QwakWqAd0hCrNYqB2Cj7ZgFJLypbKKVS8GfyR1nXIAk5SnMHC8oYy0RZjRKoTsHVAnIxwo3Cn7sVg8kNAzVNp30NAk8PUNmdNAwdGP3df466ENno29wYjM/mUt0faeBVN/2iH3UAZV/Nqi8K3mBwSuQ7vQCF8bGt7B5lPiZphEIISNaAkCf29APJ2HdNNlNs1ujaHRRQw8sAkgIaZ7uciFjHvEUs0klbUH1tEwyM18zUT32nfNM0/hEpNzoNBYvJW+STNZU/q1XVO2pat+4rZ8evF/XZt5vap0HIiggo+gvZSmgVKx745nu1GypOtVSRc+s1dS5HnKd4tepGdqR5Xwp5mQH1oZEiUVEdmqVdimKiZ06JQjDkr40E/KT6wiyM+E/wdZCLAGctvZALp+p5jJht3M1oTLD73hG2APPqaRcmeOMS8kTmMDUwBjPn6NCs2qoL4pfhylLvtdrHh2Dhy3bdD3bON1Luk9kJ9voBvo19EsVAFsEtRI4zfG8ABc5X6rsyvmjGvnl0/jbo+nbJriGvlFHajDyL+hcTSZwxtTg+ESzdaUcdKA0CJCNUt85F0yu7V+su8JExkSQZQJ9nChU0lmeFYh84rvD8eQN3QZ53rXvCa737vThPblCGdN1tmBGXkkO3pgIvD3cu6Yoty/cu+jU4b549FYIvKlNyDhNZV5b+UEJajerVvjz21Wz1nxvuHM+NMoTVNq1fZV3KNwB9adLu1TUupIOAt8OPBe9dxmN+kgoef0Ph5Jdo1K3U/IDpzgi4ibn7OcNJSgImqHE3ASvFkrskpOuFfyeLvjPTYbnOS0ybNu4LBl24aavbh6ThKoQ4pAXUoQCqq4aFk3ObFMQBbbUU597CnM6A3uMLOTVuWsXJH3XTqhRl187G3n+Ad7/3F+ukNd0L+6w4zJ2UZU2NF0pVW2UtUzaelyqWiWn3alqiPO4OOsRVWSjK3uzWVOT2pvNGmX7IMUrv6uG4lVFFJLXXBX0MfxZCJ6oV11/A0TVoVJVX2EcXFwIZvFZwtBu53DcZ4MTmSp0q8/65Z2g+ucId/I/&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="0" y="0" width="490" height="80" fill="#ffffff" stroke="#000000" pointer-events="all"/><rect x="14" y="58" width="40" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 38px; height: 1px; padding-top: 68px; margin-left: 15px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; "><b>Heimdall</b></div></div></div></foreignObject><text x="34" y="72" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">Heimda...</text></switch></g><rect x="360" y="10" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="all"/><rect x="380" y="30" width="80" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 40px; margin-left: 381px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">Staking Module</div></div></div></foreignObject><text x="420" y="44" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">Staking Module</text></switch></g><path d="M 562 130 L 420 130 L 420 76.37" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 420 71.12 L 423.5 78.12 L 420 76.37 L 416.5 78.12 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><ellipse cx="577" cy="117.5" rx="7.5" ry="7.5" fill="#ffffff" stroke="#000000" pointer-events="all"/><path d="M 577 125 L 577 150 M 577 130 L 562 130 M 577 130 L 592 130 M 577 150 L 562 170 M 577 150 L 592 170" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe flex-start; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 177px; margin-left: 577px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; background-color: #ffffff; white-space: nowrap; ">Validator</div></div></div></foreignObject><text x="577" y="189" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">Valid...</text></switch></g><rect x="332" y="140" width="186" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 184px; height: 1px; padding-top: 150px; margin-left: 333px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">2. Validator related transaction (Heimdall Transaction)</div></div></div></foreignObject><text x="425" y="154" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">2. Validator related transactio...</text></switch></g><rect x="0" y="240" width="492" height="100" fill="#ffffff" stroke="#000000" pointer-events="all"/><rect x="15" y="318" width="40" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 38px; height: 1px; padding-top: 328px; margin-left: 16px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; "><b>Ethereum </b></div></div></div></foreignObject><text x="35" y="332" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">Ethere...</text></switch></g><path d="M 162 316 L 162 380 L 412 380 L 412 322.37" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 412 317.12 L 415.5 324.12 L 412 322.37 L 408.5 324.12 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="102" y="256" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="all"/><rect x="352" y="256" width="120" height="60" fill="#ffffff" stroke="#000000" pointer-events="all"/><rect x="141" y="279" width="40" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 38px; height: 1px; padding-top: 289px; margin-left: 142px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">StakeManager.sol</div></div></div></foreignObject><text x="161" y="293" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">StakeM...</text></switch></g><rect x="392" y="276" width="40" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 38px; height: 1px; padding-top: 286px; margin-left: 393px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">StakingInfo.sol</div></div></div></foreignObject><text x="412" y="290" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">Stakin...</text></switch></g><rect x="202" y="390" width="220" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 218px; height: 1px; padding-top: 400px; margin-left: 204px;"><div style="box-sizing: border-box; font-size: 0; text-align: left; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">1. Emits event in StakingInfo.sol by stake manager</div></div></div></foreignObject><text x="204" y="404" fill="#000000" font-family="Helvetica" font-size="12px">1. Emits event in StakingInfo.sol by...</text></switch></g><path d="M 360 40 L 246 40 L 246 233.63" fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="3 3" pointer-events="stroke"/><path d="M 246 238.88 L 242.5 231.88 L 246 233.63 L 249.5 231.88 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="101" y="130" width="140" height="20" fill="none" stroke="none" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject style="overflow: visible; text-align: left;" pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 138px; height: 1px; padding-top: 140px; margin-left: 102px;"><div style="box-sizing: border-box; font-size: 0; text-align: center; "><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: #000000; line-height: 1.2; pointer-events: all; white-space: normal; word-wrap: normal; ">2.5 Validates stake data from txHash and logIndex</div></div></div></foreignObject><text x="171" y="144" fill="#000000" font-family="Helvetica" font-size="12px" text-anchor="middle">2.5 Validates stake dat...</text></switch></g></g><switch><g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/><a transform="translate(0,-5)" xlink:href="https://desk.draw.io/support/solutions/articles/16000042487" target="_blank"><text text-anchor="middle" font-size="10px" x="50%" y="100%">Viewer does not support full SVG 1.1</text></a></switch></svg>
diff --git a/docs/pos/architecture/heimdall/staking.md b/docs/pos/architecture/heimdall/staking.md
@@ -4,7 +4,7 @@ Staking module manages validator related transactions and state for Heimdall. No
 
 ## Messages
 
-<img src="img/pos/stake-management-flow.svg" />
+![](../../../img/pos/stake-management-flow.svg)
 
 ### MsgValidatorJoin
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -257,14 +257,14 @@ nav:
             - Governance: pos/architecture/heimdall/governance.md
             - Key management: pos/architecture/heimdall/key-management.md
             - Stdtx: pos/architecture/heimdall/stdtx.md
+            - Staking: pos/architecture/heimdall/staking.md
             - Modules:
               - Modules: pos/architecture/heimdall/modules/index.md
               - Ante handler: pos/architecture/heimdall/modules/antehandler.md
               - Auth: pos/architecture/heimdall/modules/auth.md
               - Bank: pos/architecture/heimdall/modules/bank.md
               - Bor: pos/architecture/heimdall/modules/bor.md
               - Chain manager: pos/architecture/heimdall/modules/chain-manager.md
-              - Staking: pos/architecture/heimdall/modules/staking.md
               - Topup: pos/architecture/heimdall/modules/topup.md
             - FAQ: pos/architecture/heimdall/faq.md
       - Specification:
