From 4d01be711fcd57ec40abbebea39457f5a1b9cd5e Mon Sep 17 00:00:00 2001 From: Simone Date: Sun, 3 Nov 2024 23:10:50 +0100 Subject: [PATCH 1/2] Update QUICK_START.md --- docs/QUICK_START.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md index cf73c9a7..5dbb580c 100644 --- a/docs/QUICK_START.md +++ b/docs/QUICK_START.md @@ -4,7 +4,7 @@ Ensure you have the following tools installed: -- [ioctl](https://docs.iotex.io/builders/reference-docs/ioctl-client#install-latest-release-build): For interacting with the IoTeX blockchain. +- [ioctl](https://docs.iotex.io/builders/reference-docs/ioctl-client#install-latest-release-build): For interacting with the IoTeX blockchain (please [build the latest dev branch](https://docs.iotex.io/builders/reference-docs/ioctl-client#build-the-current-development-branch)). - [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html): Required for building the prover code. - [curl](https://curl.se/): For sending messages to the API node. @@ -16,16 +16,26 @@ Start by creating an IoTeX developer wallet and funding it with test tokens. ```sh ioctl account createadd devaccount + +# Display account info +ioctl account info devaccount ``` Note the 0x wallet address provided. You can claim test IOTX tokens on the Developer portal at +```sh +# Query account balance +ioctl account balance devaccount +# Export the private key if needed +ioctl account export devaccount +``` + ## Step 2: Register a new DePIN Project on IoTeX To register a new project: ```sh -ioctl ioid register "your project unique name" +ioctl ioid register "your_project_unique_name" ``` Take note of your `Project ID` and set it as an environment variable: @@ -43,7 +53,7 @@ git clone https://github.com/iotexproject/w3bstream cd w3bstream/examples/risc0-circuit -ioctl ws project update --id $PROJECT_ID --path range_prover.json +ioctl ws project update --id $PROJECT_ID --path range-prover.json ``` ## Step 4: Link Your Project to the Dummy DApp Contract @@ -82,14 +92,14 @@ curl --location 'https://dragonfruit-testnet.w3bstream.com/message' \ }' ``` -Record the Task ID from the response, wait a few minutes, and then check its status: +Record the Task ID from the response, wait a few minutes, and then check its status (customise the Task ID field): ```sh -curl --location --request GET 'https://dragonfruit-testnet.w3bstream.com/task' \ +curl --location --request GET 'https://dragonfruit-testnet.w3bstream.com/task' \ --header 'Content-Type: application/json' \ --data '{ "projectID": '"$PROJECT_ID"', - "taskID": "YOUR TASK ID HERE" + "taskID": "YOUR_TASK_ID_HERE" }' | jq ``` From 9e6965104c3a2e4119e61bed1c8f93ec2888eaeb Mon Sep 17 00:00:00 2001 From: simonerom Date: Mon, 4 Nov 2024 16:10:38 +0100 Subject: [PATCH 2/2] Replace mock dapp address in quick start --- docs/QUICK_START.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md index 5dbb580c..c99285ba 100644 --- a/docs/QUICK_START.md +++ b/docs/QUICK_START.md @@ -32,7 +32,7 @@ ioctl account export devaccount ## Step 2: Register a new DePIN Project on IoTeX -To register a new project: +To register a new project: ```sh ioctl ioid register "your_project_unique_name" @@ -61,12 +61,13 @@ ioctl ws project update --id $PROJECT_ID --path range-prover.json Bind your project to a sample DApp contract to ensure it receives your ZK proofs: ```sh -ioctl ws router bind --project-id $PROJECT_ID --dapp 0xba0104cD02672840Da55Bb14bebdd047Dfbfc02B +ioctl ws router bind --project-id $PROJECT_ID --dapp 0xe48eF7D13805487B74CDFC47BDC174446C31f541 ```
Learn more The "dummy dapp" is a simple contract that will store ZK-Proofs from W3bstream without further processing. This can be useful for debugging proof generation if your Dapp is experiencing issues. + find the [source code here](https://github.com/iotexproject/w3bstream/blob/develop/examples/risc0-circuit/contract/Risc0Dapp.sol)
## Step 5: Activate Your Project