Skip to content

Crossmint/crossmint-sdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

98d8197 Β· Feb 25, 2025
Feb 25, 2025
Nov 5, 2024
Feb 25, 2025
Feb 25, 2025
Nov 17, 2021
Feb 11, 2025
Nov 30, 2023
Dec 31, 2021
Jan 27, 2025
Sep 20, 2024
Oct 8, 2024
Jul 13, 2024
Feb 20, 2025
Feb 25, 2025
Dec 12, 2024
Aug 28, 2024
Sep 14, 2023
Oct 10, 2024
Nov 22, 2024

Repository files navigation

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
  2. Package Overview
  3. Getting Started
  4. Building SDK Locally
  5. Publishing
  6. Documentation
  7. Contact

About The Project

Crossmint SDK

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

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
  1. Install dependencies:
cd crossmint-sdk
pnpm install
  1. 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
  1. Reinstall dependencies in your project:
# From the root directory
pnpm install
  1. 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)