Skip to content

mintclub SDK

A brief introduction on common patterns.

Introduction

mintclub

You will most likely find everything needed within the mintclub module exported from mint.club-v2-sdk.

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

network

The SDK follows a common pattern of having a network method to set the network to interact with.

Available networks are ethereum base blast optimism arbitrum polygon avalanche bnbchain sepolia blastsepolia and avalanchefuji.

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

mintclub.network('
ethereum
base
blast
optimism
arbitrum
avalanche
polygon
bnbchain
sepolia
avalanchefuji
blastsepolia
'
app.ts
import { mintclub } from 'mint.club-v2-sdk';
 

mintclub.network(1
1
10
11155111
137
168587773

token | nft

Then follows the token and nft methods to interact with.

token represents fungible ERC-20 tokens, while nft represents non-fungible ERC-1155 tokens.

It takes in a string parameter which could be the token symbol or address.

app.ts
import { mintclub } from 'mint.club-v2-sdk'
 
const symbolOrAddress: string = 'CHICKEN'

mintclub.network('base').token(
const symbolOrAddress: string
symbolOrAddress)

functionName

Lastly, you can call the functions on the token or nft.

app.ts
import { mintclub } from 'mint.club-v2-sdk'
 
const symbolOrAddress: string = 'CHICKEN'

mintclub.network('base').token(symbolOrAddress).g
getAllowance
getBalanceOf
getBondAddress
getBuyEstimation
getDecimals
getDetail
getMaxSupply
getName
getPriceForNextMint
getReserveToken
getReserveTokenAddress
getSellEstimation
getSteps
getSymbol
getTokenAddress
getTokenBond
getTotalSupply