Solana NFT Candy Factory

To quickly set up a local development environment on Solana Devnet, use the setup-dev command.

What this command does:

• Creates a new Solana wallet.
• Airdrops SOL to that wallet.
• Uploads resources to the Devnet Metaplex program.
• Automatically generates a .env.local file containing the start date, candy machine addresses, and treasury addresses.

⚠️ WARNING: Nuke Solution Running this command will replace your existing Solana devwallet at ~/.config/solana/candyfactory-devnet.json and overwrite your existing .env.local file. It is a complete reset of the development environment.

Requirements:

• You must have your NFT sources ready in the nft-sources folder.
• Files must follow the naming convention starting with 0.json and 0.png.

Workflow:

1. Run setup: yarn setup-dev
2. Run the dev server: yarn dev (starts the NextJS server with wallet connection, minting UI, and countdown features).

To deploy your NFT collection to the Solana Mainnet, use the deploy-mainnet command.

Deployment Process:

1. Run yarn deploy-mainnet and follow the interactive prompts.
2. You will be asked to import a Wallet PK. This wallet must have sufficient SOL and will be the recipient of the mint value.
3. The command stores your wallet key at ~/.config/solana/candyfactory-mainnet.json (this path can be modified in setup-solana-mainnet.sh).

Important Constraints:

• No Incremental Uploads: You cannot upload NFTs in batches. You must upload the entire collection in one go. If you need to update your batch, you must delete the candy machine folder and start over.
• Wallet Consistency: Ensure the wallet used for Metaplex uploading (yarn deploy-mainnet) is the same one used in the NFTs' creators.address[0] to ensure royalties are earned correctly.
• Post-Deployment: After successful deployment, a .env.local.production file will be generated in the project root. You must add these values to your production hosting environment (e.g., Vercel Environment Variables).

When using the Metaplex candy machine CLI upload command, a timeout error may occur during the initializing config step. This error looks like: Error: Transaction was not confirmed in 60.00 seconds. It is unknown if it succeeded or failed.

If this happens, your deployment wallet might appear to have lost funds without the command completing. Because the transaction may have actually succeeded on-chain despite the timeout, you must manually recover the state to resume the upload.

Recovery Steps:

1. Identify the Transaction Hash: Locate the signature hash (HASH_HERE) from the error message.
2. Inspect the Transaction: Go to https://solscan.io/tx/HASH_HERE to view the transaction details.
3. Extract Account Values: Look for the Create Account instruction. Identify and save the values for the first two input accounts: NewAccount and Source.
4. Create a Temporary Cache File: In your project's .cache folder, create a file named mainnet-beta-temp (with no file extension).
5. Configure the Cache File: Populate the file with a JSON object using the values extracted from Solscan. Use the first 6 characters of the NewAccount value for the uuid field.
6. Resume Upload: Re-run the upload command. It should now resume from the point of failure instead of restarting.

{
   "program":{
      "uuid":"First 6 Characters of the NewAccount value",
      "config":"NewAccount Value"
   },
   "items":{
      
   },
   "env":"mainnet-beta",
   "cacheName":"temp",
   "authority":"Source Value"
}

The sendTransaction function simplifies sending a single transaction by handling instruction aggregation, blockhash fetching, signing (via the provided wallet), and awaiting confirmation.

Parameters:

• connection: Solana Connection object.
• wallet: The wallet object (must have a publicKey and signTransaction method).
• instructions: An array of TransactionInstruction objects.
• signers: An array of Keypair objects required for the transaction.
• awaitConfirmation: Boolean. If true, the function waits for the transaction to be confirmed (default: true).
• commitment: Solana commitment level (default: 'singleGossip').
• includesFeePayer: If true, the wallet.publicKey is NOT automatically added as a signer. If false (default), the wallet.publicKey is added as the fee payer.
• block: (Optional) An object containing blockhash and feeCalculator to reuse a specific blockhash.

const { txid, slot } = await sendTransaction(
  connection,
  wallet,
  instructions,
  signers,
  true, // awaitConfirmation
  'confirmed'
);

The useHashTable React hook provides a managed way to fetch and store the Candy Machine hash table, including loading states and error handling via toasts.

Parameters:

• candyMachineId (string): The ID of the Candy Machine to query.
• metadataEnabled (boolean): Whether to fetch full metadata or just mint addresses.

Returns an object containing:

• hashTable (any[]): The current list of retrieved hashes or metadata.
• isLoading (boolean): Indicates if the fetch operation is in progress.
• getHashTable (function): An async function to trigger the fetch process.

Note: If candyMachineId is empty, the hook will trigger a toast error: "Please type the Candy Machine ID in the input box."

import { useHashTable } from './path-to-hook';

function MyComponent() {
  const { hashTable, isLoading, getHashTable } = useHashTable('CANDY_MACHINE_ID', false);

  return (
    <div>
      <button onClick={getHashTable} disabled={isLoading}>
        {isLoading ? 'Loading...' : 'Fetch Hashes'}
      </button>
      <ul>
        {hashTable.map((hash) => (
          <li key={hash}>{hash}</li>
        ))}
      </ul>
    </div>
  );
}