Getting Started

Overview

Mint.club is a multichain supported DApp that lets you easily create Bonding Curved ERC-20 and ERC-1155 with custom tokenomics.

You can use this SDK in both the browser and Node.js, and it's strongly-typed with TypeScript. Both ESM and CommonJS are supported.

Maximize the bonding curve protocol with your own flavor. 🍏

Quick Start

Below is a quick example of how to use the SDK to communicate with the Mint.club Protocol.

Install

First, we will install mint.club-v2-sdk as a dependency in our project.

npm

npm i mint.club-v2-sdk

Reading Data

Below is a simple example of retrieving the token's total supply.

app.ts

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

const 
const totalSupply: biginttotalSupply = await mintclub 
 
  .network('base') 
  .token('CHICKEN') 
  .getTotalSupply() 
 
// $CHICKEN token actually exists!
// https://mint.club/token/base/CHICKEN 🐔

Go to full documentation

Writing Data

Below is a simple example of purchasing a token.

app.ts

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

const result = await mintclub.network('base').token('CHICKEN').buy({

  amount: 100n, 
  slippage: 0, 
  recipient: '0x...', 
})

Go to full documentation

Next Steps 🎊

You can find more examples and detailed documentation throughout the rest of this site.