📜 Add v8.0.0 predicates documentation version

[bot-anik]

📜 Documentation update

🎉 A new version of axone-protocol/axoned is available.

This PR add this new v8.0.0 version into the documentation.

Summary by CodeRabbit

• New Features
  • Introduced various predicates for handling blockchain-related data, including:
    • bank_locked_balances/2 for retrieving locked balances.
    • bank_spendable_balances/2 for retrieving spendable balances.
    • bech32_address/2 for converting bech32 encoded strings.
    • block_height/1 for current block height.
    • block_time/1 for current block time.
    • chain_id/1 for current chain ID.
    • crypto_data_hash/3 for computing data hash.
    • did_components/2 for dissecting DIDs.
    • ecdsa_verify/4 and eddsa_verify/4 for signature verification.
    • hex_bytes/2 for hexadecimal conversion.
    • json_prolog/2 for JSON-Prolog conversion.
    • open/3 and open/4 for stream handling.
    • read_string/3 for reading strings from streams.
    • string_bytes/3 for string-byte conversion.
    • uri_encoded/3 for URI encoding/decoding.
  • Added consult/1 and current_output/1 predicates for Prolog file and stream handling.
  • Updated documentation to include these new features in version "v8.0.0".

[coderabbitai]

Note

Reviews Paused

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Walkthrough

In version 8.0.0, a variety of new predicates have been introduced to enhance Prolog's capabilities in handling blockchain-related data, cryptographic operations, file I/O, and data encoding/decoding. These additions include predicates for retrieving account balances, verifying cryptographic signatures, converting between different data formats, and managing stream operations. This update significantly broadens the scope of Prolog's utility in modern applications, especially in blockchain and cryptography.

Changes

Files	Change Summary
.../bank_locked_balances_2.md, .../bank_spendable_balances_2.md, .../bech32_address_2.md	Introduces predicates for handling account balances and Bech32 address conversions.
.../block_height_1.md, .../block_time_1.md, .../chain_id_1.md	Introduces predicates to retrieve blockchain-specific data like block height, time, and chain ID.
.../consult_1.md, .../current_output_1.md, .../source_file_1.md	Introduces predicates for Prolog file operations and stream management.
.../crypto_data_hash_3.md, .../ecdsa_verify_4.md, .../eddsa_verify_4.md	Introduces predicates for cryptographic hashing and signature verification.
.../hex_bytes_2.md, .../json_prolog_2.md, .../string_bytes_3.md, .../uri_encoded_3.md	Introduces predicates for data encoding and decoding between various formats.
.../open_3.md, .../open_4.md, .../read_string_3.md	Introduces predicates for opening streams and reading data.
predicates_versions.json	Adds the new version "v8.0.0" to the list of versions.

In the realm of code, where logic does abide,
New predicates emerge, enhancing the ride.
From blockchain heights to cryptographic might,
Streams and bytes now dance in the light.
Prolog’s grown stronger, with each new line,
Version 8.0.0, a leap so fine.
🐇✨

---

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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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: 9

Outside diff range and nitpick comments (6)

predicates_versioned_docs/version-v8.0.0/open_3.md (1)

1-1: Ensure the first line is a top-level heading to maintain consistency and clarity in documentation.

predicates_versioned_docs/version-v8.0.0/ecdsa_verify_4.md (1)

1-1: Ensure the first line is a top-level heading to maintain consistency and clarity in documentation.

predicates_versioned_docs/version-v8.0.0/block_height_1.md (1)

1-1: Ensure the first line is a top-level heading to maintain consistency and clarity in documentation.

predicates_versioned_docs/version-v8.0.0/block_time_1.md (1)

1-1: Ensure the first line is a top-level heading to maintain consistency and clarity in documentation.

predicates_versioned_docs/version-v8.0.0/crypto_data_hash_3.md (1)

1-1: Ensure the first line is a top-level heading to maintain consistency and clarity in documentation.

predicates_versioned_docs/version-v8.0.0/current_output_1.md (1)

1-1: Ensure the first line is a top-level heading to maintain consistency and clarity in documentation.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 107f789 and 9d20ab8.

Files selected for processing (23)

• predicates_versioned_docs/version-v8.0.0/bank_balances_2.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/bank_locked_balances_2.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/bank_spendable_balances_2.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/bech32_address_2.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/block_height_1.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/block_time_1.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/chain_id_1.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/consult_1.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/crypto_data_hash_3.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/current_output_1.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/did_components_2.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/ecdsa_verify_4.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/eddsa_verify_4.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/hex_bytes_2.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/json_prolog_2.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/open_3.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/open_4.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/read_string_3.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/source_file_1.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/string_bytes_3.md (1 hunks)
• predicates_versioned_docs/version-v8.0.0/uri_encoded_3.md (1 hunks)
• predicates_versioned_sidebars/version-v8.0.0-sidebars.json (1 hunks)
• predicates_versions.json (1 hunks)

Files not summarized due to errors (1)

• predicates_versioned_docs/version-v8.0.0/bank_balances_2.md: Error: Server error. Please try again later.

Files skipped from review due to trivial changes (2)

• predicates_versioned_sidebars/version-v8.0.0-sidebars.json
• predicates_versions.json

Additional Context Used

Markdownlint (21)

predicates_versioned_docs/version-v8.0.0/bank_balances_2.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/bank_locked_balances_2.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/bank_spendable_balances_2.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/bech32_address_2.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/block_height_1.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/block_time_1.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/chain_id_1.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/consult_1.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/crypto_data_hash_3.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/current_output_1.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/did_components_2.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/ecdsa_verify_4.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/eddsa_verify_4.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/hex_bytes_2.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/json_prolog_2.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/open_3.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/open_4.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/read_string_3.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/source_file_1.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/string_bytes_3.md (1)

4: null
First line in a file should be a top-level heading

predicates_versioned_docs/version-v8.0.0/uri_encoded_3.md (1)

4: null
First line in a file should be a top-level heading

Additional comments not posted (12)

predicates_versioned_docs/version-v8.0.0/source_file_1.md (1)

1-20: The documentation for source_file/1 is clear and well-structured. The explanation and examples are concise and informative.

predicates_versioned_docs/version-v8.0.0/chain_id_1.md (1)

1-27: The documentation for chain_id/1 is clear and well-structured. The explanation and examples are concise and informative.

predicates_versioned_docs/version-v8.0.0/hex_bytes_2.md (1)

1-28: The documentation for hex_bytes/2 is clear and well-structured. The explanation and examples are concise and informative.

predicates_versioned_docs/version-v8.0.0/json_prolog_2.md (1)

1-30: The documentation for json_prolog/2 is clear and well-structured. The explanation and examples are concise and informative.

predicates_versioned_docs/version-v8.0.0/bank_balances_2.md (1)

1-34: The documentation for bank_balances/2 is clear and well-structured. The explanation and examples are concise and informative.

predicates_versioned_docs/version-v8.0.0/uri_encoded_3.md (1)

1-35: The documentation for uri_encoded/3 is clear and well-structured. The explanation and examples are concise and informative.

predicates_versioned_docs/version-v8.0.0/consult_1.md (2)

6-16: The description and signature of the consult/1 predicate are clear and well-documented.

---

24-208: The examples provided are comprehensive and effectively illustrate the usage of the consult/1 predicate in various scenarios.

predicates_versioned_docs/version-v8.0.0/bech32_address_2.md (2)

6-17: The description and signature of the bech32_address/2 predicate are clear and well-documented.

---

24-224: The examples and error handling scenarios provided are comprehensive and effectively illustrate the usage of the bech32_address/2 predicate in various scenarios.

predicates_versioned_docs/version-v8.0.0/open_4.md (2)

6-16: The description and signature of the open/4 predicate are clear and well-documented.

---

25-315: The examples and error handling scenarios provided are comprehensive and effectively illustrate the usage of the open/4 predicate in various scenarios.

[bot-anik]

Device	URL
desktop	http://localhost:3000/

Device	URL
mobile	http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

[ccamel]

@coderabbitai ignore

[coderabbitai]

@coderabbitai ignore

Actions Performed

Reviews paused.

[ccamel]

LGTM! 😃