W3bStream is a general framework for connecting data generated by devices and machines in the physical world to the blockchain world. In a nutshell, W3bStream uses the IoTeX blockchain to orchestrate a decentralized network of gateways (i.e., W3bStream nodes) that streams encrypted data from IoT devices and machines and generates proofs of real-world facts to different blockchains. A overview graphic of W3bstream is
Plese visit https://docs.w3bstream.com/.
Interested in contributing to the doc? Please edit on Github
Make a path for w3bstream node. In the path, run the following command
curl https://raw.githubusercontent.com/machinefi/w3bstream/main/docker-compose.yaml > docker-compose.yaml
Edit the config in the yaml
file if needed. Then run
docker-compose -p w3bstream -f ./docker-compose.yaml up -d
Your node should be up and running.
Please note: the docker images are hosted at GitHub Docker Registry
W3bstream Studio is a web tool that allows W3bstream node operators to administrate their node, deploy and run applets, and explore data.
Visit http://localhost:3000 to get started. The default admin password is iotex.W3B.admin
. Learn more from documentation.
Interested in W3bstream Studio source code? Check it out here https://github.com/machinefi/w3bstream-studio.
If you are interested in diving into the code and run the node using a locally built docker, here is the steps of building the docker image from code.
make init_submodules
make update_studio
make build_docker_images
make run_docker
make stop_docker
make drop_docker
This section is for building the W3bstream binanry files from code.
- OS : macOS(11.0+) / Linux (tested on Ubuntu 16+)
- Go: golang (1.18+)
- Docker: to start a postgres
- Tinygo: to build wasm code
- make: run makefile
- GCC: 11.3.0
- protobuf: 3.12+
- Httpie: (optional) a simple curl command (used to interact with W3bstream node via cli)
make run_depends # start postgres and mqtt
make migrate # create or update schema
make run_server
Please refer to HOWTO.md for more details.
- Android: https://github.com/machinefi/w3bstream-android-sdk
- iOS: https://github.com/machinefi/w3bstream-ios-sdk
- Embedded: Coming soon!
Learning how to get started with W3bstream? Here is a quick get-start example: https://github.com/machinefi/get-started
More code examples: https://github.com/machinefi/w3bstream-examples
Step-by-step tutorials can be found on dev portal: https://developers.iotex.io/
- Developer portal: https://developers.iotex.io/
- Developer Discord (join #w3bstream channel): https://w3bstream.com/discord