InjectiveLabs / docs

Injective Protocol Documentation
Apache License 2.0
16 stars 4 forks source link

feat/add_staking_and_chain_exchange_documentation #159

Closed aarmoa closed 6 months ago

aarmoa commented 6 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent updates focus on enhancing security, flexibility, and precision within the SDK. Key improvements include better handling of environment variables, updating import statements, refining code snippets for various functionalities like auctions, authorization, and broadcasting, and introducing more detailed documentation. These changes aim to streamline development processes, improve code security through dynamic key loading, and ensure accurate computations and data handling across different modules.

Changes

Files Change Summaries
Makefile Added -c json-to-html-table option to markdown-autodocs command.
source/includes/_auction.md
source/includes/_authz.md
source/includes/_bank.md
source/includes/_broadcaster.md
source/includes/_insurance.md
source/includes/_oracle.md
source/includes/_wasmx.md
Updated code snippets: import statements, environment variable handling, private key configuration, gas fee computation, and method adjustments.
source/includes/_chainstream.md
source/includes/_tokenfactory.md
Updated functionality and paths for Python and Go examples.
source/includes/_changelog.md Added support for distribution and chain exchange modules in Python SDK v1.4.0.
source/includes/_faq.md Added details on transaction latency, block production, gas limit, and P2P latency.
source/includes/_spotrpc.md Renamed ***SpotOrderHistory*** to **SpotOrderHistory**.
source/includes/_wasm.md Updated querying functionalities for validator rewards, contract interactions, and metadata.
source/index.html.md Reorganized listed modules in the documentation.

"In the garden of code, where the bits softly tread,
🐇 A rabbit hopped in, with a mission ahead.
To tweak and to change, with a meticulous care,
Ensuring security's tight, with none to spare.
From auctions to auth, and oracles too,
It spruced up the docs, making everything new.
🌟 'Tis a tale of updates, both big and small,
A hop in the right step, for one and for all."


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.` - `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 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.