Skip to content

ogazboiz/sui-token-wizard

Repository files navigation

πŸš€ Sui Token Wizard

A comprehensive platform for creating, managing, and deploying tokens on the Sui blockchain with an intuitive interface and powerful management tools.

Sui Token wizard Next.js TypeScript Tailwind CSS

✨ Features

πŸͺ™ Token Creation

  • Standard Coins: Basic fungible coins with essential functionality
  • Regulated Coins: Advanced coins with compliance features
  • Closed Loop Tokens: Policy-controlled tokens with governance and action requests
  • Custom Parameters: Configurable name, symbol, decimals, and supply
  • Multi-Network Support: Deploy on Mainnet, Testnet, or Devnet

🎨 NFT Creation

  • NFT Collections: Create and deploy NFT collections with metadata
  • Batch Minting: Mint multiple NFTs in a single transaction
  • Royalty Management: Set creator royalties and revenue sharing
  • Metadata Standards: integration for decentralized metadata storage
  • Collection Management: Update collection info, freeze metadata
  • Multi-Network Support: Deploy on Mainnet, Testnet, or Devnet

πŸ› οΈ Token Management

  • Mint Tokens: Create new tokens and distribute to any address
  • Burn Tokens: Reduce total supply by burning existing tokens
  • Pausable Transfers: Emergency pause/unpause functionality
  • Denylist Management: Block/unblock specific addresses
  • Ownership Transfer: Transfer token control to other addresses

πŸ”§ Developer Tools

  • Gas Estimator: Calculate deployment and transaction costs
  • Blockchain Explorer: Integrated Sui blockchain explorer

πŸ“Š Analytics & Monitoring

  • Token Dashboard: Comprehensive token overview and statistics
  • Transaction History: Detailed transaction logs and analytics
  • Real-time Updates: Live blockchain data synchronization
  • Portfolio Tracking: Multi-token portfolio management

πŸš€ Quick Start

Prerequisites

  • Node.js 18+ and npm/yarn
  • A Sui wallet (Sui Wallet, Ethos, or Martian)
  • SUI tokens for gas fees

Installation

  1. Clone the repository ```bash git clone https://github.com/ogazboiz/sui-token-wizard.git cd sui-token-wizard ```

  2. Install dependencies ```bash npm install

    or

    yarn install ```

  3. Run the development server ```bash npm run dev

    or

    yarn dev ```

  4. Open your browser Navigate to http://localhost:3000

πŸ—οΈ Project Structure

``` sui-token-wizard/ β”œβ”€β”€ app/ # Next.js 14 App Router β”‚ β”œβ”€β”€ blog/ # Blog pages and articles β”‚ β”œβ”€β”€ docs/ # Documentation pages β”‚ β”œβ”€β”€ generate/ # Token creation pages β”‚ β”œβ”€β”€ tools/ # Utility tools (explorer, gas estimator) β”‚ └── layout.tsx # Root layout β”œβ”€β”€ components/ # Reusable React components β”‚ β”œβ”€β”€ ui/ # shadcn/ui components β”‚ β”œβ”€β”€ tokenManager/ # Token management components β”‚ └── ... # Feature-specific components β”œβ”€β”€ lib/ # Utility functions and configurations β”œβ”€β”€ public/ # Static assets └── styles/ # Global styles and Tailwind config ```

πŸ”§ Technology Stack

Frontend

  • Framework: Next.js 14 with App Router
  • Language: TypeScript
  • Styling: Tailwind CSS + shadcn/ui
  • Animations: Framer Motion
  • State Management: React Hooks + Context

Blockchain Integration

  • Wallet Connection: @mysten/dapp-kit
  • Sui SDK: @mysten/sui.js for blockchain interactions
  • Transaction Handling: Sui Move call integration
  • Network Support: Mainnet, Testnet, and Devnet
  • Documentation: Based on official Sui documentation

πŸ“– Usage Guide

Creating Your First Token

  1. Connect Wallet

    • Click "Connect Wallet" in the navigation
    • Select your preferred Sui wallet
    • Approve the connection
  2. Choose Token Type

    • Standard: Basic fungible token
    • Regulated: Advanced features (pausable, denylist)
    • Closed Loop: Policy-controlled with governance and multi-party approvals
  3. Configure Token ```typescript { name: "My Awesome Token", symbol: "MAT", description: "A token for my awesome project", decimals: 9, initialSupply: "1000000" } ```

  4. Deploy

    • Review gas estimates
    • Confirm transaction in wallet
    • Wait for blockchain confirmation

Creating Your First NFT Collection

  1. Connect Wallet

    • Click "Connect Wallet" in the navigation
    • Select your preferred Sui wallet
    • Approve the connection
  2. Navigate to NFT Creation

    • Go to "Create NFT" section
    • Choose your deployment network
  3. Configure Collection ```typescript { name: "My Awesome NFT Collection", symbol: "MANC", description: "A unique NFT collection for my project", maxSupply: 10000, royaltyPercentage: 5, imagwUri: "https://image/avatars/..." } ```

  4. Deploy Collection

    • Review gas estimates
    • Confirm transaction in wallet
    • Wait for blockchain confirmation

Managing Tokens

Minting New Tokens

```typescript // Mint 1000 tokens to a specific address await mintTokens({ amount: "1000", recipient: "0x1234...5678" }); ```

Burning Tokens

```typescript // Burn 500 tokens from supply await burnTokens({ amount: "500", coinId: "0xabcd...ef01" }); ```

Pausing Transfers

```typescript // Emergency pause all transfers await pauseToken();

// Resume transfers await unpauseToken(); ```

πŸš€ Deployment

Vercel (Recommended)

  1. Fork this repository
  2. Connect to Vercel
  3. Configure environment variables
  4. Deploy automatically

Manual Deployment

```bash

Build for production

npm run build

Start production server

npm start ```

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes
  4. Run tests: npm test
  5. Commit changes: git commit -m 'Add amazing feature'
  6. Push to branch: git push origin feature/amazing-feature
  7. Open a Pull Request

Code Style

  • Use TypeScript for all new code
  • Follow ESLint configuration
  • Use Prettier for formatting
  • Write tests for new features

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

Community

Issues

If you encounter any issues, please create a GitHub issue with:

  • Detailed description
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)

πŸ™ Acknowledgments


Made with ❀️ by the Sui Token Creator team

Website β€’ Documentation β€’

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages