🥜
Peanut Docs
  • Learn
    • 🥜What is Peanut?
    • 🏦Cashout
      • Supported geographies
    • 📩How to use Peanut Links?
      • ⚙️How do Peanut Links Work?
      • 🔒Trust assumptions
    • 📌Use cases
    • 📚Case Studies
      • 🎁Welcome Packs
      • 📘Raffles to Boost UWAs and Transactions
      • 📗Sending Testnet Tokens at Hackathons
      • 📙IRL Events Marketing
    • ⛓️Supported Chains and Tokens
    • 💰Pricing
    • 🆘Support
  • Integrate
    • Using the SDK
      • Create ClaimLinks
        • Create Link
        • Batch Create Links
        • Create Raffle Links
        • Create Multi-Token Link
        • Create NFT Link
        • Create Gasless Links
        • Create Branded Links
      • Claim
        • Claim Link
        • Claim Gasless Link
        • Claim Cross-Chain Link
        • Claim Raffle Link
        • Claim Link as Sender (Reclaiming)
      • Create Request Link
      • Pay a Request Link
      • Pay a Request Link X-Chain
      • Utils
        • Get Link Details
        • Cross-chain
          • Get Supported Destination Chains
          • Get Supported Destination Tokens
          • Get Cross-Chain Options
          • Get Cross-Chain Route
        • Raffle (Legacy)
          • Get Raffle Info
          • Get User Raffle Status
          • Get Raffle Leaderboard
        • Get Default Provider
        • Get Supported Peanut Chains
        • Toggle Verbosity
        • EthersV5 <> Peanut Transaction Types
        • Estimate Fee Options
        • Get Random String
        • Get all deposits for an Address
        • Get Token Balance
      • API Keys
      • White-Labelling
      • Troubleshooting
      • SDK FAQ
    • Embedding an IFrame
    • Integrate Directly in Smart Contracts
    • Wallet Integrations
      • 🎬UI Examples
  • Other
    • 👾Bug bounties
    • 🔓Security Audit
    • 📜Peanut Protocol Contracts
  • BLOGS
    • Transfer Abstraction
    • Can We Sidestep Onchain Identity?
  • Additional Links
    • 🐦Twitter
    • 😊Telegram
    • 🤙Discord
    • 🥜Work with Us
    • 🎨Press Kit
    • 👨‍⚖️Contact and Legal
Powered by GitBook
On this page
  • Why use the SDK?
  • Who is the SDK for?
  • Who is the SDK not for?
  1. Integrate
  2. Using the SDK

SDK FAQ

Why use the SDK?

The SDK provides the fastest option to get started with Peanut Protocol.

The SDK wraps up all the low level complexities of Links and enables you to build immediately. Cryptographic security and full non-custodial with just npm i @squirrel-labs/peanut-sdk

Peanut Protocol SDK provides:

  • High level abstraction functions that make creating Peanut Links extremely fast and simple

  • Granular functions that allow for more control over the Link creation, transaction signing and claiming processes

Both offer a powerful and streamlined way of integrating with Peanut Protocol depending on the use case.

Who is the SDK for?

Typescript and JavaScript developers that wish to integrate Peanut Links in to their front end or back end services.

Who is the SDK not for?

The SDK is not for:

🐿️ Non-Typescript/JavaScript Developers (Do you use Swift, Kotlin or otherwise? Talk with us).

🐿️ Protocol Level Integrations

🐿️ Easy DApps Peanut Claiming Integrations (see Embedding an IFrame)

PreviousTroubleshootingNextEmbedding an IFrame

Last updated 11 months ago