Update examples docs with signature verification

[lealobanov]

Description

Update examples docs with recently merged PR for signature verification

---

For contributor use:

• Targeted PR against master branch
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Code follows the standards mentioned here.
• Updated relevant documentation
• Re-reviewed Files changed in the Github PR explorer
• Added appropriate labels

Summary by CodeRabbit

• New Features

  • Added a "Verifying Signatures" section in the README for both Java and Kotlin examples, enhancing user understanding of message signing and verification processes.

• Documentation

  • Improved clarity and usability of the SDK documentation by detailing common paradigms for signing messages.

[coderabbitai]

Walkthrough

The changes introduce a new section titled "Verifying Signatures" in the README files for both the Java and Kotlin examples. This section describes common paradigms for signing messages, including methods for signing arbitrary messages, user messages with public key verification, and flexible verification allowing any public key to validate a message.

Changes

Files	Change Summary
java-example/README.md	Added "Verifying Signatures" section detailing signing methods.
kotlin-example/README.md	Added "Verifying Signatures" section detailing signing methods.

Poem

🐇 In the meadow where bunnies play,
New signatures dance in a bright array.
With keys that twinkle, and messages clear,
We hop with joy, for the changes are here!
A leap of code, a bound of delight,
Verifying signatures, oh what a sight! 🌼

---

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.

[github-actions]

SDK Examples Unit Test Results

16 files  16 suites   0s ⏱️
32 tests   0 ✔️ 0 💤 32 ❌

For more details on these failures, see this check.

Results for commit bac6417.

[github-actions]

Common Integration Test Results

0 files  0 suites   0s ⏱️
0 tests 0 ✔️ 0 💤 0 ❌

Results for commit bac6417.

[github-actions]

Unit Test Results

  53 files  ±0    53 suites  ±0   8s ⏱️ ±0s
310 tests ±0  307 ✔️ ±0  0 💤 ±0  3 ❌ ±0 

For more details on these failures, see this check.

Results for commit bac6417. ± Comparison against base commit b4df69c.

[github-actions]

Integration Test Results

0 files  ±0  0 suites  ±0   0s ⏱️ ±0s
0 tests ±0  0 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit bac6417. ± Comparison against base commit b4df69c.

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b4df69c and bac6417.

Files selected for processing (2)

• java-example/README.md (2 hunks)
• kotlin-example/README.md (2 hunks)

Additional context used

LanguageTool

java-example/README.md

[style] ~121-~121: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ..., respecting the weights of each key. - Signing an arbitrary user message and verifying...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

kotlin-example/README.md

[style] ~121-~121: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ..., respecting the weights of each key. - Signing an arbitrary user message and verifying...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Markdownlint

kotlin-example/README.md

22-22: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

Additional comments not posted (1)

java-example/README.md (1)

22-22: Table of Contents Updated Correctly

The addition of "Verifying Signatures" to the Table of Contents is correctly implemented and links appropriately to the new section.