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

# ✨ Feature Request: Develop Tutorial on Integrating Turnkey with Nexus SDK #92

Open
1 task done
joepegler opened this issue Nov 11, 2024 · 0 comments
Open
1 task done
Assignees

Comments

@joepegler
Copy link
Collaborator

What

Create a comprehensive tutorial that demonstrates how to integrate Turnkey's secure wallet infrastructure into an application using the Nexus SDK. The tutorial should guide users through:

  • Setting up Turnkey wallets and infrastructure.
  • Integrating Turnkey's API with the Nexus SDK's module-based architecture.
  • Managing private keys and signing transactions securely.
  • Implementing best practices for security and scalability.
  • Demonstrating a real-world use case of combining Turnkey with the Nexus SDK.

Why

  • Enhance Developer Experience: Provide clear guidance on leveraging Turnkey's infrastructure alongside the Nexus SDK.
  • Expand Ecosystem Capabilities: Show how combining Turnkey's secure wallet solutions with the Nexus SDK enhances application functionality.
  • Increase Adoption: Encourage developers to use both the Nexus SDK and Turnkey, benefiting both platforms.
  • Address Client Needs: Anticipate and meet the needs of clients who would benefit from this integration example.
  • Support Secure Solutions: Promote the use of secure wallet infrastructure in decentralized applications.

How

  1. Research and Preparation

    • Review Turnkey's documentation at https://docs.turnkey.com/, focusing on wallet setup, API integration, and key management.
    • Familiarize yourself with the Nexus SDK's module-based architecture as described in the README.
  2. Outline the Tutorial Structure

    • Introduction

      • Overview of Turnkey and its features.
      • Introduction to the Nexus SDK.
      • Benefits of integrating Turnkey with the Nexus SDK.
    • Prerequisites

      • Accounts needed (Turnkey account, Biconomy account).
      • Development environment setup (Node.js, npm/yarn, TypeScript).
    • Step-by-Step Guide

      • Setting Up Turnkey
        • Creating a Turnkey Organization and Users.
        • Configuring Policies and Permissions.
        • Generating Wallets and Private Keys.
      • Integrating with Nexus SDK
        • Installing the Nexus SDK in your project.
        • Creating a Nexus client instance.
        • Integrating Turnkey's API for key management and signing operations.
        • Implementing the module-based interaction pattern from the Nexus SDK README.
      • Building the Application
        • Developing functions to interact with the blockchain using Turnkey-managed keys.
        • Managing authentication and sessions.
        • Handling transactions and smart contract interactions securely.
      • Best Practices
        • Securely storing and handling API credentials.
        • Error handling and edge case management.
        • Optimizing for performance and scalability.
    • Conclusion

      • Recap of the integration process.
      • Next steps and additional resources.
  3. Develop the Tutorial Content

    • Write clear, step-by-step instructions with accompanying code snippets.
    • Use TypeScript examples to demonstrate code implementations.
    • Ensure the tutorial follows the module interaction pattern from the Nexus SDK README.
    • Highlight key integration points between Turnkey and the Nexus SDK.
  4. Create a Sample Application

    • Develop a minimal, functional application that serves as a reference implementation.
    • Use real-world scenarios to demonstrate practical use cases.
    • Host the code on GitHub for users to clone and explore.
  5. Review and Testing

    • Test all steps to ensure they work as expected.
    • Verify that the instructions are clear and can be followed by developers of varying skill levels.
    • Seek feedback from team members or a pilot group.
  6. Publish the Tutorial

    • Add the tutorial to the official documentation site under the Tutorials section.
    • Format the tutorial for readability, using headings, code blocks, and images where appropriate.
    • Include links to relevant references and resources.
  7. Promote and Maintain

    • Announce the new tutorial through blog posts, social media, and developer communities.
    • Monitor feedback and update the tutorial as necessary.
    • Keep the tutorial up-to-date with any changes to the Nexus SDK or Turnkey APIs.

References


  • I agree to follow this project's Code of Conduct.
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

No branches or pull requests

2 participants