|
|
@@ -0,0 +1,94 @@
|
|
|
+
|
|
|
+
|
|
|
+# Joystream Runtime
|
|
|
+
|
|
|
+The runtime is the code that defines the consensus rules of the Joystream protocol.
|
|
|
+It is compiled to WASM and lives on chain. Joystream [full nodes](https://github.com/Joystream/substrate-node-joystream) execute the logic of the runtime to validate transactions and blocks on the Joystream blockchain.
|
|
|
+
|
|
|
+The joystream runtime builds on the substrate runtime library (srml) and adds additional functionality:
|
|
|
+
|
|
|
+Council elections
|
|
|
+User membership system
|
|
|
+Runtime Upgrade proposal system
|
|
|
+Staked Roles
|
|
|
+ Storage Provider
|
|
|
+
|
|
|
+### Prerequisites
|
|
|
+
|
|
|
+To compile the runtime you will need some tools such as: Rust, llvm and openssl. You can install most of the dependencies with:
|
|
|
+
|
|
|
+```bash
|
|
|
+curl https://getsubstrate.io -sSf | bash
|
|
|
+```
|
|
|
+
|
|
|
+## Getting Started - Building the WASM runtime
|
|
|
+
|
|
|
+```bash
|
|
|
+git clone https://github.com/Joystream/substrate-runtime-joystream
|
|
|
+cd substrate-runtime-joystream/
|
|
|
+./setup.sh
|
|
|
+./build.sh
|
|
|
+```
|
|
|
+
|
|
|
+This produces the WASM "blob" output in:
|
|
|
+
|
|
|
+`wasm/target/wasm32-unknown-unknown/release/joystream_node_runtime_wasm.compact.wasm`
|
|
|
+
|
|
|
+See deployment for notes on how to deploy this runtime on a live system.
|
|
|
+
|
|
|
+## Deployment
|
|
|
+
|
|
|
+Deploying the compiled runtime on a live system can be done in one of two ways:
|
|
|
+
|
|
|
+1. Joystream runtime upgrade proposals which will be voted on by the council. When joystream platform is live, this will be the only way to upgrade the chain's runtime code.
|
|
|
+
|
|
|
+2. During development and testnet phases, we can send an extrinsic (transaction signed with the sudo key) invoking `conesnsus::setCode()`. This can be done either from the UI/extrinsics app, or direc with a script.
|
|
|
+
|
|
|
+## Running the tests
|
|
|
+
|
|
|
+```bash
|
|
|
+cargo test
|
|
|
+```
|
|
|
+
|
|
|
+### Coding style
|
|
|
+
|
|
|
+We use `rustfmt` to format the source code for consistency.
|
|
|
+
|
|
|
+[rustfmt](https://github.com/rust-lang/rustfmt) can be installed with rustup:
|
|
|
+
|
|
|
+```
|
|
|
+rustup component add rustfmt
|
|
|
+```
|
|
|
+
|
|
|
+Running rustfmt can be applied to all source files recursing subfolders:
|
|
|
+
|
|
|
+```
|
|
|
+rustfmt src/*.*
|
|
|
+```
|
|
|
+
|
|
|
+## Built With
|
|
|
+
|
|
|
+* [Substrate](https://github.com/paritytech/substrate)
|
|
|
+
|
|
|
+## Contributing
|
|
|
+
|
|
|
+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
|
|
|
+
|
|
|
+## Versioning
|
|
|
+
|
|
|
+Versioning of the runtime is set in `src/lib.rs`
|
|
|
+For detailed information about how to set correct version numbers when developing a new runtime, [see this](https://github.com/paritytech/substrate/blob/master/core/sr-version/src/lib.rs#L60)
|
|
|
+
|
|
|
+
|
|
|
+## Authors
|
|
|
+
|
|
|
+See also the list of [contributors](./CONTRIBUTORS) who participated in this project.
|
|
|
+
|
|
|
+## License
|
|
|
+
|
|
|
+This project is licensed under the GPLv3 License - see the [LICENSE](LICENSE) file for details
|
|
|
+
|
|
|
+## Acknowledgments
|
|
|
+
|
|
|
+* Thanks to the whole Parity Tech team for making substrate and helping on riot chat with tips, suggestions, tutorials and answering all our questions during development.
|
|
|
+
|
Mokhtar Naamani