Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Chondria/SiB
"Substrate in Bits": Going in-depth in all-things-substrate
https://github.com/Chondria/SiB
Last synced: 9 days ago
JSON representation
"Substrate in Bits": Going in-depth in all-things-substrate
- Host: GitHub
- URL: https://github.com/Chondria/SiB
- Owner: Chondria
- License: gpl-3.0
- Created: 2023-04-05T18:39:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-24T08:13:07.000Z (9 months ago)
- Last Synced: 2024-08-02T19:34:13.800Z (4 months ago)
- Size: 992 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-dot - Substrate in Bits - Going in-depth in all-things-substrate. (Learning Materials / Websites)
README
# Substrate in Bits
![Substrate in Bits](./Images/sibbb.png)
Substrate in Bits is a technical content series/reference aimed at solving the pain points of developers building with Substrate and Rust. The content is designed to go in-depth on some of the common issues faced by developers and provide practical solutions to those issues. This repository contains the [code samples](https://github.com/Chondria/SiB/tree/main/Sandbox), [tutorials](https://github.com/Chondria/SiB/tree/main/docs), and other resources associated with the series.
## Content
- [Getting started](#getting-started)
- [Code samples](#code-samples)
- [Directory structure](#directory-structure)
- [Using the code samples](#using-the-code-samples)
- [Table of technical content](#table-of-technical-content)
- [Contributing](#contributing)
- [Code of conduct](#code-of-conduct)## Getting started
To get started with Substrate in Bits, you can browse the available content on the [doc](https://github.com/Chondria/SiB/tree/main/docs) folder or the table below. Substrate in Bits content will also be available on [Polkadot.study](https://polkadot.study). You can clone the repository to your local machine and run the examples to get a better understanding of the concepts discussed in the series.
## Code samples
Each Substrate in Bits content comes with its own repository containing all the code and programs used in that content. These code samples are designed to help you understand the concepts discussed in the content and try them out for yourself.
### Using the code samples
To use the code samples, follow these steps:
1. Clone the repository for the specific guide/tutorial.
2. Navigate to the repository's directory: `cd [name of repo]`
3. Follow the instructions in the guide or the `README.md` file of the code sample repository to build and run the example program.By following these steps, you can test out the code samples for each Substrate in Bits content and gain a better understanding of the concepts discussed in the series.
## Table of technical content
| S/N | Content Name | Category | Link |
| --- | --- | --- | --- |
| 1 | Accessing storage and functions across pallets | Pallet integration | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/accessing-storage-and-functions-across-pallets) |
| 2 | Using generic types in custom data | Custom data | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/using-generic-type-in-custom-data) |
| 3 | DispatchResult vs DispatchResultWithPostInfo | Dispatchables | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/DispatchResult%20vs%20DispathResultWithPostInfo) |
| 4 | Blake2 vs TwoX | Hashing | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/Blake2_128Concat%20vs%20Twox64Concat) |
| 5 | Let’s distill the construct_runtime macro | Macros | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/Let%E2%80%99s%20distill%20the%20construct_runtime%20macro) |
| 6 | Running unit tests on substrate pallet | Unit test | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/Running-unit-test-on-substrate-pallet) |
| 7 | Substrate Pallets Configuration: An Error-based Approach | Pallet integration | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/Substrate%20Pallets%20Configuration:%20An%20Error-based%20Approach) |
| 8 | Working with Assets on Substrate | Fungible Tokens | [Visit](https://polkadot.study/tutorials/substrate-in-bits/docs/working-with-assets-on-substrate) |
| 9 | Let’s distill the #[pallet::storage] macro | Macros | [Visit](./docs/Let’s%20distill%20the%20pallet%20storage%20macro.md) |
| 10 | Benchmarking substrate pallet | Benchmarking | [Visit](./docs/Benchmarking-substrate-pallet.md) |
| 11 | Build a substrate node from scratch (sub-series) part 1 | Nodes | [Visit](./docs/Build%20a%20substrate%20node%20from%20scratch%20(sub-series)%20part%201.md) |
| 12 | Working with substrate pallet hooks | Hooks | [Visit](./docs/working-with-hooks.md) |
| 13 | Deconstructing pallet genesis config | Configuration | [Visit](./docs/deconstructing-pallet-genesis-config.md) |
| 14 | Understanding substrate pallet instance | Pallet Instance | [Visit](./docs/understanding-substrate-pallet-instance.md) |
| 15 | Dealing with runtime constants | Runtime | [Visit](./docs/Dealing%20with%20runtime%20constants.md) |
| 16 | Writing efficient storage items | Storage Items | [Visit](#table-of-technical-content) |
| 17 | Breaking down substrate runtime | Runtime | [Visit](./docs/breaking-down-substrate-runtime.md) |
| 18 | From transaction to block - part 1 | Transaction Execution | [Visit](./docs/from-transaction-to-block-part-1.md) |
| 19 | From transaction to block - part 2 | Block Propagation | [Visit](./docs/from-transaction-to-block-part-2.md) |
| 20 | Deep dive into Substrate consensus - part 1 | Consensus (Block Authoring) | [Visit](./docs/deep-dive-into-substrate-consensus-part-1.md) |
| 21 | Common Iterator Consumers and Adapters used in Substrate | Idioms | [Visit]([./docs/deep-dive-into-substrate-consensus-part-1.md](https://github.com/Chondria/SiB/blob/main/docs/Common%20Iterator%20Adapters%20and%20Consumers%20used%20in%20Substrate.md)) |
| 22 | Deep dive into Substrate consensus - part 2 | Consensus (Block Finality) | [Visit](./docs/deep-dive-into-substrate-consensus-part-2.md) |
| 23 | Associated types vs Generic type parameters in Rust and Substrate | Idioms | [Visit](./docs/Associated%20types%20vs%20Generic%20type%20parameters%20in%20Rust%20and%20Substrate.md) |
| 24 | Deep dive into Substrate storage - part 1 | Tries | [Visit](./docs/deep-dive-into-substrate-storage-part-1.md) |
| 25 | Deep dive into Substrate storage - part 2 | KVDB | [Visit](./docs/deep-dive-into-substrate-storage-part-2.md) |
| 26 | Understanding runtime aggregation in substrate | Runtime | [Visit](https://github.com/Chondria/SiB/blob/main/docs/Understanding%20runtime%20aggregation%20in%20substrate.md) |
| 27 | Networking in Substrate - part 1 | Network | [Visit](./docs/networking-in-substrate-1.md) |
| 28 | Networking in Substrate - part 1 | Network | [Visit](./docs/networking-in-substrate-2.md) |
| 29 | Understanding Node Configurations | Node | [Visit](./docs/networking-in-substrate.md) |
| 30 | Testing a Substrate Node | Testing | [Visit](./docs/networking-in-substrate.md) |
| 31 | Understanding Offchain Workers | Offchain workers | [Visit](./docs/understanding-offchain-workers.md) |## Contributing
We welcome contributions to Substrate in Bits! If you would like to contribute, please read our [contributing guidelines](https://github.com/Chondria/SiB/blob/main/CONTRIBUTING.md) (WIP) for more information.
## Code of Conduct
We expect all contributors to abide by our [code of conduct](https://github.com/Chondria/SiB/blob/main/CODE_OF_CONDUCT.md) (WIP). Please read it carefully before contributing to the Substrate in Bits repository.
## Links
Have ideas to help improve SiB content? drop them [here](https://github.com/Chondria/SiB/discussions/categories/ideas)
You can ask questions regarding siB content [here](https://github.com/Chondria/SiB/discussions/categories/q-a)
Track our progress [here](https://airtable.com/shrrqq3AdMIbaJ4xT)
Track our content release [here](https://airtable.com/shrogrBF0CJ4caIYL)