add taplo CI + format all TOML files

.github/workflows/fmt.yaml

@@ -8,7 +8,7 @@ on:
       - main
       - dev
 
-name: Rustfmt
+name: Rustfmt + Taplo
 
 jobs:
   fmt:
@@ -32,6 +32,7 @@ jobs:
           toolchain: nightly
           override: true
           components: rustfmt
+
       - name: Run fmt in different workspaces and crates
         run: |
           cargo fmt --all --manifest-path=benches/Cargo.toml -- --check
@@ -40,3 +41,18 @@ jobs:
           cargo fmt --all --manifest-path=roles/Cargo.toml -- --check
           cargo fmt --all --manifest-path=utils/Cargo.toml -- --check
           cargo fmt --all --manifest-path=utils/message-generator/Cargo.toml -- --check
+
+      - name: Install Taplo
+        run: cargo install taplo-cli
+
+      - name: Run Taplo to check formatting on Cargo.toml files
+        id: taplo-check
+        run: taplo fmt --check -c .taplo-cargo.toml
+
+      - name: Run Taplo to check formatting on user-facing TOML files
+        id: taplo-check
+        run: taplo fmt --check -c .taplo-user-config.toml
+
+      - name: Run Taplo to check formatting on misc TOML files (not user-facing configs nor Cargo.toml)
+        id: taplo-check
+        run: taplo fmt --check -c .taplo-misc.toml

.taplo-cargo.toml

@@ -0,0 +1,2 @@
+# these formatting rules only apply to Cargo.toml files
+include = ["*/**/Cargo.toml"]

.taplo-misc.toml

@@ -0,0 +1,7 @@
+# these formatting rules only apply to misc TOML files (not user-facing configs nor Cargo.toml)
+exclude = [
+  "roles/**/*config*.toml",
+  "test/config/**/*.toml",
+  "examples/**/*config*.toml",
+  "*/**/Cargo.toml",
+]

.taplo-user-config.toml

@@ -0,0 +1,6 @@
+# these formatting rules only apply to user-facing TOML files
+include = [
+  "roles/**/*config*.toml",
+  "test/config/**/*.toml",
+  "examples/**/*config*.toml",
+]

CONTRIBUTING.md

@@ -94,6 +94,8 @@ The SRI project follows an open contributor model, where anyone is welcome to co
 
     `cargo fmt`: this command formats your code according to the project's style guidelines. Make sure to run this command to ensure consistency in code formatting.
 
+    `taplo fmt`: this command formats TOML files according to the project's style guidelines. Make sure to run this command to ensure consistency in code formatting.
+
 5. **Submit a Pull Request:** once you're satisfied with your changes, submit a pull request to the original SRI repository. Provide a clear and concise description of the changes you've made. If your pull request addresses an existing issue, reference the issue number in the description. In order to contribute to the protocol implementation, every PR must be opened against `dev` branch. To better understand which is the SRI branches structure, please have a look [here](https://github.com/stratum-mining/stratum/blob/main/RELEASE.md#principal-branches).
 
 6. **Review and Iterate** 

benches/Cargo.toml

@@ -4,32 +4,39 @@ version = "1.0.0"
 edition = "2021"
 
 [dependencies]
-async-std={version = "1.10.0", features = ["attributes"]}
+async-std = { version = "1.10.0", features = ["attributes"] }
 criterion = "0.5.1"
 async-channel = "1.4.0"
-v1 = { path="../protocols/v1", package="sv1_api", version = "^1.0.0" }
-serde_json = { version = "1.0.64", default-features = false, features = ["alloc"] }
-iai="0.1"
+v1 = { path = "../protocols/v1", package = "sv1_api", version = "^1.0.0" }
+serde_json = { version = "1.0.64", default-features = false, features = [
+  "alloc",
+] }
+iai = "0.1"
 mining_sv2 = { path = "../protocols/v2/subprotocols/mining", version = "^1.0.0" }
 roles_logic_sv2 = { path = "../protocols/v2/roles-logic-sv2", version = "^1.0.0" }
 framing_sv2 = { version = "1.1.0", path = "../protocols/v2/framing-sv2" }
-serde = { version = "1.0.89", default-features = false, features = ["derive", "alloc"] }
+serde = { version = "1.0.89", default-features = false, features = [
+  "derive",
+  "alloc",
+] }
 num-bigint = "0.4.3"
 num-traits = "0.2.15"
-bitcoin="0.28.1"
-codec_sv2 = { path = "../protocols/v2/codec-sv2", features=["noise_sv2"] }
+bitcoin = "0.28.1"
+codec_sv2 = { path = "../protocols/v2/codec-sv2", features = ["noise_sv2"] }
 binary_sv2 = { path = "../protocols/v2/binary-sv2/binary-sv2" }
-network_helpers_sv2 = { path = "../roles/roles-utils/network-helpers", features=["async_std"] }
+network_helpers_sv2 = { path = "../roles/roles-utils/network-helpers", features = [
+  "async_std",
+] }
 rand = "0.8.4"
 
 [[bench]]
 name = "criterion_sv1_benchmark"
-path="benches/src/sv1/criterion_sv1_benchmark.rs"
+path = "benches/src/sv1/criterion_sv1_benchmark.rs"
 harness = false
 
 [[bench]]
 name = "iai_sv1_benchmark"
-path="benches/src/sv1/iai_sv1_benchmark.rs"
+path = "benches/src/sv1/iai_sv1_benchmark.rs"
 harness = false
 
 [[bench]]

common/Cargo.toml

@@ -7,5 +7,9 @@ license = "MIT OR Apache-2.0"
 repository = "https://github.com/stratum-mining/stratum"
 
 [dependencies]
-bitcoin = {version="0.29.1",optional=true}
-secp256k1 = { version = "0.28.2", default-features = false, features =["alloc","rand","rand-std"] }
+bitcoin = { version = "0.29.1", optional = true }
+secp256k1 = { version = "0.28.2", default-features = false, features = [
+  "alloc",
+  "rand",
+  "rand-std",
+] }

examples/ping-pong-with-noise/Cargo.toml

@@ -9,14 +9,26 @@ publish = false
 
 [dependencies]
 rand = "0.8.3"
-serde = { version = "1.0.89", features = ["derive", "alloc"], default-features = false, optional = true}
+serde = { version = "1.0.89", features = [
+  "derive",
+  "alloc",
+], default-features = false, optional = true }
 async-channel = "1.5.1"
-async-std="1.8.0"
+async-std = "1.8.0"
 bytes = "1.0.1"
 binary_sv2 = { version = "^1.0.0", path = "../../protocols/v2/binary-sv2/binary-sv2" }
-codec_sv2 = { version = "^1.0.0", path = "../../protocols/v2/codec-sv2", features=["noise_sv2"] }
-network_helpers_sv2 = { version = "^2.0.0", path = "../../roles/roles-utils/network-helpers", features=["async_std"] }
+codec_sv2 = { version = "^1.0.0", path = "../../protocols/v2/codec-sv2", features = [
+  "noise_sv2",
+] }
+network_helpers_sv2 = { version = "^2.0.0", path = "../../roles/roles-utils/network-helpers", features = [
+  "async_std",
+] }
 key-utils = { version = "^1.0.0", path = "../../utils/key-utils" }
 
 [features]
-with_serde = ["binary_sv2/with_serde", "serde", "codec_sv2/with_serde", "network_helpers_sv2/with_serde"]
+with_serde = [
+  "binary_sv2/with_serde",
+  "serde",
+  "codec_sv2/with_serde",
+  "network_helpers_sv2/with_serde",
+]

examples/ping-pong-without-noise/Cargo.toml

@@ -9,9 +9,12 @@ publish = false
 
 [dependencies]
 rand = "0.8.3"
-serde = { version = "1.0.89", features = ["derive", "alloc"], default-features = false, optional = true}
+serde = { version = "1.0.89", features = [
+  "derive",
+  "alloc",
+], default-features = false, optional = true }
 async-channel = "1.5.1"
-async-std="1.8.0"
+async-std = "1.8.0"
 bytes = "1.0.1"
 binary_sv2 = { path = "../../protocols/v2/binary-sv2/binary-sv2" }
 codec_sv2 = { path = "../../protocols/v2/codec-sv2" }

examples/sv1-client-and-server/Cargo.toml

@@ -8,8 +8,13 @@ publish = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-v1={path="../../protocols/v1", package="sv1_api"}
-async-std="1.8.0"
-serde = { version = "1.0.89", default-features = false, features = ["derive", "alloc"] }
-serde_json = { version = "1.0.64", default-features = false, features = ["alloc"] }
+v1 = { path = "../../protocols/v1", package = "sv1_api" }
+async-std = "1.8.0"
+serde = { version = "1.0.89", default-features = false, features = [
+  "derive",
+  "alloc",
+] }
+serde_json = { version = "1.0.64", default-features = false, features = [
+  "alloc",
+] }
 async-channel = "1.5.1"

examples/sv2-proxy/proxy-config.toml

@@ -1,4 +1,6 @@
-upstreams = [{ address = "127.0.0.1", port = 34254, pub_key = "2di19GHYQnAZJmEpoUeP7C3Eg9TCcksHr23rZCC83dvUiZgiDL"}]
+upstreams = [
+  { address = "127.0.0.1", port = 34254, pub_key = "2di19GHYQnAZJmEpoUeP7C3Eg9TCcksHr23rZCC83dvUiZgiDL" },
+]
 listen_address = "127.0.0.1"
 listen_mining_port = 34255
 max_supported_version = 2

examples/template-provider-test/Cargo.toml

@@ -7,8 +7,12 @@ publish = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-codec_sv2 = { version = "1.0", path = "../../protocols/v2/codec-sv2", features=["noise_sv2"] }
+codec_sv2 = { version = "1.0", path = "../../protocols/v2/codec-sv2", features = [
+  "noise_sv2",
+] }
 roles_logic_sv2 = { version = "^0.1.0", path = "../../protocols/v2/roles-logic-sv2" }
-network_helpers_sv2 = { version = "^0.1.0", path = "../../roles/roles-utils/network-helpers", features=["async_std"] }
+network_helpers_sv2 = { version = "^0.1.0", path = "../../roles/roles-utils/network-helpers", features = [
+  "async_std",
+] }
 async-channel = "1.5.1"
-async-std={version = "1.8.0", features = ["attributes"]}
+async-std = { version = "1.8.0", features = ["attributes"] }

protocols/Cargo.toml

@@ -13,24 +13,24 @@ keywords = ["stratum", "mining", "bitcoin", "protocol"]
 
 [workspace]
 
-resolver="2"
+resolver = "2"
 
 members = [
-    "v1",
-    "v2/binary-sv2/serde-sv2",
-    "v2/binary-sv2/no-serde-sv2/codec",
-    "v2/binary-sv2/no-serde-sv2/derive_codec",
-    "v2/binary-sv2/binary-sv2",
-    "v2/noise-sv2",
-    "v2/framing-sv2",
-    "v2/codec-sv2",
-    "v2/const-sv2",
-    "v2/subprotocols/common-messages",
-    "v2/subprotocols/template-distribution",
-    "v2/subprotocols/mining",
-    "v2/subprotocols/job-declaration",
-    "v2/sv2-ffi",
-    "v2/roles-logic-sv2",
+  "v1",
+  "v2/binary-sv2/serde-sv2",
+  "v2/binary-sv2/no-serde-sv2/codec",
+  "v2/binary-sv2/no-serde-sv2/derive_codec",
+  "v2/binary-sv2/binary-sv2",
+  "v2/noise-sv2",
+  "v2/framing-sv2",
+  "v2/codec-sv2",
+  "v2/const-sv2",
+  "v2/subprotocols/common-messages",
+  "v2/subprotocols/template-distribution",
+  "v2/subprotocols/mining",
+  "v2/subprotocols/job-declaration",
+  "v2/sv2-ffi",
+  "v2/roles-logic-sv2",
 ]
 
 [profile.dev]

protocols/fuzz-tests/Cargo.toml

@@ -12,9 +12,11 @@ cargo-fuzz = true
 libfuzzer-sys = { version = "0.4.0", features = ["arbitrary-derive"] }
 arbitrary = { version = "1", features = ["derive"] }
 rand = "0.8.3"
-binary_codec_sv2 = { version = "1.0.0", path = "../v2/binary-sv2/no-serde-sv2/codec"}
-codec_sv2 = { version = "1.0.0", path = "../v2/codec-sv2", features = ["noise_sv2"]}
-roles_logic_sv2 = { version = "1.0.0", path = "../v2/roles-logic-sv2"}
+binary_codec_sv2 = { version = "1.0.0", path = "../v2/binary-sv2/no-serde-sv2/codec" }
+codec_sv2 = { version = "1.0.0", path = "../v2/codec-sv2", features = [
+  "noise_sv2",
+] }
+roles_logic_sv2 = { version = "1.0.0", path = "../v2/roles-logic-sv2" }
 affinity = "0.1.1"
 threadpool = "1.8.1"
 lazy_static = "1.4.0"

protocols/tarpaulin.toml

@@ -1,6 +1,6 @@
 [default]
 features = "disable_nopanic prop_test noise_sv2 with_buffer_pool derive_codec_sv2 binary_codec_sv2 default core"
-run-types = [ "Lib" ]
+run-types = ["Lib"]
 timeout = "120s"
 fail-under = 20
 

protocols/v1/Cargo.toml

@@ -15,10 +15,15 @@ byteorder = "1.2.7"
 pretty_env_logger = "0.4.0"
 log = "0.4.0"
 hex = "0.4.3"
-serde = { version = "1.0.89", default-features = false, features = ["derive", "alloc"] }
-serde_json = { version = "1.0.64", default-features = false, features = ["alloc"] }
-tracing = {version = "0.1"}
-binary_sv2 = { version = "^1.0.0", path = "../v2/binary-sv2/binary-sv2"}
+serde = { version = "1.0.89", default-features = false, features = [
+  "derive",
+  "alloc",
+] }
+serde_json = { version = "1.0.64", default-features = false, features = [
+  "alloc",
+] }
+tracing = { version = "0.1" }
+binary_sv2 = { version = "^1.0.0", path = "../v2/binary-sv2/binary-sv2" }
 
 [dev-dependencies]
 quickcheck = "1"

protocols/v2/binary-sv2/binary-sv2/Cargo.toml

@@ -10,11 +10,14 @@ repository = "https://github.com/stratum-mining/stratum"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-serde_sv2 = {version = "^1.0.0", path = "../serde-sv2", optional = true}
-serde = { version = "1.0.89", features = ["derive", "alloc"], default-features = false, optional = true }
-binary_codec_sv2 = {version = "^1.0.0", path = "../no-serde-sv2/codec", optional = true}
-derive_codec_sv2 = {version = "^1.0.0", path = "../no-serde-sv2/derive_codec", optional = true}
-tracing = {version = "0.1"}
+serde_sv2 = { version = "^1.0.0", path = "../serde-sv2", optional = true }
+serde = { version = "1.0.89", features = [
+  "derive",
+  "alloc",
+], default-features = false, optional = true }
+binary_codec_sv2 = { version = "^1.0.0", path = "../no-serde-sv2/codec", optional = true }
+derive_codec_sv2 = { version = "^1.0.0", path = "../no-serde-sv2/derive_codec", optional = true }
+tracing = { version = "0.1" }
 
 [features]
 default = ["core"]

protocols/v2/binary-sv2/no-serde-sv2/codec/Cargo.toml

@@ -10,8 +10,8 @@ repository = "https://github.com/stratum-mining/stratum"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-quickcheck = {version = "1.0.0", optional = true}
-buffer_sv2 = { version = "^1.0.0", path = "../../../../../utils/buffer", optional=true}
+quickcheck = { version = "1.0.0", optional = true }
+buffer_sv2 = { version = "^1.0.0", path = "../../../../../utils/buffer", optional = true }
 
 [features]
 no_std = []

protocols/v2/binary-sv2/no-serde-sv2/derive_codec/Cargo.toml

@@ -10,7 +10,7 @@ repository = "https://github.com/stratum-mining/stratum"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-binary_codec_sv2 = {version = "^1.0.0", path="../codec"}
+binary_codec_sv2 = { version = "^1.0.0", path = "../codec" }
 
 [lib]
 proc-macro = true

protocols/v2/binary-sv2/serde-sv2/Cargo.toml

@@ -7,9 +7,11 @@ description = "Serlializer and Deserializer for Stratum V2 data format"
 license = "MIT"
 repository = "https://github.com/stratum-mining/stratum"
 
-
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-serde = { version = "1.0.89", features = ["derive", "alloc"], default-features = false }
-buffer_sv2 = {version = "^1.0.0",  path = "../../../../utils/buffer"}
+serde = { version = "1.0.89", features = [
+  "derive",
+  "alloc",
+], default-features = false }
+buffer_sv2 = { version = "^1.0.0", path = "../../../../utils/buffer" }

protocols/v2/codec-sv2/Cargo.toml

@@ -10,14 +10,17 @@ repository = "https://github.com/stratum-mining/stratum"
 [dependencies]
 serde = { version = "1.0.89", default-features = false, optional = true }
 framing_sv2 = { version = "1.1.0", path = "../../../protocols/v2/framing-sv2" }
-noise_sv2 = { version = "1.0", path = "../../../protocols/v2/noise-sv2", optional=true}
+noise_sv2 = { version = "1.0", path = "../../../protocols/v2/noise-sv2", optional = true }
 binary_sv2 = { version = "1.0.0", path = "../../../protocols/v2/binary-sv2/binary-sv2" }
-const_sv2 = { version = "1.0.0", path = "../../../protocols/v2/const-sv2"}
-buffer_sv2 = { version = "1.0.0", path = "../../../utils/buffer"}
-tracing = { version = "0.1"}
-
-
+const_sv2 = { version = "1.0.0", path = "../../../protocols/v2/const-sv2" }
+buffer_sv2 = { version = "1.0.0", path = "../../../utils/buffer" }
+tracing = { version = "0.1" }
 
 [features]
-with_serde = ["binary_sv2/with_serde", "serde", "framing_sv2/with_serde", "buffer_sv2/with_serde"]
+with_serde = [
+  "binary_sv2/with_serde",
+  "serde",
+  "framing_sv2/with_serde",
+  "buffer_sv2/with_serde",
+]
 with_buffer_pool = ["framing_sv2/with_buffer_pool"]

protocols/v2/const-sv2/Cargo.toml

@@ -10,7 +10,12 @@ repository = "https://github.com/stratum-mining/stratum"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-secp256k1 = { version = "0.28.2", default-features = false, features =["hashes", "alloc","rand","rand-std"] }
+secp256k1 = { version = "0.28.2", default-features = false, features = [
+  "hashes",
+  "alloc",
+  "rand",
+  "rand-std",
+] }
 
 #[dev-dependencies]
 #cbindgen = "0.16.0"