Skip to content

Commit

Permalink
Adding or updating preview build for PR: 1474
Browse files Browse the repository at this point in the history
  • Loading branch information
Hodor The Master committed Jan 10, 2025
1 parent d4c22c0 commit cbb211c
Show file tree
Hide file tree
Showing 12 changed files with 248 additions and 91 deletions.
2 changes: 1 addition & 1 deletion pr-1474/search-index.js

Large diffs are not rendered by default.

178 changes: 89 additions & 89 deletions pr-1474/sitemap.xml

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions pr-1474/staking/architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
<h1 class="page">Staking Architecture</h1>
<div id="preamble">
<div class="sectionbody">
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Staking on Starknet is designed to enhance network security and decentralization by allowing users to stake their STRK tokens directly or delegate them to other validators. The architecture is modular, with different contracts handling specific responsibilities to ensure flexibility, security, and ease of upgrades. For more details on the staking architecture, visit the following link: <a href="https://github.com/starkware-libs/starknet-staking">Starknet Staking Repository</a>.</p>
</div>
Expand Down
17 changes: 17 additions & 0 deletions pr-1474/staking/claiming-rewards/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
</aside>
<article class="doc">
<h1 class="page">Claiming Rewards</h1>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Staking rewards on Starknet accumulate over time as your staked STRK tokens contribute to network security. To claim these rewards, you need to interact with the staking contract (if you are a validator) or the specific delegation pooling contract associated with the validator you have staked with (if you are a delegator) and execute the appropriate functions.</p>
</div>
Expand Down
17 changes: 17 additions & 0 deletions pr-1474/staking/delegating-stake/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
</aside>
<article class="doc">
<h1 class="page">Delegating Stake</h1>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Delegating your stake on Starknet involves adding your stake to a validator&#8217;s delegation pool managed by the staking contract. This approach offers the advantage of lower capital requirements and relieves you of the need to manage the operational aspects of staking, as the validator handles these responsibilities.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion pr-1474/staking/entering-staking/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ <h1 class="page">Becoming a Validator</h1>
</td>
<td class="content">
<div class="paragraph">
<p><strong>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now open!</strong></p>
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
Expand Down
17 changes: 17 additions & 0 deletions pr-1474/staking/exiting-staking/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
<h1 class="page">Exiting the Staking Protocol</h1>
<div id="preamble">
<div class="sectionbody">
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Exiting the staking protocol involves either unstaking your STRK tokens as a validator or undelegating your stake as a delegator. Both processes require you to first signal your intent to exit, followed by an action to finalize the process after a waiting period.</p>
</div>
Expand Down
17 changes: 17 additions & 0 deletions pr-1474/staking/increasing-staking/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
</aside>
<article class="doc">
<h1 class="page">Increasing Stake</h1>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>The staking and pooling contracts allow validators and delegators to increase their existing stake. Validators use the <code>increase_stake</code> function, which is called from the Staking contract, while delegators use the <code>add_to_delegation_pool</code> function, which is called from the delegation pooling contract. These functions add the specified amount of STRK tokens to the current stake, recalculate rewards before the staked amount is updated, and update the total staked amount.</p>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
<h1 class="page">Managing Staking and Delegation Operations</h1>
<div id="preamble">
<div class="sectionbody">
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>This guide outlines how both validators and delegators can manage various aspects of their staking and delegation activities on Starknet. Validators can perform operations such as opening delegation pools and updating commission rates. Delegators can manage their participation by changing their reward addresses associated with delegation pools.</p>
</div>
Expand Down
21 changes: 21 additions & 0 deletions pr-1474/staking/overview/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,27 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
</aside>
<article class="doc">
<h1 class="page">Staking Overview</h1>
<div id="preamble">
<div class="sectionbody">
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="introduction"><a class="anchor" href="#introduction"></a>Introduction</h2>
<div class="sectionbody">
Expand Down
17 changes: 17 additions & 0 deletions pr-1474/staking/staking-events-and-read-functions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
<h1 class="page">Staking Events and Read Functions</h1>
<div id="preamble">
<div class="sectionbody">
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Staking events provide critical information about changes in the staking process, such as balance updates, delegation pool creation, and exit intents. Read functions allow you to query important staking details. For a complete list of events and read functions, including keys and data, please refer to the official Starknet staking repository (<a href="https://github.com/starkware-libs/starknet-staking">Starknet Staking Repo</a>) and the spec file (<a href="https://github.com/starkware-libs/starknet-staking/blob/main/docs/spec.md">spec.md</a>).</p>
</div>
Expand Down
17 changes: 17 additions & 0 deletions pr-1474/staking/switching-delegation-pools/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,23 @@ <h3 class="title"><a href="../../">Starknet</a></h3>
</aside>
<article class="doc">
<h1 class="page">Switching Delegation Pools</h1>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
<div class="paragraph">
<p>The first ever <a href="https://56xbnnm18jz.typeform.com/validatorsurvey" target="_blank" rel="noopener">Starknet validator survey</a> is now live!</p>
</div>
<div class="paragraph">
<p>Make your voice heard and help improve Starknet and its ecosystem together 🤜🤛</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>Switching your delegated stake from one validator&#8217;s delegation pool to another allows you to optimize your staking strategy by moving your funds to a different validator. This process involves interacting with the <code>switch_delegation_pool</code> function in the delegation pooling contract, which coordinates with the staking contract to move your stake.</p>
</div>
Expand Down

0 comments on commit cbb211c

Please sign in to comment.