Skip to content

Commit

Permalink
feat: template readme
Browse files Browse the repository at this point in the history
  • Loading branch information
murongg committed Nov 1, 2023
1 parent 8a9a321 commit 041cf13
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 0 deletions.
20 changes: 20 additions & 0 deletions packages/create-zkgraph/templates/template-default/README.md
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 packages/create-zkgraph/templates/template-hello/README.md
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 packages/create-zkgraph/templates/template-multiaddr/README.md
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 packages/create-zkgraph/templates/template-uniswapprice/README.md
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

0 comments on commit 041cf13

Please sign in to comment.