Skip to content

Commit

Permalink
Merge branch 'develop' into update-contract-deployments
Browse files Browse the repository at this point in the history
  • Loading branch information
Liuhaai authored Oct 31, 2024
2 parents a2f3561 + bb9e81e commit 59f1623
Show file tree
Hide file tree
Showing 6 changed files with 241 additions and 342 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ W3bstream is a key Layer-2 solution within the IoTeX ecosystem, designed to supp
## Workflow

<p align="center">
<img src="./docs/arch_new.png"/>
<img src="./docs/arch_new.png" width="75%"/>
</p>

**Sequencer nodes** assemble received data messages with a “block header” that (among other things) references the previous block of data. Each block of data is mined using a proof-of-work mechanism and is then assigned as a Task to a Prover node that is available for data computation. Sequencer nodes receive rewards in IOTX for the mining activity.
Expand All @@ -18,25 +18,27 @@ The chain of tasks and their ZK-proofs are recorded **on the IoTeX blockchain**,

This architecture ensures secure, reliable, and scalable data processing, allowing DePIN dApps to act on verified real-world facts to trigger blockchain-based incentives.

## Architecture
## Running nodes
> **Note**: Joining the W3bstream network as a sequencer or prover node is currently unavailable. Stay tuned for updates in future releases. [Follow us on X](https://x.com/iotex_dev).
[Detailed system architecture description →](./docs/ARCHITECTURE.md)
## Get Started for Builders

## Docker images
[Deploy a simple zk prover to W3bstream →](./docs/QUICK_START.md)

* [Sequencer](https://github.com/iotexproject/w3bstream/pkgs/container/w3bstream-sequencer)
* [Prover](https://github.com/iotexproject/w3bstream/pkgs/container/w3bstream-prover)
[Build your custom zk prover for W3bstream →](./docs/DEVELOPER_GUIDE.md)

## Running
## Docker images

For users who just want to give it a try, please refer to [Quick Start](./docs/QUICK_START.md), which will guide you through how to interact with existing projects deployed on testnet.
[Sequencer Node](https://github.com/iotexproject/w3bstream/pkgs/container/w3bstream-sequencer)

Developers looking to build circuits and deploy W3bstream projects should consult the [DEVELOPER_GUIDE ](./docs/DEVELOPER_GUIDE.md)
[Prover Node ](https://github.com/iotexproject/w3bstream/pkgs/container/w3bstream-prover)

## Contract Deployments

Coming
[smartcontracts/README.md](./smartcontracts/README.md#deployment)

## Contributing

We welcome contributions! Please read our [contributing guidelines](./docs/CONTRIBUTING.md) and submit pull requests to our GitHub repository.
We welcome contributions!

Please read our [contributing guidelines](./docs/CONTRIBUTING.md) and submit pull requests to our GitHub repository.
Loading

0 comments on commit 59f1623

Please sign in to comment.