Crossmint SDK

A comprehensive suite of tools for blockchain integration, authentication, and NFT functionality
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Why Crossmint?
   • Core Features
2. Package Overview
   • Client-Side Packages
   • Server-Side Packages
   • Demo Applications
3. Getting Started
4. Building SDK Locally
   • Prerequisites
   • Installation
   • Making Package Changes
5. Publishing
6. Documentation
7. Contact

About The Project

The Crossmint SDK is a powerful collection of packages designed to simplify blockchain integration for developers. Our goal is to make Web3 development accessible without requiring extensive blockchain experience or cryptocurrency knowledge.

Why Crossmint?

• 🚀 Quick Integration: All our tools have 5-min quickstarts
• 💻 Developer-First: Build end-to-end blockchain solutions without deep Web3 expertise
• 🔒 Secure: Enterprise-grade security for all blockchain interactions
• 💳 Fiat-First: Enable users to participate in Web3 without cryptocurrency
• 🆓 Free to Start: Start developing at no cost

Core Features

• 💳 NFT checkout: with credit card and cross-chain
• 🔐 Authentication and session management
• 👛 Embedded wallets
• 📜 Verifiable credentials

Package Overview

Client-Side Packages

• @crossmint/client-sdk-react-ui: React SDK, with UI components.

• @crossmint/client-sdk-auth: Headless typescript SDK for managing auth and user profiles.

• @crossmint/client-sdk-verifiable-credentials: Headless typescript SDK for Verifiable Credentials.

• @crossmint/client-sdk-smart-wallet: Headless typescript SDK for smart wallets.

Other:

• @crossmint/client-sdk-base: Core client-side functionality and essential building blocks for Crossmint integration. Typically you don't need to integrate against this directly.

Server-Side Packages

• @crossmint/server-sdk: Server-side SDK.

Demo Applications

• 🔒 Smart Wallet + Auth Demo): A NextJS application showcasing the full capabilities of the SDK, including authentication and smart wallet integration.

Getting Started

To get started with the SDK, install the packages you need into your project.

ie. pnpm add @crossmint/client-sdk-smart-wallet

Then, import the package you need.

ie. import { SmartWalletSDK } from "@crossmint/client-sdk-smart-wallet";

For more information on how to use the SDK, see the Crossmint SDK Documentation.

Building SDK locally

Prerequisites

node >= 20
pnpm

Installation

1. Clone the repository:

git clone https://github.com/Crossmint/crossmint-sdk.git

2. Install dependencies:

cd crossmint-sdk
pnpm install

3. Build all packages:

pnpm build

Making Package Changes

When modifying packages locally:

1. Make your changes in the relevant package
2. Rebuild the modified package:

# Inside the package directory
pnpm build

3. Reinstall dependencies in your project:

# From the root directory
pnpm install

4. Restart the demo application to see your changes

Publishing

1. Run pnpm change:add to select packages for update
2. Commit the generated changeset file
3. Merge your PR to main
4. A "Release packages" PR will be created automatically
5. Merge the release PR to publish to NPM

Documentation

For detailed documentation and guides, visit our official documentation.

Contact

To get in touch with the Crossmint team, please visit our contact page. or on X

(back to top)