[Debt] Improve consistency of best practice application

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,33 @@
+<!--
+Thank you for your Pull Request. Please provide a description above and review
+the requirements below.
+
+Bug fixes and new features should include tests.
+
+Contributors guide: https://github.com/alloy-rs/examples/blob/main/CONTRIBUTING.md
+
+The contributors guide includes instructions for running rustfmt and building the
+documentation.
+-->
+
+<!-- ** Please select "Allow edits from maintainers" in the PR Options ** -->
+
+## Motivation
+
+<!--
+Explain the context and why you're making that change. What is the problem
+you're trying to solve? In some cases there is not a problem and this can be
+thought of as being the motivation for your change.
+-->
+
+## Solution
+
+<!--
+Summarize the solution and provide any necessary context needed to understand
+the code change.
+-->
+
+## PR Checklist
+
+- [ ] Added Documentation
+- [ ] Breaking changes

CONTRIBUTING.md

@@ -125,11 +125,13 @@ less work from you.
 This section lists some commonly needed commands.
 
 ```sh
-cargo check --all-features
+cargo check --examples --all-features
+cargo build --examples --all-features
 cargo +nightly fmt --all
-cargo build --all-features
-cargo test --all-features
-cargo +nightly clippy --all-features
+cargo +nightly clippy \
+	--examples \
+	--all-features \
+	-- -D warnings
 ```
 
 ### Tests

Cargo.toml

@@ -13,6 +13,50 @@ repository = "https://github.com/alloy-rs/examples"
 publish = false
 exclude = ["examples/"]
 
+[workspace.lints]
+rust.missing_debug_implementations = "warn"
+rust.missing_docs = "warn"
+rust.unreachable_pub = "warn"
+rustdoc.all = "warn"
+rust.unused_must_use = "deny"
+rust.rust_2018_idioms = "deny"
+
+[workspace.lints.clippy]
+# These are some of clippy's nursery (i.e., experimental) lints that we like.
+# By default, nursery lints are allowed. Some of the lints below have made good
+# suggestions which we fixed. The others didn't have any findings, so we can
+# assume they don't have that many false positives. Let's enable them to
+# prevent future problems.
+branches_sharing_code = "warn"
+clear_with_drain = "warn"
+derive_partial_eq_without_eq = "warn"
+empty_line_after_outer_attr = "warn"
+equatable_if_let = "warn"
+imprecise_flops = "warn"
+iter_on_empty_collections = "warn"
+iter_with_drain = "warn"
+large_stack_frames = "warn"
+manual_clamp = "warn"
+mutex_integer = "warn"
+needless_pass_by_ref_mut = "warn"
+nonstandard_macro_braces = "warn"
+or_fun_call = "warn"
+path_buf_push_overwrite = "warn"
+read_zero_byte_vec = "warn"
+redundant_clone = "warn"
+suboptimal_flops = "warn"
+suspicious_operation_groupings = "warn"
+trailing_empty_array = "warn"
+trait_duplication_in_bounds = "warn"
+transmute_undefined_repr = "warn"
+trivial_regex = "warn"
+tuple_array_conversions = "warn"
+uninhabited_references = "warn"
+unused_peekable = "warn"
+unused_rounding = "warn"
+useless_let_if_seq = "warn"
+uninlined_format_args = "warn"
+
 [workspace.dependencies]
 alloy = { git = "https://github.com/alloy-rs/alloy", rev = "f7333c4", features = [
     # "dyn-abi",

README.md

@@ -3,7 +3,8 @@
 Example code using [alloy](https://github.com/alloy-rs/alloy) and [alloy-core](https://github.com/alloy-rs/core).
 
 These examples demonstrate the main features of [Alloy](https://github.com/alloy-rs/alloy) and how to use them.
-To run an example, use the command `cargo run --example <Example>`.
+
+To run an example, use the command `cargo run --example <Example>`:
 
 ```sh
 cargo run --example mnemonic_signer

examples/anvil/Cargo.toml

@@ -1,6 +1,5 @@
 [package]
 name = "examples-anvil"
-
 publish.workspace = true
 version.workspace = true
 edition.workspace = true
@@ -10,6 +9,9 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[lints]
+workspace = true
+
 [dev-dependencies]
 alloy.workspace = true
 

examples/anvil/examples/deploy_contract_anvil.rs

@@ -13,6 +13,7 @@ use eyre::Result;
 
 // Codegen from embedded Solidity code and precompiled bytecode.
 sol! {
+    #[allow(missing_docs)]
     // solc v0.8.24; solc a.sol --via-ir --optimize --bin
     #[sol(rpc, bytecode="608080604052346100155760d2908161001a8239f35b5f80fdfe60808060405260043610156011575f80fd5b5f3560e01c9081633fb5c1cb1460865781638381f58a14606f575063d09de08a146039575f80fd5b34606b575f366003190112606b575f545f1981146057576001015f55005b634e487b7160e01b5f52601160045260245ffd5b5f80fd5b34606b575f366003190112606b576020905f548152f35b34606b576020366003190112606b576004355f5500fea2646970667358221220bdecd3c1dd631eb40587cafcd6e8297479db76db6a328e18ad1ea5b340852e3864736f6c63430008180033")]
     contract Counter {
@@ -31,17 +32,17 @@ sol! {
 #[tokio::main]
 async fn main() -> Result<()> {
     // Spin up a local Anvil node.
-    // Ensure `anvil` is available in $PATH
+    // Ensure `anvil` is available in $PATH.
     let anvil = Anvil::new().try_spawn()?;
 
-    // Set up wallet
-    let wallet: LocalWallet = anvil.keys()[0].clone().into();
+    // Set up signer from the first default Anvil account (Alice).
+    let signer: LocalWallet = anvil.keys()[0].clone().into();
 
     // Create a provider with a signer and the network.
-    let http = anvil.endpoint().parse()?;
+    let rpc_url = anvil.endpoint().parse()?;
     let provider = ProviderBuilder::new()
-        .signer(EthereumSigner::from(wallet))
-        .on_client(RpcClient::new_http(http));
+        .signer(EthereumSigner::from(signer))
+        .on_client(RpcClient::new_http(rpc_url));
 
     println!("Anvil running at `{}`", anvil.endpoint());
 
@@ -54,7 +55,7 @@ async fn main() -> Result<()> {
     let contract_address =
         contract_builder.gas(estimate).gas_price(base_fee).nonce(0).deploy().await?;
 
-    println!("Deployed contract at address: {:?}", contract_address);
+    println!("Deployed contract at address: {contract_address:?}");
 
     let contract = Counter::new(contract_address, &provider);
 

examples/anvil/examples/fork_anvil.rs

@@ -6,7 +6,7 @@ use eyre::Result;
 #[tokio::main]
 async fn main() -> Result<()> {
     // Spin up a forked Anvil node.
-    // Ensure `anvil` is available in $PATH
+    // Ensure `anvil` is available in $PATH.
     let anvil = Anvil::new().fork("https://eth.merkle.io").try_spawn()?;
 
     println!("Anvil running at `{}`", anvil.endpoint());

examples/anvil/examples/local_anvil.rs

@@ -6,7 +6,7 @@ use eyre::Result;
 #[tokio::main]
 async fn main() -> Result<()> {
     // Spin up a local Anvil node.
-    // Ensure `anvil` is available in $PATH
+    // Ensure `anvil` is available in $PATH.
     let anvil = Anvil::new().block_time(1).chain_id(1337).try_spawn()?;
 
     println!("Anvil running at `{}`", anvil.endpoint());

examples/big-numbers/Cargo.toml

@@ -1,6 +1,5 @@
 [package]
 name = "examples-big-numbers"
-
 publish.workspace = true
 version.workspace = true
 edition.workspace = true
@@ -10,6 +9,9 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[lints]
+workspace = true
+
 [dev-dependencies]
 alloy.workspace = true
 

examples/contracts/Cargo.toml

@@ -1,6 +1,5 @@
 [package]
 name = "examples-contracts"
-
 publish.workspace = true
 version.workspace = true
 edition.workspace = true
@@ -10,6 +9,9 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[lints]
+workspace = true
+
 [dev-dependencies]
 alloy.workspace = true
 

examples/contracts/examples/deploy_from_artifact.rs

@@ -13,6 +13,7 @@ use eyre::Result;
 
 // Codegen from artifact.
 sol!(
+    #[allow(missing_docs)]
     #[sol(rpc)]
     Counter,
     "examples/artifacts/Counter.json"
@@ -21,17 +22,17 @@ sol!(
 #[tokio::main]
 async fn main() -> Result<()> {
     // Spin up a local Anvil node.
-    // Ensure `anvil` is available in $PATH
+    // Ensure `anvil` is available in $PATH.
     let anvil = Anvil::new().try_spawn()?;
 
-    // Set up wallet
-    let wallet: LocalWallet = anvil.keys()[0].clone().into();
+    // Set up signer from the first default Anvil account (Alice).
+    let signer: LocalWallet = anvil.keys()[0].clone().into();
 
     // Create a provider with a signer.
-    let http = anvil.endpoint().parse()?;
+    let rpc_url = anvil.endpoint().parse()?;
     let provider = ProviderBuilder::new()
-        .signer(EthereumSigner::from(wallet))
-        .on_client(RpcClient::new_http(http));
+        .signer(EthereumSigner::from(signer))
+        .on_client(RpcClient::new_http(rpc_url));
 
     println!("Anvil running at `{}`", anvil.endpoint());
 
@@ -44,7 +45,7 @@ async fn main() -> Result<()> {
     let contract_address =
         contract_builder.gas(estimate).gas_price(base_fee).nonce(0).deploy().await?;
 
-    println!("Deployed contract at address: {:?}", contract_address);
+    println!("Deployed contract at address: {contract_address:?}");
 
     let contract = Counter::new(contract_address, &provider);
 

examples/contracts/examples/deploy_from_contract.rs

@@ -13,6 +13,7 @@ use eyre::Result;
 
 // Codegen from embedded Solidity code and precompiled bytecode.
 sol! {
+    #[allow(missing_docs)]
     // solc v0.8.24; solc a.sol --via-ir --optimize --bin
     #[sol(rpc, bytecode="608080604052346100155760d2908161001a8239f35b5f80fdfe60808060405260043610156011575f80fd5b5f3560e01c9081633fb5c1cb1460865781638381f58a14606f575063d09de08a146039575f80fd5b34606b575f366003190112606b575f545f1981146057576001015f55005b634e487b7160e01b5f52601160045260245ffd5b5f80fd5b34606b575f366003190112606b576020905f548152f35b34606b576020366003190112606b576004355f5500fea2646970667358221220bdecd3c1dd631eb40587cafcd6e8297479db76db6a328e18ad1ea5b340852e3864736f6c63430008180033")]
     contract Counter {
@@ -31,17 +32,17 @@ sol! {
 #[tokio::main]
 async fn main() -> Result<()> {
     // Spin up a local Anvil node.
-    // Ensure `anvil` is available in $PATH
+    // Ensure `anvil` is available in $PATH.
     let anvil = Anvil::new().try_spawn()?;
 
-    // Set up wallet
-    let wallet: LocalWallet = anvil.keys()[0].clone().into();
+    // Set up signer from the first default Anvil account (Alice).
+    let signer: LocalWallet = anvil.keys()[0].clone().into();
 
     // Create a provider with a signer.
-    let http = anvil.endpoint().parse()?;
+    let rpc_url = anvil.endpoint().parse()?;
     let provider = ProviderBuilder::new()
-        .signer(EthereumSigner::from(wallet))
-        .on_client(RpcClient::new_http(http));
+        .signer(EthereumSigner::from(signer))
+        .on_client(RpcClient::new_http(rpc_url));
 
     println!("Anvil running at `{}`", anvil.endpoint());
 
@@ -54,7 +55,7 @@ async fn main() -> Result<()> {
     let contract_address =
         contract_builder.gas(estimate).gas_price(base_fee).nonce(0).deploy().await?;
 
-    println!("Deployed contract at address: {:?}", contract_address);
+    println!("Deployed contract at address: {contract_address:?}");
 
     let contract = Counter::new(contract_address, &provider);
 

examples/contracts/examples/generate.rs

@@ -5,6 +5,7 @@ use eyre::Result;
 
 // Codegen from ABI file to interact with the contract.
 sol!(
+    #[allow(missing_docs)]
     #[sol(rpc)]
     IERC20,
     "examples/abi/IERC20.json"
@@ -13,7 +14,7 @@ sol!(
 #[tokio::main]
 async fn main() -> Result<()> {
     // Spin up a forked Anvil node.
-    // Ensure `anvil` is available in $PATH
+    // Ensure `anvil` is available in $PATH.
     let anvil = Anvil::new().fork("https://eth.merkle.io").try_spawn()?;
 
     // Create a provider.

examples/layers/Cargo.toml

@@ -1,6 +1,5 @@
 [package]
 name = "examples-layers"
-
 publish.workspace = true
 version.workspace = true
 edition.workspace = true
@@ -10,6 +9,9 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[lints]
+workspace = true
+
 [dev-dependencies]
 alloy.workspace = true