InjectiveLabs / sdk-go

Tools to work with the Injective Chain, Injective EVM and EIP712.
Apache License 2.0
95 stars 41 forks source link

Feat/permissions module messages #230

Closed aarmoa closed 3 months ago

aarmoa commented 3 months ago

Added support in the SDK for the permissions module's queries and messages Included examples for the queries and messages

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduce a comprehensive permissions management system within the blockchain client, enhancing the ChainClient interface with multiple new methods for querying permissions-related data. This modular approach allows for better control over access and roles associated with blockchain namespaces. Additionally, new test cases and examples illustrate how to implement and interact with these features, promoting usability and developer engagement.

Changes

Files Change Summary
client/chain/chain.go Enhanced ChainClient with new permission-related methods; added permissionsQueryClient.
client/chain/chain_test.go, Updated test functions to use "devnet" instead of "testnet".
client/chain/chain_test_support.go Added new methods to MockChainClient for permissions queries.
client/common/network.go Simplified LoadNetwork function, removing detailed handling for "testnet" and "mainnet".
examples/chain/permissions/1_CreateNamespace/example.go Implemented namespace creation with permissions.
examples/chain/permissions/2_DeleteNamespace/example.go Implemented functionality to delete a namespace.
examples/chain/permissions/3_UpdateNamespace/example.go Allowed updating of a namespace's permissions.
examples/chain/permissions/4_UpdateNamespaceRoles/example.go Added capability to update roles within a namespace.
examples/chain/permissions/5_RevokeNamespaceRoles/example.go Implemented role revocation for a namespace.
examples/chain/permissions/6_ClaimVoucher/example.go Facilitated claiming of vouchers on the blockchain.
examples/chain/permissions/query/1_AllNamespaces/example.go Created a tool to fetch all namespaces.
examples/chain/permissions/query/2_NamespaceByDenom/example.go Implemented fetching namespace by denomination.
examples/chain/permissions/query/3_AddressRoles/example.go Enabled queries for roles associated with an address.
examples/chain/permissions/query/4_AddressesByRole/example.go Retrieved addresses linked to a specific role.
examples/chain/permissions/query/5_VouchersForAddress/example.go Implemented fetching vouchers associated with an address.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChainClient
    participant Blockchain

    User->>ChainClient: Create Namespace with Permissions
    ChainClient->>Blockchain: Send MsgCreateNamespace
    Blockchain-->>ChainClient: Confirmation
    ChainClient-->>User: Success Response
sequenceDiagram
    participant User
    participant ChainClient
    participant Blockchain

    User->>ChainClient: Fetch All Namespaces
    ChainClient->>Blockchain: Query All Namespaces
    Blockchain-->>ChainClient: Namespaces Data
    ChainClient-->>User: Display Namespaces

A Bunny's Delight
In fields of code, I hop with glee,
New permissions bloom, as fresh as can be!
With roles and namespaces, all in a row,
I dance through the changes, watch my garden grow.
🐰✨


Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.