Skip to content

Commit

Permalink
Fix Typos in Documentation and Tests (#2460)
Browse files Browse the repository at this point in the history
# Fix Typos in Documentation and Tests

## Summary
This pull request addresses minor typos in the following files:
1. `apps/hubble/src/test/e2e/gossipNetworkBundle.test.ts`
2. `packages/hub-nodejs/docs/signers/EthersV5Eip712Signer.md`

## Changes Made
### 1. `gossipNetworkBundle.test.ts`
- Fixed a typo in the comment: 
  - From: "beacuse" 
  - To: "because"

### 2. `EthersV5Eip712Signer.md`
- Fixed a typo in the comment: 
  - From: "can't erro" 
  - To: "can't error"

## Testing
These changes only affect comments and do not impact the functionality
of the code. No new tests were added as the code logic remains
unchanged.

## Checklist
- [x] Followed the [contributing guidelines](link-to-guidelines).
- [x] Verified changes locally.
- [x] Added clear descriptions and comments.

---

Thank you for reviewing this PR! Let me know if there’s anything else to
address.


<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on correcting minor typographical errors in comments
within the documentation and test files related to the
`EthersV5Eip712Signer` and `gossipNetworkBundle`.

### Detailed summary
- Fixed a typo in the comment for `blockHashBytes` in
`packages/hub-nodejs/docs/signers/EthersV5Eip712Signer.md`.
- Corrected a typo in the comment regarding invalid bundle gossiping in
`apps/hubble/src/test/e2e/gossipNetworkBundle.test.ts`.

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

<!-- end pr-codex -->
  • Loading branch information
teenager-ETH authored Jan 9, 2025
1 parent a4c5f2e commit ec23c0a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion packages/hub-nodejs/docs/signers/EthersV5Eip712Signer.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Generates a 256-bit signature for a VerificationClaim and returns the bytes.
import { FarcasterNetwork, hexStringToBytes, makeVerificationEthAddressClaim } from '@farcaster/hub-nodejs';

const blockHashHex = '0x1d3b0456c920eb503450c7efdcf9b5cf1f5184bf04e5d8ecbcead188a0d02018';
const blockHashBytes = hexStringToBytes(blockHashHex)._unsafeUnwrap(); // Safety: blockHashHex is known and can't erro
const blockHashBytes = hexStringToBytes(blockHashHex)._unsafeUnwrap(); // Safety: blockHashHex is known and can't error

const ethereumAddressResult = await eip712Signer.getSignerKey();

Expand Down

0 comments on commit ec23c0a

Please sign in to comment.