Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Liuhaai committed Nov 25, 2024
1 parent d1dd439 commit d655e71
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 13 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

W3bstream is a key Layer-2 solution within the IoTeX ecosystem, designed to support verifiable data processing for Decentralized Physical Infrastructure Networks (*DePINs*). It operates through a network of *Sequencer nodes* and *Prover nodes*.

## Workflow

<p align="center">
<img src="./docs/arch_new.png" width="75%"/>
</p>
Expand All @@ -17,25 +15,33 @@ W3bstream is a key Layer-2 solution within the IoTeX ecosystem, designed to supp
The chain of tasks and their ZK-proofs are recorded **on the IoTeX blockchain**, making them accessible for dApps. The actual data, uniquely referenced by the on-chain tasks, remains available for full off-chain verification.

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


## Getting Started

### For Embedded Developer

[<u>ioID-SDK</u>](https://github.com/iotexproject/ioID-SDK) repo provides SDK for DePIN hardwares to connect W3bstream and IoTeX ecosystem


### For Project Builder

[<u>Build a custom zk prover for W3bstream</u>](./docs/DEVELOPER_GUIDE.md)

## 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).

## Get Started for Builders
[<u>Deploy the zk prover to W3bstream</u>](./docs/QUICK_START.md)

[Deploy a simple zk prover to W3bstream →](./docs/QUICK_START.md)
### For Node operator

[Build your custom zk prover for W3bstream →](./docs/DEVELOPER_GUIDE.md)

## Docker images
> **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).
[Sequencer Node →](https://github.com/iotexproject/w3bstream/pkgs/container/w3bstream-sequencer)
### For Module Integrator

[Prover Node →](https://github.com/iotexproject/w3bstream/pkgs/container/w3bstream-prover)
- Storage: [<u>./datasource</u>](./datasource/) folder contains [<u>documentation</u>](./datasource/README.md) and existing implementations W3bstream can suppport.

## Contract Deployments
- ZK Engine: ZK Service needs to support [Protobuf interface](./vm/proto/vm.proto) to communication with ZK Node

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

## Contributing

Expand Down
Loading

0 comments on commit d655e71

Please sign in to comment.