Skip to content

Commit

Permalink
docs: write FAQ and organize gitbook directories (#157)
Browse files Browse the repository at this point in the history
* chore: add gitbook config

* docs: add FAQ

* docs: move FAQ to about-yab directory

* docs: add SUMMARY.md

* docs: rename FAQ title

* docs: sort FAQ sections

* docs(about_yab): grammar update

* docs(about_yab): grammar update on cost section

* docs(faq): fix markdown lint
docs: edit supported sections zksync paragraph
docs: add x next to twitter and mention it is a group in telegram link

* docs(summary): update links and run lint

---------

Co-authored-by: Gian <[email protected]>
  • Loading branch information
JuArce and glpecile authored Feb 9, 2024
1 parent ffd8715 commit 45e2c40
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
root: ./docs/
10 changes: 10 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Summary

## About YAB

* [❓ FAQ](about_yab/FAQ.md)

## Links

* [Telegram Group](https://t.me/grindlabs)
* [Twitter/X](https://twitter.com/yanotherbridge)
46 changes: 46 additions & 0 deletions docs/about_yab/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# FAQ

## What is YAB?

Yet Another Bridge (YAB) is the cheapest, fastest and most secure bridge
solution from Starknet to Ethereum.

## What makes YAB different from other bridge solutions?

Bridges are generally insecure and economically inefficient. They exhibit an
asymmetry between users and bridge operators, where users can easily lose funds.
We propose a bridge design that is simple, modular, and utilizes multi-storage
proofs and the native messaging system between Ethereum and Layer 2 networks
(L2s) as a fallback mechanism.

## How much time does it take to bridge?

From the user's perspective, the bridging is completed in less than 30 seconds,
as quickly as the time it takes the market maker to observe the user's deposit
and execute a transfer.

From the market maker’s perspective, they will be able to receive back the money
after paying the user and sending a message using the native messaging system.
It takes less than 30 seconds, due to the time it takes to make a transaction
in Ethereum and the L2’s sequencer receiving the message.

Storage proofs are also implemented but they are not in use because they are useful to
scale and bridge from multiple L2 chains. This normally takes between 5 and 15
minutes.

## How much does it cost to bridge?

The base cost of YAB is similar to an ERC20 transfer plus the cost of proving the state of the L1 and L2. Therefore, the bridge's final cost would be approximately $15.

## What chains are currently supported?

Currently, Starknet is the only supported chain.

We are working on integrating ZkSync in the near future...

## How can I get in touch with the team?

You can contact us in:

- [Telegram Group](https://t.me/grindlabs)
- [Twitter/X](https://twitter.com/yanotherbridge)

0 comments on commit 45e2c40

Please sign in to comment.