Skip to content

Commit

Permalink
fix: typos in documentation files (#2481)
Browse files Browse the repository at this point in the history
This pull request contains changes to improve clarity, correctness and
structure.

**Description correction:**
Corrected `singerAdd` to `signerAdd` x2


Please review the changes and let me know if any additional changes are
needed.

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on correcting a typo in the comments of the
`multiPeerSyncEngine.test.ts` file, changing "singerAdd" to "signerAdd"
to ensure clarity regarding the synchronization process between
`syncEngine1` and `syncEngine2`.

### Detailed summary
- Corrected the comment from "singerAdd" to "signerAdd" in two instances
to accurately reflect the functionality of `syncEngine1`.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->
  • Loading branch information
leopardracer authored Jan 27, 2025
1 parent 50cd650 commit 0d57424
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions apps/hubble/src/network/sync/multiPeerSyncEngine.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ describe("Multi peer sync engine with streams", () => {
expect(await syncEngine2.trie.items()).toEqual(3 + 2); // 2 onchain events + 2 castAdds
expect(await syncEngine1.trie.items()).toEqual(3 + 1); // 2 onchain events + 1 castAdd

// Attempt to sync engine2 <-- engine1. Engine1 has only singerAdd
// Attempt to sync engine2 <-- engine1. Engine1 has only signerAdd
await syncEngine2.performSync("engine1", clientForServer1);

// The sync engine should realize that castAdd2 is not in it's engine, so it should be removed from the sync trie
Expand Down Expand Up @@ -1496,7 +1496,7 @@ describe("Multi peer sync engine with rpcs", () => {
expect(await syncEngine2.trie.items()).toEqual(3 + 2); // 2 onchain events + 2 castAdds
expect(await syncEngine1.trie.items()).toEqual(3 + 1); // 2 onchain events + 1 castAdd

// Attempt to sync engine2 <-- engine1. Engine1 has only singerAdd
// Attempt to sync engine2 <-- engine1. Engine1 has only signerAdd
await syncEngine2.performSync("engine1", clientForServer1);

// The sync engine should realize that castAdd2 is not in it's engine, so it should be removed from the sync trie
Expand Down

0 comments on commit 0d57424

Please sign in to comment.