Skip to content

Add Jupiter Swap + Gill Template to Community Folder #136

Description

@GuiBibeau

Background

The Solana Foundation maintains a templates repo with both official and community templates. Developers use these templates with create-solana-dapp to quickly scaffold projects.

Currently, there are Gill‑based starters and a community folder with examples like gill-jito-airdrop. This task proposes adding a Gill + Jupiter Plugin swap template to provide an easy on‑ramp for teams who want to embed a working swap UI using Jupiter and Gill.


Goal

Add a community template at community/gill-jupiter-swap that includes:

  • A minimal Next.js + Tailwind + Gill app
  • Jupiter Plugin (successor to Jupiter Terminal) embedded with wallet passthrough
  • Environment variables for cluster selection, referral fees, and default token mints
  • A clear README.md with setup instructions and links to Jupiter Plugin + API docs

Deliverables

  1. community/gill-jupiter-swap/ directory with working template code

  2. README.md explaining:

    • Setup and usage
    • Wallet passthrough integration
    • Referral configuration
    • Changing input/output token mints
    • Where to find mint addresses and info on wSOL vs native SOL
    • Link to Jupiter Plugin docs and Swap API guides
  3. package.json with a create-solana-dapp block for post-install guidance

  4. Type declaration file for window.Jupiter

  5. Registration in templates.json so template is discoverable under Community Templates


Acceptance Criteria

  • A new directory community/gill-jupiter-swap exists with a scaffolded Next.js + Gill + Tailwind project

  • Jupiter Plugin is integrated with wallet passthrough enabled

  • Referral fees configurable via env (NEXT_PUBLIC_JUP_REFERRAL_ACCOUNT, NEXT_PUBLIC_JUP_REFERRAL_BPS)

  • Default input/output mints configurable via env (not hardcoded)

  • README.md includes:

    • Quickstart instructions
    • Wallet passthrough explanation
    • Referral setup steps
    • Mint configuration guidance with links to token references
    • Pointer to Jupiter Swap API for advanced usage
  • package.json includes a create-solana-dapp block for next steps

  • Template registered in templates.json with proper metadata (id, name, path, tags)

  • Repo builds successfully with the new template included

  • Scaffolding via CLI works: npm create solana-dapp@latest -t gh:solana-foundation/templates/community/gill-jupiter-swap


Risks

  • Terminal vs Plugin: Must use Jupiter Plugin, as Terminal is deprecated
  • Devnet tokens: Devnet USDC mints vary; docs should guide developers to configure manually

Definition of Done

  • All acceptance criteria met
  • Template merged into solana-foundation/templates
  • Verified via CLI scaffolding and demo screenshot or GIF added to PR

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions