Merge pull request #15 from aoraki-labs/a5-doc-v2

update doc
aoraki-labs · Sep 26, 2023 · 7297d64 · 7297d64
2 parents 0b4f05e + 49e8c67
commit 7297d64
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 75 deletions.
diff --git a/docs/guides/ZKPool-A0.md b/docs/guides/ZKPool-A0.md
diff --git a/docs/guides/how-to-connect-ZKPool.md b/docs/guides/how-to-connect-ZKPool.md
@@ -0,0 +1,14 @@
+---
+sidebar_label: 'How to Connect as ZKP Requester'
+sidebar_position: 1
+---
+
+# Introduction
+Currently, in ZKPool A1, we are opening the prover market to Taiko projects.
+
+We are also working on opening it to all zkp projects. A detailed guide will be released soon.
+
+# The Prover Market Endpoint for Taiko
+HTTP: http://taiko-a5-prover-simple.zkpool.io
+
+HTTPS: https://taiko-a5-prover.zkpool.io
diff --git a/docs/overview.md b/docs/overview.md
@@ -55,6 +55,6 @@ The design principles of ZKPool include:
 
 The ZKPool will have the following milestones:
 
-- Centralized solution for one ZKP project
-- Connect multiple ZKP projects with the unified ZKP provers
-- Fully decentralized ZKP computing pool
+- Connect one ZKP project (Done)
+- Connect multiple ZKP projects with the UMP (Universal Modular Prover) (Ongoing)
+- Fully decentralized ZKP computing pool via Super-UMP (TBD)
diff --git a/docs/guides/introduction.md → docs/products/Release.md b/docs/guides/introduction.md → docs/products/Release.md
@@ -1,38 +1,17 @@
 ---
-sidebar_label: 'Introduction'
-sidebar_position: 1
+sidebar_label: 'Release'
+sidebar_position: 2
 ---
 
-# Introduction
+# ZKPool A1
 
-ZKPool aims to connect various ZKP applications and ZKP provers and provide the following capabilities:
-
-- ZKPool gathers smaller provers' capacity together and provides bond as a pool.
-- ZKPool operates to minimize the risks of being slashed.
-- ZKPool calculates and distributes the rewards of provers.
-- ZKPool makes it really easy for provers to join.
-
-Initially, ZKPool will assume the risk and provides bond on behalf of all the provers connected to the pool. The pool is open for registered provers to connect to.
-
-## General Flow
-
-Currently, the general flow is as follows:
-
-1. Register on [https://zkpool.io](https://zkpool.io/), generate the user account's unique access key.
-2. Use the one command installation script to connect to ZKPool.
-3. Login to [https://zkpool.io](https://zkpool.io/) to view prover machine status and rewards.
-
-## Releases
-
-### ZKPool A1
-
-#### Taiko Project Support
+## Taiko Project Support
 
 Taiko is a decentralized, Ethereum-equivalent zk-rollup project with Type 1 zkEVM technology.
 
 ZKPool A1 is dedicated to the [Taiko Alpha-5 (A5) Testnet](https://taiko.mirror.xyz/0jc5XA5RVjOUNVdRdGmw9prlsC4deA1XgZJppmXh8rs), and supports users who want to join as individual provers.
 
-#### Hardware requirements
+## Hardware requirements
 
 ZKPool supports various provers to join, CPU, GPU, and so on. 
 
@@ -43,7 +22,7 @@ The hardware that meets the minimum requirements can run CPU prover binary:
 - 8 or 16 core CPU
 - 32 GB memory
 
-#### Reward distribution
+## Reward distribution
 
 As ZKPool takes the risk of slashing, pays the Gas fee for submitting the proof and operation cost, ZKPool will share the reward of tokens with provers. Currently the distribution rule is:
 
@@ -59,6 +38,4 @@ Note:
 5. The actual value of the reward is not guaranteed. We participate to help Taiko test and become a successful zk-rollup.
 6. ZKPool may consider offering additional incentives from the platform side, especially for early participants. However, this has not yet been determined.
 
-### Legacy
-#### [ZKPool A0](./ZKPool-A0.md)
 
diff --git a/docs/products/_category_.json b/docs/products/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Products",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Introduction about the products of ZKPool"
+  }
+}
diff --git a/docs/products/images/UMP.jpg b/docs/products/images/UMP.jpg
diff --git a/docs/products/images/ecosystem.png b/docs/products/images/ecosystem.png
diff --git a/docs/products/images/two tier table.jpg b/docs/products/images/two tier table.jpg
diff --git a/docs/products/images/two-tier.jpg b/docs/products/images/two-tier.jpg
diff --git a/docs/products/introduction.md b/docs/products/introduction.md
@@ -0,0 +1,46 @@
+---
+sidebar_label: 'Introduction'
+sidebar_position: 1
+---
+
+# Introduction
+
+ZKPool is an open and permissionless platform that connects various ZKP projects and provers, offering multiple capabilities:
+
+- ZKPool gathers the capacity of smaller provers and acts as a super prover proxy, providing necessary stake to ZKP projects.
+- ZKPool provides competitive price to win the proof tasks and minimize the risks of being slashed.
+- ZKPool distributes the rewards of provers among participants.
+- ZKPool simplifies the process of joining for provers and ZKP projects.
+
+# The Ecosystem of ZKPool
+The participants in ZKPool include:
+1. ZKP Requester: Refers to ZKP projects that require ZKP proofs.
+2. ZKP Prover: Operators who own the hardware and run the provers.
+3. ZKP Accelerator: A team that provides accelerated software implementation for certain ZKP projects.
+
+The ZKP requester can also be a ZKP accelerator. For example, a ZKP project may have its own best GPU-accelerated software.
+
+The ZKP prover can also be a ZKP accelerator. For example, ZKP prover operators may develop their own accelerated software.
+
+The ecosystem is represented in the following diagram:
+![Ecosystem](./images/ecosystem.png)
+
+# Two-tier ZKP proving tokenomics
+Currently, many ZKP projects use their own proving systems and tokenomics. To establish a healthier and more cost-effective ZKP proving ecosystem, a two-tier proving tokenomics model can be a viable solution. Taiko proposed a solution after several rounds of iteration of proving tokenomics. We have further extended this solution to a two-tier framework.
+
+Under this approach, each ZKP project operates as tier 1, defining its own tokenomics. However, the selection, scheduling, penalty, reward, and rating of provers are delegated to tier 2, which is a shared prover pool.
+![Two-tier](./images/two-tier.jpg)
+
+The scope of the two tiers is as follows:
+
+|  | Tier 1 (ZKP projects)  | Tier 2 (ZKPool) |
+| --- | --- | --- |
+| Scope | • Publish proof task.<br/> • Establish rewards and penalties.<br/> • Define key metrics such as proof window. | • Aggregate proof task.<br/> • Schedule and rate prover resources.<br/> • Distribute rewards. <br/>• Assume penalty risk.<br/> • Define price competition strategy |
+
+
+# UMP (Universal Modular Prover)
+ZKPool utilizes UMP (Universal Modular Prover) to integrate various provers.
+
+A Universal Modular Prover can run on the same hardware platform while supporting the proving work of various ZKP projects.
+
+![UMP](./images/UMP.jpg)