https://github.com/Crossmint/crossmint-sdk
Crossmint SDK for client and server integrations
https://github.com/Crossmint/crossmint-sdk
credit-card ethereum mint nextjs nft nfts polygon react solana
Last synced: 3 months ago
JSON representation
Crossmint SDK for client and server integrations
- Host: GitHub
- URL: https://github.com/Crossmint/crossmint-sdk
- Owner: Crossmint
- License: apache-2.0
- Created: 2021-11-17T00:39:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T02:03:18.000Z (11 months ago)
- Last Synced: 2024-10-29T09:13:39.666Z (11 months ago)
- Topics: credit-card, ethereum, mint, nextjs, nft, nfts, polygon, react, solana
- Language: TypeScript
- Homepage: https://demo.crossmint.io/
- Size: 14.7 MB
- Stars: 27
- Watchers: 2
- Forks: 17
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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
-
About The Project
-
Package Overview
- Getting Started
-
Building SDK Locally
- Publishing
- Documentation
- 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
### Wallet SDK
- `@crossmint/wallets-sdk`: Universal Wallet SDK.
### Client-Side Packages
- `@crossmint/client-sdk-react-ui`: React SDK, with UI components.
- `@crossmint/client-sdk-react-native-ui`: React Native SDK.
- `@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` [DEPRECATED]: Headless typescript SDK for smart wallets.
- `@crossmint/wallets-sdk`: Headless typescript SDK for EVM + Solana MPC / 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
- [🔒 Wallets Quickstart)](https://github.com/Crossmint/wallets-quickstart): Create and interact with Crossmint wallets. This quickstart uses Crossmint Auth and uses your email as a signer for that wallet. [Demo](https://wallets.demos-crossmint.com/)
- [💳 Hosted Checkout Quickstart)](https://github.com/Crossmint/hosted-checkout-quickstart): Allow your customers to buy NFTs with credit card and crypto payments, using Crossmint's hosted checkout. This quickstart provides a seamless integration for accepting payments in your dApp. [Demo](https://hosted-checkout.demos-crossmint.com/)
- [🏦 Fintech Quickstart)](https://github.com/Crossmint/fintech-starter-app): Create your own Fintech app in minutes using Crossmint wallets and onramp. [Demo](https://fintech-starter-app.demos-crossmint.com/)
## Getting Started
To get started with the SDK, install the packages you need into your project.
ie.
`pnpm add @crossmint/wallets-sdk`
Then, import the package you need.
ie.
`import { CrossmintWallet } from "@crossmint/wallets-sdk";`
For more information on how to use the SDK, see the [Crossmint SDK Documentation](https://docs.crossmint.com/sdk-reference/introduction).
## Building SDK locally
### Prerequisites
```shell
node >= 20
pnpm
```
### Installation
1. Clone the repository:
```shell
git clone https://github.com/Crossmint/crossmint-sdk.git
```
2. Install dependencies:
```shell
cd crossmint-sdk
pnpm install
```
3. Build all packages:
```shell
pnpm build
```
### Making Package Changes
When modifying packages locally:
1. Make your changes in the relevant package
2. Rebuild the modified package:
```shell
# Inside the package directory
pnpm build
```
3. Reinstall dependencies in your project:
```shell
# 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](https://docs.crossmint.com/).
## Contact
To get in touch with the Crossmint team, please visit our [contact page](https://www.crossmint.com/contact).
or on [X](https://x.com/crossmint)