lexicongovernance / pluraltools-backend

Backend implementation of the plural voting tool.
https://demo.lexicongovernance.org/
GNU General Public License v3.0
3 stars 1 forks source link

diego/wallet poc #457

Open diegoalzate opened 1 month ago

diegoalzate commented 1 month ago

inspired by https://docs.login.xyz/sign-in-with-ethereum/quickstart-guide/implement-the-backend

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This update introduces a robust access control mechanism through the creation of an access_rules table, enhancing user authentication processes. New schema definitions and service functions facilitate improved user verification and access checks, fortifying the application's security and functionality. The changes foster a more modular and efficient approach to managing permissions and user interactions within the system.

Changes

File(s) Change Summary
migrations/.../0030_sleepy_moira_mactaggert.sql, migrations/.../0030_snapshot.json, migrations/.../_journal.json Introduced new access_rules table for access control, including constraints and indexes. Updated schema snapshot and migration history.
package.json Added "siwe": "^2.3.2" dependency for Sign-In with Ethereum functionality.
src/db/schema/access-rules.ts Defined access_rules table schema using Drizzle ORM, including fields and type definitions for TypeScript.
src/db/schema/index.ts Exported access rules schema to enhance module functionality.
src/handlers/auth.ts Added handlers for SIWE: getSIWENonceHandler, verifySIWEHandler, and getSIWESessionHandler. Updated existing verification logic.
src/routers/auth.ts Expanded authRouter to include new SIWE routes for nonce generation and verification.
src/services/access-rules.ts Implemented checkAccessRules function to evaluate user permissions based on access rules.
src/services/auth.ts Integrated access control checks in createOrSignInPCD and introduced createOrSignInSIWE for Ethereum-based authentication.
src/types/auth.ts Renamed verifyUserSchema to verifyZupassUserSchema and added verifySIWEUserSchema for SIWE authentication.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AuthRouter
    participant AuthHandlers
    participant AccessRulesService
    participant Database

    Client->>AuthRouter: Request SIWE Nonce
    AuthRouter->>AuthHandlers: Call getSIWENonceHandler()
    AuthHandlers->>Database: Store nonce and respond
    Database-->>AuthHandlers: Nonce stored
    AuthHandlers-->>Client: Return nonce

    Client->>AuthRouter: Submit SIWE Verification
    AuthRouter->>AuthHandlers: Call verifySIWEHandler()
    AuthHandlers->>AccessRulesService: Check access permissions
    AccessRulesService->>Database: Query access_rules
    Database-->>AccessRulesService: Access result
    AccessRulesService-->>AuthHandlers: Return access result
    AuthHandlers-->>Client: Respond with verification result

🐰 In a garden where rules now grow,
Access granted, watch the flow.
With Ethereum’s light, we leap and bound,
In a world of trust, our friends are found!
Hopping with joy, we sing and cheer,
For access rules bring everyone near! πŸ₯•


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