Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/golemfactory/yagna-zksync


https://github.com/golemfactory/yagna-zksync

golem

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README 

        
# zkSync in Yagna



This repository is a collection of docs and examples to help implement zkSync into Yagna



- [Yagna](https://github.com/golemfactory/yagna) is: An open platform and marketplace for distributed computations

- [zkSync](https://zksync.io/) is: scaling and privacy engine for Ethereum



## Introduction



Yagna, as a marketplace, would like to use zkSync as a means of value transfer.



The main reasons are:



- [Cheaper transactions](https://zksync.io/faq/tokens.html)

- [No ETH required for gas](https://zksync.io/faq/tokens.html#how-fees-are-payed)

- [Better scalable](https://zksync.io/faq/tech.html#maximum-throughput)



Compared to [other tools investigated](https://docs.google.com/document/d/1r54ECD3Fcb0maZLTYCAaizvmtLIPRo_Tw6609stg7ic/edit#heading=h.yo8rqpdd38p2):



- Native support for ERC20 tokens

- Quick exit possible ( 10 min ) [src](https://zksync.io/faq/tech.html#transaction-finality)

- Security like the main chain [src](https://zksync.io/faq/security.html)



## Happy user flow ( no yagna )



### Provider



- set signing key ( [how-to](https://zksync.io/dev/tutorial.html#unlocking-zksync-account) )

- monitor incoming payments( [how-to](https://zksync.io/dev/tutorial.html#checking-zksync-account-balance) - _TODO: better way then check balance?_ )

- withdraw to any(?) mainnet address( [how-to](https://zksync.io/dev/tutorial.html#withdrawing-funds-back-to-ethereum) )



### Requestor



- set signing key( [how-to](https://zksync.io/dev/tutorial.html#unlocking-zksync-account) )

- deposit funds to zkSync contract( [how-to](https://zksync.io/dev/tutorial.html#depositing-assets-from-ethereum-into-zksync) )

- send payments when computations are accepted( [how-to](https://zksync.io/dev/tutorial.html#making-a-transfer-in-zksync) )

- withdraw to any(?) mainnet address( [how-to](https://zksync.io/dev/tutorial.html#withdrawing-funds-back-to-ethereum) )



## Happy user flow with yagna



- Account unlocked -> check if signing key is set -> set signing key

- Requestor

  - Before allocation is created, funds need to be deposited in zkSync contract

  - Make allocation required for posting demand, options for allowance:

    - Can be a "virtual" safe only inside Yagna ( current )

    - Can be a safe inside the zkSync contract ( nice to have )

    - Can be the funds deposited in zkSync ( not feasable )

  - Send zkSync transaction on each debit note and invoice

- Provider

  - Withdraw funds to any(?) mainnet ethereum wallet

    - out of the box only own wallet seems possible ( TODO check )

    - transaction fees will be payed from the withdrawn funds

      - Example: withdraw 10$ in value, pay 0.05$ to the network, receive 9.95$ in ethereum wallet



## Components



zkSync exists of the following components:



- Client library

- Contracts

- Provider



### Client library



The [client library](https://github.com/matter-labs/zksync/tree/master/js/zksync.js) is the gateway between yagna and the zkSync network.

It is currently written in JavaScript, but the Rust version is on the roadmap ( At GF or ML )

The library providers easy to use methods to call the [Provider](#provider).



### Contracts



The [contracts](https://github.com/matter-labs/zksync/blob/master/contracts/contracts) are used to produce the blocks and govern the network.

The [Main contract]() handles new blocks, deposits/withdraws and exists

The [Gov contract]() handles what ERC20 tokens are available and management of validators



### Provider



The provider is a server that serves the API's for the clients to use.

It also serves as a back-bone for the zkSync network: collecting transactions, creating and validation of blocks.

In the best case scenario we could run these Providers on the Golem network. But for now we can start with ML's infrastructure and upgrade to GF infrastructure when required.



## Steps



- [x] Describe happy user flow abstract and from yagna

- [x] Describe `zkSync` components and their applicability to yagna

- [ ] Write examples to use the javascript library like yagna would use it

- [ ] Write rust client library for zkSync

- [ ] Write examples to run a full local dev environment

- [ ] Describe worse case scenario exit strategy



## Remarks



- [ ] Decide on what provers we will use ( Matter Labs or Golem Factory)