Skip to content

getBuyEstimation

Returns the estimated output amount of the token for the given input amount of the token.

Usage

example.ts
import { mintclub } from 'mint.club-v2-sdk'
 
const [estimation, royalty] = await mintclub.network('ethereum').token('SYMBOL').getBuyEstimation(1n)

Return Value

Promise<[estimatedOutcome: bigint, royalty: bigint]>

estimatedOutcome

  • Type: bigint

Estimated output amount of the token for the given input amount of the token.

royalty

  • Type: bigint

Royalty amount given to the creator of the token.

Parameters

amount

  • Type: bigint

The input amount of the token.