axone-protocol / docs

📜 Axone documentation portal (built with Docusaurus).
https://docs.axone.xyz/
BSD 3-Clause "New" or "Revised" License
40 stars 22 forks source link

Feat/add okp4d predicates doc #444

Closed ccamel closed 7 months ago

ccamel commented 7 months ago

Add the (missing) versioned documentation from the okp4/okp4d predicates v6.0.0, v7.0.0.

image

Summary by CodeRabbit

coderabbitai[bot] commented 7 months ago

[!WARNING]

Rate Limit Exceeded

@ccamel has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 22 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 399df3bf65779e39ed02c1edff1659885bc8df3e and 58ed0ade3e504b36c79d8147ecce365fee3957b0.

Walkthrough

The updates involve enhancing a collection of Prolog predicates tailored for blockchain operations, data processing, and encoding/decoding tasks. These changes introduce new functionalities and improve existing ones, covering a wide range of operations from querying blockchain data to handling various data formats and cryptographic verification, ensuring more robust and versatile applications.

Changes

Files Summary
predicates/bech32_address_2.md Modified formatting by removing code block indicator.
.../version-v6.0.0/predicates.md Introduced blockchain-related predicates.
.../version-v7.0.0/bank_balances_2.md Added bank_balances/2 for querying account balances.
.../version-v7.0.0/bank_locked_balances_2.md,
.../bank_spendable_balances_2.md
Introduced predicates for querying locked and spendable coin balances.
.../version-v7.0.0/bech32_address_2.md,
.../block_height_1.md,
.../block_time_1.md,
.../chain_id_1.md,
.../crypto_data_hash_3.md,
.../did_components_2.md,
.../ecdsa_verify_4.md,
.../eddsa_verify_4.md,
.../hex_bytes_2.md,
.../json_prolog_2.md,
.../open_4.md,
.../read_string_3.md,
.../source_file_1.md,
.../string_bytes_3.md,
.../uri_encoded_3.md
Added and updated predicates for blockchain data, encoding/decoding, and data processing.

🐇 A rabbit hopped through the code,
With a leap, a skip, and a nod to the node.
Changes made with care and glee,
Enhancing how data flows, as free as can be.
🌟 Through lines of logic, it danced with ease,
Celebrating updates with a soft, gentle breeze.
"To better programs," it whispered with delight,
As it vanished into the digital night. 🌙

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

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 .` - `Generate unit-tests for this file.` - 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 tests 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 tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.