Grants General Documentation
- Grants General Documentation
- Round 8
- Round 7
- Round 6
- Rounds 1–5
In round 8, the zkSync checkout flow was significantly simplified thanks to the new
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.
In round 7 we introduced the option to checkout on L2 using zkSync. This means there are now three possible checkout flows—the Bulk Checkout flow introduced in Round 6, and two zkSync checkout flows.
Before describing these two flows, we'll review how zkSync accounts work at a high level. When logging in to your zkSync account, such as at https://wallet.zksync.io/, you are asked to sign a message. That signature is used to generate a private key, and each transfer then requires two signatures—one from this private key, and as an additional security measure, one more from your regular web3 wallet. This is great from a security perspective, but not so great from a UX perspective. Requiring one signature for each transfer can be a pain if you want to send a lot of transfers, so you'd be doing a lot of clicking when checking out with large carts.
To remedy this, we ask you to login to a "Gitcoin zkSync" account. This generates an L1 account that the Gitcoin frontend can use to sign transactions directly. The private key to this account is derived from the signature, and is never stored or transmitted anywhere. We then login to zkSync with this account, and now can use this account to send transfers without prompting you for each transfer! Funds are only held by this account temporarily to improve UX. Because it does not permanently hold funds there is no additional security risk.
Based on the items in your cart, we check your zkSync balances to see if you already have enough funds on zkSync to complete checkout.
If you do, the checkout flow is as follows:
- Sign a message to login to your Gitcoin zkSync account
- Sign a message to login to your regular zkSync account
- Sign a message to transfer funds from your regular zkSync account to your Gitcoin zkSync account
Step 3 is repeated for each token you are donating. If you only are using DAI, step 3 will ask for one signature. If you are donating DAI and ETH, it will ask for two signatures.
After those signatures are received, the transfers are executed so the funds are in your Gitcoin zkSync account. From there, all transfers of funds to grant owners are fired off in a rapid process that only takes a few seconds. Any leftover funds in the Gitcoin zkSync account (typically due to our conservative estimates of what zkSync trasfer fees will be) are transferred back to your regular zkSync account so you can access them at https://wallet.zksync.io/.
If you do not have enough funds in your zkSync account to complete checkout, the flow is as follows:
- Sign a message to login to your Gitcoin zkSync account
- Confirm one transaction for each required ERC20 approval (~25k–50k gas)
- Confirm one transaction to deposit funds into zkSync (~180k–200k gas)
If you are only donating with one token, step 3 calls the deposit function directly on the zkSync contract. If you are donating with multiple tokens, step 3 uses our Batch ZkSync Deposit Contract to reduce both the number of transactions and the gas costs for multiple deposits.
Funds are deposited directly to your Gitcoin zkSync account. To ensure your deposit is not reverted, it takes 10 confirmations for your deposit to be accepted by zkSync. After waiting for those 10 confirmations, we converge on the above flow, so all transfers of funds to grant owners are now executed. Again, any leftover funds in the Gitcoin zkSync account (in this case, this includes any additional funds you elected to deposit into zkSync) are transferred back to your regular zkSync account.
zkSync transfer costs can be found in their documentation. Right now it costs about 2k gas per transfer, compared to ~60k gas to transfer DAI on L1, and ~180k gas to deposit funds into zkSync. Once zkSync 1.1 is released, these transfer fees will be reduced to about 400 gas per transfer.
These transfers support what zkSync calls gasless meta-transactions, where all transaction fees are paid in the token being transferred. For example, if you want to transfer 5 DAI, there may be a fee of, say, 0.10 DAI, resulting in a total cost of 5.10 DAI.
When checking out with Gitcoin grants, fees are additive. If you have 20 DAI in your cart, the total cost will be 20 DAI plus transaction fees. Transfers to new recipients in zkSync cost more than transfers to users who have previously used zkSync. Gitcoin takes a conservative approach and assumes all transfers are to new users to ensure you don't run out of fees when transferring funds. As a result, the "Estimated fees" shown are checkout may be much higher than the actual fees you will pay. Any leftover fees are transferred from your Gitcoin zkSync account back to your regular zkSync account.
In round 6 we transitioned away from the EIP 1337 contract and replaced
it with a single contract that enables bulk donations for all grants. The source of this
can be found here,
and it has been deployed to the mainnet at
It works as follows:
- Instead of funding each grant individually, grants are now added to your cart
- For each grant in your cart, you select the token and amount you want to donate
- Upon checking out, all donations are handled in a single transaction thanks to the
- This contract has one main function,
donate()which takes an array of structs.
- Each struct contains all information required for a donation—the token to donate with, the amount to donate, and the grant to donate to
- Prior to calling this function, the Gitcoin frontend will ensure you have approved the
BulkCheckoutcontract to spend your tokens. If you haven't, you will be prompted to confirm an approval transaction for the exact amount to be donated. You are free to adjust the approval amount to remove the need to re-approve the contract in subsequent donations.
- After the approval transactions are submitted, the bulk checkout transaction is submitted through the
grants is built upon EIP 1337.
How Grants works
When you create a new grant at
/grants/new, you are deploying a new version of this contract.
When you fund a new grant at
/grants/<pk>/<slug>/fund, you are
approve()ing a batch of ERC20 tokens to be sent, and you are signing a message that will be used to create recurring transactions down the line.
How are those transactions created, you say? Well, it's via a sub-miner....
The subminer takes the signed message you created in the frontend (see above), and runs
executeSubscription every periodSeconds interval.
Here's what it does in psuedocode:
iterate through all subscriptions: contract.methods.getSubscriptionHash(..) ready = contract.methods.isSubscriptionReady(..) if ready: contract.methods.executeSubscription(..)
In order to run it, this is what you want to do:
./manage.py subminer <network> <optional_live_flag>
./manage.py subminer rinkeby --live
When you run this code, it looks through all of the active grants on your local on
<network>, and then runs
executeSubscription() on them. if
executeSubscription() succeeds, it will trigger some other actions (mostly emails, db mutations, etc)
Heres an example successful tx created by the subminer: https://rinkeby.etherscan.io/tx/0x274c159a6d89513c3f0b533a5329bef4ce02b3ffc770bece9a8ce5d269319f72
For more information on the subminer for grants, checkout
- https://github.com/gitcoinco/web/pull/3055 https://discord.gg/gitcoin