kindfi-org / kindfi

KindFi is an open-source Web3 crowdfunding platform built on Stellar. Featuring milestone-based escrows, transparent transactions, gamified engagement, and AI-driven tools. **Development Guide:** https://kindfis-organization.gitbook.io/development
https://kind-fi.com/
12 stars 52 forks source link

chore/setup-trustless-work #159

Closed JoelVR17 closed 4 weeks ago

JoelVR17 commented 1 month ago

Summary by CodeRabbit

vercel[bot] commented 1 month ago

@JoelVR17 is attempting to deploy a commit to the kindfi Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai[bot] commented 1 month ago

Walkthrough

This PR refactors the escrow initialization flow in the web application. The API endpoint now validates the incoming payload (now typed as EscrowPayload), creates an escrow request via a dedicated function, and then sends a transaction through the Stellar network. Legacy escrow contract logic and type definitions have been removed. New modules for HTTP configuration, Supabase integration, and various escrow-related TypeScript types have been added to enhance code modularity and clarity. Package configuration has also been tidied up for improved readability.

Changes

File(s) Change Summary
apps/web/app/api/escrow/initialize/route.ts Restructured the POST endpoint to validate EscrowPayload, create escrow requests with createEscrowRequest, and send transactions via sendTransaction; database insertions now update escrow status post-success.
apps/web/lib/axios/http.ts, apps/web/lib/supabase/config.ts New files added to configure an Axios HTTP client and initialize a Supabase client using environment variables.
apps/web/lib/stellar/utils/create-escrow.ts, apps/web/lib/stellar/utils/get-endpoint.ts, apps/web/lib/stellar/utils/send-transaction.ts, apps/web/lib/stellar/utils/sign-transaction.ts Introduced new utility functions for escrow request creation, endpoint resolution, sending transactions, and a placeholder for signing transactions.
apps/web/lib/stellar/escrow.ts, apps/web/lib/types/escrow.types.ts (old) Removed legacy escrow contract functionality and type definitions related to contract initialization and escrow state management.
apps/web/lib/validators/escrow.ts Updated validation logic to use EscrowPayload with modified field checks, including changes in milestone validation and metadata handling.
apps/web/lib/types/date.types.ts, apps/web/lib/types/escrow/escrow-endpoint.types.ts, apps/web/lib/types/escrow/escrow-payload.types.ts, apps/web/lib/types/escrow/escrow-response.types.ts, apps/web/lib/types/escrow/escrow.types.ts, apps/web/lib/types/utils.types.ts, apps/web/lib/types/index.ts New and restructured TypeScript types and interfaces for escrow operations, endpoints, payloads, responses, dates, and HTTP utilities. Export paths have been updated accordingly.
package.json Reformatted the workspaces section into a multi-line format and removed the empty dependencies object for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant EscrowService
    participant Stellar
    participant DB

    Client->>API: POST /escrow/initialize
    API->>API: Validate EscrowPayload
    API->>EscrowService: createEscrowRequest(props)
    EscrowService-->>API: { unsignedTransaction, status }
    API->>Stellar: sendTransaction(unsignedTransaction)
    Stellar-->>API: Transaction response
    API->>DB: Insert escrow record (set state to INITIALIZED)
    DB-->>API: Confirmation
    API-->>Client: Response (with contract_id, status, and message)

Possibly related PRs

Poem

In refactored code our functions play,
New payloads guide the escrow way.
With HTTP and Supabase standing tall,
Stellar transactions answer the call.
Code sings in types and logic so bright,
Celebrating change with joyful insight!
🚀✨

✨ Finishing Touches - [ ] 📝 Generate Docstrings (Beta)

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR. ([Beta](https://docs.coderabbit.ai/early-access#beta)) - `@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. ### 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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kindfi ❌ Failed (Inspect) Feb 19, 2025 3:39am
AndlerRL commented 4 weeks ago

Changes look great! Amazing work on the TL API configuration and the extra comments you're creating for all the other devs.

However, I noticed this is a fork-based PR, whereas our contributor guide recommends using the branch creation method instead. For this case, we’ll make a small exception since your PR includes a lot of valuable info and the performance was really great. But for future contributions, please take a look at the contribution guide to align with our workflow. We'd love to have you continue contributing and learning together.

@AndlerRL will take care of two little details that are missing, one is removing one file and the other one is fixing the build. After those ones we will merge your code.

Nice Job!

I will be doing it in a new PR, cannot push into a forked PR. Merging!

cc - @Bran18