Woofswap NFT Factory - User Guide

Introduction

Welcome to the Woofswap NFT Factory! This guide explains how to create, manage, and mint NFTs on the Shibarium blockchain using our interface. Follow these steps to launch your NFT collection.

Prerequisites

Using the NFT Factory

1. Connect Your Wallet

  1. Open the Woofswap NFT Factory interface in your browser.
  2. Click Connect Wallet.
  3. In MetaMask, select your account and approve the connection.
  4. Ensure you're on Shibarium (chain ID: 109). The interface will prompt to switch if needed.
  5. Once connected, the button shows your wallet address (e.g., "Connected: 0x123...4567").

2. Create an NFT Contract

  1. In the Create New NFT Contract section, fill in:
    • NFT Name: Collection name (e.g., "My Awesome NFT").
    • NFT Symbol: Short symbol (e.g., "MANFT").
    • Max Supply: Total NFTs allowed (e.g., 10000).
    • Payment Type: Select "BONE (Native)" or "ERC20 Token".
    • Payment Token Address: For BONE, it’s "0x000...000". For ERC20, enter the token contract address.
    • Mint Price: Price per NFT in BONE or ERC20 tokens (e.g., 100). Fees go to the contract creator (you).
  2. Click Create NFT Contract.
  3. Confirm the transaction in MetaMask.
  4. After confirmation, the new contract address appears in the NFT Contract Address field.

3. View Your Created Contracts

  1. In the Your Created NFT Contracts (Latest 10) section, view up to 10 recently created contracts.
  2. Each shows the NFT name, symbol, and address.
  3. Click Copy to copy a contract address.

4. Set the Base URI

  1. In the Manage NFT Contract section, enter the NFT contract address.
  2. Enter the Base URI (e.g., "https://shibfun.github.io/nft/Royal.json").
  3. Click Set Base URI. Only the contract creator can do this.
  4. Confirm the transaction in MetaMask.
  5. After confirmation, the Base URI applies to all NFTs in the contract.

5. Mint an NFT

  1. In the Manage NFT Contract section, enter the contract address.
  2. Click Mint NFT.
  3. Confirm the transaction in MetaMask, paying the mint price (in BONE or ERC20 tokens) to the contract creator.
  4. For ERC20 tokens, approve the contract to spend your tokens if prompted.
  5. After confirmation, the NFT appears in the Owned NFTs list.

6. View Your Owned NFTs

  1. In the Owned NFTs section, see NFTs you own for the selected contract.
  2. Each shows the NFT ID (e.g., "NFT ID: 1").
  3. Click View to preview the NFT image (requires a valid Base URI).

Setting Up JSON Metadata (Base URI)

The Base URI points to a JSON file defining metadata for all NFTs in your contract (e.g., name, description, image). Here's how to set it up:

1. Create the JSON Metadata File

Create a JSON file (e.g., `metadata.json`) with this structure:

{
    "name": "Your NFT Collection",
    "description": "A unique NFT collection on Shibarium",
    "image": "https://ipfs.io/ipfs/Qm.../image.png"
}
            

All NFTs share this metadata since the contract uses a single Base URI. For unique metadata per NFT, contact a developer to modify the contract.

2. Host the JSON and Image Files

Host your JSON and image files on IPFS or a web server. Recommended options:

Option 1: IPFS (Using Pinata)

  1. Sign up at Pinata.
  2. Upload your image (e.g., `image.png`). Copy the IPFS URL (e.g., "https://ipfs.io/ipfs/Qm.../image.png").
  3. Update `metadata.json` with the image URL.
  4. Upload `metadata.json`. Copy the IPFS URL (e.g., "https://ipfs.io/ipfs/Qm.../metadata.json").
  5. Use this URL as the Base URI.

Option 2: GitHub Pages

  1. Create a GitHub repository (GitHub).
  2. Upload your image and `metadata.json` (e.g., `nft/metadata.json`).
  3. Enable GitHub Pages in the repository’s Settings > Pages, selecting the main branch.
  4. Get the URL (e.g., "https://yourusername.github.io/your-repo/nft/metadata.json").
  5. Use this URL as the Base URI.

Option 3: NFT.Storage

  1. Sign up at NFT.Storage.
  2. Upload image and JSON files via the web interface.
  3. Copy the IPFS URLs.
  4. Use the JSON URL as the Base URI.

3. Set the Base URI

Follow the "Set the Base URI" steps above to apply the URL to your NFT contract. Ensure the URL is publicly accessible.

Troubleshooting

Shiba Dog
Woof! Create your NFT empire, pup!