RektHubToken

Overview

RektHubToken is RektHub’s implementation of creator tokens, standard ERC20 tokens with metadata URI support and a one-time mint mechanism. Every creator token on RektHub uses this battle-tested standard, ensuring consistency, security, and gas efficiency.

For Creators: Your token is a standard ERC20, which means it’s compatible with all wallets, DEXes, and DeFi protocols. The metadata URI lets you add personality, your brand, socials, and community links.

Purpose & Design

What Makes It Special

Standard ERC20: Full compatibility with existing infrastructure
Metadata URI: Link to your token’s identity (name, image, socials)
One-Time Mint: Exactly 1 billion tokens minted once, then permanently locked
Gas Efficient: Uses minimal proxy pattern (EIP-1167) to clone a master implementation
Creator Control: Only creators can update metadata

Why One-Time Mint?

uint256 public constant TOTAL_SUPPLY = 1_000_000_000 * 10**18;

Supply is hardcoded and minted exactly once during initialization:

Token is deployed by Factory
Factory calls mintAndDisableMinting()
1B tokens go to the bonding curve
Minting is permanently disabled

This ensures:

No inflation: Supply cannot increase
Predictable economics: Creators and traders know the total supply upfront
Security: No rug pulls via minting

Token Distribution

When a token is created, the 1 billion total supply is distributed as follows:

Allocation	Amount	Purpose
Bonding Curve	1,000,000,000	Sent to curve on creation
└─ Tradeable	850,000,000 (85%)	Available for trading via bonding curve
└─ Reserved	150,000,000 (15%)	Held in curve for graduation liquidity

Why 150M Reserved? When a token graduates to DEX, it needs token liquidity for the pool. The reserved tokens ensure there’s always liquidity available for graduation.

Key Functions

Core ERC20

RektHubToken implements standard ERC20 functions:

function transfer(address to, uint256 amount) external returns (bool);
function approve(address spender, uint256 amount) external returns (bool);
function transferFrom(address from, address to, uint256 amount) external returns (bool);
function balanceOf(address account) external view returns (uint256);
function allowance(address owner, address spender) external view returns (uint256);

For Integrators: Treat RektHub tokens like any other ERC20. Standard patterns (approve/transferFrom, balanceOf checks) all work identically.

Metadata Management

`tokenURI`

Get the metadata URI for this token. Returns:

string: URI pointing to token metadata JSON (usually IPFS/Arweave)

Example:

const token = new ethers.Contract(tokenAddress, TOKEN_ABI, provider);
const uri = await token.tokenURI();
console.log('Metadata URI:', uri);

const response = await fetch(uri.replace('ipfs://', 'https://ipfs.io/ipfs/'));
const metadata = await response.json();
console.log('Token name:', metadata.name);
console.log('Description:', metadata.description);
console.log('Image:', metadata.image);

`setTokenURI`

Update the token’s metadata URI. Creator-only.

newURI

string

required

New metadata URI (must not be empty)

Events Emitted:

TokenURIUpdated

Example:

const newURI = 'ipfs://QmNewMetadata...';
const tx = await token.setTokenURI(newURI);
await tx.wait();

console.log('Metadata updated to:', newURI);

Creator Responsibility: Ensure your metadata URI points to permanent storage (IPFS, Arweave). Centralized hosting (your server) can break if the server goes down.

View Functions

`creator`

Get the token creator’s address. Returns:

address: Creator address

Example:

const creatorAddress = await token.creator();
console.log('Token created by:', creatorAddress);

`factory`

Get the Factory contract address. Returns:

address: RektHub Factory address

Example:

const factoryAddress = await token.factory();
console.log('Factory:', factoryAddress);

`mintingDisabled`

Check if minting is permanently disabled (always returns true after initialization). Returns:

bool: Always true after the one-time mint

Example:

const disabled = await token.mintingDisabled();
console.log('Minting disabled:', disabled);

`decimals`

Get token decimals (always 18). Returns:

uint8: 18 (standard for EVM tokens)

Metadata Structure

Your tokenURI should point to a JSON file with this structure:

{
	"name": "Creator Coin",
	"symbol": "CRTR",
	"description": "The official token of [Creator Name]. Join our community and support our mission.",
	"image": "ipfs://QmImageHash...",
	"external_url": "https://your-website.com",
	"attributes": [
		{
			"trait_type": "Creator",
			"value": "YourName"
		},
		{
			"trait_type": "Launch Date",
			"value": "2025-01-15"
		}
	],
	"social_links": {
		"twitter": "https://x.com/yourusername",
		"telegram": "https://t.me/yourchannel",
		"discord": "https://discord.gg/yourserver",
		"website": "https://your-website.com"
	}
}

Required Fields

name

string

required

Token name (e.g., “Creator Coin”)

symbol

string

required

Token symbol (e.g., “CRTR”)

description

string

required

Brief description of your token and community

image

string

required

IPFS/Arweave URI for token logo/artwork

Optional Fields

external_url

string

Your website or landing page

attributes

array

Token traits (creator name, launch date, etc.)

Links to your social presence (Twitter, Telegram, Discord, etc.)

Image Best Practices: - Use square images (1:1 ratio) - Recommended size: 500x500px minimum - Formats: PNG, JPG, SVG, GIF - Host on IPFS or Arweave for permanence

Events

TokenURIUpdated

Emitted when creator updates the metadata URI.

event TokenURIUpdated(
    string newURI,
    uint256 timestamp
);

Example:

token.on('TokenURIUpdated', (newURI, timestamp) => {
	console.log('Metadata updated:', newURI);
	console.log('At block timestamp:', timestamp);

	fetchAndDisplayMetadata(newURI);
});

MintingDisabled

Emitted once when minting is permanently disabled (during initialization).

event MintingDisabled(
    uint256 timestamp
);

Integration Patterns

Fetch and Display Token Metadata

async function getTokenMetadata(tokenAddress) {
	const token = new ethers.Contract(tokenAddress, TOKEN_ABI, provider);

	const [name, symbol, creator, uri] = await Promise.all([
		token.name(),
		token.symbol(),
		token.creator(),
		token.tokenURI(),
	]);

	const ipfsGateway = 'https://ipfs.io/ipfs/';
	const metadataURL = uri.replace('ipfs://', ipfsGateway);

	const response = await fetch(metadataURL);
	const metadata = await response.json();

	return {
		address: tokenAddress,
		name,
		symbol,
		creator,
		description: metadata.description,
		image: metadata.image.replace('ipfs://', ipfsGateway),
		socials: metadata.social_links || {},
		website: metadata.external_url,
	};
}

Build a Token Card Component

async function renderTokenCard(tokenAddress) {
	const metadata = await getTokenMetadata(tokenAddress);

	return `
    <div class="token-card">
      <img src="${metadata.image}" alt="${metadata.name}">
      <h3>${metadata.name} (${metadata.symbol})</h3>
      <p>${metadata.description}</p>
      <div class="creator">
        Created by: ${metadata.creator.slice(0, 6)}...${metadata.creator.slice(
		-4
	)}
      </div>
      <div class="socials">
        ${
									metadata.socials.twitter
										? `<a href="${metadata.socials.twitter}">Twitter</a>`
										: ''
								}
        ${
									metadata.socials.telegram
										? `<a href="${metadata.socials.telegram}">Telegram</a>`
										: ''
								}
        ${metadata.website ? `<a href="${metadata.website}">Website</a>` : ''}
      </div>
      <button onclick="buyToken('${tokenAddress}')">Trade</button>
    </div>
  `;
}

Upload Metadata to IPFS

Here’s a quick guide for creators to upload metadata:

Prepare Your Metadata

Create a JSON file following the structure above. Include all social links and a high-quality image.

Upload to IPFS

Use a service like Pinata, NFT.Storage, or Web3.Storage:

const pinata = new pinataSDK(apiKey, secretKey);

const imageUpload = await pinata.pinFileToIPFS(imageFile);
const imageURI = `ipfs://${imageUpload.IpfsHash}`;

const metadata = {
  name: "Creator Coin",
  image: imageURI,
  description: "...",
};

const jsonUpload = await pinata.pinJSONToIPFS(metadata);
const metadataURI = `ipfs://${jsonUpload.IpfsHash}`;

console.log('Use this URI:', metadataURI);

Use URI in Token Creation

Pass the ipfs://... URI when creating your token via the Factory.

Pin Your Content: Make sure to “pin” your files on IPFS to ensure they remain accessible. Most pinning services offer free tiers for small files.

Gas Optimization

RektHub uses the minimal proxy pattern (EIP-1167) for token deployment:

How It Works

Implementation Contract: Deployed once per chain (master copy)
Clone Creation: Each new token is a minimal proxy (~100KB of bytecode)
Delegatecall: All logic delegated to the implementation

Gas Savings

Deployment Method	Gas Cost
Traditional Deploy	~3,000,000 gas
Minimal Proxy (RektHub)	~100,000 gas
Savings	~97% reduction

This makes token creation affordable on any chain, even mainnet Ethereum.

For Integrators: You don’t need to worry about the clone pattern. Interact with token addresses like normal ERC20s, the proxy handles delegation automatically.

Security Considerations

Supply is Immutable

function mintAndDisableMinting(address to) external onlyFactory {
    _mintToBondingCurve(to);
    _disableMinting();
}

Once minting is disabled:

No one can mint more tokens (not even the creator)
Total supply is forever fixed at 1 billion
Economic model is predictable and transparent

Creator Powers

Creators can only:

Update the tokenURI (metadata)
Transfer creator role to another address

Creators cannot:

Mint new tokens
Burn tokens
Pause transfers
Control user balances
Modify bonding curve parameters

Trust Minimization: Creator powers are intentionally limited. Your tokens are yours, creators can’t rug pull or manipulate supply.

Next Steps

Factory Contract

Learn how to create tokens

Bonding Curve

Understand the trading engine

Metadata Standards

Deep dive into metadata format

Quick Start

Core Contracts

Reference

Overview

Purpose & Design

What Makes It Special

Why One-Time Mint?

Token Distribution

Key Functions

Core ERC20

Metadata Management

`tokenURI`

`setTokenURI`

View Functions

`creator`

`factory`

`mintingDisabled`

`decimals`

Metadata Structure

Required Fields

Optional Fields

Events

TokenURIUpdated

MintingDisabled

Integration Patterns

Fetch and Display Token Metadata

Build a Token Card Component

Upload Metadata to IPFS

Gas Optimization

How It Works

Gas Savings

Security Considerations

Supply is Immutable

Creator Powers

Next Steps

Factory Contract

Bonding Curve

Metadata Standards

Quick Start

Core Contracts

Reference

Documentation Index

​Overview

​Purpose & Design

​What Makes It Special

​Why One-Time Mint?

​Token Distribution

​Key Functions

​Core ERC20

​Metadata Management

​tokenURI

​setTokenURI

​View Functions

​creator

​factory

​mintingDisabled

​decimals

​Metadata Structure

​Required Fields

​Optional Fields

​Events

​TokenURIUpdated

​MintingDisabled

​Integration Patterns

​Fetch and Display Token Metadata

​Build a Token Card Component

​Upload Metadata to IPFS

​Gas Optimization

​How It Works

​Gas Savings

​Security Considerations

​Supply is Immutable

​Creator Powers

​Next Steps

Factory Contract

Bonding Curve

Metadata Standards

Overview

Purpose & Design

What Makes It Special

Why One-Time Mint?

Token Distribution

Key Functions

Core ERC20

Metadata Management

`tokenURI`

`setTokenURI`

View Functions

`creator`

`factory`

`mintingDisabled`

`decimals`

Metadata Structure

Required Fields

Optional Fields

Events

TokenURIUpdated

MintingDisabled

Integration Patterns

Fetch and Display Token Metadata

Build a Token Card Component

Upload Metadata to IPFS

Gas Optimization

How It Works

Gas Savings

Security Considerations

Supply is Immutable

Creator Powers

Next Steps