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

docs: Remove TVL limits #1030

Merged
merged 2 commits into from
Dec 19, 2023
Merged

docs: Remove TVL limits #1030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f65af1
docs: Add table with list of bridged tokens (#1009)
stoobie Dec 10, 2023
59e3c1b
Added StarkGate version/network to StarkGate Overview
stoobie Dec 19, 2023
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
52 changes: 22 additions & 30 deletions components/Starknet/modules/tools/pages/starkgate-bridge.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
[id="starkgate_token_bridge"]
= StarkGate bridge overview

StarkGate, developed by StarkWare, bridges ETH and ERC-20 tokens between Ethereum and Starknet. Each supported token is associated with an L1 and L2 bridge contract that communicates via Starknet's messaging mechanism.
A bridge enables you to fund your L2 wallet with ETH and ERC-20 tokens that reside on L1.

StarkGate, developed by StarkWare, bridges ETH and ERC-20 tokens between Ethereum and Starknet. Each supported token is associated with an L1 and L2 bridge contract that communicates using Starknet's messaging mechanism.

To use StarkGate, go to https://starkgate.starknet.io.

A bridge enables you to fund your L2 wallet with ETH and ERC-20 tokens that reside on L1.
.StarkGate version in each environment
[%autowidth.stretch]
|===
|Environment |StarkGate version

|Mainnet| Alpha
|Goerli Testnet| 2.0
|Sepolia Testnet| Alpha
|===

The terms _deposit_, _transact_, and _transfer_ refer to various operations involving a bridge, even though ETH and ERC-20 tokens never actually leave Ethereum.

Expand All @@ -14,40 +24,23 @@ include::partial$snippet_backwards_compatibiity_note.adoc[]
[#starkgate_supported_tokens]
== Supported tokens in StarkGate

In order to reduce the risks involved in using an Alpha version, StarkGate Alpha on Mainnet has limitations regarding the deposit amount and total value locked in the L1 bridge contract:

[%autowidth.stretch,stripes=even]
|===
| Token | Max total value locked
StarkGate supports many tokens, including ETH, WBTC, USDC, DAI, and many more.

| ETH
| 150,000 ETH
For a comprehensive list of tokens that StarkGate supports, see the JSON files in the Starknet Github repository shown in the table xref:#table_StarkGate_token_addresses[].

| WBTC
| 200 WBTC

| USDC
| 40,000,000 USDC

| USDT
| 20,000,000 USDT

| DAI
| 5,000,000 DAI

| rETH
| 10,000 rETH

| wstETH
| 5,000 wstETH
[#table_StarkGate_token_addresses]
.StarkGate bridged tokens
|===
| Network | StarkGate bridged tokens JSON file

| Mainnet | link:https://github.com/starknet-io/starknet-addresses/blob/master/bridged_tokens/mainnet.json[mainnet.json]
| Sepolia testnet | link:https://github.com/starknet-io/starknet-addresses/blob/master/bridged_tokens/sepolia.json[sepolia.json]
| Goerli testnet (deprecated) | https://github.com/starknet-io/starknet-addresses/blob/master/bridged_tokens/goerli.json[goerli.json]
|===

[NOTE]
====
StarkWare plans to gradually ease these limitations and lift them completely, as confidence grows.

Changes will be updated here.
Previously, StarkGate placed limitations for each supported token on the amount that could be deposited and the total value locked in the L1 bridge contract on Mainnet. These limits have been removed.
====

[id="l1l2_transfer_deposit"]
Expand All @@ -61,7 +54,6 @@ Changes will be updated here.
. The function does the following:
+
--
* Checks that the funds transferred are within the Alpha xref:starkgate-bridge.adoc#starkgate_alpha_limitations[limitations].
* Transfers the funds from the user's account to the Starknet bridge.
* Emits a `Deposit` event that includes the L1 and L2 addresses of the user, and the amount deposited.
* Sends a message to the corresponding L2 bridge with the amount deposited, and the recipient's address.
Expand Down
6 changes: 2 additions & 4 deletions components/Starknet/modules/tools/pages/starkgate-cancelling a deposit.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ When StarkGate receives the cancellation request, a counter begins to count five

[NOTE]
====
As long as the `depositReclaim` was not performed, the deposit may be processed, even if
the cancellation delay time has already passed.
As long as the `depositReclaim` is not performed, the deposit can be processed, even if the cancellation delay time has already passed.

Only the depositor is allowed to cancel
a deposit, and only before depositReclaim was performed.
Only the depositor is allowed to cancel a deposit, and only before `depositReclaim` is performed.
====

== Additional resources
Expand Down
1 change: 0 additions & 1 deletion components/Starknet/modules/tools/pages/starkgate_function_reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ Deposits the specified amount of an ERC-20 token to the L1 StarkGate bridge cont

The deposit function does the following:

* Checks that the funds transferred are within the xref:starkgate-bridge.adoc#starkgate_alpha_limitations[Starknet Alpha limitations]
* Transfers the funds from the caller's account to the Starknet bridge contract
* Emits the `Deposit` event with the sender's address on L1, the recipient's address on L2, and the amount

Expand Down
2 changes: 1 addition & 1 deletion ...onents/Starknet/modules/tools/partials/snippet_backwards_compatibiity_note.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[NOTE]
====
StarkGate provides a contract that enables seamless backward compatibility with the previous version of StarkGate.
StarkGate 2.0 provides a contract that enables seamless backward compatibility with the previous version of StarkGate.

When you update the code in your contract, make sure that you use the most up-to-date versions of all StarkGate contracts.
====
Loading