bark-community / nft

BARKER's Club | NFT Tiered Membership

NFT Minting DApp & Collection on Solana Using Sugar and Umi (Candy Machine)

This guide provides step-by-step instructions to deploy an NFT collection on Solana using Sugar (Candy Machine) and Umi (a Metaplex JS protocol for Solana).

---

Prerequisites

Ensure you have the following tools installed before proceeding:

• Solana's Install Tool: Use the following command to install Solana's command-line tools:

  sh -c "$(curl -sSfL https://release.solana.com/v1.18.15/install)"

• Rust: Install Rust using the following command:

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

---

Generate New Keypair

Run the following command to generate a new keypair:

tsc generateKeypair.ts && node generateKeypair.js

---

Tiered Membership and Clubs Files and Folder Structure

dapp/
├── .env
├── wallet.json
├── config.json
└── assets/
    ├── clubs/
    │   ├── sparky.png
    │   ├── peaky.png
    │   └── barker.png
    └── membership/
        ├── prospect.png
        ├── prospect.json
        ├── soldier.png
        ├── soldier.json
        ├── full_member.png
        ├── full_member.json
        ├── veteran_member.png
        ├── veteran_member.json
        ├── collection.png
        └── collection.json

---

Usage

1. Generate Private Key: Run the following command to generate a private key and save it in the .env file:

   echo "PRIVATE_KEY=<your_private_key>" > .env

2. Validate Configuration: Use the following command to validate the configuration:

   sugar validate

3. Upload Assets: Upload assets to the Candy Machine using Sugar:

   sugar upload

4. Verify: Verify the Candy Machine:

   sugar verify

5. Test Mint: Test the minting process:

   sugar mint

---

Example: BARKER's Club NFT & Membership Tier CA:

• The Peaky Barker Pubkey: 4BZ3gQFxCU7hW3X2MqeFU2WBb5Zdsr5xnFLr6HerFA6i (Solscan Link)

---

Example Collection Metadata (collection.json)

{
  "name": "BARKER's Club Collection",
  "symbol": "BARK",
  "description": "An exclusive collection of NFTs representing tiered memberships in the BARKER's Club. Each NFT grants access to unique benefits and community features within the BARK Protocol ecosystem.",
  "image": "collection.png",
  "attributes": [
    {
      "trait_type": "Tier",
      "value": "Prospect"
    },
    {
      "trait_type": "Membership",
      "value": "Full Member"
    }
  ],
  "seller_fee_basis_points": 500,
  "external_url": "https://barkersclub.com",
  "creators": [
    {
      "address": "4BZ3gQFxCU7hW3X2MqeFU2WBb5Zdsr5xnFLr6HerFA6i",
      "share": 100
    }
  ]
}

---

Example Individual NFT Metadata (prospect.json)

{
  "name": "BARKER's Club Prospect Membership #prospect",
  "symbol": "BARK",
  "description": "A prospect membership NFT for the BARKER's Club.",
  "image": "prospect.png",
  "attributes": [
    {
      "trait_type": "Tier",
      "value": "Prospect"
    },
    {
      "trait_type": "Membership",
      "value": "Annual"
    }
  ],
  "seller_fee_basis_points": 500,
  "external_url": "https://barkerclub.com/nft/0",
  "creators": [
    {
      "address": "4BZ3gQFxCU7hW3X2MqeFU2WBb5Zdsr5xnFLr6HerFA6i",
      "share": 100
    }
  ]
}

---

Staking NFTs

Staking within the BARK allows members to lock up their membership tokens (NFTs) for a certain period in exchange for rewards and benefits. This mechanism incentivizes members to contribute to the stability and growth of the BARKER´s Club ecosystem while earning passive income.

• Staking Mechanism: NFTs involves locking up non-fungible tokens (NFTs) in a smart contract for a certain period in exchange for rewards or other benefits

---

Security

Ensure to keep your .env file secure and do not expose your private key. You can add .env to your .gitignore file to prevent it from being committed to your repository.

---

Sample `wallet.json

{
  "version": 1,
  "account": "4BZ3gQFxCU7hW3X2MqeFU2WBb5Zdsr5xnFLr6HerFA6i",
  "private_key": "<your_private_key>"
}

Notice

Notice! The website for this project is not deployed yet.

---

Additional Resources

• Solana Documentation
• Metaplex Documentation
• Sugar Documentation
• Umi Documentation

This README provides a comprehensive guide to setting up and deploying your NFT collection on Solana using Sugar and Umi.

---

License

BARKER's Club is licensed under the ISC License.