FeeCalculator
SIP Protocol API Reference v0.15.1
SIP Protocol API Reference / FeeCalculator
Class: FeeCalculator
Section titled “Class: FeeCalculator”Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4564
Fee Calculator
Calculates protocol fees based on transaction parameters.
Example
Section titled “Example”const calculator = new FeeCalculator()
const result = calculator.calculate({ amount: 1000000000n, // 1 token amountUsd: 100, // $100 sourceChain: 'near', destinationChain: 'ethereum', viewingKeyDisclosed: true,})
console.log(`Fee: ${result.protocolFeeUsd} USD (${result.appliedBps} bps)`)Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FeeCalculator(
options?):FeeCalculator
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4569
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”FeeCalculator
Methods
Section titled “Methods”calculate()
Section titled “calculate()”calculate(
input):FeeCalculationResult
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4573
Calculate fee for a transaction
Parameters
Section titled “Parameters”Returns
Section titled “Returns”estimateFee()
Section titled “estimateFee()”estimateFee(
amountUsd,chain):number
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4577
Get estimated fee for display (quick calculation)
Parameters
Section titled “Parameters”amountUsd
Section titled “amountUsd”number
Returns
Section titled “Returns”number
getTierForVolume()
Section titled “getTierForVolume()”getTierForVolume(
tiers,volumeUsd):FeeTier
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4581
Get fee tier for a volume
Parameters
Section titled “Parameters”FeeTier[]
volumeUsd
Section titled “volumeUsd”number
Returns
Section titled “Returns”getChainConfig()
Section titled “getChainConfig()”getChainConfig(
chain):ChainFeeConfig
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4585
Get chain configuration
Parameters
Section titled “Parameters”Returns
Section titled “Returns”updateChainConfig()
Section titled “updateChainConfig()”updateChainConfig(
chain,config):void
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4589
Update chain configuration
Parameters
Section titled “Parameters”config
Section titled “config”Partial<ChainFeeConfig>
Returns
Section titled “Returns”void
addWaiver()
Section titled “addWaiver()”addWaiver(
waiver):void
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4593
Add a waiver
Parameters
Section titled “Parameters”waiver
Section titled “waiver”Returns
Section titled “Returns”void
removeWaiver()
Section titled “removeWaiver()”removeWaiver(
type):void
Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:4597
Remove a waiver by type
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void