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

Gateway page improvements #518

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+26 −3
Open

Gateway page improvements #518

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3cf325d
Gateway page improvements
fadeev Dec 9, 2024
7c51a66
revert handling
fadeev Dec 12, 2024
4552342
update diagram
fadeev Dec 16, 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
29 changes: 26 additions & 3 deletions src/pages/developers/evm/gateway.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Gateway is an interface that serves as a unified entry point for interactions
between contracts on connected chains and universal apps on ZetaChain.

<iframe
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Figma diagram looks really cool, I'm wondering if they have any query params or options to remove the footer of the diagram that redirects to the actual Figma page, for one I don't think "Untitled" is a very fitting name.

image

But I also don't think it makes sense to display the names of the core contributors that are currently viewing the file.

image

style={{ border: "1px solid rgba(0,0,0,.1)", marginTop: "2rem", borderRadius: "0.5rem" }}
width="800"
height="450"
src="https://embed.figma.com/design/mYXNTORUuvGVaQ01SF7h9Y/Untitled?node-id=0-1&embed-host=share"
allowfullscreen
></iframe>
Comment on lines +4 to +10
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance iframe accessibility and styling

The Figma embed should include accessibility attributes and consider moving styles to a CSS file.

 <iframe
+  title="Gateway Interface Design"
   style={{ border: "1px solid rgba(0,0,0,.1)", marginTop: "2rem", borderRadius: "0.5rem" }}
   width="800"
   height="450"
   src="https://embed.figma.com/design/mYXNTORUuvGVaQ01SF7h9Y/Untitled?node-id=0-1&embed-host=share"
   allowfullscreen
 ></iframe>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<iframe
style={{ border: "1px solid rgba(0,0,0,.1)", marginTop: "2rem", borderRadius: "0.5rem" }}
width="800"
height="450"
src="https://embed.figma.com/design/mYXNTORUuvGVaQ01SF7h9Y/Untitled?node-id=0-1&embed-host=share"
allowfullscreen
></iframe>
<iframe
title="Gateway Interface Design"
style={{ border: "1px solid rgba(0,0,0,.1)", marginTop: "2rem", borderRadius: "0.5rem" }}
width="800"
height="450"
src="https://embed.figma.com/design/mYXNTORUuvGVaQ01SF7h9Y/Untitled?node-id=0-1&embed-host=share"
allowfullscreen
></iframe>


## Gateway on Connected Chains

The gateway on connected chains (like Ethereum, Solana and Bitcoin) facilitates
Expand Down Expand Up @@ -28,13 +36,18 @@ Gateway supports the following features:
data passing) to a universal app
- making a contract call (with arbitrary data passing) to a universal app

These features may vary depending on each specific connected chain. For example,
deposits from Bitcoin can only be made in native gas token (BTC). And deposits
from Solana can be made in SOL and (soon) SPL tokens.
[These features may vary](/developers/chains/functionality) depending on each
specific connected chain. For example, deposits from Bitcoin can only be made in
native gas token (BTC). And deposits from Solana can be made in SOL and (soon)
SPL tokens.

Currently, only one asset can be deposited at a time to a universal app. Support
for multi-asset deposits will be added in the future updates to the protocol.

Learn more about Gateway functionality on connected chains:
[EVM](/developers/chains/evm), [Solana](/developers/chains/solana),
[Bitcoin](/developers/chains/bitcoin).

## Gateway on ZetaChain

Gateway on ZetaChain facilitates outgoing transactions: calls and token
Expand All @@ -50,3 +63,13 @@ Gateway supports the following features:
Currently, only one asset can be withdrawn at a time from a universal app.
Support for multi-asset withdrawals will be added in the future updates to the
protocol.

Learn more about [ZetaChain Gateway](/developers/chains/zetachain).

## Revert Handling

The Gateway supports handling reverts during cross-chain operations with
flexible refund mechanisms. If a Gateway call fails on the destination chain,
refunds can either be issued by calling a specified contract on the source chain
or sent directly to an externally owned account (EOA) without invoking any
contract.
Loading