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.

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

Update GRANTS.md #7996

Merged
merged 2 commits into from
Dec 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 app/grants/templates/grants/cart-vue.html
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ <h2 class="middle-line mb-3"><span class="text-muted font-body">or</span></h2>

{% comment %} ===================== START ZKSYNC SCRIPTS ====================== {% endcomment %}
<script type="text/javascript" src="https://cdn.ethers.io/lib/ethers-5.0.umd.min.js"></script>
<script type="text/javascript" src="https://unpkg.com/[email protected].8/dist/main.js"></script>
<script type="text/javascript" src="https://unpkg.com/[email protected].9/dist/main.js"></script>
{% comment %} ====================== END ZKSYNC SCRIPTS ======================= {% endcomment %}

<script src="{% static "v2/js/lib/bootstrap-vue.min.js" %}"></script>
Expand Down
27 changes: 27 additions & 0 deletions docs/GRANTS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
# Grants General Documentation

- [Grants General Documentation](#grants-general-documentation)
- [Round 8](#round-8)
- [Round 7](#round-7)
- [Architecture Background](#architecture-background)
- [Checkout Flow](#checkout-flow)
- [Transfer Fees](#transfer-fees)
- [Round 6](#round-6)
- [Rounds 1–5](#rounds-15)
- [How Grants works](#how-grants-works)
- [Sub Miner](#sub-miner)
- [More information](#more-information)

## Round 8

In round 8, the zkSync checkout flow was significantly simplified thanks to the new
[`zksync-checkout`](https://www.npmjs.com/package/zksync-checkout) library released by zkSync. This library natively supports batch transfers, meaning multiple transfers can be approved
with just one L1 signature. This provides many benefits over the round 7 approach:

- It resolves the UX issues we worked around by introducing "Gitcoin zkSync wallets" in round 7
- Security is improved, as Gitcoin never sees any of your zkSync private keys
- It provides a familiar web2 checkout flow, similar to "Checkout with Amazon" or "Checkout with Google Pay"
- It's less confusing to users as your transaction history on zkScan now shows ordinary transfers to grants instead of one big transfer to an unknown address
- These native batch transfers are atomic, so your checkout will either succeed or fail. The previous approach can leave user accounts in an odd state if one of the multiple transfers failed, and care must be taken to properly recover from this

For more information on how this new checkout flow works, please see the
[zkSync Checkout documentation](https://www.notion.so/zkSync-Checkout-docs-2bffd6f169e746d0b51873e4127992a6).

## Round 7

In round 7 we introduced the option to checkout on L2 using [zkSync](https://zksync.io/).
Expand Down