From 4f65af1c408220c2da5e1f8236a2e8eed8d9ac05 Mon Sep 17 00:00:00 2001 From: Steve Goodman <39279277+stoobie@users.noreply.github.com> Date: Sun, 10 Dec 2023 16:30:39 +0200 Subject: [PATCH 1/2] docs: Add table with list of bridged tokens (#1009) * Add table with list of bridged tokens * Removed TVL limitations from StarkGate overview. --- .../modules/tools/pages/starkgate-bridge.adoc | 38 +++++-------------- .../pages/starkgate-cancelling a deposit.adoc | 6 +-- .../pages/starkgate_function_reference.adoc | 1 - .../snippet_backwards_compatibiity_note.adoc | 2 +- 4 files changed, 13 insertions(+), 34 deletions(-) diff --git a/components/Starknet/modules/tools/pages/starkgate-bridge.adoc b/components/Starknet/modules/tools/pages/starkgate-bridge.adoc index 7a3166e6f5..b7c3594371 100644 --- a/components/Starknet/modules/tools/pages/starkgate-bridge.adoc +++ b/components/Starknet/modules/tools/pages/starkgate-bridge.adoc @@ -14,40 +14,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: +StarkGate supports many tokens, including ETH, WBTC, USDC, DAI, and many more. -[%autowidth.stretch,stripes=even] -|=== -| Token | Max total value locked - -| ETH -| 150,000 ETH - -| WBTC -| 200 WBTC - -| USDC -| 40,000,000 USDC - -| USDT -| 20,000,000 USDT +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[]. -| 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"] @@ -61,7 +44,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. diff --git a/components/Starknet/modules/tools/pages/starkgate-cancelling a deposit.adoc b/components/Starknet/modules/tools/pages/starkgate-cancelling a deposit.adoc index 3281782923..ef2f18f608 100644 --- a/components/Starknet/modules/tools/pages/starkgate-cancelling a deposit.adoc +++ b/components/Starknet/modules/tools/pages/starkgate-cancelling a deposit.adoc @@ -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 diff --git a/components/Starknet/modules/tools/pages/starkgate_function_reference.adoc b/components/Starknet/modules/tools/pages/starkgate_function_reference.adoc index b99fe861f9..253baed5db 100644 --- a/components/Starknet/modules/tools/pages/starkgate_function_reference.adoc +++ b/components/Starknet/modules/tools/pages/starkgate_function_reference.adoc @@ -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 diff --git a/components/Starknet/modules/tools/partials/snippet_backwards_compatibiity_note.adoc b/components/Starknet/modules/tools/partials/snippet_backwards_compatibiity_note.adoc index f791aedd60..3759bb8b49 100644 --- a/components/Starknet/modules/tools/partials/snippet_backwards_compatibiity_note.adoc +++ b/components/Starknet/modules/tools/partials/snippet_backwards_compatibiity_note.adoc @@ -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. ==== \ No newline at end of file From 59e3c1bba3106cf09a6699f86ae64b947bc207ba Mon Sep 17 00:00:00 2001 From: Steve Goodman Date: Tue, 19 Dec 2023 13:54:42 +0200 Subject: [PATCH 2/2] Added StarkGate version/network to StarkGate Overview --- .../modules/tools/pages/starkgate-bridge.adoc | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/components/Starknet/modules/tools/pages/starkgate-bridge.adoc b/components/Starknet/modules/tools/pages/starkgate-bridge.adoc index b7c3594371..e1fd406c8e 100644 --- a/components/Starknet/modules/tools/pages/starkgate-bridge.adoc +++ b/components/Starknet/modules/tools/pages/starkgate-bridge.adoc @@ -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.