blockworks-foundation
/
whirlpools-client
mirror of https://github.com/blockworks-foundation/whirlpools-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
whirlpools-client/docs/modules.html

403 lines
248 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@orca-so/whirlpools-sdk</title><meta name="description" content="Documentation for @orca-so/whirlpools-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@orca-so/whirlpools-sdk</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@orca-so/whirlpools-sdk </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section"><h3>Constants</h3><ul class="tsd-index-list"><li class="tsd-kind-variable"><a href="modules.html#FEE_RATE_MUL_VALUE" class="tsd-kind-icon">FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE</a></li><li class="tsd-kind-variable"><a href="modules.html#MAX_SQRT_PRICE" class="tsd-kind-icon">MAX_<wbr/>SQRT_<wbr/>PRICE</a></li><li class="tsd-kind-variable"><a href="modules.html#MAX_SWAP_TICK_ARRAYS" class="tsd-kind-icon">MAX_<wbr/>SWAP_<wbr/>TICK_<wbr/>ARRAYS</a></li><li class="tsd-kind-variable"><a href="modules.html#MAX_TICK_INDEX" class="tsd-kind-icon">MAX_<wbr/>TICK_<wbr/>INDEX</a></li><li class="tsd-kind-variable"><a href="modules.html#METADATA_PROGRAM_ADDRESS" class="tsd-kind-icon">METADATA_<wbr/>PROGRAM_<wbr/>ADDRESS</a></li><li class="tsd-kind-variable"><a href="modules.html#MIN_SQRT_PRICE" class="tsd-kind-icon">MIN_<wbr/>SQRT_<wbr/>PRICE</a></li><li class="tsd-kind-variable"><a href="modules.html#MIN_TICK_INDEX" class="tsd-kind-icon">MIN_<wbr/>TICK_<wbr/>INDEX</a></li><li class="tsd-kind-variable"><a href="modules.html#NUM_REWARDS" class="tsd-kind-icon">NUM_<wbr/>REWARDS</a></li><li class="tsd-kind-variable"><a href="modules.html#ORCA_WHIRLPOOLS_CONFIG" class="tsd-kind-icon">ORCA_<wbr/>WHIRLPOOLS_<wbr/>CONFIG</a></li><li class="tsd-kind-variable"><a href="modules.html#ORCA_WHIRLPOOL_PROGRAM_ID" class="tsd-kind-icon">ORCA_<wbr/>WHIRLPOOL_<wbr/>PROGRAM_<wbr/>ID</a></li><li class="tsd-kind-variable"><a href="modules.html#PROTOCOL_FEE_RATE_MUL_VALUE" class="tsd-kind-icon">PROTOCOL_<wbr/>FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE</a></li><li class="tsd-kind-variable"><a href="modules.html#TICK_ARRAY_SIZE" class="tsd-kind-icon">TICK_<wbr/>ARRAY_<wbr/>SIZE</a></li></ul></section><section class="tsd-index-section"><h3>Core</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/AccountFetcher.html" class="tsd-kind-icon">Account<wbr/>Fetcher</a></li><li class="tsd-kind-class"><a href="classes/WhirlpoolContext.html" class="tsd-kind-icon">Whirlpool<wbr/>Context</a></li><li class="tsd-kind-class"><a href="classes/WhirlpoolIx.html" class="tsd-kind-icon">Whirlpool<wbr/>Ix</a></li><li class="tsd-kind-interface"><a href="interfaces/WhirlpoolClient.html" class="tsd-kind-icon">Whirlpool<wbr/>Client</a></li></ul></section><section class="tsd-index-section"><h3>Instruction Types</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#ClosePositionParams" class="tsd-kind-icon">Close<wbr/>Position<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectFeesParams" class="tsd-kind-icon">Collect<wbr/>Fees<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectProtocolFeesParams" class="tsd-kind-icon">Collect<wbr/>Protocol<wbr/>Fees<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectRewardParams" class="tsd-kind-icon">Collect<wbr/>Reward<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityInput" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityParams" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityInput" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityParams" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitConfigParams" class="tsd-kind-icon">Init<wbr/>Config<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitFeeTierParams" class="tsd-kind-icon">Init<wbr/>Fee<wbr/>Tier<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitPoolParams" class="tsd-kind-icon">Init<wbr/>Pool<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitTickArrayParams" class="tsd-kind-icon">Init<wbr/>Tick<wbr/>Array<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitializeRewardParams" class="tsd-kind-icon">Initialize<wbr/>Reward<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OpenPositionParams" class="tsd-kind-icon">Open<wbr/>Position<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetCollectProtocolFeesAuthorityParams" class="tsd-kind-icon">Set<wbr/>Collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetDefaultFeeRateParams" class="tsd-kind-icon">Set<wbr/>Default<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetDefaultProtocolFeeRateParams" class="tsd-kind-icon">Set<wbr/>Default<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetFeeAuthorityParams" class="tsd-kind-icon">Set<wbr/>Fee<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetFeeRateParams" class="tsd-kind-icon">Set<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetProtocolFeeRateParams" class="tsd-kind-icon">Set<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardAuthorityBySuperAuthorityParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Authority<wbr/>By<wbr/>Super<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardAuthorityParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardEmissionsParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Emissions<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardEmissionsSuperAuthorityParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapInput" class="tsd-kind-icon">Swap<wbr/>Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapParams" class="tsd-kind-icon">Swap<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#UpdateFeesAndRewardsParams" class="tsd-kind-icon">Update<wbr/>Fees<wbr/>And<wbr/>Rewards<wbr/>Params</a></li></ul></section><section class="tsd-index-section"><h3>Other</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#TokenAccountInfo" class="tsd-kind-icon">Token<wbr/>Account<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolRewardInfo" class="tsd-kind-icon">Whirlpool<wbr/>Reward<wbr/>Info</a></li><li class="tsd-kind-function"><a href="modules.html#toTx" class="tsd-kind-icon">to<wbr/>Tx</a></li></ul></section><section class="tsd-index-section"><h3>Parsables</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/AccountName.html" class="tsd-kind-icon">Account<wbr/>Name</a></li><li class="tsd-kind-class"><a href="classes/ParsableFeeTier.html" class="tsd-kind-icon">Parsable<wbr/>Fee<wbr/>Tier</a></li><li class="tsd-kind-class"><a href="classes/ParsableMintInfo.html" class="tsd-kind-icon">Parsable<wbr/>Mint<wbr/>Info</a></li><li class="tsd-kind-class"><a href="classes/ParsablePosition.html" class="tsd-kind-icon">Parsable<wbr/>Position</a></li><li class="tsd-kind-class"><a href="classes/ParsableTickArray.html" class="tsd-kind-icon">Parsable<wbr/>Tick<wbr/>Array</a></li><li class="tsd-kind-class"><a href="classes/ParsableTokenInfo.html" class="tsd-kind-icon">Parsable<wbr/>Token<wbr/>Info</a></li><li class="tsd-kind-class"><a href="classes/ParsableWhirlpool.html" class="tsd-kind-icon">Parsable<wbr/>Whirlpool</a></li><li class="tsd-kind-class"><a href="classes/ParsableWhirlpoolsConfig.html" class="tsd-kind-icon">Parsable<wbr/>Whirlpools<wbr/>Config</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ParsableEntity.html" class="tsd-kind-icon">Parsable<wbr/>Entity</a></li></ul></section><section class="tsd-index-section"><h3>Quotes</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#CollectFeesQuote" class="tsd-kind-icon">Collect<wbr/>Fees<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectFeesQuoteParam" class="tsd-kind-icon">Collect<wbr/>Fees<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectRewardsQuote" class="tsd-kind-icon">Collect<wbr/>Rewards<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectRewardsQuoteParam" class="tsd-kind-icon">Collect<wbr/>Rewards<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityQuote" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityQuoteParam" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DevFeeSwapQuote" class="tsd-kind-icon">Dev<wbr/>Fee<wbr/>Swap<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityQuote" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityQuoteParam" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NormalSwapQuote" class="tsd-kind-icon">Normal<wbr/>Swap<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapQuote" class="tsd-kind-icon">Swap<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapQuoteParam" class="tsd-kind-icon">Swap<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-function"><a href="modules.html#collectFeesQuote" class="tsd-kind-icon">collect<wbr/>Fees<wbr/>Quote</a></li><li class="tsd-kind-function"><a href="modules.html#collectRewardsQuote" class="tsd-kind-icon">collect<wbr/>Rewards<wbr/>Quote</a></li><li class="tsd-kind-function"><a href="modules.html#decreaseLiquidityQuoteByLiquidity" class="tsd-kind-icon">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity</a></li><li class="tsd-kind-function"><a href="modules.html#decreaseLiquidityQuoteByLiquidityWithParams" class="tsd-kind-icon">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity<wbr/>With<wbr/>Params</a></li><li class="tsd-kind-function"><a href="modules.html#increaseLiquidityQuoteByInputToken" class="tsd-kind-icon">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#increaseLiquidityQuoteByInputTokenWithParams" class="tsd-kind-icon">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Params</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteByInputToken" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteByInputTokenWithDevFees" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Dev<wbr/>Fees</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteByOutputToken" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Output<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteWithParams" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>With<wbr/>Params</a></li></ul></section><section class="tsd-index-section"><h3>Solana Accounts</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#FeeTierData" class="tsd-kind-icon">Fee<wbr/>Tier<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OpenPositionBumpsData" class="tsd-kind-icon">Open<wbr/>Position<wbr/>Bumps<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OpenPositionWithMetadataBumpsData" class="tsd-kind-icon">Open<wbr/>Position<wbr/>With<wbr/>Metadata<wbr/>Bumps<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PositionData" class="tsd-kind-icon">Position<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PositionRewardInfoData" class="tsd-kind-icon">Position<wbr/>Reward<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TickArrayData" class="tsd-kind-icon">Tick<wbr/>Array<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TickData" class="tsd-kind-icon">Tick<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolBumpsData" class="tsd-kind-icon">Whirlpool<wbr/>Bumps<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolData" class="tsd-kind-icon">Whirlpool<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolRewardInfoData" class="tsd-kind-icon">Whirlpool<wbr/>Reward<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolsConfigData" class="tsd-kind-icon">Whirlpools<wbr/>Config<wbr/>Data</a></li></ul></section><section class="tsd-index-section"><h3>Whirlpool Utils</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/SwapDirection.html" class="tsd-kind-icon">Swap<wbr/>Direction</a></li><li class="tsd-kind-enum"><a href="enums/TokenType.html" class="tsd-kind-icon">Token<wbr/>Type</a></li><li class="tsd-kind-class"><a href="classes/PDAUtil.html" class="tsd-kind-icon">PDAUtil</a></li><li class="tsd-kind-class"><a href="classes/PoolUtil.html" class="tsd-kind-icon">Pool<wbr/>Util</a></li><li class="tsd-kind-class"><a href="classes/PriceMath.html" class="tsd-kind-icon">Price<wbr/>Math</a></li><li class="tsd-kind-class"><a href="classes/SwapUtils.html" class="tsd-kind-icon">Swap<wbr/>Utils</a></li><li class="tsd-kind-class"><a href="classes/TickArrayUtil.html" class="tsd-kind-icon">Tick<wbr/>Array<wbr/>Util</a></li><li class="tsd-kind-class"><a href="classes/TickUtil.html" class="tsd-kind-icon">Tick<wbr/>Util</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenAmounts" class="tsd-kind-icon">Token<wbr/>Amounts</a></li><li class="tsd-kind-function"><a href="modules.html#toTokenAmount" class="tsd-kind-icon">to<wbr/>Token<wbr/>Amount</a></li></ul></section><section class="tsd-index-section"><h3>WhirlpoolClient</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/Position.html" class="tsd-kind-icon">Position</a></li><li class="tsd-kind-interface"><a href="interfaces/Whirlpool.html" class="tsd-kind-icon">Whirlpool</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TickArray" class="tsd-kind-icon">Tick<wbr/>Array</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenInfo" class="tsd-kind-icon">Token<wbr/>Info</a></li><li class="tsd-kind-function"><a href="modules.html#buildWhirlpoolClient" class="tsd-kind-icon">build<wbr/>Whirlpool<wbr/>Client</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group undefined"><h2>Constants</h2><section class="tsd-panel tsd-member tsd-kind-variable"><a id="FEE_RATE_MUL_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE<a href="#FEE_RATE_MUL_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L77">types/public/constants.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The denominator which the fee rate is divided on.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="MAX_SQRT_PRICE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> MAX_<wbr/>SQRT_<wbr/>PRICE<a href="#MAX_SQRT_PRICE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">MAX_<wbr/>SQRT_<wbr/>PRICE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;79226673515401279992447579055&quot;</span><span class="tsd-signature-symbol"> = &quot;79226673515401279992447579055&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L40">types/public/constants.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum sqrt-price supported by the Whirlpool program.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="MAX_SWAP_TICK_ARRAYS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> MAX_<wbr/>SWAP_<wbr/>TICK_<wbr/>ARRAYS<a href="#MAX_SWAP_TICK_ARRAYS" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">MAX_<wbr/>SWAP_<wbr/>TICK_<wbr/>ARRAYS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L65">types/public/constants.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum number of tick-arrays that can traversed across in a swap.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="MAX_TICK_INDEX" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> MAX_<wbr/>TICK_<wbr/>INDEX<a href="#MAX_TICK_INDEX" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">MAX_<wbr/>TICK_<wbr/>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">443636</span><span class="tsd-signature-symbol"> = 443636</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L28">types/public/constants.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum tick index supported by the Whirlpool program.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="METADATA_PROGRAM_ADDRESS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> METADATA_<wbr/>PROGRAM_<wbr/>ADDRESS<a href="#METADATA_PROGRAM_ADDRESS" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">METADATA_<wbr/>PROGRAM_<wbr/>ADDRESS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L57">types/public/constants.ts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="MIN_SQRT_PRICE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> MIN_<wbr/>SQRT_<wbr/>PRICE<a href="#MIN_SQRT_PRICE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">MIN_<wbr/>SQRT_<wbr/>PRICE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;4295048016&quot;</span><span class="tsd-signature-symbol"> = &quot;4295048016&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L46">types/public/constants.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The minimum sqrt-price supported by the Whirlpool program.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="MIN_TICK_INDEX" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> MIN_<wbr/>TICK_<wbr/>INDEX<a href="#MIN_TICK_INDEX" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">MIN_<wbr/>TICK_<wbr/>INDEX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-443636</span><span class="tsd-signature-symbol"> = -443636</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L34">types/public/constants.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The minimum tick index supported by the Whirlpool program.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="NUM_REWARDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> NUM_<wbr/>REWARDS<a href="#NUM_REWARDS" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">NUM_<wbr/>REWARDS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span><span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L22">types/public/constants.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The number of rewards supported by this whirlpool.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="ORCA_WHIRLPOOLS_CONFIG" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> ORCA_<wbr/>WHIRLPOOLS_<wbr/>CONFIG<a href="#ORCA_WHIRLPOOLS_CONFIG" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ORCA_<wbr/>WHIRLPOOLS_<wbr/>CONFIG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L16">types/public/constants.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Orca&#39;s WhirlpoolsConfig PublicKey.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="ORCA_WHIRLPOOL_PROGRAM_ID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> ORCA_<wbr/>WHIRLPOOL_<wbr/>PROGRAM_<wbr/>ID<a href="#ORCA_WHIRLPOOL_PROGRAM_ID" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ORCA_<wbr/>WHIRLPOOL_<wbr/>PROGRAM_<wbr/>ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L8">types/public/constants.ts:8</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Program ID hosting Orca&#39;s Whirlpool program.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="PROTOCOL_FEE_RATE_MUL_VALUE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> PROTOCOL_<wbr/>FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE<a href="#PROTOCOL_FEE_RATE_MUL_VALUE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">PROTOCOL_<wbr/>FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L71">types/public/constants.ts:71</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The denominator which the protocol fee rate is divided on.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable"><a id="TICK_ARRAY_SIZE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> TICK_<wbr/>ARRAY_<wbr/>SIZE<a href="#TICK_ARRAY_SIZE" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">TICK_<wbr/>ARRAY_<wbr/>SIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">88</span><span class="tsd-signature-symbol"> = 88</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/constants.ts#L52">types/public/constants.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The number of initialized ticks that a tick-array account can hold.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group undefined"><h2>Instruction Types</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="ClosePositionParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Close<wbr/>Position<wbr/>Params<a href="#ClosePositionParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Close<wbr/>Position<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionTokenAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>receiver<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/close-position-ix.ts#L17">instructions/close-position-ix.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to close a position in a Whirlpool.</p>
</div><dl class="tsd-comment-tags"><dt>param receiver</dt><dd><p>PublicKey for the wallet that will receive the rented lamports.</p>
</dd><dt>param position</dt><dd><p>PublicKey for the position.</p>
</dd><dt>param positionMint</dt><dd><p>PublicKey for the mint token for the Position token.</p>
</dd><dt>param positionTokenAccount</dt><dd><p>The associated token address for the position token in the owners wallet.</p>
</dd><dt>param positionAuthority</dt><dd><p>Authority that owns the position token.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Token<wbr/>Account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>receiver<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CollectFeesParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collect<wbr/>Fees<wbr/>Params<a href="#CollectFeesParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Collect<wbr/>Fees<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionTokenAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/collect-fees-ix.ts#L21">instructions/collect-fees-ix.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to collect fees from a position.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param position</dt><dd><p>PublicKey for the position will be opened for.</p>
</dd><dt>param positionTokenAccount</dt><dd><p>PublicKey for the position token&#39;s associated token address.</p>
</dd><dt>param tokenOwnerAccountA</dt><dd><p>PublicKey for the token A account that will be withdrawed from.</p>
</dd><dt>param tokenOwnerAccountB</dt><dd><p>PublicKey for the token B account that will be withdrawed from.</p>
</dd><dt>param tokenVaultA</dt><dd><p>PublicKey for the tokenA vault for this whirlpool.</p>
</dd><dt>param tokenVaultB</dt><dd><p>PublicKey for the tokenB vault for this whirlpool.</p>
</dd><dt>param positionAuthority</dt><dd><p>authority that owns the token corresponding to this desired position.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Token<wbr/>Account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>Owner<wbr/>AccountA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>Owner<wbr/>AccountB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CollectProtocolFeesParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collect<wbr/>Protocol<wbr/>Fees<wbr/>Params<a href="#CollectProtocolFeesParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Collect<wbr/>Protocol<wbr/>Fees<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>collectProtocolFeesAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/collect-protocol-fees-ix.ts#L19">instructions/collect-protocol-fees-ix.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to collect protocol fees for a Whirlpool</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param tokenVaultA</dt><dd><p>PublicKey for the tokenA vault for this whirlpool.</p>
</dd><dt>param tokenVaultB</dt><dd><p>PublicKey for the tokenB vault for this whirlpool.</p>
</dd><dt>param tokenOwnerAccountA</dt><dd><p>PublicKey for the associated token account for tokenA in the collection wallet</p>
</dd><dt>param tokenOwnerAccountB</dt><dd><p>PublicKey for the associated token account for tokenA in the collection wallet</p>
</dd><dt>param collectProtocolFeesAuthority</dt><dd><p>assigned authority in the WhirlpoolsConfig that can collect protocol fees</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>Owner<wbr/>AccountA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>Owner<wbr/>AccountB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CollectRewardParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collect<wbr/>Reward<wbr/>Params<a href="#CollectRewardParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Collect<wbr/>Reward<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionTokenAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rewardOwnerAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardVault<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/collect-reward-ix.ts#L19">instructions/collect-reward-ix.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to collect rewards from a reward index in a position.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param position</dt><dd><p>PublicKey for the position will be opened for.</p>
</dd><dt>param positionTokenAccount</dt><dd><p>PublicKey for the position token&#39;s associated token address.</p>
</dd><dt>param rewardIndex</dt><dd><p>The reward index that we&#39;d like to initialize. (0 &lt;= index &lt;= NUM_REWARDS).</p>
</dd><dt>param rewardOwnerAccount</dt><dd><p>PublicKey for the reward token account that the reward will deposit into.</p>
</dd><dt>param rewardVault</dt><dd><p>PublicKey of the vault account that reward will be withdrawn from.</p>
</dd><dt>param positionAuthority</dt><dd><p>authority that owns the token corresponding to this desired position.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Token<wbr/>Account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Owner<wbr/>Account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Vault<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="DecreaseLiquidityInput" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Decrease<wbr/>Liquidity<wbr/>Input<a href="#DecreaseLiquidityInput" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Input<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>liquidityAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tokenMinA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tokenMinB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/decrease-liquidity-ix.ts#L42">instructions/decrease-liquidity-ix.ts:42</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>liquidity<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MinA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MinB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="DecreaseLiquidityParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Decrease<wbr/>Liquidity<wbr/>Params<a href="#DecreaseLiquidityParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionTokenAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArrayLower<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArrayUpper<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules.html#DecreaseLiquidityInput" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityInput</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/decrease-liquidity-ix.ts#L26">instructions/decrease-liquidity-ix.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to remove liquidity from a position.</p>
</div><dl class="tsd-comment-tags"><dt>param liquidityAmount</dt><dd><p>The total amount of Liquidity the user is withdrawing</p>
</dd><dt>param tokenMinA</dt><dd><p>The minimum amount of token A to remove from the position.</p>
</dd><dt>param tokenMinB</dt><dd><p>The minimum amount of token B to remove from the position.</p>
</dd><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param position</dt><dd><p>PublicKey for the position will be opened for.</p>
</dd><dt>param positionTokenAccount</dt><dd><p>PublicKey for the position token&#39;s associated token address.</p>
</dd><dt>param tokenOwnerAccountA</dt><dd><p>PublicKey for the token A account that will be withdrawed from.</p>
</dd><dt>param tokenOwnerAccountB</dt><dd><p>PublicKey for the token B account that will be withdrawed from.</p>
</dd><dt>param tokenVaultA</dt><dd><p>PublicKey for the tokenA vault for this whirlpool.</p>
</dd><dt>param tokenVaultB</dt><dd><p>PublicKey for the tokenB vault for this whirlpool.</p>
</dd><dt>param tickArrayLower</dt><dd><p>PublicKey for the tick-array account that hosts the tick at the lower tick index.</p>
</dd><dt>param tickArrayUpper</dt><dd><p>PublicKey for the tick-array account that hosts the tick at the upper tick index.</p>
</dd><dt>param positionAuthority</dt><dd><p>authority that owns the token corresponding to this desired position.</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="IncreaseLiquidityInput" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Increase<wbr/>Liquidity<wbr/>Input<a href="#IncreaseLiquidityInput" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Input<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>liquidityAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tokenMaxA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>tokenMaxB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/increase-liquidity-ix.ts#L50">instructions/increase-liquidity-ix.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Input parameters to deposit liquidity into a position.</p>
</div><div><p>This type is usually generated by a quote class to estimate the amount of tokens required to
deposit a certain amount of liquidity into a position.</p>
</div><dl class="tsd-comment-tags"><dt>param tokenMaxA</dt><dd><p>the maximum amount of tokenA allowed to withdraw from the source wallet.</p>
</dd><dt>param tokenMaxB</dt><dd><p>the maximum amount of tokenB allowed to withdraw from the source wallet.</p>
</dd><dt>param liquidityAmount</dt><dd><p>the desired amount of liquidity to deposit into the position/</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>liquidity<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MaxA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MaxB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="IncreaseLiquidityParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Increase<wbr/>Liquidity<wbr/>Params<a href="#IncreaseLiquidityParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionTokenAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArrayLower<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArrayUpper<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules.html#IncreaseLiquidityInput" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityInput</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/increase-liquidity-ix.ts#L26">instructions/increase-liquidity-ix.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to increase liquidity for a position.</p>
</div><dl class="tsd-comment-tags"><dt>param liquidityAmount</dt><dd><p>The total amount of Liquidity the user is willing to deposit.</p>
</dd><dt>param tokenMaxA</dt><dd><p>The maximum amount of token A to add to the position.</p>
</dd><dt>param tokenMaxB</dt><dd><p>The maximum amount of token B to add to the position.</p>
</dd><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param position</dt><dd><p>PublicKey for the position will be opened for.</p>
</dd><dt>param positionTokenAccount</dt><dd><p>PublicKey for the position token&#39;s associated token address.</p>
</dd><dt>param tokenOwnerAccountA</dt><dd><p>PublicKey for the token A account that will be withdrawed from.</p>
</dd><dt>param tokenOwnerAccountB</dt><dd><p>PublicKey for the token B account that will be withdrawed from.</p>
</dd><dt>param tokenVaultA</dt><dd><p>PublicKey for the tokenA vault for this whirlpool.</p>
</dd><dt>param tokenVaultB</dt><dd><p>PublicKey for the tokenB vault for this whirlpool.</p>
</dd><dt>param tickArrayLower</dt><dd><p>PublicKey for the tick-array account that hosts the tick at the lower tick index.</p>
</dd><dt>param tickArrayUpper</dt><dd><p>PublicKey for the tick-array account that hosts the tick at the upper tick index.</p>
</dd><dt>param positionAuthority</dt><dd><p>authority that owns the token corresponding to this desired position.</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="InitConfigParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Init<wbr/>Config<wbr/>Params<a href="#InitConfigParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Init<wbr/>Config<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>collectProtocolFeesAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>defaultProtocolFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardEmissionsSuperAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfigKeypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/initialize-config-ix.ts#L18">instructions/initialize-config-ix.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to initialize a WhirlpoolsConfig account.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfigKeypair</dt><dd><p>Generated keypair for the WhirlpoolsConfig.</p>
</dd><dt>param feeAuthority</dt><dd><p>Authority authorized to initialize fee-tiers and set customs fees.</p>
</dd><dt>param collect_protocol_fees_authority</dt><dd><p>Authority authorized to collect protocol fees.</p>
</dd><dt>param rewardEmissionsSuperAuthority</dt><dd><p>Authority authorized to set reward authorities in pools.</p>
</dd><dt>param defaultProtocolFeeRate</dt><dd><p>The default protocol fee rate. Stored as a basis point of the total fees collected by feeRate.</p>
</dd><dt>param funder</dt><dd><p>The account that would fund the creation of this account</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>default<wbr/>Protocol<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<wbr/>Keypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="InitFeeTierParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Init<wbr/>Fee<wbr/>Tier<wbr/>Params<a href="#InitFeeTierParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Init<wbr/>Fee<wbr/>Tier<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>defaultFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>feeTierPda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span><span class="tsd-signature-symbol">; </span>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickSpacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/initialize-fee-tier-ix.ts#L19">instructions/initialize-fee-tier-ix.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to initialize a FeeTier account.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfig</dt><dd><p>PublicKey for the whirlpool config space that the fee-tier will be initialized for.</p>
</dd><dt>param feeTierPda</dt><dd><p>PDA for the fee-tier account that will be initialized</p>
</dd><dt>param tickSpacing</dt><dd><p>The tick spacing this fee tier recommends its default fee rate for.</p>
</dd><dt>param defaultFeeRate</dt><dd><p>The default fee rate for this fee-tier. Stored as a hundredths of a basis point.</p>
</dd><dt>param feeAuthority</dt><dd><p>Authority authorized to initialize fee-tiers and set customs fees.</p>
</dd><dt>param funder</dt><dd><p>The account that would fund the creation of this account</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>default<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Tier<wbr/>Pda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span></h5></li><li class="tsd-parameter"><h5>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Spacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="InitPoolParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Init<wbr/>Pool<wbr/>Params<a href="#InitPoolParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Init<wbr/>Pool<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeTierKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>initSqrtPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tickSpacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tokenMintA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenMintB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultAKeypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span><span class="tsd-signature-symbol">; </span>tokenVaultBKeypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span><span class="tsd-signature-symbol">; </span>whirlpoolPda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/initialize-pool-ix.ts#L25">instructions/initialize-pool-ix.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to initialize a Whirlpool account.</p>
</div><dl class="tsd-comment-tags"><dt>param initSqrtPrice</dt><dd><p>The desired initial sqrt-price for this pool</p>
</dd><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param whirlpoolPda</dt><dd><p>PDA for the whirlpool account that would be initialized</p>
</dd><dt>param tokenMintA</dt><dd><p>Mint public key for token A</p>
</dd><dt>param tokenMintB</dt><dd><p>Mint public key for token B</p>
</dd><dt>param tokenVaultAKeypair</dt><dd><p>Keypair of the token A vault for this pool</p>
</dd><dt>param tokenVaultBKeypair</dt><dd><p>Keypair of the token B vault for this pool</p>
</dd><dt>param feeTierKey</dt><dd><p>PublicKey of the fee-tier account that this pool would use for the fee-rate</p>
</dd><dt>param tickSpacing</dt><dd><p>The desired tick spacing for this pool.</p>
</dd><dt>param funder</dt><dd><p>The account that would fund the creation of this account</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>Tier<wbr/>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>init<wbr/>Sqrt<wbr/>Price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Spacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MintA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MintB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultAKeypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultBKeypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span></h5></li><li class="tsd-parameter"><h5>whirlpool<wbr/>Pda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="InitTickArrayParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Init<wbr/>Tick<wbr/>Array<wbr/>Params<a href="#InitTickArrayParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Init<wbr/>Tick<wbr/>Array<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>startTick<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickArrayPda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/initialize-tick-array-ix.ts#L17">instructions/initialize-tick-array-ix.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to initialize a TickArray account.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the initialized tick-array will host ticks for.</p>
</dd><dt>param tickArrayPda</dt><dd><p>PDA for the tick array account that will be initialized</p>
</dd><dt>param startTick</dt><dd><p>The starting tick index for this tick-array. Has to be a multiple of TickArray size &amp; the tick spacing of this pool.</p>
</dd><dt>param funder</dt><dd><p>The account that would fund the creation of this account</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>start<wbr/>Tick<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Array<wbr/>Pda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="InitializeRewardParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Initialize<wbr/>Reward<wbr/>Params<a href="#InitializeRewardParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Initialize<wbr/>Reward<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rewardMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardVaultKeypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/initialize-reward-ix.ts#L20">instructions/initialize-reward-ix.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to initialize a rewards for a Whirlpool</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool config space that the fee-tier will be initialized for.</p>
</dd><dt>param rewardIndex</dt><dd><p>The reward index that we&#39;d like to initialize. (0 &lt;= index &lt;= NUM_REWARDS).</p>
</dd><dt>param rewardMint</dt><dd><p>PublicKey for the reward mint that we&#39;d use for the reward index.</p>
</dd><dt>param rewardVaultKeypair</dt><dd><p>Keypair of the vault for this reward index.</p>
</dd><dt>param rewardAuthority</dt><dd><p>Assigned authority by the reward_super_authority for the specified reward-index in this Whirlpool</p>
</dd><dt>param funder</dt><dd><p>The account that would fund the creation of this account</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Vault<wbr/>Keypair<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Keypair</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="OpenPositionParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Open<wbr/>Position<wbr/>Params<a href="#OpenPositionParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Open<wbr/>Position<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionMintAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>positionPda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span><span class="tsd-signature-symbol">; </span>positionTokenAccount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickLowerIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickUpperIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/open-position-ix.ts#L25">instructions/open-position-ix.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to open a position in a Whirlpool.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param ownerKey</dt><dd><p>PublicKey for the wallet that will host the minted position token.</p>
</dd><dt>param positionPda</dt><dd><p>PDA for the derived position address.</p>
</dd><dt>param positionMintAddress</dt><dd><p>PublicKey for the mint token for the Position token.</p>
</dd><dt>param positionTokenAccount</dt><dd><p>The associated token address for the position token in the owners wallet.</p>
</dd><dt>param tickLowerIndex</dt><dd><p>The tick specifying the lower end of the position range.</p>
</dd><dt>param tickUpperIndex</dt><dd><p>The tick specifying the upper end of the position range.</p>
</dd><dt>param funder</dt><dd><p>The account that would fund the creation of this account</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>funder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Mint<wbr/>Address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Pda<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PDA</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Token<wbr/>Account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Lower<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Upper<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetCollectProtocolFeesAuthorityParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<wbr/>Params<a href="#SetCollectProtocolFeesAuthorityParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>collectProtocolFeesAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>newCollectProtocolFeesAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-collect-protocol-fees-authority-ix.ts#L14">instructions/set-collect-protocol-fees-authority-ix.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set the collect fee authority in a WhirlpoolsConfig</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param collectProtocolFeesAuthority</dt><dd><p>The current collectProtocolFeesAuthority in the WhirlpoolsConfig</p>
</dd><dt>param newCollectProtocolFeesAuthority</dt><dd><p>The new collectProtocolFeesAuthority in the WhirlpoolsConfig</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>new<wbr/>Collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetDefaultFeeRateParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Default<wbr/>Fee<wbr/>Rate<wbr/>Params<a href="#SetDefaultFeeRateParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Default<wbr/>Fee<wbr/>Rate<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>defaultFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickSpacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-default-fee-rate-ix.ts#L17">instructions/set-default-fee-rate-ix.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set the default fee rate for a FeeTier.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this fee-tier is initialized in</p>
</dd><dt>param feeAuthority</dt><dd><p>Authority authorized in the WhirlpoolsConfig to set default fee rates.</p>
</dd><dt>param tickSpacing</dt><dd><p>The tick spacing of the fee-tier that we would like to update.</p>
</dd><dt>param defaultFeeRate</dt><dd><p>The new default fee rate for this fee-tier. Stored as a hundredths of a basis point.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>default<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Spacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetDefaultProtocolFeeRateParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Default<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params<a href="#SetDefaultProtocolFeeRateParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Default<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>defaultProtocolFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-default-protocol-fee-rate-ix.ts#L14">instructions/set-default-protocol-fee-rate-ix.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set the default fee rate for a FeeTier.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param feeAuthority</dt><dd><p>Authority authorized in the WhirlpoolsConfig to set default fee rates.</p>
</dd><dt>param defaultProtocolFeeRate</dt><dd><p>The new default protocol fee rate for this config. Stored as a basis point of the total fees collected by feeRate.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>default<wbr/>Protocol<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetFeeAuthorityParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Fee<wbr/>Authority<wbr/>Params<a href="#SetFeeAuthorityParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Fee<wbr/>Authority<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>newFeeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-fee-authority-ix.ts#L14">instructions/set-fee-authority-ix.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set the fee authority in a WhirlpoolsConfig</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param feeAuthority</dt><dd><p>The current feeAuthority in the WhirlpoolsConfig</p>
</dd><dt>param newFeeAuthority</dt><dd><p>The new feeAuthority in the WhirlpoolsConfig</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>new<wbr/>Fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetFeeRateParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Fee<wbr/>Rate<wbr/>Params<a href="#SetFeeRateParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Fee<wbr/>Rate<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>feeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-fee-rate-ix.ts#L15">instructions/set-fee-rate-ix.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set fee rate for a Whirlpool.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool to update. This whirlpool has to be part of the provided WhirlpoolsConfig space.</p>
</dd><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param feeAuthority</dt><dd><p>Authority authorized in the WhirlpoolsConfig to set default fee rates.</p>
</dd><dt>param feeRate</dt><dd><p>The new fee rate for this fee-tier. Stored as a hundredths of a basis point.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetProtocolFeeRateParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params<a href="#SetProtocolFeeRateParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>protocolFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-protocol-fee-rate-ix.ts#L15">instructions/set-protocol-fee-rate-ix.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set fee rate for a Whirlpool.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool to update. This whirlpool has to be part of the provided WhirlpoolsConfig space.</p>
</dd><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param feeAuthority</dt><dd><p>Authority authorized in the WhirlpoolsConfig to set default fee rates.</p>
</dd><dt>param protocolFeeRate</dt><dd><p>The new default protocol fee rate for this pool. Stored as a basis point of the total fees collected by feeRate.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>protocol<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetRewardAuthorityBySuperAuthorityParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Reward<wbr/>Authority<wbr/>By<wbr/>Super<wbr/>Authority<wbr/>Params<a href="#SetRewardAuthorityBySuperAuthorityParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Reward<wbr/>Authority<wbr/>By<wbr/>Super<wbr/>Authority<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>newRewardAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardEmissionsSuperAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-reward-authority-by-super-authority-ix.ts#L16">instructions/set-reward-authority-by-super-authority-ix.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to update the reward authority at a particular rewardIndex on a Whirlpool.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool to update. This whirlpool has to be part of the provided WhirlpoolsConfig space.</p>
</dd><dt>param whirlpoolsConfig</dt><dd><p>The public key for the WhirlpoolsConfig this pool is initialized in</p>
</dd><dt>param rewardIndex</dt><dd><p>The reward index that we&#39;d like to update. (0 &lt;= index &lt;= NUM_REWARDS).</p>
</dd><dt>param rewardEmissionsSuperAuthority</dt><dd><p>The current rewardEmissionsSuperAuthority in the WhirlpoolsConfig</p>
</dd><dt>param newRewardAuthority</dt><dd><p>The new rewardAuthority in the Whirlpool at the rewardIndex</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>new<wbr/>Reward<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetRewardAuthorityParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Reward<wbr/>Authority<wbr/>Params<a href="#SetRewardAuthorityParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Reward<wbr/>Authority<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>newRewardAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-reward-authority-ix.ts#L15">instructions/set-reward-authority-ix.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to update the reward authority at a particular rewardIndex on a Whirlpool.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool to update.</p>
</dd><dt>param rewardIndex</dt><dd><p>The reward index that we&#39;d like to update. (0 &lt;= index &lt;= NUM_REWARDS).</p>
</dd><dt>param rewardAuthority</dt><dd><p>The current rewardAuthority in the Whirlpool at the rewardIndex</p>
</dd><dt>param newRewardAuthority</dt><dd><p>The new rewardAuthority in the Whirlpool at the rewardIndex</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>new<wbr/>Reward<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetRewardEmissionsParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Reward<wbr/>Emissions<wbr/>Params<a href="#SetRewardEmissionsParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Reward<wbr/>Emissions<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>emissionsPerSecondX64<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>rewardAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rewardVaultKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-reward-emissions-ix.ts#L17">instructions/set-reward-emissions-ix.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set rewards emissions for a reward in a Whirlpool</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool which the reward resides in.</p>
</dd><dt>param rewardIndex</dt><dd><p>The reward index that we&#39;d like to initialize. (0 &lt;= index &lt;= NUM_REWARDS).</p>
</dd><dt>param rewardVaultKey</dt><dd><p>PublicKey of the vault for this reward index.</p>
</dd><dt>param rewardAuthority</dt><dd><p>Assigned authority by the reward_super_authority for the specified reward-index in this Whirlpool</p>
</dd><dt>param emissionsPerSecondX64</dt><dd><p>The new emissions per second to set for this reward.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>emissions<wbr/>Per<wbr/>Second<wbr/>X64<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Vault<wbr/>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SetRewardEmissionsSuperAuthorityParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Set<wbr/>Reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<wbr/>Params<a href="#SetRewardEmissionsSuperAuthorityParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Set<wbr/>Reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>newRewardEmissionsSuperAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardEmissionsSuperAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/set-reward-emissions-super-authority-ix.ts#L14">instructions/set-reward-emissions-super-authority-ix.ts:14</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to set rewards emissions for a reward in a Whirlpool</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpoolsConfig</dt><dd><p>PublicKey for the WhirlpoolsConfig that we want to update.</p>
</dd><dt>param rewardEmissionsSuperAuthority</dt><dd><p>Current reward emission super authority in this WhirlpoolsConfig</p>
</dd><dt>param newRewardEmissionsSuperAuthority</dt><dd><p>New reward emission super authority for this WhirlpoolsConfig</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>new<wbr/>Reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SwapInput" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Swap<wbr/>Input<a href="#SwapInput" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Swap<wbr/>Input<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>aToB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>amountSpecifiedIsInput<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>otherAmountThreshold<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>sqrtPriceLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tickArray0<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArray1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArray2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/swap-ix.ts#L52">instructions/swap-ix.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to swap on a Whirlpool</p>
</div><dl class="tsd-comment-tags"><dt>param aToB</dt><dd><p>The direction of the swap. True if swapping from A to B. False if swapping from B to A.</p>
</dd><dt>param amountSpecifiedIsInput</dt><dd><p>Specifies the token the parameter <code>amount</code>represents. If true, the amount represents
the input token of the swap.</p>
</dd><dt>param amount</dt><dd><p>The amount of input or output token to swap from (depending on amountSpecifiedIsInput).</p>
</dd><dt>param otherAmountThreshold</dt><dd><p>The maximum/minimum of input/output token to swap into (depending on amountSpecifiedIsInput).</p>
</dd><dt>param sqrtPriceLimit</dt><dd><p>The maximum/minimum price the swap will swap to.</p>
</dd><dt>param tickArray0</dt><dd><p>PublicKey of the tick-array where the Whirlpool&#39;s currentTickIndex resides in</p>
</dd><dt>param tickArray1</dt><dd><p>The next tick-array in the swap direction. If the swap will not reach the next tick-aray, input the same array as tickArray0.</p>
</dd><dt>param tickArray2</dt><dd><p>The next tick-array in the swap direction after tickArray2. If the swap will not reach the next tick-aray, input the same array as tickArray1.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>a<wbr/>ToB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li><li class="tsd-parameter"><h5>amount<wbr/>Specified<wbr/>Is<wbr/>Input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>other<wbr/>Amount<wbr/>Threshold<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li><li class="tsd-parameter"><h5>sqrt<wbr/>Price<wbr/>Limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Array0<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Array1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Array2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SwapParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Swap<wbr/>Params<a href="#SwapParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Swap<wbr/>Params<span class="tsd-signature-symbol">:</span> <a href="modules.html#SwapInput" class="tsd-signature-type" data-tsd-kind="Type alias">SwapInput</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>oracle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenOwnerAccountB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/swap-ix.ts#L28">instructions/swap-ix.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters and accounts to swap on a Whirlpool</p>
</div><dl class="tsd-comment-tags"><dt>param aToB</dt><dd><p>The direction of the swap. True if swapping from A to B. False if swapping from B to A.</p>
</dd><dt>param amountSpecifiedIsInput</dt><dd><p>Specifies the token the parameter <code>amount</code>represents. If true, the amount represents
the input token of the swap.</p>
</dd><dt>param amount</dt><dd><p>The amount of input or output token to swap from (depending on amountSpecifiedIsInput).</p>
</dd><dt>param otherAmountThreshold</dt><dd><p>The maximum/minimum of input/output token to swap into (depending on amountSpecifiedIsInput).</p>
</dd><dt>param sqrtPriceLimit</dt><dd><p>The maximum/minimum price the swap will swap to.</p>
</dd><dt>param tickArray0</dt><dd><p>PublicKey of the tick-array where the Whirlpool&#39;s currentTickIndex resides in</p>
</dd><dt>param tickArray1</dt><dd><p>The next tick-array in the swap direction. If the swap will not reach the next tick-aray, input the same array as tickArray0.</p>
</dd><dt>param tickArray2</dt><dd><p>The next tick-array in the swap direction after tickArray2. If the swap will not reach the next tick-aray, input the same array as tickArray1.</p>
</dd><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param tokenOwnerAccountA</dt><dd><p>PublicKey for the associated token account for tokenA in the collection wallet</p>
</dd><dt>param tokenOwnerAccountB</dt><dd><p>PublicKey for the associated token account for tokenB in the collection wallet</p>
</dd><dt>param tokenVaultA</dt><dd><p>PublicKey for the tokenA vault for this whirlpool.</p>
</dd><dt>param tokenVaultB</dt><dd><p>PublicKey for the tokenB vault for this whirlpool.</p>
</dd><dt>param oracle</dt><dd><p>PublicKey for the oracle account for this Whirlpool.</p>
</dd><dt>param tokenAuthority</dt><dd><p>authority to withdraw tokens from the input token account</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="UpdateFeesAndRewardsParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Update<wbr/>Fees<wbr/>And<wbr/>Rewards<wbr/>Params<a href="#UpdateFeesAndRewardsParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Update<wbr/>Fees<wbr/>And<wbr/>Rewards<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArrayLower<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tickArrayUpper<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/instructions/update-fees-and-rewards-ix.ts#L16">instructions/update-fees-and-rewards-ix.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Parameters to update fees and reward values for a position.</p>
</div><dl class="tsd-comment-tags"><dt>param whirlpool</dt><dd><p>PublicKey for the whirlpool that the position will be opened for.</p>
</dd><dt>param position</dt><dd><p>PublicKey for the position will be opened for.</p>
</dd><dt>param tickArrayLower</dt><dd><p>PublicKey for the tick-array account that hosts the tick at the lower tick index.</p>
</dd><dt>param tickArrayUpper</dt><dd><p>PublicKey for the tick-array account that hosts the tick at the upper tick index.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>position<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Array<wbr/>Lower<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Array<wbr/>Upper<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group undefined"><h2>Other</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TokenAccountInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Token<wbr/>Account<wbr/>Info<a href="#TokenAccountInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Token<wbr/>Account<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AccountInfo</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/client-types.ts#L11">types/public/client-types.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WhirlpoolRewardInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Whirlpool<wbr/>Reward<wbr/>Info<a href="#WhirlpoolRewardInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Whirlpool<wbr/>Reward<wbr/>Info<span class="tsd-signature-symbol">:</span> <a href="modules.html#WhirlpoolRewardInfoData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolRewardInfoData</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>initialized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>vaultAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/client-types.ts#L13">types/public/client-types.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="toTx" class="tsd-anchor"></a><h3 class="tsd-anchor-link">to<wbr/>Tx<a href="#toTx" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">to<wbr/>Tx<span class="tsd-signature-symbol">(</span>ctx<span class="tsd-signature-symbol">: </span><a href="classes/WhirlpoolContext.html" class="tsd-signature-type" data-tsd-kind="Class">WhirlpoolContext</a>, ix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Instruction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TransactionBuilder</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/utils/public/ix-utils.ts#L4">utils/public/ix-utils.ts:4</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ctx: <a href="classes/WhirlpoolContext.html" class="tsd-signature-type" data-tsd-kind="Class">WhirlpoolContext</a></h5></li><li><h5>ix: <span class="tsd-signature-type">Instruction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TransactionBuilder</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group undefined"><h2>Quotes</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CollectFeesQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collect<wbr/>Fees<wbr/>Quote<a href="#CollectFeesQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Collect<wbr/>Fees<wbr/>Quote<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeOwedA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>feeOwedB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/collect-fees-quote.ts#L18">quotes/public/collect-fees-quote.ts:18</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>OwedA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>OwedB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CollectFeesQuoteParam" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collect<wbr/>Fees<wbr/>Quote<wbr/>Param<a href="#CollectFeesQuoteParam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Collect<wbr/>Fees<wbr/>Quote<wbr/>Param<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><a href="modules.html#PositionData" class="tsd-signature-type" data-tsd-kind="Type alias">PositionData</a><span class="tsd-signature-symbol">; </span>tickLower<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a><span class="tsd-signature-symbol">; </span>tickUpper<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolData</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/collect-fees-quote.ts#L8">quotes/public/collect-fees-quote.ts:8</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>position<span class="tsd-signature-symbol">: </span><a href="modules.html#PositionData" class="tsd-signature-type" data-tsd-kind="Type alias">PositionData</a></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Lower<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Upper<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolData</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CollectRewardsQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collect<wbr/>Rewards<wbr/>Quote<a href="#CollectRewardsQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Collect<wbr/>Rewards<wbr/>Quote<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/collect-rewards-quote.ts#L20">quotes/public/collect-rewards-quote.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CollectRewardsQuoteParam" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Collect<wbr/>Rewards<wbr/>Quote<wbr/>Param<a href="#CollectRewardsQuoteParam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Collect<wbr/>Rewards<wbr/>Quote<wbr/>Param<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>position<span class="tsd-signature-symbol">: </span><a href="modules.html#PositionData" class="tsd-signature-type" data-tsd-kind="Type alias">PositionData</a><span class="tsd-signature-symbol">; </span>tickLower<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a><span class="tsd-signature-symbol">; </span>tickUpper<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolData</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/collect-rewards-quote.ts#L10">quotes/public/collect-rewards-quote.ts:10</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>position<span class="tsd-signature-symbol">: </span><a href="modules.html#PositionData" class="tsd-signature-type" data-tsd-kind="Type alias">PositionData</a></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Lower<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Upper<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolData</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="DecreaseLiquidityQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Decrease<wbr/>Liquidity<wbr/>Quote<a href="#DecreaseLiquidityQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Quote<span class="tsd-signature-symbol">:</span> <a href="modules.html#DecreaseLiquidityInput" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityInput</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>tokenEstA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tokenEstB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/decrease-liquidity-quote.ts#L37">quotes/public/decrease-liquidity-quote.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Return object from decrease liquidity quote functions.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="DecreaseLiquidityQuoteParam" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Decrease<wbr/>Liquidity<wbr/>Quote<wbr/>Param<a href="#DecreaseLiquidityQuoteParam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Quote<wbr/>Param<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>liquidity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span><span class="tsd-signature-symbol">; </span>sqrtPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tickCurrentIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickLowerIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickUpperIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/decrease-liquidity-quote.ts#L24">quotes/public/decrease-liquidity-quote.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param liquidity</dt><dd><p>The desired liquidity to withdraw from the Whirlpool</p>
</dd><dt>param tickCurrentIndex</dt><dd><p>The Whirlpool&#39;s current tickIndex</p>
</dd><dt>param sqrtPrice</dt><dd><p>The Whirlpool&#39;s current sqrtPrice</p>
</dd><dt>param tickLowerIndex</dt><dd><p>The lower index of the position that we are withdrawing from.</p>
</dd><dt>param tickUpperIndex</dt><dd><p>The upper index of the position that we are withdrawing from.</p>
</dd><dt>param slippageTolerance</dt><dd><p>The maximum slippage allowed when calculating the minimum tokens received.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>liquidity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>slippage<wbr/>Tolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span></h5></li><li class="tsd-parameter"><h5>sqrt<wbr/>Price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Current<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Lower<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Upper<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="DevFeeSwapQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Dev<wbr/>Fee<wbr/>Swap<wbr/>Quote<a href="#DevFeeSwapQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Dev<wbr/>Fee<wbr/>Swap<wbr/>Quote<span class="tsd-signature-symbol">:</span> <a href="modules.html#NormalSwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">NormalSwapQuote</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>amountSpecifiedIsInput<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>devFeeAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>estimatedSwapFeeAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/dev-fee-swap-quote.ts#L20">quotes/public/dev-fee-swap-quote.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A collection of estimated values from quoting a swap that collects a developer-fee.</p>
</div><dl class="tsd-comment-tags"><dt>param estimatedAmountIn</dt><dd><p>Approximate number of input token swapped in the swap</p>
</dd><dt>param estimatedAmountOut</dt><dd><p>Approximate number of output token swapped in the swap</p>
</dd><dt>param estimatedEndTickIndex</dt><dd><p>Approximate tick-index the Whirlpool will land on after this swap</p>
</dd><dt>param estimatedEndSqrtPrice</dt><dd><p>Approximate sqrtPrice the Whirlpool will land on after this swap</p>
</dd><dt>param estimatedFeeAmount</dt><dd><p>Approximate feeAmount (all fees) charged on this swap</p>
</dd><dt>param estimatedSwapFeeAmount</dt><dd><p>Approximate feeAmount (LP + protocol fees) charged on this swap</p>
</dd><dt>param devFeeAmount</dt><dd><p>FeeAmount (developer fees) charged on this swap</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="IncreaseLiquidityQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Increase<wbr/>Liquidity<wbr/>Quote<a href="#IncreaseLiquidityQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Quote<span class="tsd-signature-symbol">:</span> <a href="modules.html#IncreaseLiquidityInput" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityInput</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>tokenEstA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>tokenEstB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/increase-liquidity-quote.ts#L48">quotes/public/increase-liquidity-quote.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Return object from increase liquidity quote functions.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="IncreaseLiquidityQuoteParam" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Increase<wbr/>Liquidity<wbr/>Quote<wbr/>Param<a href="#IncreaseLiquidityQuoteParam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Quote<wbr/>Param<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>inputTokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>inputTokenMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span><span class="tsd-signature-symbol">; </span>sqrtPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tickCurrentIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickLowerIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickUpperIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tokenMintA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenMintB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/increase-liquidity-quote.ts#L32">quotes/public/increase-liquidity-quote.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param inputTokenAmount</dt><dd><p>The amount of input tokens to deposit.</p>
</dd><dt>param inputTokenMint</dt><dd><p>The mint of the input token the user would like to deposit.</p>
</dd><dt>param tokenMintA</dt><dd><p>The mint of tokenA in the Whirlpool the user is depositing into.</p>
</dd><dt>param tokenMintB</dt><dd><p>-The mint of tokenB in the Whirlpool the user is depositing into.</p>
</dd><dt>param tickCurrentIndex</dt><dd><p>The Whirlpool&#39;s current tickIndex</p>
</dd><dt>param sqrtPrice</dt><dd><p>The Whirlpool&#39;s current sqrtPrice</p>
</dd><dt>param tickLowerIndex</dt><dd><p>The lower index of the position that we are withdrawing from.</p>
</dd><dt>param tickUpperIndex</dt><dd><p>The upper index of the position that we are withdrawing from.</p>
</dd><dt>param slippageTolerance</dt><dd><p>The maximum slippage allowed when calculating the minimum tokens received.</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>input<wbr/>Token<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li><li class="tsd-parameter"><h5>input<wbr/>Token<wbr/>Mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>slippage<wbr/>Tolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span></h5></li><li class="tsd-parameter"><h5>sqrt<wbr/>Price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Current<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Lower<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Upper<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MintA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MintB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="NormalSwapQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Normal<wbr/>Swap<wbr/>Quote<a href="#NormalSwapQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Normal<wbr/>Swap<wbr/>Quote<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>estimatedAmountIn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>estimatedAmountOut<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>estimatedEndSqrtPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>estimatedEndTickIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>estimatedFeeAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> &amp; </span><a href="modules.html#SwapInput" class="tsd-signature-type" data-tsd-kind="Type alias">SwapInput</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/swap-quote.ts#L53">quotes/public/swap-quote.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A collection of estimated values from quoting a swap.</p>
</div><dl class="tsd-comment-tags"><dt>param estimatedAmountIn</dt><dd><p>Approximate number of input token swapped in the swap</p>
</dd><dt>param estimatedAmountOut</dt><dd><p>Approximate number of output token swapped in the swap</p>
</dd><dt>param estimatedEndTickIndex</dt><dd><p>Approximate tick-index the Whirlpool will land on after this swap</p>
</dd><dt>param estimatedEndSqrtPrice</dt><dd><p>Approximate sqrtPrice the Whirlpool will land on after this swap</p>
</dd><dt>param estimatedFeeAmount</dt><dd><p>Approximate feeAmount (all fees) charged on this swap</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SwapQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Swap<wbr/>Quote<a href="#SwapQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Swap<wbr/>Quote<span class="tsd-signature-symbol">:</span> <a href="modules.html#NormalSwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">NormalSwapQuote</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#DevFeeSwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">DevFeeSwapQuote</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/swap-quote.ts#L42">quotes/public/swap-quote.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A collection of estimated values from quoting a swap.</p>
</div><dl class="tsd-comment-tags"><dt>link</dt><dd><p>{BaseSwapQuote}</p>
</dd><dt>link</dt><dd><p>{DevFeeSwapQuote}</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SwapQuoteParam" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Swap<wbr/>Quote<wbr/>Param<a href="#SwapQuoteParam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Swap<wbr/>Quote<wbr/>Param<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>aToB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>amountSpecifiedIsInput<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>otherAmountThreshold<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>sqrtPriceLimit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tickArrays<span class="tsd-signature-symbol">: </span><a href="modules.html#TickArray" class="tsd-signature-type" data-tsd-kind="Type alias">TickArray</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>tokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>whirlpoolData<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolData</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/swap-quote.ts#L26">quotes/public/swap-quote.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param tokenAmount</dt><dd><p>The amount of input or output token to swap from (depending on amountSpecifiedIsInput).</p>
</dd><dt>param otherAmountThreshold</dt><dd><p>The maximum/minimum of input/output token to swap into (depending on amountSpecifiedIsInput).</p>
</dd><dt>param sqrtPriceLimit</dt><dd><p>The maximum/minimum price the swap will swap to.</p>
</dd><dt>param aToB</dt><dd><p>The direction of the swap. True if swapping from A to B. False if swapping from B to A.</p>
</dd><dt>param amountSpecifiedIsInput</dt><dd><p>Specifies the token the parameter <code>amount</code>represents. If true, the amount represents
the input token of the swap.</p>
</dd><dt>param tickArrays</dt><dd><p>An sequential array of tick-array objects in the direction of the trade to swap on</p>
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>a<wbr/>ToB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>amount<wbr/>Specified<wbr/>Is<wbr/>Input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>other<wbr/>Amount<wbr/>Threshold<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li><li class="tsd-parameter"><h5>sqrt<wbr/>Price<wbr/>Limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Arrays<span class="tsd-signature-symbol">: </span><a href="modules.html#TickArray" class="tsd-signature-type" data-tsd-kind="Type alias">TickArray</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>Amount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li><li class="tsd-parameter"><h5>whirlpool<wbr/>Data<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolData</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="collectFeesQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">collect<wbr/>Fees<wbr/>Quote<a href="#collectFeesQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">collect<wbr/>Fees<wbr/>Quote<span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="modules.html#CollectFeesQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">CollectFeesQuoteParam</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#CollectFeesQuote" class="tsd-signature-type" data-tsd-kind="Type alias">CollectFeesQuote</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/collect-fees-quote.ts#L30">quotes/public/collect-fees-quote.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get a quote on the outstanding fees owed to a position.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>param: <a href="modules.html#CollectFeesQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">CollectFeesQuoteParam</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A collection of fetched Whirlpool accounts to faciliate the quote.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#CollectFeesQuote" class="tsd-signature-type" data-tsd-kind="Type alias">CollectFeesQuote</a></h4><div><p>A quote object containing the fees owed for each token in the pool.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="collectRewardsQuote" class="tsd-anchor"></a><h3 class="tsd-anchor-link">collect<wbr/>Rewards<wbr/>Quote<a href="#collectRewardsQuote" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">collect<wbr/>Rewards<wbr/>Quote<span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="modules.html#CollectRewardsQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">CollectRewardsQuoteParam</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#CollectRewardsQuote" class="tsd-signature-type" data-tsd-kind="Type alias">CollectRewardsQuote</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/collect-rewards-quote.ts#L29">quotes/public/collect-rewards-quote.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get a quote on the outstanding rewards owed to a position.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>param: <a href="modules.html#CollectRewardsQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">CollectRewardsQuoteParam</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A collection of fetched Whirlpool accounts to faciliate the quote.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#CollectRewardsQuote" class="tsd-signature-type" data-tsd-kind="Type alias">CollectRewardsQuote</a></h4><div><p>A quote object containing the rewards owed for each reward in the pool.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="decreaseLiquidityQuoteByLiquidity" class="tsd-anchor"></a><h3 class="tsd-anchor-link">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity<a href="#decreaseLiquidityQuoteByLiquidity" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity<span class="tsd-signature-symbol">(</span>liquidity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span>, position<span class="tsd-signature-symbol">: </span><a href="interfaces/Position.html" class="tsd-signature-type" data-tsd-kind="Interface">Position</a>, whirlpool<span class="tsd-signature-symbol">: </span><a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#DecreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityQuote</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/decrease-liquidity-quote.ts#L49">quotes/public/decrease-liquidity-quote.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get an estimated quote on the minimum tokens receivable based on the desired withdraw liquidity value.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>liquidity: <span class="tsd-signature-type">BN</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The desired liquidity to withdraw from the Whirlpool</p>
</div></div></li><li><h5>slippageTolerance: <span class="tsd-signature-type">Percentage</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum slippage allowed when calculating the minimum tokens received.</p>
</div></div></li><li><h5>position: <a href="interfaces/Position.html" class="tsd-signature-type" data-tsd-kind="Interface">Position</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A Position helper class to help interact with the Position account.</p>
</div></div></li><li><h5>whirlpool: <a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A Whirlpool helper class to help interact with the Whirlpool account.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#DecreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityQuote</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>An DecreaseLiquidityQuote object detailing the tokenMin &amp; liquidity values to use when calling decrease-liquidity-ix.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="decreaseLiquidityQuoteByLiquidityWithParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity<wbr/>With<wbr/>Params<a href="#decreaseLiquidityQuoteByLiquidityWithParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity<wbr/>With<wbr/>Params<span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="modules.html#DecreaseLiquidityQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityQuoteParam</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#DecreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityQuote</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/decrease-liquidity-quote.ts#L80">quotes/public/decrease-liquidity-quote.ts:80</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get an estimated quote on the minimum tokens receivable based on the desired withdraw liquidity value.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>param: <a href="modules.html#DecreaseLiquidityQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityQuoteParam</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>DecreaseLiquidityQuoteParam</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#DecreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">DecreaseLiquidityQuote</a></h4><div><p>An DecreaseLiquidityInput object detailing the tokenMin &amp; liquidity values to use when calling decrease-liquidity-ix.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="increaseLiquidityQuoteByInputToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<a href="#increaseLiquidityQuoteByInputToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<span class="tsd-signature-symbol">(</span>inputTokenMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Address</span>, inputTokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Decimal</span>, tickLower<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, tickUpper<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span>, whirlpool<span class="tsd-signature-symbol">: </span><a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#IncreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityQuote</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/increase-liquidity-quote.ts#L62">quotes/public/increase-liquidity-quote.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get an estimated quote on the maximum tokens required to deposit based on a specified input token amount.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>inputTokenMint: <span class="tsd-signature-type">Address</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The mint of the input token the user would like to deposit.</p>
</div></div></li><li><h5>inputTokenAmount: <span class="tsd-signature-type">Decimal</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of input tokens to deposit.</p>
</div></div></li><li><h5>tickLower: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The lower index of the position that we are withdrawing from.</p>
</div></div></li><li><h5>tickUpper: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The upper index of the position that we are withdrawing from.</p>
</div></div></li><li><h5>slippageTolerance: <span class="tsd-signature-type">Percentage</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum slippage allowed when calculating the minimum tokens received.</p>
</div></div></li><li><h5>whirlpool: <a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>A Whirlpool helper class to help interact with the Whirlpool account.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#IncreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityQuote</a></h4><div><p>An IncreaseLiquidityInput object detailing the required token amounts &amp; liquidity values to use when calling increase-liquidity-ix.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="increaseLiquidityQuoteByInputTokenWithParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Params<a href="#increaseLiquidityQuoteByInputTokenWithParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Params<span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><a href="modules.html#IncreaseLiquidityQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityQuoteParam</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#IncreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityQuote</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/increase-liquidity-quote.ts#L94">quotes/public/increase-liquidity-quote.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get an estimated quote on the maximum tokens required to deposit based on a specified input token amount.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>param: <a href="modules.html#IncreaseLiquidityQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityQuoteParam</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>IncreaseLiquidityQuoteParam</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#IncreaseLiquidityQuote" class="tsd-signature-type" data-tsd-kind="Type alias">IncreaseLiquidityQuote</a></h4><div><p>An IncreaseLiquidityInput object detailing the required token amounts &amp; liquidity values to use when calling increase-liquidity-ix.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="swapQuoteByInputToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<a href="#swapQuoteByInputToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<span class="tsd-signature-symbol">(</span>whirlpool<span class="tsd-signature-symbol">: </span><a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a>, inputTokenMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Address</span>, tokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span>, slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span>, programId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Address</span>, fetcher<span class="tsd-signature-symbol">: </span><a href="classes/AccountFetcher.html" class="tsd-signature-type" data-tsd-kind="Class">AccountFetcher</a>, refresh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#SwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuote</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/swap-quote.ts#L74">quotes/public/swap-quote.ts:74</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get an estimated swap quote using input token amount.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>whirlpool: <a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whirlpool to perform the swap on</p>
</div></div></li><li><h5>inputTokenMint: <span class="tsd-signature-type">Address</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>PublicKey for the input token mint to swap with</p>
</div></div></li><li><h5>tokenAmount: <span class="tsd-signature-type">u64</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of input token to swap from</p>
</div></div></li><li><h5>slippageTolerance: <span class="tsd-signature-type">Percentage</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of slippage to account for in this quote</p>
</div></div></li><li><h5>programId: <span class="tsd-signature-type">Address</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>PublicKey for the Whirlpool ProgramId</p>
</div></div></li><li><h5>fetcher: <a href="classes/AccountFetcher.html" class="tsd-signature-type" data-tsd-kind="Class">AccountFetcher</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>AccountFetcher object to fetch solana accounts</p>
</div></div></li><li><h5>refresh: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, fetcher would default to fetching the latest accounts</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#SwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuote</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>a SwapQuote object with slippage adjusted SwapInput parameters &amp; estimates on token amounts, fee &amp; end whirlpool states.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="swapQuoteByInputTokenWithDevFees" class="tsd-anchor"></a><h3 class="tsd-anchor-link">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Dev<wbr/>Fees<a href="#swapQuoteByInputTokenWithDevFees" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Dev<wbr/>Fees<span class="tsd-signature-symbol">(</span>whirlpool<span class="tsd-signature-symbol">: </span><a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a>, inputTokenMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Address</span>, tokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span>, slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span>, programId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Address</span>, fetcher<span class="tsd-signature-symbol">: </span><a href="classes/AccountFetcher.html" class="tsd-signature-type" data-tsd-kind="Class">AccountFetcher</a>, devFeePercentage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span>, refresh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#DevFeeSwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">DevFeeSwapQuote</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/dev-fee-swap-quote.ts#L44">quotes/public/dev-fee-swap-quote.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get an estimated swap quote using input token amount while collecting dev fees.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>whirlpool: <a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whirlpool to perform the swap on</p>
</div></div></li><li><h5>inputTokenMint: <span class="tsd-signature-type">Address</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>PublicKey for the input token mint to swap with</p>
</div></div></li><li><h5>tokenAmount: <span class="tsd-signature-type">u64</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of input token to swap from</p>
</div></div></li><li><h5>slippageTolerance: <span class="tsd-signature-type">Percentage</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of slippage to account for in this quote</p>
</div></div></li><li><h5>programId: <span class="tsd-signature-type">Address</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>PublicKey for the Whirlpool ProgramId</p>
</div></div></li><li><h5>fetcher: <a href="classes/AccountFetcher.html" class="tsd-signature-type" data-tsd-kind="Class">AccountFetcher</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>AccountFetcher object to fetch solana accounts</p>
</div></div></li><li><h5>devFeePercentage: <span class="tsd-signature-type">Percentage</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The percentage amount to send to developer wallet prior to the swap. Percentage num/dem values has to match token decimal.</p>
</div></div></li><li><h5>refresh: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, fetcher would default to fetching the latest accounts</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#DevFeeSwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">DevFeeSwapQuote</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>a SwapQuote object with slippage adjusted SwapInput parameters &amp; estimates on token amounts, fee &amp; end whirlpool states.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="swapQuoteByOutputToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">swap<wbr/>Quote<wbr/>By<wbr/>Output<wbr/>Token<a href="#swapQuoteByOutputToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Output<wbr/>Token<span class="tsd-signature-symbol">(</span>whirlpool<span class="tsd-signature-symbol">: </span><a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a>, outputTokenMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Address</span>, tokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span>, slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span>, programId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Address</span>, fetcher<span class="tsd-signature-symbol">: </span><a href="classes/AccountFetcher.html" class="tsd-signature-type" data-tsd-kind="Class">AccountFetcher</a>, refresh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#SwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuote</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/swap-quote.ts#L112">quotes/public/swap-quote.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get an estimated swap quote using an output token amount.</p>
</div><div><p>Use this quote to get an estimated amount of input token needed to receive
the defined output token amount.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>whirlpool: <a href="interfaces/Whirlpool.html" class="tsd-signature-type" data-tsd-kind="Interface">Whirlpool</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whirlpool to perform the swap on</p>
</div></div></li><li><h5>outputTokenMint: <span class="tsd-signature-type">Address</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>PublicKey for the output token mint to swap into</p>
</div></div></li><li><h5>tokenAmount: <span class="tsd-signature-type">u64</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum amount of output token to receive in this swap.</p>
</div></div></li><li><h5>slippageTolerance: <span class="tsd-signature-type">Percentage</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of slippage to account for in this quote</p>
</div></div></li><li><h5>programId: <span class="tsd-signature-type">Address</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>PublicKey for the Whirlpool ProgramId</p>
</div></div></li><li><h5>fetcher: <a href="classes/AccountFetcher.html" class="tsd-signature-type" data-tsd-kind="Class">AccountFetcher</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>AccountFetcher object to fetch solana accounts</p>
</div></div></li><li><h5>refresh: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>If true, fetcher would default to fetching the latest accounts</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="modules.html#SwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuote</a><span class="tsd-signature-symbol">&gt;</span></h4><div><p>a SwapQuote object with slippage adjusted SwapInput parameters &amp; estimates on token amounts, fee &amp; end whirlpool states.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="swapQuoteWithParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">swap<wbr/>Quote<wbr/>With<wbr/>Params<a href="#swapQuoteWithParams" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">swap<wbr/>Quote<wbr/>With<wbr/>Params<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="modules.html#SwapQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuoteParam</a>, slippageTolerance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Percentage</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#SwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuote</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/quotes/public/swap-quote.ts#L142">quotes/public/swap-quote.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Perform a sync swap quote based on the basic swap instruction parameters.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>params: <a href="modules.html#SwapQuoteParam" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuoteParam</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>SwapQuote parameters</p>
</div></div></li><li><h5>slippageTolerance: <span class="tsd-signature-type">Percentage</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of slippage to account for when generating the final quote.</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#SwapQuote" class="tsd-signature-type" data-tsd-kind="Type alias">SwapQuote</a></h4><div><p>a SwapQuote object with slippage adjusted SwapInput parameters &amp; estimates on token amounts, fee &amp; end whirlpool states.</p>
</div></li></ul></section></section><section class="tsd-panel-group tsd-member-group undefined"><h2>Solana Accounts</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="FeeTierData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Fee<wbr/>Tier<wbr/>Data<a href="#FeeTierData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Fee<wbr/>Tier<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>defaultFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickSpacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L140">types/public/anchor-types.ts:140</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>default<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Spacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="OpenPositionBumpsData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Open<wbr/>Position<wbr/>Bumps<wbr/>Data<a href="#OpenPositionBumpsData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Open<wbr/>Position<wbr/>Bumps<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>positionBump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L109">types/public/anchor-types.ts:109</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>position<wbr/>Bump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="OpenPositionWithMetadataBumpsData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Open<wbr/>Position<wbr/>With<wbr/>Metadata<wbr/>Bumps<wbr/>Data<a href="#OpenPositionWithMetadataBumpsData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Open<wbr/>Position<wbr/>With<wbr/>Metadata<wbr/>Bumps<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>metadataBump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>positionBump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L116">types/public/anchor-types.ts:116</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>metadata<wbr/>Bump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Bump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="PositionData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Position<wbr/>Data<a href="#PositionData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Position<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeGrowthCheckpointA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>feeGrowthCheckpointB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>feeOwedA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>feeOwedB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>liquidity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>positionMint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardInfos<span class="tsd-signature-symbol">: </span><a href="modules.html#PositionRewardInfoData" class="tsd-signature-type" data-tsd-kind="Type alias">PositionRewardInfoData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>tickLowerIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickUpperIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L124">types/public/anchor-types.ts:124</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>Growth<wbr/>CheckpointA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Growth<wbr/>CheckpointB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>OwedA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>OwedB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>liquidity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>position<wbr/>Mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Infos<span class="tsd-signature-symbol">: </span><a href="modules.html#PositionRewardInfoData" class="tsd-signature-type" data-tsd-kind="Type alias">PositionRewardInfoData</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Lower<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Upper<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="PositionRewardInfoData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Position<wbr/>Reward<wbr/>Info<wbr/>Data<a href="#PositionRewardInfoData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Position<wbr/>Reward<wbr/>Info<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>amountOwed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>growthInsideCheckpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L101">types/public/anchor-types.ts:101</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>amount<wbr/>Owed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>growth<wbr/>Inside<wbr/>Checkpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TickArrayData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Tick<wbr/>Array<wbr/>Data<a href="#TickArrayData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Tick<wbr/>Array<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>startTickIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>ticks<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L80">types/public/anchor-types.ts:80</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>start<wbr/>Tick<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>ticks<span class="tsd-signature-symbol">: </span><a href="modules.html#TickData" class="tsd-signature-type" data-tsd-kind="Type alias">TickData</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>whirlpool<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TickData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Tick<wbr/>Data<a href="#TickData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Tick<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeGrowthOutsideA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>feeGrowthOutsideB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>initialized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>liquidityGross<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>liquidityNet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>rewardGrowthsOutside<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L89">types/public/anchor-types.ts:89</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>Growth<wbr/>OutsideA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Growth<wbr/>OutsideB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>initialized<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5>liquidity<wbr/>Gross<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>liquidity<wbr/>Net<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Growths<wbr/>Outside<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WhirlpoolBumpsData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Whirlpool<wbr/>Bumps<wbr/>Data<a href="#WhirlpoolBumpsData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Whirlpool<wbr/>Bumps<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>whirlpoolBump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L49">types/public/anchor-types.ts:49</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>whirlpool<wbr/>Bump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WhirlpoolData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Whirlpool<wbr/>Data<a href="#WhirlpoolData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Whirlpool<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>feeGrowthGlobalA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>feeGrowthGlobalB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>feeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>liquidity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>protocolFeeOwedA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>protocolFeeOwedB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>protocolFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rewardInfos<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolRewardInfoData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolRewardInfoData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>rewardLastUpdatedTimestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>sqrtPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>tickCurrentIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickSpacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tokenMintA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenMintB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>tokenVaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>whirlpoolBump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>whirlpoolsConfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L56">types/public/anchor-types.ts:56</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fee<wbr/>Growth<wbr/>GlobalA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Growth<wbr/>GlobalB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>liquidity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>protocol<wbr/>Fee<wbr/>OwedA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>protocol<wbr/>Fee<wbr/>OwedB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>protocol<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Infos<span class="tsd-signature-symbol">: </span><a href="modules.html#WhirlpoolRewardInfoData" class="tsd-signature-type" data-tsd-kind="Type alias">WhirlpoolRewardInfoData</a><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Last<wbr/>Updated<wbr/>Timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>sqrt<wbr/>Price<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Current<wbr/>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Spacing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MintA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>MintB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>token<wbr/>VaultB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>whirlpool<wbr/>Bump<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>whirlpools<wbr/>Config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WhirlpoolRewardInfoData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Whirlpool<wbr/>Reward<wbr/>Info<wbr/>Data<a href="#WhirlpoolRewardInfoData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Whirlpool<wbr/>Reward<wbr/>Info<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>emissionsPerSecondX64<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>growthGlobalX64<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>vault<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L38">types/public/anchor-types.ts:38</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>emissions<wbr/>Per<wbr/>Second<wbr/>X64<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>growth<wbr/>Global<wbr/>X64<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>vault<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="WhirlpoolsConfigData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Whirlpools<wbr/>Config<wbr/>Data<a href="#WhirlpoolsConfigData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Whirlpools<wbr/>Config<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>collectProtocolFeesAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>defaultFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>defaultProtocolFeeRate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>feeAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>rewardEmissionsSuperAuthority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/anchor-types.ts#L27">types/public/anchor-types.ts:27</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>default<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>default<wbr/>Protocol<wbr/>Fee<wbr/>Rate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>fee<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group undefined"><h2>Whirlpool Utils</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TokenAmounts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Token<wbr/>Amounts<a href="#TokenAmounts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Token<wbr/>Amounts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>tokenA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol">; </span>tokenB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/utils/public/pool-utils.ts#L196">utils/public/pool-utils.ts:196</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>tokenA<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li><li class="tsd-parameter"><h5>tokenB<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">u64</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="toTokenAmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">to<wbr/>Token<wbr/>Amount<a href="#toTokenAmount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">to<wbr/>Token<wbr/>Amount<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="modules.html#TokenAmounts" class="tsd-signature-type" data-tsd-kind="Type alias">TokenAmounts</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/utils/public/pool-utils.ts#L204">utils/public/pool-utils.ts:204</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>a: <span class="tsd-signature-type">number</span></h5></li><li><h5>b: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="modules.html#TokenAmounts" class="tsd-signature-type" data-tsd-kind="Type alias">TokenAmounts</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group undefined"><h2>WhirlpoolClient</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TickArray" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Tick<wbr/>Array<a href="#TickArray" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Tick<wbr/>Array<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><a href="modules.html#TickArrayData" class="tsd-signature-type" data-tsd-kind="Type alias">TickArrayData</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/client-types.ts#L22">types/public/client-types.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A wrapper class of a TickArray on a Whirlpool</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><a href="modules.html#TickArrayData" class="tsd-signature-type" data-tsd-kind="Type alias">TickArrayData</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TokenInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Token<wbr/>Info<a href="#TokenInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Token<wbr/>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MintInfo</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>mint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/types/public/client-types.ts#L9">types/public/client-types.ts:9</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Extended MintInfo class to host token info.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-function"><a id="buildWhirlpoolClient" class="tsd-anchor"></a><h3 class="tsd-anchor-link">build<wbr/>Whirlpool<wbr/>Client<a href="#buildWhirlpoolClient" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-function"><li class="tsd-signature tsd-kind-icon">build<wbr/>Whirlpool<wbr/>Client<span class="tsd-signature-symbol">(</span>ctx<span class="tsd-signature-symbol">: </span><a href="classes/WhirlpoolContext.html" class="tsd-signature-type" data-tsd-kind="Class">WhirlpoolContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/WhirlpoolClient.html" class="tsd-signature-type" data-tsd-kind="Interface">WhirlpoolClient</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/orca-so/whirlpools/blob/7b9ec35/sdk/src/whirlpool-client.ts#L63">whirlpool-client.ts:63</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Construct a WhirlpoolClient instance to help interact with Whirlpools accounts with.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ctx: <a href="classes/WhirlpoolContext.html" class="tsd-signature-type" data-tsd-kind="Class">WhirlpoolContext</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>WhirlpoolContext object</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="interfaces/WhirlpoolClient.html" class="tsd-signature-type" data-tsd-kind="Interface">WhirlpoolClient</a></h4><div><p>a WhirlpoolClient instance to help with interacting with Whirlpools accounts.</p>
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/AccountName.html" class="tsd-kind-icon">Account<wbr/>Name</a></li><li class="tsd-kind-enum"><a href="enums/SwapDirection.html" class="tsd-kind-icon">Swap<wbr/>Direction</a></li><li class="tsd-kind-enum"><a href="enums/TokenType.html" class="tsd-kind-icon">Token<wbr/>Type</a></li><li class="tsd-kind-class"><a href="classes/AccountFetcher.html" class="tsd-kind-icon">Account<wbr/>Fetcher</a></li><li class="tsd-kind-class"><a href="classes/PDAUtil.html" class="tsd-kind-icon">PDAUtil</a></li><li class="tsd-kind-class"><a href="classes/ParsableFeeTier.html" class="tsd-kind-icon">Parsable<wbr/>Fee<wbr/>Tier</a></li><li class="tsd-kind-class"><a href="classes/ParsableMintInfo.html" class="tsd-kind-icon">Parsable<wbr/>Mint<wbr/>Info</a></li><li class="tsd-kind-class"><a href="classes/ParsablePosition.html" class="tsd-kind-icon">Parsable<wbr/>Position</a></li><li class="tsd-kind-class"><a href="classes/ParsableTickArray.html" class="tsd-kind-icon">Parsable<wbr/>Tick<wbr/>Array</a></li><li class="tsd-kind-class"><a href="classes/ParsableTokenInfo.html" class="tsd-kind-icon">Parsable<wbr/>Token<wbr/>Info</a></li><li class="tsd-kind-class"><a href="classes/ParsableWhirlpool.html" class="tsd-kind-icon">Parsable<wbr/>Whirlpool</a></li><li class="tsd-kind-class"><a href="classes/ParsableWhirlpoolsConfig.html" class="tsd-kind-icon">Parsable<wbr/>Whirlpools<wbr/>Config</a></li><li class="tsd-kind-class"><a href="classes/PoolUtil.html" class="tsd-kind-icon">Pool<wbr/>Util</a></li><li class="tsd-kind-class"><a href="classes/PriceMath.html" class="tsd-kind-icon">Price<wbr/>Math</a></li><li class="tsd-kind-class"><a href="classes/SwapUtils.html" class="tsd-kind-icon">Swap<wbr/>Utils</a></li><li class="tsd-kind-class"><a href="classes/TickArrayUtil.html" class="tsd-kind-icon">Tick<wbr/>Array<wbr/>Util</a></li><li class="tsd-kind-class"><a href="classes/TickUtil.html" class="tsd-kind-icon">Tick<wbr/>Util</a></li><li class="tsd-kind-class"><a href="classes/WhirlpoolContext.html" class="tsd-kind-icon">Whirlpool<wbr/>Context</a></li><li class="tsd-kind-class"><a href="classes/WhirlpoolIx.html" class="tsd-kind-icon">Whirlpool<wbr/>Ix</a></li><li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/ParsableEntity.html" class="tsd-kind-icon">Parsable<wbr/>Entity</a></li><li class="tsd-kind-interface"><a href="interfaces/Position.html" class="tsd-kind-icon">Position</a></li><li class="tsd-kind-interface"><a href="interfaces/Whirlpool.html" class="tsd-kind-icon">Whirlpool</a></li><li class="tsd-kind-interface"><a href="interfaces/WhirlpoolClient.html" class="tsd-kind-icon">Whirlpool<wbr/>Client</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ClosePositionParams" class="tsd-kind-icon">Close<wbr/>Position<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectFeesParams" class="tsd-kind-icon">Collect<wbr/>Fees<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectFeesQuote" class="tsd-kind-icon">Collect<wbr/>Fees<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectFeesQuoteParam" class="tsd-kind-icon">Collect<wbr/>Fees<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectProtocolFeesParams" class="tsd-kind-icon">Collect<wbr/>Protocol<wbr/>Fees<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectRewardParams" class="tsd-kind-icon">Collect<wbr/>Reward<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectRewardsQuote" class="tsd-kind-icon">Collect<wbr/>Rewards<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CollectRewardsQuoteParam" class="tsd-kind-icon">Collect<wbr/>Rewards<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityInput" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityParams" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityQuote" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DecreaseLiquidityQuoteParam" class="tsd-kind-icon">Decrease<wbr/>Liquidity<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#DevFeeSwapQuote" class="tsd-kind-icon">Dev<wbr/>Fee<wbr/>Swap<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#FeeTierData" class="tsd-kind-icon">Fee<wbr/>Tier<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityInput" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityParams" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityQuote" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#IncreaseLiquidityQuoteParam" class="tsd-kind-icon">Increase<wbr/>Liquidity<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitConfigParams" class="tsd-kind-icon">Init<wbr/>Config<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitFeeTierParams" class="tsd-kind-icon">Init<wbr/>Fee<wbr/>Tier<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitPoolParams" class="tsd-kind-icon">Init<wbr/>Pool<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitTickArrayParams" class="tsd-kind-icon">Init<wbr/>Tick<wbr/>Array<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#InitializeRewardParams" class="tsd-kind-icon">Initialize<wbr/>Reward<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#NormalSwapQuote" class="tsd-kind-icon">Normal<wbr/>Swap<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OpenPositionBumpsData" class="tsd-kind-icon">Open<wbr/>Position<wbr/>Bumps<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OpenPositionParams" class="tsd-kind-icon">Open<wbr/>Position<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OpenPositionWithMetadataBumpsData" class="tsd-kind-icon">Open<wbr/>Position<wbr/>With<wbr/>Metadata<wbr/>Bumps<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PositionData" class="tsd-kind-icon">Position<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#PositionRewardInfoData" class="tsd-kind-icon">Position<wbr/>Reward<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetCollectProtocolFeesAuthorityParams" class="tsd-kind-icon">Set<wbr/>Collect<wbr/>Protocol<wbr/>Fees<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetDefaultFeeRateParams" class="tsd-kind-icon">Set<wbr/>Default<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetDefaultProtocolFeeRateParams" class="tsd-kind-icon">Set<wbr/>Default<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetFeeAuthorityParams" class="tsd-kind-icon">Set<wbr/>Fee<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetFeeRateParams" class="tsd-kind-icon">Set<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetProtocolFeeRateParams" class="tsd-kind-icon">Set<wbr/>Protocol<wbr/>Fee<wbr/>Rate<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardAuthorityBySuperAuthorityParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Authority<wbr/>By<wbr/>Super<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardAuthorityParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardEmissionsParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Emissions<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SetRewardEmissionsSuperAuthorityParams" class="tsd-kind-icon">Set<wbr/>Reward<wbr/>Emissions<wbr/>Super<wbr/>Authority<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapInput" class="tsd-kind-icon">Swap<wbr/>Input</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapParams" class="tsd-kind-icon">Swap<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapQuote" class="tsd-kind-icon">Swap<wbr/>Quote</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SwapQuoteParam" class="tsd-kind-icon">Swap<wbr/>Quote<wbr/>Param</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TickArray" class="tsd-kind-icon">Tick<wbr/>Array</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TickArrayData" class="tsd-kind-icon">Tick<wbr/>Array<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TickData" class="tsd-kind-icon">Tick<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenAccountInfo" class="tsd-kind-icon">Token<wbr/>Account<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenAmounts" class="tsd-kind-icon">Token<wbr/>Amounts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TokenInfo" class="tsd-kind-icon">Token<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#UpdateFeesAndRewardsParams" class="tsd-kind-icon">Update<wbr/>Fees<wbr/>And<wbr/>Rewards<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolBumpsData" class="tsd-kind-icon">Whirlpool<wbr/>Bumps<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolData" class="tsd-kind-icon">Whirlpool<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolRewardInfo" class="tsd-kind-icon">Whirlpool<wbr/>Reward<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolRewardInfoData" class="tsd-kind-icon">Whirlpool<wbr/>Reward<wbr/>Info<wbr/>Data</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WhirlpoolsConfigData" class="tsd-kind-icon">Whirlpools<wbr/>Config<wbr/>Data</a></li><li class="tsd-kind-variable"><a href="modules.html#FEE_RATE_MUL_VALUE" class="tsd-kind-icon">FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE</a></li><li class="tsd-kind-variable"><a href="modules.html#MAX_SQRT_PRICE" class="tsd-kind-icon">MAX_<wbr/>SQRT_<wbr/>PRICE</a></li><li class="tsd-kind-variable"><a href="modules.html#MAX_SWAP_TICK_ARRAYS" class="tsd-kind-icon">MAX_<wbr/>SWAP_<wbr/>TICK_<wbr/>ARRAYS</a></li><li class="tsd-kind-variable"><a href="modules.html#MAX_TICK_INDEX" class="tsd-kind-icon">MAX_<wbr/>TICK_<wbr/>INDEX</a></li><li class="tsd-kind-variable"><a href="modules.html#METADATA_PROGRAM_ADDRESS" class="tsd-kind-icon">METADATA_<wbr/>PROGRAM_<wbr/>ADDRESS</a></li><li class="tsd-kind-variable"><a href="modules.html#MIN_SQRT_PRICE" class="tsd-kind-icon">MIN_<wbr/>SQRT_<wbr/>PRICE</a></li><li class="tsd-kind-variable"><a href="modules.html#MIN_TICK_INDEX" class="tsd-kind-icon">MIN_<wbr/>TICK_<wbr/>INDEX</a></li><li class="tsd-kind-variable"><a href="modules.html#NUM_REWARDS" class="tsd-kind-icon">NUM_<wbr/>REWARDS</a></li><li class="tsd-kind-variable"><a href="modules.html#ORCA_WHIRLPOOLS_CONFIG" class="tsd-kind-icon">ORCA_<wbr/>WHIRLPOOLS_<wbr/>CONFIG</a></li><li class="tsd-kind-variable"><a href="modules.html#ORCA_WHIRLPOOL_PROGRAM_ID" class="tsd-kind-icon">ORCA_<wbr/>WHIRLPOOL_<wbr/>PROGRAM_<wbr/>ID</a></li><li class="tsd-kind-variable"><a href="modules.html#PROTOCOL_FEE_RATE_MUL_VALUE" class="tsd-kind-icon">PROTOCOL_<wbr/>FEE_<wbr/>RATE_<wbr/>MUL_<wbr/>VALUE</a></li><li class="tsd-kind-variable"><a href="modules.html#TICK_ARRAY_SIZE" class="tsd-kind-icon">TICK_<wbr/>ARRAY_<wbr/>SIZE</a></li><li class="tsd-kind-function"><a href="modules.html#buildWhirlpoolClient" class="tsd-kind-icon">build<wbr/>Whirlpool<wbr/>Client</a></li><li class="tsd-kind-function"><a href="modules.html#collectFeesQuote" class="tsd-kind-icon">collect<wbr/>Fees<wbr/>Quote</a></li><li class="tsd-kind-function"><a href="modules.html#collectRewardsQuote" class="tsd-kind-icon">collect<wbr/>Rewards<wbr/>Quote</a></li><li class="tsd-kind-function"><a href="modules.html#decreaseLiquidityQuoteByLiquidity" class="tsd-kind-icon">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity</a></li><li class="tsd-kind-function"><a href="modules.html#decreaseLiquidityQuoteByLiquidityWithParams" class="tsd-kind-icon">decrease<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Liquidity<wbr/>With<wbr/>Params</a></li><li class="tsd-kind-function"><a href="modules.html#increaseLiquidityQuoteByInputToken" class="tsd-kind-icon">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#increaseLiquidityQuoteByInputTokenWithParams" class="tsd-kind-icon">increase<wbr/>Liquidity<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Params</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteByInputToken" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteByInputTokenWithDevFees" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Input<wbr/>Token<wbr/>With<wbr/>Dev<wbr/>Fees</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteByOutputToken" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>By<wbr/>Output<wbr/>Token</a></li><li class="tsd-kind-function"><a href="modules.html#swapQuoteWithParams" class="tsd-kind-icon">swap<wbr/>Quote<wbr/>With<wbr/>Params</a></li><li class="tsd-kind-function"><a href="modules.html#toTokenAmount" class="tsd-kind-icon">to<wbr/>Token<wbr/>Amount</a></li><li class="tsd-kind-function"><a href="modules.html#toTx" class="tsd-kind-icon">to<wbr/>Tx</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink