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) Add OFAC list check #236

Closed PavelInjective closed 1 month ago

PavelInjective commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce an OfacChecker to the chainClient, enhancing its functionality to verify addresses against the OFAC blacklist. The NewChainClient function is updated to check if an address is blacklisted upon initialization. Modifications are made to the BuildGenericAuthz and BuildExchangeAuthz methods to include checks for the granter's address. A new test function, TestOfacList, is added to validate the OFAC list handling. Additionally, an example program for downloading the OFAC list is introduced, along with a new JSON file containing blacklisted addresses.

Changes

Files Change Summary
client/chain/chain.go, client/chain/ofac.go Introduced OfacChecker struct and integrated OFAC checks into chainClient methods and initialization logic.
client/chain/chain_test.go Added OfacTestSuite with TestOfacList to validate OFAC list handling and ensure proper error handling for blacklisted addresses.
examples/chain/ofac/1_DownloadOfacList/example.go Created a Go program to download the OFAC list using the chainclient module.
client/metadata/ofac.json Added a JSON file containing blacklisted Ethereum addresses for compliance checks.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChainClient
    participant OfacChecker

    User->>ChainClient: Initialize with address
    ChainClient->>OfacChecker: Check if address is blacklisted
    OfacChecker-->>ChainClient: Return blacklist status
    ChainClient-->>User: Proceed or return error

🐇 In the code we trust,
With checks that are a must,
OFAC's list we now embrace,
Ensuring compliance in our space.
With each address we verify,
No blacklisted ones slip by!
Hooray for security, hip-hip-hooray! 🎉


Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between a68a1a38a2afc65ac43b953eff4d847c78d1e2a3 and 0d5726e9b91c354ac514df4ef396cf7bf1ca5f76.
Files selected for processing (5) * client/chain/chain.go (5 hunks) * client/chain/chain_test.go (3 hunks) * client/chain/ofac.go (1 hunks) * client/metadata/ofac.json (1 hunks) * examples/chain/ofac/1_DownloadOfacList/example.go (1 hunks)
Files skipped from review as they are similar to previous changes (4) * client/chain/chain_test.go * client/chain/ofac.go * client/metadata/ofac.json * examples/chain/ofac/1_DownloadOfacList/example.go
Additional comments not posted (1)
client/chain/chain.go (1)
`324-324`: **LGTM!** The changes to initialize the `ofacChecker` and check if the account's address is blacklisted in the `NewChainClient` function are approved. This enhances the security by preventing the creation of a chain client for blacklisted addresses. Also applies to: 445-459
--- 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](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 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. ### 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.