Skip to content

Commit

Permalink
regen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Velenir
Velenir committed Sep 12, 2024
1 parent 5775a79 commit 84d9f66
Show file tree
Hide file tree
Showing 366 changed files with 6,438 additions and 418 deletions.
2 changes: 1 addition & 1 deletion docs/html/assets/search.js
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/html/enums/_internal_.PricingMethod.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,17 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>megapath</span><a href="#megapath" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature">megapath<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;megapath&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/methods/swap/rates.ts#L19">src/methods/swap/rates.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/methods/swap/rates.ts#L15">src/methods/swap/rates.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="multipath" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>multipath</span><a href="#multipath" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">multipath<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;multipath&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/methods/swap/rates.ts#L20">src/methods/swap/rates.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/methods/swap/rates.ts#L16">src/methods/swap/rates.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="simplepath" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>simplepath</span><a href="#simplepath" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">simplepath<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;simplepath&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/methods/swap/rates.ts#L21">src/methods/swap/rates.ts:21</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/paraswap/paraswap-sdk/blob/master/src/methods/swap/rates.ts#L17">src/methods/swap/rates.ts:17</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down
9 changes: 8 additions & 1 deletion docs/html/functions/_internal_.Error-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetRequiredAllowanceParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Required<wbr/>Allowance<wbr/>Params</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetRequiredBalance.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Required<wbr/>Balance</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetSpender.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Spender</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetSwapTxData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Swap<wbr/>Tx<wbr/>Data</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetTokens.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Tokens</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a href="../types/_internal_.HeadersInit.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Headers<wbr/>Init</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a href="../types/_internal_.Hex.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Hex</a></li>
Expand Down Expand Up @@ -494,8 +495,14 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SubmitLimitOrder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Submit<wbr/>Limit<wbr/>Order</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SubmitNFTOrder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>SubmitNFTOrder</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SubmitP2POrder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Submit<wbr/>P2POrder</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapApiResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Api<wbr/>Response</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapFetchMethods.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Fetch<wbr/>Methods</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapSDKMethods.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>SwapSDKMethods</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapQueryParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Query<wbr/>Params</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapRateOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Rate<wbr/>Options</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxInput.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Input</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxInputFields.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Input<wbr/>Fields</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxInputListFields.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Input<wbr/>List<wbr/>Fields</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Result</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.TokenType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Token<wbr/>Type</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.TransactionContractCallerFn.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Transaction<wbr/>Contract<wbr/>Caller<wbr/>Fn</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a href="../types/_internal_.TransactionRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Transaction<wbr/>Request</a></li>
Expand Down
9 changes: 8 additions & 1 deletion docs/html/functions/_internal_.Object-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetRequiredAllowanceParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Required<wbr/>Allowance<wbr/>Params</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetRequiredBalance.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Required<wbr/>Balance</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetSpender.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Spender</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetSwapTxData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Swap<wbr/>Tx<wbr/>Data</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.GetTokens.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Tokens</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a href="../types/_internal_.HeadersInit.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Headers<wbr/>Init</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a href="../types/_internal_.Hex.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Hex</a></li>
Expand Down Expand Up @@ -488,8 +489,14 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SubmitLimitOrder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Submit<wbr/>Limit<wbr/>Order</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SubmitNFTOrder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>SubmitNFTOrder</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SubmitP2POrder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Submit<wbr/>P2POrder</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapApiResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Api<wbr/>Response</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapFetchMethods.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Fetch<wbr/>Methods</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapSDKMethods.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>SwapSDKMethods</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapQueryParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Query<wbr/>Params</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapRateOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Rate<wbr/>Options</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxInput.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Input</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxInputFields.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Input<wbr/>Fields</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxInputListFields.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Input<wbr/>List<wbr/>Fields</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.SwapTxResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Swap<wbr/>Tx<wbr/>Result</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.TokenType.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Token<wbr/>Type</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="../types/_internal_.TransactionContractCallerFn.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Transaction<wbr/>Contract<wbr/>Caller<wbr/>Fn</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-namespace tsd-is-external"><a href="../types/_internal_.TransactionRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Transaction<wbr/>Request</a></li>
Expand Down
Loading

0 comments on commit 84d9f66

Please sign in to comment.