fix: fix typos

[aimensahnoun]

Resolves #7

• Fixes typos in the getRequestsByWalletAddress method
• Mention default value in payRequest JSDoc

Summary by CodeRabbit

• Bug Fixes

  • Corrected spelling of "Address" in function names and labels to enhance clarity and consistency.
  • Updated documentation to accurately reflect the corrected function names and clarify parameters.

• Documentation

  • Improved JSDoc comments for payRequest and getRequestsByWalletAddress functions for better user understanding.

[coderabbitai]

Walkthrough

The changes in this pull request involve correcting spelling errors in function names and associated documentation across several files. Specifically, the term "Adderess" has been consistently corrected to "Address" in function names, variable names, and documentation comments. These modifications ensure that the code and its documentation accurately reflect the intended functionality and improve overall clarity.

Changes

Files	Change Summary
src/index.ts	Renamed getRequestsByWalletAdderess to getRequestsByWalletAddress in value and label properties.
src/injector.ts	Renamed getRequestsByWalletAdderessMethod to getRequestsByWalletAddressMethod in import and functionInfoMap.
src/methods/index.ts	Renamed export const getRequestsByWalletAdderessMethod to export const getRequestsByWalletAddressMethod.
src/methods/jsDoc.ts	Updated JSDoc for payRequest to clarify confirmationBlocks as "optional, default is 2" and corrected example usage of getRequestsByWalletAddress.

Tip

New features

Walkthrough comment now includes:

• Possibly related PRs: A list of potentially related PRs to help you recall past context.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.

Notes:

• Please share any feedback in the discussion post on our Discord.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between efe4004 and 488fddb.

Files selected for processing (4)

• src/index.ts (1 hunks)
• src/injector.ts (2 hunks)
• src/methods/index.ts (1 hunks)
• src/methods/jsDoc.ts (3 hunks)

Additional comments not posted (6)

src/injector.ts (2)

19-19: Corrected method name in imports.

The method name getRequestsByWalletAddressMethod has been correctly updated in the imports section to reflect the new, typo-free naming convention.

---

68-69: Corrected method name in functionInfoMap.

The entry for getRequestsByWalletAddress in functionInfoMap has been updated to use the corrected method name. This change ensures consistency and correctness in the mapping of function names to their implementations and associated metadata.

src/index.ts (1)

40-42: Corrected function name in options list.

The value and label for the option related to getRequestsByWalletAddress have been correctly updated to reflect the new, typo-free naming convention. This change enhances the clarity and professionalism of the user interface.

src/methods/index.ts (1)

199-199: Corrected exported constant name.

The exported constant getRequestsByWalletAddressMethod has been correctly updated to reflect the new, typo-free naming convention. This change ensures that the codebase remains professional and free of typographical errors.

src/methods/jsDoc.ts (2)

86-86: Documentation improvement approved.

The clarification of the confirmationBlocks parameter as "optional, default is 2" enhances the clarity and usability of the documentation. This change ensures that developers are aware of the default behavior without ambiguity.

---

147-147: Typographical correction approved.

Correcting the typo in the function name from "Adderess" to "Address" in the example usage improves the accuracy of the documentation and prevents potential confusion. This change is crucial for maintaining the integrity and usability of the documentation.