Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,25 @@ keywords:

# Authentication Integration Guide

Crossmint provides a comprehensive user management solution tightly integrated with all other Crossmint products. Authenticate users using Web3 or traditional sign-in methods, with seamless wallet creation and unified identity management.
Crossmint provides a comprehensive user management solution tightly integrated with all other Crossmint products. Authenticate users with Web3 or traditional sign-in methods, with seamless wallet creation and unified identity management.

**Why this matters:**

- **Unified identity system**: Single user account across your backend and Web3 app
- **Multiple auth methods**: Email OTP, social logins, wallet connections, and Farcaster
- **Automatic wallet creation**: Optionally create or link wallets with user accounts
- **Drag and drop integration**: Setup in under 5 minutes
- **Unified identity system**: Single user account across your backend and Web3 app.
- **Multiple auth methods**: Email OTP, social logins, wallet connections, and Farcaster.
- **Automatic wallet creation**: Optionally create or link wallets with user accounts.
- **Drag and drop integration**: Setup in under five minutes.

## 🎯 Available Authentication Methods
## 🎯 Available authentication methods

### 1. Email OTP Authentication
### 1. Email OTP authentication

Passwordless sign-in using one-time codes delivered to the user's email.
Passwordless sign-in with one-time codes delivered to the user's email.
- No passwords required
- Secure and user-friendly
- Automatic account creation

### 2. Social Account Authentication
### 2. Social account authentication

Sign in with popular social platforms:

Expand All @@ -43,14 +43,14 @@ Sign in with popular social platforms:
- X (Twitter)
- And more

### 3. Farcaster Integration
### 3. Farcaster integration

Using the [Sign In With Farcaster (SIWF) standard]
Use the [Sign In With Farcaster (SIWF) standard]

- Web3-native authentication
- Decentralized identity support

### 4. External Wallet Authentication
### 4. External wallet authentication

Connect with crypto wallets for Web3 authentication:

Expand All @@ -59,7 +59,6 @@ Connect with crypto wallets for Web3 authentication:
- Flow wallets
- And other Web3 wallets


## Prerequisites

Make sure you have:
Expand All @@ -75,18 +74,19 @@ Make sure you have:
- TypeScript support (recommended)

**Technical knowledge:**

- Basic React hooks and state management
- Understanding of authentication flows

## Quick Start (5 minutes)
## Quick start

### Step 1: Install the SDK
### Step 1: install the SDK

```bash
npm i @crossmint/client-sdk-react-ui
```

### Step 2: Add Crossmint Providers
### Step 2: add crossmint providers

```tsx
"use client";
Expand All @@ -108,7 +108,7 @@ export function Providers({ children }: { children: React.ReactNode }) {
}
```

### Step 3: Create Authentication Component
### Step 3: create authentication component

```tsx
"use client";
Expand Down Expand Up @@ -152,7 +152,7 @@ export function AuthButton() {
}
```

### Environment Configuration
### Environment configuration

```typescript
// Use environment-specific API keys
Expand All @@ -164,30 +164,30 @@ const crossmintConfig = {
};
```

## Production Deployment
## Production deployment

### 1. Create Production Account
### 1. Create production account

1. Create a developer account on the [Production Console]
1. Create a developer account on the [Production Console].
![Production Console Login](./imgs/staging.png)

2. Complete account verification and KYB process
2. Complete account verification and KYB process.

### 2. Configure Production API Keys
### 2. Configure production API keys

1. Create a production client API key
1. Create a production client API key.

Navigate to **Integrate > API Keys**

![API Keys](./imgs/api_keys.png)

2. Enable required scopes:
2. Activate required scopes:
- `users.create`
- `users.read`
- `wallets.read`
- `wallets.create`

### 3. Update Environment Variables
### 3. Update environment variables

```bash
# Production
Expand All @@ -199,7 +199,7 @@ CROSSMINT_API_KEY=your_staging_client_api_key
CROSSMINT_ENVIRONMENT=staging
```

### 4. Test Authentication Flow
### 4. Test authentication flow

```typescript
// Test authentication in staging first
Expand All @@ -218,19 +218,21 @@ const testAuth = async () => {

## 🔧 Troubleshooting

### Common Issues
### Common issues

**Authentication fails:**
- Verify API key is correct
- Check authentication scopes are enabled
- Ensure you're using the right environment (staging vs production)

- Verify API key is correct.
- Check authentication scopes are activated.
- Make sure you're using the right environment (staging vs. production)

**Wallet creation fails:**
- Verify user is authenticated
- Check wallet creation scopes
- Ensure proper wallet configuration for Flow

### Getting Help
- Verify user is authenticated.
- Check wallet creation scopes.
- Ensure proper wallet configuration for Flow.

### Get Help

- **[Crossmint Authentication Docs](https://docs.crossmint.com/authentication/introduction)**
- **[Flow Developer Portal](https://developers.flow.com/)**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,94 +19,91 @@ keywords:

# Crossmint Integration Guide

Crossmint is an all-in-one platform that brings enterprise-grade blockchain infrastructure to Flow developers. Build complete Web3 applications without requiring users to understand crypto - from embedded wallets and gasless payments to AI agent commerce and stablecoin integration.
Crossmint is an all-in-one platform that brings enterprise-grade blockchain infrastructure to Flow developers. Build complete Web3 applications without a need for your users to understand crypto - from embedded wallets and gasless payments to AI agent commerce and stablecoin integration.

**Why this matters:**

- **Eliminate barriers**: No gas fees, seed phrases, or complex wallet setup for your users
- **Enterprise ready**: Bank-grade security trusted by Fortune 500 companies
- **Eliminate barriers**: No gas fees, seed phrases, or complex wallet setup for your users.
- **Enterprise ready**: Bank-grade security trusted by Fortune 500 companies.

With Crossmint on Flow, you can create comprehensive blockchain applications that feel like traditional Web2 apps while leveraging Flow's unique capabilities.
With Crossmint on Flow, you can create comprehensive blockchain applications that feel like traditional Web2 apps and leverage Flow's unique capabilities.

**Core features:** Gasless transactions, fiat payments, token minting



## 🎯 Available Features

### 1. Minting Platform
### 1. Minting platform

Create and distribute tokens at scale via API and no-code tools. You'll be able to:

- Deploy secure smart contracts on Flow
- Mint, update, burn, and airdrop tokens at scale
- Manage metadata and collections
- API and no-code collection creation
- Deploy secure smart contracts on Flow.
- Mint, update, burn, and airdrop tokens at scale.
- Manage metadata and collections.
- API and no-code collection creation.

### 2. Authentication

Create wallets for users with seamless authentication. This unlocks:

- Authentication with email, social logins, wallets, and passkeys
- Smart wallets with custodial and non-custodial options
- Gasless transactions and improved user experience
- Data APIs for fetching balances and activity
- Authentication with email, social logins, wallets, and passkeys.
- Smart wallets with custodial and non-custodial options.
- Gasless transactions and improved user experience.
- Data APIs to fetch balances and activity.

### 3. Fiat and Cross-chain Payment Checkout
### 3. Fiat and cross-chain payment checkout

Digital Asset Checkout supporting fiat and cross-chain payments. Allow your users to buy onchain assets using any of the following payment methods:
Digital Asset Checkout supports fiat and cross-chain payments. Allow your users to buy onchain assets with any of the following payment methods:

- Credit card, Apple Pay, Google Pay support
- Cross-chain crypto payments (40+ tokens)
- No KYC required for most transactions
- Credit card, Apple Pay, Google Pay support.
- Cross-chain crypto payments (40+ tokens).
- No KYC required for most transactions.

### 4. World Store
### 4. World store

Access to real-world goods and services via crypto payments such as:

- Over 1 billion products from Amazon, Shopify, flights, and more
- Pay with FLOW, USDF, and other supported tokens
- Perfect for expanding crypto utility to real-world commerce
- API access to global commerce platforms

- Over one billion products from Amazon, Shopify, flights, and more.
- Pay with FLOW, USDF, and other supported tokens.
- Perfect for expanding crypto utility to real-world commerce.
- API access to global commerce platforms.

## 🛠 Prerequisites

Make sure you have:

- **Crossmint account:**

- [Crossmint Console] account
- API keys configured for your project
- [Crossmint Console] account.
- API keys configured for your project.

- **Flow development environment:**

- Flow CLI installed and configured
- Flow CLI installed and configured.

- **Technical knowledge:**

- Basic JavaScript/TypeScript, React hooks
- Understanding of Flow (Cadence or EVM)
- Basic JavaScript/TypeScript, React hooks.
- Understanding of Flow (Cadence or EVM).

- **Setup:**

1. Clone or create your Flow project
1. Clone or create your Flow project.
2. Install Crossmint SDK: `npm i @crossmint/client-sdk-react-ui`
3. Configure environment variables for API keys
4. Onboard thousands of users seamlessly
3. Configure environment variables for API keys.
4. Onboard thousands of users seamlessly.

## Guides

Get up and running with Crossmint on Flow in under 15 minutes:
Get started with Crossmint on Flow in under 15 minutes:

1. **[Set up authentication](./authentication.md)** for seamless user onboarding
3. **[Enable fiat payments](./payment-checkout.md)** for your Flow assets
4. **[Minting Platform](./minting-platform.md)** to create and distribute tokens at scale
1. **[Set up authentication](./authentication.md)** to seamlessly onboard users.
3. **[Enable fiat payments](./payment-checkout.md)** for your Flow assets.
4. **[Minting Platform](./minting-platform.md)** to create and distribute tokens at scale.

If you have trouble during the integrations process, please refer to these documentation sites:
If you have trouble during the integrations process, refer to these documentation sites:

- **[Crossmint Documentation](https://docs.crossmint.com/)** - Complete platform docs
- **[Flow Developer Portal](https://developers.flow.com/)** - Flow-specific resources
- **[Crossmint Documentation](https://docs.crossmint.com/)** - Complete platform docs.
- **[Flow Developer Portal](https://developers.flow.com/)** - Flow-specific resources.


<!-- Reference-style links, does not render on page -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,30 @@ keywords:

# Minting Platform Integration Guide

Deploy secure smart contracts and mint tokens at scale on Flow using Crossmint's comprehensive minting platform.
Deploy secure smart contracts and mint tokens at scale on Flow with Crossmint's comprehensive minting platform.

## Overview

Crossmint's minting platform provides no-code tools and powerful APIs to create, mint, update, burn, and airdrop tokens on Flow.

> **Key Benefits:**
> - Deploy secure smart contracts without coding
> - Mint, update, burn, and airdrop tokens at scale
> - Manage metadata and collections
> - Flow EVM and Cadence support
> **Key benefits:**

> - Deploy secure smart contracts without coding.
> - Mint, update, burn, and airdrop tokens at scale.
> - Manage metadata and collections.
> - Flow EVM and Cadence support.

---

## Prerequisites

- Crossmint account with minting enabled
- Flow development environment
- Basic understanding of NFT standards
- Crossmint account with minting activated.
- Flow development environment.
- Basic understanding of NFT standards.

## Step 1: Deploy Smart Contract
## Step 1: Deploy smart contract

### No-Code Contract Deployment
### No-code contract deployment

1. Go to Crossmint Console > **Collections**
2. Click **Create Collection**
Expand All @@ -46,7 +47,7 @@ Crossmint's minting platform provides no-code tools and powerful APIs to create,
- Royalty settings
- Access controls

### API Contract Deployment
### API contract deployment

```typescript
// Deploy contract via API
Expand All @@ -66,9 +67,9 @@ const contract = await crossmint.contracts.deploy({
});
```

## Step 2: Mint NFTs
## Step 2: mint NFTs

### Single NFT Minting
### Single NFT minting

```typescript
const nft = await crossmint.nfts.mint({
Expand All @@ -86,7 +87,7 @@ const nft = await crossmint.nfts.mint({
});
```

### Batch Minting
### Batch minting

```typescript
const batchMint = await crossmint.nfts.batchMint({
Expand All @@ -99,7 +100,7 @@ const batchMint = await crossmint.nfts.batchMint({
```


## Step 3: Airdrops
## Step 3: airdrops

```typescript
const airdrop = await crossmint.airdrops.create({
Expand Down
Loading