Function: quoteCreditTokenPurchase()

quoteCreditTokenPurchase(tier, units, decimals?): object

Defined in: packages/bitbadgesjs-sdk/src/core/credit-tokens.ts:171

Exact terms quote; balances, eligibility, network fees and external consumption are not inferred.

Parameters#

tier#

CreditTokenTier

units#

bigint

decimals?#

CreditPurchaseDecimals = {}

Returns#

object

actualMultiplier#

actualMultiplier: bigint = units

approvalId#

approvalId: string = tier.approvalId

consumptionTracking#

consumptionTracking: string = 'external-ledger'

eligibility#

eligibility: string = 'not-checked'

feesIncluded#

feesIncluded: boolean = false

limitingRule#

limitingRule: string

maximumMultiplier#

maximumMultiplier: bigint | null

minted#

minted: object

minted.baseAmount#

baseAmount: bigint = minted

minted.decimals#

decimals: number | null

minted.displayAmount#

displayAmount: string | null

minted.tokenId#

tokenId: string = '1'

payment#

payment: object

payment.baseAmount#

baseAmount: bigint = payment

payment.decimals#

decimals: number | null

payment.denom#

denom: string = tier.paymentDenom

payment.displayAmount#

displayAmount: string | null

payment.recipient#

recipient: string = tier.recipient

ratio#

ratio: object

ratio.mintedBaseAmount#

mintedBaseAmount: bigint = tier.mintAmount

ratio.paymentBaseAmount#

paymentBaseAmount: bigint = tier.paymentAmount

remainingCredits#

remainingCredits: null = null

requestedMultiplier#

requestedMultiplier: bigint = units