w3bstream-mainnet

README

W3bstream Sprout 🍀

W3bstream Sprout (Alpha) which supports native Halo2 circuits (WIP) as well as zkVMs like zkWASM (WIP) and RISC0.

wsctl is the command line tool that interact with W3bstream protocol which can be used by node operators as well as project developers.

Minimum requirements

Components	Version	Description
Golang	≥ 1.21	Go programming language

Preparation

Install docker

Docker is needed to run the node service. Please make sure your docker is up to date.

install docker & docker-compose

Install wsctl

wsctl is the W3bstream command line.

curl https://raw.githubusercontent.com/machinefi/sprout/main/scripts/install_wsctl.sh | bash

Run server

Download docker-compose.yaml

mkdir sprout && cd sprout
curl https://raw.githubusercontent.com/machinefi/sprout/main/docker-compose.yaml -o docker-compose.yaml

Populate docker-compose.yaml fields

W3bstream-node need write proof to chain and a private key is needed. If PRIVATE_KEY is empty, write chain will skip

export PRIVATE_KEY=${your private key}

If you need risc0 snark proof, a bonsai key is needed. Or will failed to generate risc0 snark proof

export BONSAI_KEY=${your bonsai key}

Use customized project code

Docker-compose will mount current work directory to containers /data https://github.com/machinefi/sprout/blob/main/docker-compose.yaml#L23
So you can appoint the project file at https://github.com/machinefi/sprout/blob/main/docker-compose.yaml#L18

Start w3bstream node

docker-compose up -d

Monitor w3bstream node status

docker-compose logs -f w3bnode

Shut down w3bstream node

docker-compose down

Compile your own w3bstream code

After modifying w3bstream source code, the image could be rebuild by running

make docker

Replace the image name in the docker-compose.yaml to the new image built above.

Send message from client

Set remote w3bstream server

Set server endpoint and language via subcommand config:

wsctl config set endpoint localhost:8888

The value of the variables in config could be fetched via

wsctl config get endpoint

Send message to remote server

open a new terminal and execute
risc0 snark test

wsctl message send -p 10000 -v "0.1" -d "{\"private_input\":\"14\", \"public_input\":\"3,34\", \"receipt_type\":\"Snark\"}"

halo2 test

wsctl message send -p 10001 -v "0.1" -d "{\"private_a\": 3, \"private_b\": 4}"

It will send a message to project test01 running on the remote server. The processing status could be checked via docker-compose logs -f w3bnode on the server. And you would receive the message id. the output like below:

{
  "messageID": "6ae1bedd-264f-4339-a0b4-d5613d7d0ecc"
}

Query your message status

Query message handling status by the message id

wsctl message query -m "6ae1bedd-264f-4339-a0b4-d5613d7d0ecc"

You will receive a response like below:

{
  "id": "6ae1bedd-264f-4339-a0b4-d5613d7d0ecc",
  "projectID": "test01",
  "projectVersion": "0.1",
  "data": "{\"private_input\":\"14\", \"public_input\":\"3,34\", \"receipt_type\":\"Snark\"}",
  "status": 3,
  "receivedAt": "2023-11-15T14:37:13.052271046Z",
  "submitProvingAt": "2023-11-15T14:37:13.842647504Z",
  "proofResult": "get proof error",
  "SubmitToBlockchainAt": "2023-11-15T14:37:15.911203172Z",
  "succeed": false,
  "errorMessage": "estimate gas failed: execution simulation failed: status = 106"
}