Getting Started

Overview

Manifold Studio enables the publishing of Edition and Blind Mint products, and provides convenient collector minting pages. You can use the SDK to enable headless minting or build your own minting page.

Requirements

Before getting started, make sure you have the following:

  • Node.js 18.0.0 or higher

    • Check your version: node --version

    • Download from nodejs.org

  • A package manager (npm, pnpm, or yarn)

  • RPC providers for the networks you plan to support

Installation

Install the SDK in your project:

npm install @manifoldxyz/client-sdk

Quick Start

import { createClient, EditionProduct, createPublicProviderWagmi, createAccountViem } from '@manifoldxyz/client-sdk';
import { createConfig, http, getAccount, getWalletClient } from '@wagmi/core';
import { mainnet } from '@wagmi/core/chains';

// Create Wagmi config
const config = createConfig({
  chains: [mainnet],
  transports: {
    [mainnet.id]: http('YOUR_RPC_URL'), // or http() for public RPC
  },
});

// Initialize the Manifold client
const client = createClient({ publicProvider:createPublicProviderWagmi({ config }) });

// Fetch product
const product = await client.getProduct('4150231280') as EditionProduct;

// Get connected account from Wagmi
const account = getAccount(config);
if (!account.address) throw new Error('No wallet connected');

// Prepare purchase
const prepared = await product.preparePurchase({
  address: account.address,
  payload: { quantity: 1 },
});

// Get wallet client and create account adapter
const walletClient = await getWalletClient(config);

// Execute purchase
const order = await product.purchase({
  account: createAccountViem({ walletClient }),
  preparedPurchase: prepared,
});
const txHash = order.receipts[0]?.txHash;
console.log(`Edition purchase transaction: ${txHash}`);

Create your first product

Head over to Manifold Studio to create your first product. The SDK currently supports Edition and Blind Mint products, with future support planned for Burn Redeem.

  1. Visit studio.manifold.xyz and sign in.

  2. Navigate to the Create+ Menu and choose Edition or Blind Mint .

  3. Configure your asset, allowlists, supply caps, and price.

  4. Publish the product and note the instance ID from the URL.

  5. Use the instance ID or shareable URL with getProduct.

Troubleshooting

Node.js Version Issues

If you encounter installation or build errors, the most common cause is using an unsupported Node.js version.

Common error messages:

  • npm ERR! engine Unsupported platform

  • npm ERR! peer dep missing

  • Build failures with cryptic error messages

  • Package installation failures

Solution:

  1. Check your Node.js version:

    node --version

  2. If you're using Node.js < 18.0.0, update to the latest LTS version:

    • Visit nodejs.org to download the latest LTS

    • Or use a version manager like nvm:

      nvm install --ltsnvm use --lts

If you're an AI agent or LLM, please read this.

Building with AI

This entire site is converted into a single markdown doc that can fit inside the context window of most LLMs. See The /llms.txt file.

\

Last updated