Added requirements section + --ipfs-server arg to the README.md (#51)

* Added `--ipfs-server` arg

* Added requirements

* typo

* Nit

* Nits

* Add litep2p check on startup (just in case)

Author: bkontur

README.md

@@ -52,9 +52,39 @@ Stores arbitrary data on IPFS via the `store` extrinsic, provided that either th
 
 ## Prepare for a production
 
+### Requirements
+
+#### Validator node args
+
+The validator node should be started with the following arguments:
+* `--ipfs-server` - enables IPFS support.
+* `--network-backend=litep2p` - enables Bitswap support, which is only available with the litep2p network backend, but this is Substrate’s default.
+
+#### Storage
+
+There are no special requirements for the production runtime (just as the usual [validator/node](https://docs.polkadot.com/infrastructure/running-a-validator/#running-a-validator)), except those related to IPFS support.
+With the current configuration, the maximum storage requirement is estimated as follows:
+
+* Storing data for up to 2 weeks:
+
+  $$
+  2 \times 7 \times 24 \times 60 \times 60 = 1,209,600 \, \text{seconds}
+  $$
+
+  divided by a 6-second block time = **201,600 blocks**
+
+* Each block can contain up to 8–10 MiB (based on `MaxTransactionSize = 8 MiB` and `BlockLength = 10 MiB`)
+* Total = **1,612,800–2,016,000 MiB ≈ 1,575–1,968 GiB of storage (maximum)**
+
+But this is the maximum limit, assuming full utilization of every block for two weeks, which we are unlikely to reach.
+
+TODO: @georgepisaltu Can we provide a more realistic estimate based on the testnet data?
+
+TODO: @georgepisaltu Is this still valid that we need to keep 2-week data?
+
 ### Prepare keys for a production chain
 
-This chapter provides a one-time example setup. For more details about running a validator and key management, see: [https://docs.polkadot.com/infrastructure/running-a-validator/#running-a-validator.”](https://docs.polkadot.com/infrastructure/running-a-validator/#running-a-validator.”).
+This chapter provides a one-time example setup. For more details about running a validator and key management, see: [https://docs.polkadot.com/infrastructure/running-a-validator/#running-a-validator](https://docs.polkadot.com/infrastructure/running-a-validator/#running-a-validator.”).
 
 **Prerequisites:**
 ```
@@ -166,11 +196,11 @@ _Note: This is relevant only for the initial launch; after that, we expect Polka
 * Run node
    ```
    # point to updated chain spec
-   ./target/release/polkadot-bulletin-chain --validator --chain ./node/chain-specs/bulletin-polkadot.json --base-path /tmp/bulletin --node-key-file /tmp/bulletin/chains/bulletin-polkadot/network/secret_ed25519
+   ./target/release/polkadot-bulletin-chain --ipfs-server --validator --chain ./node/chain-specs/bulletin-polkadot.json --base-path /tmp/bulletin --node-key-file /tmp/bulletin/chains/bulletin-polkadot/network/secret_ed25519
    or
    # rebuild because of updated chain spec
    cargo build --release -p polkadot-bulletin-chain
-   ./target/release/polkadot-bulletin-chain --validator --chain bulletin-polkadot --base-path /tmp/bulletin --node-key-file /tmp/bulletin/chains/bulletin-polkadot/network/secret_ed25519
+   ./target/release/polkadot-bulletin-chain --ipfs-server --validator --chain bulletin-polkadot --base-path /tmp/bulletin --node-key-file /tmp/bulletin/chains/bulletin-polkadot/network/secret_ed25519
    ```
 * **You should see finalized blocks in the logs.**
 * **!!! Push changes `./scripts/create_bulletin_polkadot_spec.sh` !!!**
@@ -180,7 +210,7 @@ _Note: This is relevant only for the initial launch; after that, we expect Polka
 ### Run production chain
 ```
 # You can omit `--validator` if you are not part of the active validator set.
-./target/release/polkadot-bulletin-chain --validator --chain bulletin-polkadot <other-relevant-params: ./target/release/polkadot-bulletin-chain --help>
+./target/release/polkadot-bulletin-chain --ipfs-server --validator --chain bulletin-polkadot <other-relevant-params: ./target/release/polkadot-bulletin-chain --help>
 ```
 
 ### Run local chain

node/src/command.rs

@@ -7,9 +7,9 @@ use crate::{
 use frame_benchmarking_cli::{BenchmarkCmd, ExtrinsicFactory, SUBSTRATE_REFERENCE_HARDWARE};
 use polkadot_bulletin_chain_runtime::Block;
 use sc_cli::SubstrateCli;
+use sc_network::config::NetworkBackendType;
 use sc_service::PartialComponents;
 use std::{sync::Arc, time::Duration};
-
 #[cfg(feature = "try-runtime")]
 use {
 	polkadot_bulletin_chain_runtime::SLOT_DURATION,
@@ -239,6 +239,18 @@ pub fn run() -> sc_cli::Result<()> {
 					config.network.idle_connection_timeout = IPFS_WORKAROUND_TIMEOUT;
 				}
 
+				if config.network.ipfs_server {
+					match config.network.network_backend {
+						NetworkBackendType::Litep2p => (),
+						NetworkBackendType::Libp2p => {
+							return Err(
+								"For `ipfs-server`, we expect only the `config.network.network_backend=litep2p` (`--network-backend=litep2p`) setting, because Bitswap support requires it!"
+									.into(),
+							)
+						}
+					}
+				}
+
 				service::new_full::<sc_network::Litep2pNetworkBackend>(config)
 					.map_err(sc_cli::Error::Service)
 			})

runtime/Cargo.toml

@@ -87,7 +87,6 @@ pallet-xcm = { optional = true, workspace = true }
 pallet-staking = { optional = true, workspace = true }
 sp-staking = { optional = true, workspace = true }
 parachains-common = { optional = true, workspace = true }
-# pallet-revive = { optional = true, workspace = true }
 
 [build-dependencies]
 substrate-wasm-builder = { optional = true, workspace = true }

runtimes/bulletin-polkadot/Cargo.toml

@@ -84,7 +84,6 @@ pallet-xcm = { optional = true, workspace = true }
 pallet-staking = { optional = true, workspace = true }
 sp-staking = { optional = true, workspace = true }
 parachains-common = { optional = true, workspace = true }
-# pallet-revive = { optional = true, workspace = true }
 
 [build-dependencies]
 substrate-wasm-builder = { optional = true, workspace = true }