Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Peanut-SDK integration #45

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

borcherd
Copy link

@borcherd borcherd commented Jan 17, 2024

Pull Request: Integration of Peanut SDK into Smoldapp

Introduction

We're excited to submit this pull request for integrating the Peanut SDK into Smoldapp. This integration brings a cool feature to your application – the ability to create and distribute links that securely hold funds. These links offer a seamless way for anyone to claim tokens directly into their wallets.

Key Features and Implementations

1. Peanut SDK Implementation

  • Functionality: The core functionality provided by this implementation allows users to create links that hold funds. Recipients can easily claim these funds into their wallets, enhancing user engagement and utility within the app.

2. Domain-Agnostic Implementation

  • Seamless Integration: The implementation is entirely domain-agnostic. This means both the creation and claiming of tokens are integrated into the Smoldapp UI, ensuring a smooth user experience.
  • Custom BaseURL: The links generated carry the base URL of your web application. This ensures that when a link is opened, users are redirected back to your web application, maintaining a consistent user journey.

3. Adherence to Existing Coding Standards

  • Consistency: While implementing the SDK, we have meticulously adhered to the established coding practices and project structure of Smoldapp to ensure consistency and maintainability of the codebase.

4. Customization Flexibility

  • Branding and UI Elements: The implementation is designed with flexibility in mind. You can easily modify branding elements like the logo and textual content across components to align with Smoldapp’s branding.
  • URL Scheme Customization: The current URL scheme follows /peanut and /peanut/claim patterns. However, this can be customized as per your preferences or requirements.

5. Extra notes

  • API key: Claiming a link is done without the user needing to worry about paying for gas. This is because peanut sponsors the gas costs. To claim a link gaslessy, you will require an api key. Please reach out to us on telegram and we will happily provide one.

Conclusion and Next Steps

This integration aims to enhance the functionality of Smoldapp by leveraging the capabilities of the Peanut SDK. Built to blend seamlessly with the existing features and UI, offering both utility and a superior user experience. We are open to any modifications or suggestions you might have and look forward to your feedback.

With an eye towards progress, we'd love to announce this early next week. Therefore, please let us know if there are any blockers to merging it by the end of this week.

Looking forward to your thoughts and feedback!

Copy link

vercel bot commented Jan 17, 2024

@borcherd is attempting to deploy a commit to the YCorpo Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Jan 17, 2024

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

Name Status Preview Comments Updated (UTC)
smoldapp ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 15, 2024 10:34am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants