search

warden-protocol / wardenprotocol

Monorepo for the Warden Protocol.
https://wardenprotocol.org
Apache License 2.0
1.1k stars 107 forks source link

Faucet v2 #326

Closed Pitasi closed 4 months ago

Pitasi commented 4 months ago

A web-based faucet that uses recaptcha v3 for validating incoming requests.

I modified spaceward "Get WARD" buttons to open the faucet url in a new tab instead of making the HTTP request in the background.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago
Walkthrough ## Walkthrough The update introduces a new version of the faucet service (`faucet-v2`) with enhanced features, including reCAPTCHA verification and rate-limiting. It includes modifications to the Dockerfile, new Go files for the faucet service, changes to the frontend button behavior, and updates to the configuration and CI/CD workflows. The changes aim to improve security, usability, and maintainability of the faucet service. ## Changes | File/Path | Change Summary | |-------------------------------------------------|------------------------------------------------------------------------------------------------------------------| | .gitignore | Added `.envrc` to the ignored files list. | | CHANGELOG.md | Documented the introduction of `faucet/v2` module with reCAPTCHA verification. | | Dockerfile | Updated references from `faucet` to `faucet-v2` and adjusted the `CMD` instruction. | | cmd/faucet-v2/client.go | Introduced `Client` struct and methods for blockchain interaction and transaction handling. | | cmd/faucet-v2/html.go | Added HTML templates for the faucet's web interface. | | cmd/faucet-v2/ip.go | Added function to extract client's IP address from HTTP requests. | | cmd/faucet-v2/limiter.go | Introduced `Limiter` type for rate-limiting functionality. | | cmd/faucet-v2/main.go | Implemented faucet service with configurations, HTTP handlers, and reCAPTCHA integration. | | cmd/faucet-v2/metrics.go | Defined Prometheus metrics for tracking faucet service statistics. | | spaceward/src/components/FaucetButton.tsx | Refactored `FaucetButton` component to handle token requests by opening a URL in a new tab. | | spaceward/src/env.ts | Updated default `faucetURL` value to `"http://127.0.0.1:8000"`. | | spaceward/vite.config.ts | Removed server proxy configuration for "/api/faucet". | | .github/workflows/wardend.yml | Updated paths and environment variables to include `faucet-v2` and changed `service_name` to `faucet-v2`. | ## Sequence Diagrams (Beta) ```mermaid sequenceDiagram participant User participant Frontend participant Faucet-v2 participant Blockchain participant reCAPTCHA User->>Frontend: Click "Request Tokens" Frontend->>reCAPTCHA: Validate reCAPTCHA reCAPTCHA-->>Frontend: reCAPTCHA Success Frontend->>Faucet-v2: Submit Request with reCAPTCHA Token Faucet-v2->>Faucet-v2: Validate IP and Address Faucet-v2->>Blockchain: Send Transaction Blockchain-->>Faucet-v2: Transaction Confirmation Faucet-v2-->>Frontend: Success Response Frontend-->>User: Display Success Message ```

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 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 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](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.
github-actions[bot] commented 4 months ago

Hey @Pitasi and thank you for opening this pull request! 👋🏼

It looks like you forgot to add a changelog entry for your changes. Make sure to add a changelog entry in the 'CHANGELOG.md' file.