Run codespell spellcheck on source (payjoin#562)

Author: DanGould

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = .git,target,Cargo.toml,Cargo.lock,Cargo-minimal.lock,Cargo-recent.lock
+ignore-words-list = crate,ser

.github/workflows/rust.yml

@@ -73,3 +73,10 @@ jobs:
         run: bash contrib/coverage.sh
       - name: "Upload report to coveralls"
         uses: coverallsapp/github-action@v2
+  
+  CodeSpell: 
+    name: Code spell check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: codespell-project/actions-codespell@v2

payjoin-directory/README.md

@@ -2,7 +2,7 @@
 
 ## Payjoin v2 Directory Server
 
-Payjoin v2 peers store and forward HTTP client messages via a directory server in order to cordinate an asynchronous Payjoin transaction. Version 1 Requires the receiver to host a public HTTP server and to set up security using either HTTPS or Onion Services above and beyond typical HTTP client operation.
+Payjoin v2 peers store and forward HTTP client messages via a directory server in order to coordinate an asynchronous Payjoin transaction. Version 1 Requires the receiver to host a public HTTP server and to set up security using either HTTPS or Onion Services above and beyond typical HTTP client operation.
 
 V2 clients use Hybrid Pubkey Encryption established in the bitcoin URI payment request for security instead, allowing lightweight clients secure communication without the burden of setup, which is done by the operator of this third-party directory server. This directory only sees OHTTP encapsulated, encrypted requests to prevent it from collecting metadata to break the privacy benefits of payjoin for messages who follow the spec.
 

payjoin-test-utils/src/lib.rs

@@ -200,7 +200,7 @@ pub fn init_bitcoind_multi_sender_single_reciever(
     let wallets_to_create =
         (0..number_of_senders + 1).map(|i| (format!("sender_{}", i), None)).collect::<Vec<_>>();
     let mut wallets = create_and_fund_wallets(&bitcoind, wallets_to_create)?;
-    let receiver = wallets.pop().expect("reciever to exist");
+    let receiver = wallets.pop().expect("receiver to exist");
     let senders = wallets;
 
     Ok((bitcoind, senders, receiver))

payjoin/CHANGELOG.md

@@ -133,7 +133,7 @@ This release attempts to stabilize the Payjoin V2 Bitcoin URI format. That inclu
 - Derive `Debug, Clone` from `send::Request`, `receive::UncheckedProposal`, `optional_parameters::Params`
 - Don't derive `Debug, Clone` from `uri::{Payjoin, PayjoinParams}`
 - Derive `Serialize, Deserialize` for `RequestContext` and `Enrolled` in `v2` to enable persistent state for asynchronous requests
-- `UncheckedProposal::check_can_broadcast` became `::check_broadcast_suitability` allowing receiver to specify minnimum acceptable feerate
+- `UncheckedProposal::check_can_broadcast` became `::check_broadcast_suitability` allowing receiver to specify minimum acceptable feerate
 
 ## 0.11.0
 
@@ -144,7 +144,7 @@ This release attempts to stabilize the Payjoin V2 Bitcoin URI format. That inclu
 - Export `base64` with feature by @jbesraa in #102
 - Improve `receive` api with `ProvisionalProposal`by @jbesraa in #90
 - Document `create_pj_request` by @jbesraa in #87
-- Add BIP 78 reccommended fee `Configuration` by @DanGould in #86
+- Add BIP 78 recommended fee `Configuration` by @DanGould in #86
 
 ## 0.9.0
 

payjoin/src/io.rs

@@ -7,7 +7,7 @@ use crate::OhttpKeys;
 
 /// Fetch the ohttp keys from the specified payjoin directory via proxy.
 ///
-/// * `ohttp_relay`: The http CONNNECT method proxy to request the ohttp keys from a payjoin
+/// * `ohttp_relay`: The http CONNECT method proxy to request the ohttp keys from a payjoin
 ///   directory.  Proxying requests for ohttp keys ensures a client IP address is never revealed to
 ///   the payjoin directory.
 ///
@@ -27,7 +27,7 @@ pub async fn fetch_ohttp_keys(
 
 /// Fetch the ohttp keys from the specified payjoin directory via proxy.
 ///
-/// * `ohttp_relay`: The http CONNNECT method proxy to request the ohttp keys from a payjoin
+/// * `ohttp_relay`: The http CONNECT method proxy to request the ohttp keys from a payjoin
 ///   directory.  Proxying requests for ohttp keys ensures a client IP address is never revealed to
 ///   the payjoin directory.
 ///

payjoin/src/receive/error.rs

@@ -174,7 +174,7 @@ pub(crate) enum InternalPayloadError {
     ///
     /// First argument is the calculated fee rate of the original PSBT.
     ///
-    /// Second argument is the minimum fee rate optionaly set by the receiver.
+    /// Second argument is the minimum fee rate optionally set by the receiver.
     PsbtBelowFeeRate(bitcoin::FeeRate, bitcoin::FeeRate),
     /// Effective receiver feerate exceeds maximum allowed feerate
     FeeTooHigh(bitcoin::FeeRate, bitcoin::FeeRate),

payjoin/src/receive/mod.rs

@@ -3,7 +3,7 @@
 //! This module contains types and methods used to implement receiving via Payjoin.
 //!
 //! For most use cases, we recommended enabling the `v2` feature, as it is
-//! backwards compatible and provides the most convenient experience for users and implementors.
+//! backwards compatible and provides the most convenient experience for users and implementers.
 //! To use version 2, refer to `receive::v2` module documentation.
 //!
 //! If you specifically need to use

payjoin/src/receive/optional_parameters.rs

@@ -82,7 +82,7 @@ impl Params {
                         Ok(fee_rate_sat_per_vb) => {
                             // TODO Parse with serde when rust-bitcoin supports it
                             let fee_rate_sat_per_kwu = fee_rate_sat_per_vb * 250.0_f32;
-                            // since it's a minnimum, we want to round up
+                            // since it's a minimum, we want to round up
                             FeeRate::from_sat_per_kwu(fee_rate_sat_per_kwu.ceil() as u64)
                         }
                         Err(_) => return Err(Error::FeeRate),

payjoin/src/receive/v1/mod.rs

@@ -80,7 +80,7 @@ impl UncheckedProposal {
     /// Receiver MUST check that the Original PSBT from the sender
     /// can be broadcast, i.e. `testmempoolaccept` bitcoind rpc returns { "allowed": true,.. }.
     ///
-    /// Receiver can optionaly set a minimum feerate that will be enforced on the Original PSBT.
+    /// Receiver can optionally set a minimum feerate that will be enforced on the Original PSBT.
     /// This can be used to prevent probing attacks and make it easier to deal with
     /// high feerate environments.
     ///
@@ -794,7 +794,7 @@ pub(crate) mod test {
     use super::*;
 
     // OriginalPSBT Test Vector from BIP
-    // | InputScriptType | Orginal PSBT Fee rate | maxadditionalfeecontribution | additionalfeeoutputindex|
+    // | InputScriptType | Original PSBT Fee rate | maxadditionalfeecontribution | additionalfeeoutputindex|
     // |-----------------|-----------------------|------------------------------|-------------------------|
     // | P2SH-P2WPKH     |  2 sat/vbyte          | 0.00000182                   | 0                       |
     pub const ORIGINAL_PSBT: &str = "cHNidP8BAHMCAAAAAY8nutGgJdyYGXWiBEb45Hoe9lWGbkxh/6bNiOJdCDuDAAAAAAD+////AtyVuAUAAAAAF6kUHehJ8GnSdBUOOv6ujXLrWmsJRDCHgIQeAAAAAAAXqRR3QJbbz0hnQ8IvQ0fptGn+votneofTAAAAAAEBIKgb1wUAAAAAF6kU3k4ekGHKWRNbA1rV5tR5kEVDVNCHAQcXFgAUx4pFclNVgo1WWAdN1SYNX8tphTABCGsCRzBEAiB8Q+A6dep+Rz92vhy26lT0AjZn4PRLi8Bf9qoB/CMk0wIgP/Rj2PWZ3gEjUkTlhDRNAQ0gXwTO7t9n+V14pZ6oljUBIQMVmsAaoNWHVMS02LfTSe0e388LNitPa1UQZyOihY+FFgABABYAFEb2Giu6c4KO5YW0pfw3lGp9jMUUAAA=";