API Reference

SDK API Reference

Complete documentation for @suilab/token-creator-sdk

Installation

npm install @suilab/token-creator-sdk

View on NPM

SuiLabTokenCreatorSDK

Constructor

new SuiLabTokenCreatorSDK(apiKey: string, config: TokenCreatorConfig)

apiKey: string

Your SUILab API key (starts with SUILab_)

config: TokenCreatorConfig

{
  developerWallet: string;
  developerFee: number;
  network?: 'mainnet' | 'testnet';
  apiEndpoint?: string;
}

createNativeToken()

Create a native SUI token

async createNativeToken(params: TokenCreationParams): Promise<TokenCreationResult>

Parameters

interface TokenCreationParams {
  name: string;
  symbol: string;
  decimals: number;
  totalSupply: number;
  description: string;
  userAddress: string;
  icon?: string | File;
  metadata?: object;
}

Returns

interface TokenCreationResult {
  tokenId: string;
  digest: string;
  treasuryCap: string;
  coinMetadata: string;
  iconUrl?: string;
  totalFee: number;
}

estimateFees()

Get fee breakdown for token creation

estimateFees(): FeeEstimate

Returns

interface FeeEstimate {
  platformFee: number;
  developerFee: number;
  networkFee: number;
  total: number;
}

validateParams()

Validate token parameters before creation

validateParams(params: TokenCreationParams): ValidationResult

updateDeveloperFee()

Update your developer fee

updateDeveloperFee(newFee: number): void

Utility Functions

`suiToMist(sui)`

Convert SUI to MIST

suiToMist(5) // → 5000000000n

`mistToSui(mist)`

Convert MIST to SUI

mistToSui(5000000000n) // → 5

`validateAPIKey(key)`

Validate API key format

validateAPIKey("SUILab_abc") // → true

`uploadToIPFS(file, key, secret)`

Upload to IPFS

await uploadToIPFS(file) // → "https://..."

Error Handling

try {
  const result = await sdk.createNativeToken(params);
} catch (error: any) {
  console.error('Error:', error.message);
}

Invalid API key format

Check your API key starts with "SUILab_"

Validation failed

Check token parameters meet requirements

API Error

Server error or invalid request

No response from API

Network connectivity issue

Need Help?

← Tutorial Code Examples →