-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
74 additions
and
0 deletions.
There are no files selected for viewing
20 changes: 20 additions & 0 deletions
20
packages/create-zkgraph/templates/template-default/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# zkGraph default template | ||
|
||
|
||
## Usage CLI | ||
|
||
> Note: Only `full` image will be processed by zkOracle node. `local` (generated by commands ending with `--local` option) means the zkGraph is compiled locally and only contains partial computation (so that proving and executing will be faster). | ||
The workflow of local zkGraph development must follow: `Develop` (code in /src) -> `Compile` (get compiled wasm image) -> `Execute` (get expected output) -> `Prove` (generate input and pre-test for actual proving in zkOracle) -> `Deploy` (deploy verification contract) -> `Verify` (verify proof on-chain). | ||
|
||
To upload and publish your zkGraph, you should `Upload` (upload code to IPFS), and then `Publish` (register zkGraph on onchain zkGraph Registry). | ||
|
||
|
||
## Commonly used commands | ||
|
||
- **compile**: `zkgraph compile` | ||
- **exec**: `zkgraph exec <block id>` | ||
- **prove**: `zkgraph prove <block id> <expected state> -i|-t|-p` | ||
- …… | ||
|
||
Read more: https://github.com/hyperoracle/zkgraph-cli#cli |
18 changes: 18 additions & 0 deletions
18
packages/create-zkgraph/templates/template-hello/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# zkGraph hello template | ||
|
||
## Usage CLI | ||
|
||
> Note: Only `full` image will be processed by zkOracle node. `local` (generated by commands ending with `--local` option) means the zkGraph is compiled locally and only contains partial computation (so that proving and executing will be faster). | ||
The workflow of local zkGraph development must follow: `Develop` (code in /src) -> `Compile` (get compiled wasm image) -> `Execute` (get expected output) -> `Prove` (generate input and pre-test for actual proving in zkOracle) -> `Deploy` (deploy verification contract) -> `Verify` (verify proof on-chain). | ||
|
||
To upload and publish your zkGraph, you should `Upload` (upload code to IPFS), and then `Publish` (register zkGraph on onchain zkGraph Registry). | ||
|
||
## Commonly used commands | ||
|
||
- **compile**: `zkgraph compile` | ||
- **exec**: `zkgraph exec <block id>` | ||
- **prove**: `zkgraph prove <block id> <expected state> -i|-t|-p` | ||
- …… | ||
|
||
Read more: https://github.com/hyperoracle/zkgraph-cli#cli |
18 changes: 18 additions & 0 deletions
18
packages/create-zkgraph/templates/template-multiaddr/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# zkGraph multiaddr template | ||
|
||
## Usage CLI | ||
|
||
> Note: Only `full` image will be processed by zkOracle node. `local` (generated by commands ending with `--local` option) means the zkGraph is compiled locally and only contains partial computation (so that proving and executing will be faster). | ||
The workflow of local zkGraph development must follow: `Develop` (code in /src) -> `Compile` (get compiled wasm image) -> `Execute` (get expected output) -> `Prove` (generate input and pre-test for actual proving in zkOracle) -> `Deploy` (deploy verification contract) -> `Verify` (verify proof on-chain). | ||
|
||
To upload and publish your zkGraph, you should `Upload` (upload code to IPFS), and then `Publish` (register zkGraph on onchain zkGraph Registry). | ||
|
||
## Commonly used commands | ||
|
||
- **compile**: `zkgraph compile` | ||
- **exec**: `zkgraph exec <block id>` | ||
- **prove**: `zkgraph prove <block id> <expected state> -i|-t|-p` | ||
- …… | ||
|
||
Read more: https://github.com/hyperoracle/zkgraph-cli#cli |
18 changes: 18 additions & 0 deletions
18
packages/create-zkgraph/templates/template-uniswapprice/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# zkGraph uniswrapperice template | ||
|
||
## Usage CLI | ||
|
||
> Note: Only `full` image will be processed by zkOracle node. `local` (generated by commands ending with `--local` option) means the zkGraph is compiled locally and only contains partial computation (so that proving and executing will be faster). | ||
The workflow of local zkGraph development must follow: `Develop` (code in /src) -> `Compile` (get compiled wasm image) -> `Execute` (get expected output) -> `Prove` (generate input and pre-test for actual proving in zkOracle) -> `Deploy` (deploy verification contract) -> `Verify` (verify proof on-chain). | ||
|
||
To upload and publish your zkGraph, you should `Upload` (upload code to IPFS), and then `Publish` (register zkGraph on onchain zkGraph Registry). | ||
|
||
## Commonly used commands | ||
|
||
- **compile**: `zkgraph compile` | ||
- **exec**: `zkgraph exec <block id>` | ||
- **prove**: `zkgraph prove <block id> <expected state> -i|-t|-p` | ||
- …… | ||
|
||
Read more: https://github.com/hyperoracle/zkgraph-cli#cli |