Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add Withdrawal limit to StarkGate architecture #1140

Merged
merged 5 commits into from
Feb 22, 2024
Merged

doc: Add Withdrawal limit to StarkGate architecture #1140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba8c8ba
chore(release): 0.1.483
Feb 21, 2024
3b20e7e
Update components/Starknet/modules/tools/pages/starkgate_architecture…
stoobie Feb 21, 2024
2410fe0
Apply suggestions from code review
stoobie Feb 21, 2024
84dbd3c
Add link to the setWithdrawLimitPCT function.
stoobie Feb 22, 2024
b865eff
Comment out link to setWithdrawLimitPCT
stoobie Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/Starknet/modules/tools/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
** xref:ref_block_explorers.adoc[Block explorers]
** xref:audit.adoc[Audit providers]

** StarkGate bridge developer's guide
** StarkGate bridge guide
*** xref:starkgate-bridge.adoc[Overview]
*** xref:starkgate_architecture.adoc[StarkGate architecture]
*** Procedures
Expand Down
15 changes: 14 additions & 1 deletion components/Starknet/modules/tools/pages/starkgate_architecture.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@ The _StarkGate Registry_::
* contains the addresses to all supported bridges
* enables a bridge developer to stop servicing an existing bridge

[#stark_gate_withdrawal_limit]
== Withdrawal limit

By default, StarkGate imposes no limit on withdrawals. However, in order to mitigate risks associated with critical vulnerabilities that could result in the loss of user funds, StarkGate can enable a withdrawal limit.

If a serious security issue arises, the security agent in the StarkGate contract can limit withdrawals to 5% of the Total Value Locked (TVL) per day for any affected token by calling the `setWithdrawLimitPCT()` function in the `WithdrawalLimit.sol` contract. A dedicated team can then investigate and resolve the issue.

Only a security admin quorum can disable the withdrawal limit. The quorum will consist of Starknet Foundation members, Starknet ecosystem contributors, and StarkWare representatives. This diverse group will ensure that decisions reflect the Starknet community's broad interests.

This approach, blending manual oversight with automated detection, aims to minimize potential losses.


== Additional resources

Expand All @@ -47,4 +58,6 @@ The _StarkGate Registry_::
** xref:starkgate_function_reference.adoc#getBridge[`getBridge`]
** xref:starkgate_function_reference.adoc#enrollTokenBridge[`enrollTokenBridge`]
** L1 contracts on Github
** L2 contracts on Github
** L2 contracts on Github
// Awaiting final URL.
// * link:https://github.com/starknet-io/starkgate-contracts/blob/d62a255307d2f3de65665f18316766a2c69ead78/src/solidity/WithdrawalLimit.sol#L20[`setWithdrawLimitPCT`] in `WithdrawalLimit.sol`
Loading