warden-protocol / wardenprotocol

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

feat(faucet): new faucet #479

Open jlehtimaki opened 3 days ago

jlehtimaki commented 3 days ago

This version of the Faucet does not have any limitations per user, only limitations are daily token supply. Faucet will have the following features:

It uses HTMX + JS.

You can run it with simply:

go run .

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago
Walkthrough ## Walkthrough The recent changes enhance the `faucet` command's functionality and user experience. They include refactoring the backend code to better manage configurations and transactions, updating the frontend with new styles and templates, and introducing scripts for dynamic interaction. This ensures a robust and visually appealing user interface, improved logging, and efficient transaction handling. Key additions are new struct fields, methods in Go files, CSS styles, HTML templates, and JavaScript functions for seamless interaction and polling. ## Changes | Files | Change Summaries | |--------------------------------------------|----------------------------------------------------------------------------------------------------------| | `cmd/faucet/css/style.css` | Introduced styling for dark-themed background, form inputs, submit buttons, token circles, and spinners. | | `cmd/faucet/faucet.go` | Refactored `Faucet` struct, added new fields and methods, and modified transaction handling logic. | | `cmd/faucet/go.mod` | Updated to include dependencies such as `cosmos-sdk`, `echo/v4`, and `zerolog`. | | `cmd/faucet/js/circle.js` | Added functionality for progress circle visualization based on token information. | | `cmd/faucet/js/tx.js` | Introduced server polling for transaction status updates. | | `cmd/faucet/main.go` | Defined an HTTP server, introduced handlers for template rendering and form processing. | | `cmd/faucet/pkg/config/config.go` | Added configuration handling using environment variables and config files. | | `cmd/faucet/templates/form.html` | Introduced a form template for address input and error handling. | | `cmd/faucet/templates/index.html` | Created a main template for the Buenavista Faucet web page. | | `cmd/faucet/templates/tokens.html` | Added a dynamic section for displaying token information and token circle. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Browser participant Server as Faucet HTTP Server participant Faucet as Faucet Backend participant Config as Config Loader User->>Browser: Open Faucet Web Page Browser->>Server: GET / Server-->>Browser: Serve HTML (index.html) Browser->>Server: POST /form (with Address) Server->>Faucet: Init and Send Tokens Faucet->>Config: Load Config Config-->>Faucet: Return Config Faucet->>Server: Process Transaction (Setup New Account, Send Tokens) Server-->>Browser: Return Status (Tokens Sent/Error) Note right of User: User sees transaction status/update Browser->>Server: Poll /status Server-->>Browser: Return Transaction Status ``` In this sequence: - The user interacts with the browser to access the Faucet web page. - The browser requests the page from the HTTP server, which serves the required HTML. - Upon form submission, the server processes the request using the Faucet backend, which loads the necessary configurations and handles the transaction. - The browser continuously polls the server for transaction status updates, providing real-time feedback to the user.

[!TIP]

AI model upgrade ## `gpt-4o` model for reviews and chat is now live OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide any feedback or to report any issues.

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 3 days ago

Hey @jlehtimaki 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.