Skip to content

Repository files navigation

Mint Club

Mint Club V2 SDK

The TypeScript SDK for creating, trading, and managing assets on the Mint Club bonding curve protocol.

npm downloads install size GitHub BSD-3-Clause


What is Mint Club V2?

Mint Club V2 is a permissionless bonding curve protocol. Launch tokens backed by any reserve asset (HUNT, ETH, USDC, …) with automated pricing — no liquidity pool required. The protocol handles minting, burning, and price discovery through audited smart contracts.

This SDK is the canonical TypeScript client for the protocol. Use it from Node.js, browsers, or any JavaScript runtime.

→ Full docs: sdk.mint.club


Install

Version 2 moved the SDK from mint.club-v2-sdk to the official Mint Club scope. Use @mint.club/v2-sdk for all new installations.

npm install @mint.club/v2-sdk
# or
yarn add @mint.club/v2-sdk
# or
bun add @mint.club/v2-sdk

Quick Start

import { mintclub } from '@mint.club/v2-sdk';

// Read token state without connecting a wallet.
const signet = mintclub.network('base').token('SIGNET');
const [details, nextMintPrice] = await Promise.all([
  signet.getDetail(),
  signet.getPriceForNextMint(),
]);

// Resolve the current USD price and its quote path.
const { usdRate, path } = await mintclub.network('base').token('HUNT').getUsdRate();

For trusted Node.js environments, configure a private key after selecting the network. Never expose a private key in browser code.

import { mintclub, wei } from '@mint.club/v2-sdk';

const serverToken = mintclub
  .network('base')
  .withPrivateKey(process.env.PRIVATE_KEY as `0x${string}`)
  .token('SIGNET');

const serverAmount = wei(100, await serverToken.getDecimals());
await serverToken.buy({ amount: serverAmount, slippage: 1 });

Browser applications should pass a viem wallet client from their wallet integration to mintclub.withWalletClient(). See the getting started guide for a complete example.


Features

Bonding curves Create, buy, sell, estimate, and inspect ERC-20 and ERC-1155 assets
Wallet integration Use viem wallet clients, injected wallets, or a server-side private key
Airdrops Create and claim Merkle airdrops with IPFS-backed allowlists
Lockups and staking Create token lockups and interact with staking pools
Wrapped-native Zap Buy with or sell to the native asset when the reserve is its wrapped token
USD pricing Resolve token prices through bonding curves and supported price providers
IPFS and metadata Upload and resolve asset metadata and airdrop lists

Supported Networks

The SDK accepts a chain ID or the lowercase network key shown below.

Environment Network keys
Mainnet ethereum, base, blast, optimism, arbitrum, polygon, bnbchain, avalanche, kaia, cyber, degen, ham, shibarium, unichain, zora, apechain, hashkey, robinhood, over
Testnet sepolia, basesepolia, blastsepolia, avalanchefuji, cybertestnet, puppynet

Contract availability differs by feature and network. Use getMintClubContractAddress() or the contract repository when you need a specific deployment.


Development

npm install
npm run typecheck
npm test
npm run build

Integration tests that require credentials (PRIVATE_KEY, FILEBASE_API_KEY) are auto-skipped when the env var is not set.


Links

App mint.club
SDK docs sdk.mint.club
Protocol docs docs.mint.club
Contracts Steemhunt/mint.club-v2-contract
CLI and MCP Steemhunt/mint.club-v2-ai
Community OnChat
X / Twitter @MintClubPro

License

BSD-3-Clause — built with 🏗️ by Hunt Town

About

No description, website, or topics provided.

Resources

Stars

35 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages