@huma-finance/widgets 0.0.37 → 0.0.38-beta.0

package/API.md

@@ -1,332 +1,404 @@
-## Functions
-
-<dl>
-<dt><a href="#InvoiceFactoringBorrowWidget">InvoiceFactoringBorrowWidget(props)</a> ⇒</dt>
-<dd><p>Invoice factoring borrow widget</p></dd>
-<dt><a href="#InvoiceFactoringPaymentWidget">InvoiceFactoringPaymentWidget(props)</a> ⇒</dt>
-<dd><p>Invoice factoring payment widget</p></dd>
-<dt><a href="#CreditLineBorrowWidget">CreditLineBorrowWidget(props)</a> ⇒</dt>
-<dd><p>Credit line borrow widget</p></dd>
-<dt><a href="#CreditLinePaymentWidget">CreditLinePaymentWidget(props)</a> ⇒</dt>
-<dd><p>Credit line payment widget</p></dd>
-<dt><a href="#LendSupplyWidget">LendSupplyWidget(props)</a> ⇒</dt>
-<dd><p>Lend supply widget</p></dd>
-<dt><a href="#LendWithdrawWidget">LendWithdrawWidget(props)</a> ⇒</dt>
-<dd><p>Lend withdraw widget</p></dd>
-<dt><a href="#SuperfluidFactoringWidget">SuperfluidFactoringWidget(props)</a> ⇒</dt>
-<dd><p>Superfluid factoring widget</p></dd>
-</dl>
-
-## Typedefs
-
-<dl>
-<dt><a href="#CreditLineBorrowProps">CreditLineBorrowProps</a> : <code>Object</code></dt>
-<dd><p>Credit line pool borrow props</p></dd>
-<dt><a href="#CreditLinePaymentProps">CreditLinePaymentProps</a> : <code>Object</code></dt>
-<dd><p>Credit line pool payment props</p></dd>
-<dt><a href="#InvoiceFactoringBorrowProps">InvoiceFactoringBorrowProps</a> : <code>Object</code></dt>
-<dd><p>Invoice factoring pool borrow props</p></dd>
-<dt><a href="#InvoiceFactoringPaymentProps">InvoiceFactoringPaymentProps</a> : <code>Object</code></dt>
-<dd><p>Invoice factoring pool payment props</p></dd>
-<dt><a href="#LendSupplyProps">LendSupplyProps</a> : <code>Object</code></dt>
-<dd><p>Lend pool supply props</p></dd>
-<dt><a href="#LendWithdrawProps">LendWithdrawProps</a> : <code>Object</code></dt>
-<dd><p>Lend pool withdraw props</p></dd>
-<dt><a href="#JsonRpcConnectionMap">JsonRpcConnectionMap</a> : <code>Object</code></dt>
-<dd><p>Mapping of your JSON-RPC connections indexed by chainId</p></dd>
-<dt><a href="#WidgetProps">WidgetProps</a> : <code>Object</code></dt>
-<dd><p>Object representing the props passed to web3 provider</p></dd>
-<dt><a href="#InvoiceFactoringBorrowWidgetProps">InvoiceFactoringBorrowWidgetProps</a> : <code>Object</code></dt>
-<dd><p>Invoice factoring pool borrow widget props</p></dd>
-<dt><a href="#InvoiceFactoringPaymentWidgetProps">InvoiceFactoringPaymentWidgetProps</a> : <code>Object</code></dt>
-<dd><p>Invoice factoring pool payment widget props</p></dd>
-<dt><a href="#CreditLineBorrowWidgetProps">CreditLineBorrowWidgetProps</a> : <code>Object</code></dt>
-<dd><p>Credit line pool borrow widget props</p></dd>
-<dt><a href="#CreditLinePaymentWidgetProps">CreditLinePaymentWidgetProps</a> : <code>Object</code></dt>
-<dd><p>Credit line pool payment widget props</p></dd>
-<dt><a href="#LendSupplyWidgetProps">LendSupplyWidgetProps</a> : <code>Object</code></dt>
-<dd><p>Lend pool supply widget props</p></dd>
-<dt><a href="#LendWithdrawWidgetProps">LendWithdrawWidgetProps</a> : <code>Object</code></dt>
-<dd><p>Lend pool withdraw widget props</p></dd>
-</dl>
-
-<a name="InvoiceFactoringBorrowWidget"></a>
-
-## InvoiceFactoringBorrowWidget(props) ⇒
-<p>Invoice factoring borrow widget</p>
-
-**Kind**: global function  
-**Returns**: <p>Invoice factoring pool borrow widget component</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| props | [<code>InvoiceFactoringBorrowProps</code>](#InvoiceFactoringBorrowProps) \| [<code>WidgetProps</code>](#WidgetProps) | <p>The invoice factoring pool borrow widget props.</p> |
-
-<a name="InvoiceFactoringPaymentWidget"></a>
-
-## InvoiceFactoringPaymentWidget(props) ⇒
-<p>Invoice factoring payment widget</p>
-
-**Kind**: global function  
-**Returns**: <p>Invoice factoring pool payment widget component</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| props | [<code>InvoiceFactoringPaymentProps</code>](#InvoiceFactoringPaymentProps) \| [<code>WidgetProps</code>](#WidgetProps) | <p>The invoice factoring pool payment widget props.</p> |
-
-<a name="CreditLineBorrowWidget"></a>
-
-## CreditLineBorrowWidget(props) ⇒
-<p>Credit line borrow widget</p>
-
-**Kind**: global function  
-**Returns**: <p>Credit line pool borrow widget component</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| props | [<code>CreditLineBorrowProps</code>](#CreditLineBorrowProps) \| [<code>WidgetProps</code>](#WidgetProps) | <p>The credit line pool borrow widget props.</p> |
-
-<a name="CreditLinePaymentWidget"></a>
-
-## CreditLinePaymentWidget(props) ⇒
-<p>Credit line payment widget</p>
-
-**Kind**: global function  
-**Returns**: <p>Credit line pool payment widget component</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| props | [<code>CreditLinePaymentProps</code>](#CreditLinePaymentProps) \| [<code>WidgetProps</code>](#WidgetProps) | <p>The credit line pool payment widget props.</p> |
-
-<a name="LendSupplyWidget"></a>
-
-## LendSupplyWidget(props) ⇒
-<p>Lend supply widget</p>
-
-**Kind**: global function  
-**Returns**: <p>Lend pool supply widget component</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| props | [<code>LendSupplyProps</code>](#LendSupplyProps) \| [<code>WidgetProps</code>](#WidgetProps) | <p>The lend pool supply widget props.</p> |
-
-<a name="LendWithdrawWidget"></a>
-
-## LendWithdrawWidget(props) ⇒
-<p>Lend withdraw widget</p>
-
-**Kind**: global function  
-**Returns**: <p>Lend pool withdraw widget component</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| props | [<code>LendWithdrawProps</code>](#LendWithdrawProps) \| [<code>WidgetProps</code>](#WidgetProps) | <p>The lend pool withdraw widget props</p> |
-
-<a name="SuperfluidFactoringWidget"></a>
-
-## SuperfluidFactoringWidget(props) ⇒
-<p>Superfluid factoring widget</p>
-
-**Kind**: global function  
-**Returns**: <p>Superfluid factoring widget component</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| props | [<code>WidgetProps</code>](#WidgetProps) | <p>The superfluid factoring widget props.</p> |
-
-<a name="CreditLineBorrowProps"></a>
-
-## CreditLineBorrowProps : <code>Object</code>
-<p>Credit line pool borrow props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
-| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
-| handleApprove | <code>function</code> | <p>Optional function to notify when user is approved successfully to borrow again pool.</p> |
-| handleSuccess | <code>function</code> | <p>Optional function to notify that the credit line pool borrow action is successful.</p> |
-
-<a name="CreditLinePaymentProps"></a>
-
-## CreditLinePaymentProps : <code>Object</code>
-<p>Credit line pool payment props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
-| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
-| handleSuccess | <code>function</code> | <p>Optional function to notify that the credit line pool payment action is successful.</p> |
-
-<a name="InvoiceFactoringBorrowProps"></a>
-
-## InvoiceFactoringBorrowProps : <code>Object</code>
-<p>Invoice factoring pool borrow props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
-| tokenId | <code>string</code> \| <code>BigNumber</code> | <p>The NFT token id representing invoice.</p> |
-| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
-| handleSuccess | <code>function</code> | <p>Optional function to notify that the invoice pool borrow action is successful.</p> |
-
-<a name="InvoiceFactoringPaymentProps"></a>
-
-## InvoiceFactoringPaymentProps : <code>Object</code>
-<p>Invoice factoring pool payment props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
-| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
-| handleSuccess | <code>function</code> | <p>Optional function to notify that the invoice pool payment action is successful.</p> |
-
-<a name="LendSupplyProps"></a>
-
-## LendSupplyProps : <code>Object</code>
-<p>Lend pool supply props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
-| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
-| handleSuccess | <code>function</code> | <p>Optional function to notify that the lending pool supply action is successful.</p> |
-
-<a name="LendWithdrawProps"></a>
-
-## LendWithdrawProps : <code>Object</code>
-<p>Lend pool withdraw props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
-| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
-| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
-| handleSuccess | <code>function</code> | <p>Optional function to notify that the lending pool withdraw action is successful.</p> |
-
-<a name="JsonRpcConnectionMap"></a>
-
-## JsonRpcConnectionMap : <code>Object</code>
-<p>Mapping of your JSON-RPC connections indexed by chainId</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| chainId | <code>Object.&lt;number, (string\|Array.&lt;string&gt;\|JsonRpcProvider\|Array.&lt;JsonRpcProvider&gt;)&gt;</code> | <p>Chain id to map the JSON-RPC URL/URLs or JsonRpcProvider/JsonRpcProviders</p> |
-
-<a name="WidgetProps"></a>
-
-## WidgetProps : <code>Object</code>
-<p>Object representing the props passed to web3 provider</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| desiredChainId | <code>desiredChainId</code> \| <code>undefined</code> | <p>Optional desired chain id, will trigger the switch network action if different from the current chain id</p> |
-| jsonRpcUrlMap | [<code>JsonRpcConnectionMap</code>](#JsonRpcConnectionMap) \| <code>undefined</code> | <p>Optional mapping of your JSON-RPC connections indexed by chainId</p> |
-| provider | <code>Eip1193Provider</code> \| <code>JsonRpcProvider</code> \| <code>null</code> \| <code>undefined</code> | <p>Optional EIP-1193 provider or JsonRpc Provider</p> |
-
-<a name="InvoiceFactoringBorrowWidgetProps"></a>
-
-## InvoiceFactoringBorrowWidgetProps : <code>Object</code>
-<p>Invoice factoring pool borrow widget props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| InvoiceFactoringBorrowProps | [<code>InvoiceFactoringBorrowProps</code>](#InvoiceFactoringBorrowProps) | <p>Invoice factoring pool borrow props.</p> |
-| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
-
-<a name="InvoiceFactoringPaymentWidgetProps"></a>
-
-## InvoiceFactoringPaymentWidgetProps : <code>Object</code>
-<p>Invoice factoring pool payment widget props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| InvoiceFactoringPaymentProps | [<code>InvoiceFactoringPaymentProps</code>](#InvoiceFactoringPaymentProps) | <p>Invoice factoring pool payment props.</p> |
-| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
-
-<a name="CreditLineBorrowWidgetProps"></a>
-
-## CreditLineBorrowWidgetProps : <code>Object</code>
-<p>Credit line pool borrow widget props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| CreditLineBorrowProps | [<code>CreditLineBorrowProps</code>](#CreditLineBorrowProps) | <p>Credit line pool borrow props.</p> |
-| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
-
-<a name="CreditLinePaymentWidgetProps"></a>
-
-## CreditLinePaymentWidgetProps : <code>Object</code>
-<p>Credit line pool payment widget props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| CreditLinePaymentProps | [<code>CreditLinePaymentProps</code>](#CreditLinePaymentProps) | <p>Credit line pool payment props.</p> |
-| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
-
-<a name="LendSupplyWidgetProps"></a>
-
-## LendSupplyWidgetProps : <code>Object</code>
-<p>Lend pool supply widget props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| LendSupplyProps | [<code>LendSupplyProps</code>](#LendSupplyProps) | <p>Lend pool supply props.</p> |
-| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
-
-<a name="LendWithdrawWidgetProps"></a>
-
-## LendWithdrawWidgetProps : <code>Object</code>
-<p>Lend pool withdraw widget props</p>
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| LendWithdrawProps | [<code>LendWithdrawProps</code>](#LendWithdrawProps) | <p>Lend pool withdraw props.</p> |
-| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
-
+## Members
+
+<dl>
+<dt><a href="#ChainEnum">ChainEnum</a></dt>
+<dd><p>Updates cy.visit() to include an injected window.ethereum provider.</p></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#InvoiceFactoringBorrowWidget">InvoiceFactoringBorrowWidget(props)</a> ⇒</dt>
+<dd><p>Invoice factoring borrow widget</p></dd>
+<dt><a href="#InvoiceFactoringPaymentWidget">InvoiceFactoringPaymentWidget(props)</a> ⇒</dt>
+<dd><p>Invoice factoring payment widget</p></dd>
+<dt><a href="#CreditLineBorrowWidget">CreditLineBorrowWidget(props)</a> ⇒</dt>
+<dd><p>Credit line borrow widget</p></dd>
+<dt><a href="#CreditLinePaymentWidget">CreditLinePaymentWidget(props)</a> ⇒</dt>
+<dd><p>Credit line payment widget</p></dd>
+<dt><a href="#CreditLineApproveWidget">CreditLineApproveWidget(props)</a> ⇒</dt>
+<dd><p>Credit line allowance approve widget to top up a pool's ERC20 token allowance.
+To be used when re-enabling autopay and other pool actions that require allowance.</p></dd>
+<dt><a href="#LendSupplyWidget">LendSupplyWidget(props)</a> ⇒</dt>
+<dd><p>Lend supply widget</p></dd>
+<dt><a href="#LendWithdrawWidget">LendWithdrawWidget(props)</a> ⇒</dt>
+<dd><p>Lend withdraw widget</p></dd>
+<dt><a href="#SuperfluidFactoringWidget">SuperfluidFactoringWidget(props)</a> ⇒</dt>
+<dd><p>Superfluid factoring widget</p></dd>
+<dt><a href="#components">components()</a></dt>
+<dd><p>This file can be used to override default props and styles on the various Material components
+see: https://mui.com/customization/theme-components/</p></dd>
+</dl>
+
+## Typedefs
+
+<dl>
+<dt><a href="#CreditLineApproveProps">CreditLineApproveProps</a> : <code>Object</code></dt>
+<dd><p>Credit line pool approve allowance props</p></dd>
+<dt><a href="#CreditLineBorrowProps">CreditLineBorrowProps</a> : <code>Object</code></dt>
+<dd><p>Credit line pool borrow props</p></dd>
+<dt><a href="#CreditLinePaymentProps">CreditLinePaymentProps</a> : <code>Object</code></dt>
+<dd><p>Credit line pool payment props</p></dd>
+<dt><a href="#InvoiceFactoringBorrowProps">InvoiceFactoringBorrowProps</a> : <code>Object</code></dt>
+<dd><p>Invoice factoring pool borrow props</p></dd>
+<dt><a href="#InvoiceFactoringPaymentProps">InvoiceFactoringPaymentProps</a> : <code>Object</code></dt>
+<dd><p>Invoice factoring pool payment props</p></dd>
+<dt><a href="#LendSupplyProps">LendSupplyProps</a> : <code>Object</code></dt>
+<dd><p>Lend pool supply props</p></dd>
+<dt><a href="#LendWithdrawProps">LendWithdrawProps</a> : <code>Object</code></dt>
+<dd><p>Lend pool withdraw props</p></dd>
+<dt><a href="#JsonRpcConnectionMap">JsonRpcConnectionMap</a> : <code>Object</code></dt>
+<dd><p>Mapping of your JSON-RPC connections indexed by chainId</p></dd>
+<dt><a href="#WidgetProps">WidgetProps</a> : <code>Object</code></dt>
+<dd><p>Object representing the props passed to web3 provider</p></dd>
+<dt><a href="#InvoiceFactoringBorrowWidgetProps">InvoiceFactoringBorrowWidgetProps</a> : <code>Object</code></dt>
+<dd><p>Invoice factoring pool borrow widget props</p></dd>
+<dt><a href="#InvoiceFactoringPaymentWidgetProps">InvoiceFactoringPaymentWidgetProps</a> : <code>Object</code></dt>
+<dd><p>Invoice factoring pool payment widget props</p></dd>
+<dt><a href="#CreditLineBorrowWidgetProps">CreditLineBorrowWidgetProps</a> : <code>Object</code></dt>
+<dd><p>Credit line pool borrow widget props</p></dd>
+<dt><a href="#CreditLinePaymentWidgetProps">CreditLinePaymentWidgetProps</a> : <code>Object</code></dt>
+<dd><p>Credit line pool payment widget props</p></dd>
+<dt><a href="#CreditLinePaymentWidgetProps">CreditLinePaymentWidgetProps</a> : <code>Object</code></dt>
+<dd><p>Credit line allowance approval widget props</p></dd>
+<dt><a href="#LendSupplyWidgetProps">LendSupplyWidgetProps</a> : <code>Object</code></dt>
+<dd><p>Lend pool supply widget props</p></dd>
+<dt><a href="#LendWithdrawWidgetProps">LendWithdrawWidgetProps</a> : <code>Object</code></dt>
+<dd><p>Lend pool withdraw widget props</p></dd>
+</dl>
+
+<a name="ChainEnum"></a>
+
+## ChainEnum
+<p>Updates cy.visit() to include an injected window.ethereum provider.</p>
+
+**Kind**: global variable  
+<a name="InvoiceFactoringBorrowWidget"></a>
+
+## InvoiceFactoringBorrowWidget(props) ⇒
+<p>Invoice factoring borrow widget</p>
+
+**Kind**: global function  
+**Returns**: <p>Invoice factoring pool borrow widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | [<code>InvoiceFactoringBorrowWidgetProps</code>](#InvoiceFactoringBorrowWidgetProps) | <p>The invoice factoring pool borrow widget props.</p> |
+
+<a name="InvoiceFactoringPaymentWidget"></a>
+
+## InvoiceFactoringPaymentWidget(props) ⇒
+<p>Invoice factoring payment widget</p>
+
+**Kind**: global function  
+**Returns**: <p>Invoice factoring pool payment widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | [<code>InvoiceFactoringPaymentWidgetProps</code>](#InvoiceFactoringPaymentWidgetProps) | <p>The invoice factoring pool payment widget props.</p> |
+
+<a name="CreditLineBorrowWidget"></a>
+
+## CreditLineBorrowWidget(props) ⇒
+<p>Credit line borrow widget</p>
+
+**Kind**: global function  
+**Returns**: <p>Credit line pool borrow widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | [<code>CreditLineBorrowWidgetProps</code>](#CreditLineBorrowWidgetProps) | <p>The credit line pool borrow widget props.</p> |
+
+<a name="CreditLinePaymentWidget"></a>
+
+## CreditLinePaymentWidget(props) ⇒
+<p>Credit line payment widget</p>
+
+**Kind**: global function  
+**Returns**: <p>Credit line pool payment widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | [<code>CreditLinePaymentWidgetProps</code>](#CreditLinePaymentWidgetProps) | <p>The credit line pool payment widget props.</p> |
+
+<a name="CreditLineApproveWidget"></a>
+
+## CreditLineApproveWidget(props) ⇒
+<p>Credit line allowance approve widget to top up a pool's ERC20 token allowance.
+To be used when re-enabling autopay and other pool actions that require allowance.</p>
+
+**Kind**: global function  
+**Returns**: <p>Credit line pool approve widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | <code>CreditLineApproveWidgetProps</code> | <p>The credit line pool approve widget props.</p> |
+
+<a name="LendSupplyWidget"></a>
+
+## LendSupplyWidget(props) ⇒
+<p>Lend supply widget</p>
+
+**Kind**: global function  
+**Returns**: <p>Lend pool supply widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | [<code>LendSupplyWidgetProps</code>](#LendSupplyWidgetProps) | <p>The lend pool supply widget props.</p> |
+
+<a name="LendWithdrawWidget"></a>
+
+## LendWithdrawWidget(props) ⇒
+<p>Lend withdraw widget</p>
+
+**Kind**: global function  
+**Returns**: <p>Lend pool withdraw widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | [<code>LendWithdrawWidgetProps</code>](#LendWithdrawWidgetProps) | <p>The lend pool withdraw widget props</p> |
+
+<a name="SuperfluidFactoringWidget"></a>
+
+## SuperfluidFactoringWidget(props) ⇒
+<p>Superfluid factoring widget</p>
+
+**Kind**: global function  
+**Returns**: <p>Superfluid factoring widget component</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| props | [<code>WidgetProps</code>](#WidgetProps) | <p>The superfluid factoring widget props.</p> |
+
+<a name="components"></a>
+
+## components()
+<p>This file can be used to override default props and styles on the various Material components
+see: https://mui.com/customization/theme-components/</p>
+
+**Kind**: global function  
+<a name="CreditLineApproveProps"></a>
+
+## CreditLineApproveProps : <code>Object</code>
+<p>Credit line pool approve allowance props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| amount | <code>BigNumberish</code> \| <code>undefined</code> | <p>The amount to approve.</p> |
+| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
+| handleSuccess | <code>function</code> | <p>Optional function to notify that the credit line pool approve allowance action is successful.</p> |
+
+<a name="CreditLineBorrowProps"></a>
+
+## CreditLineBorrowProps : <code>Object</code>
+<p>Credit line pool borrow props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
+| handleApprove | <code>function</code> | <p>Optional function to notify when user is approved successfully to borrow again pool.</p> |
+| handleSuccess | <code>function</code> | <p>Optional function to notify that the credit line pool borrow action is successful.</p> |
+
+<a name="CreditLinePaymentProps"></a>
+
+## CreditLinePaymentProps : <code>Object</code>
+<p>Credit line pool payment props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
+| handleSuccess | <code>function</code> | <p>Optional function to notify that the credit line pool payment action is successful.</p> |
+
+<a name="InvoiceFactoringBorrowProps"></a>
+
+## InvoiceFactoringBorrowProps : <code>Object</code>
+<p>Invoice factoring pool borrow props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| tokenId | <code>string</code> \| <code>BigNumber</code> | <p>The NFT token id representing invoice.</p> |
+| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
+| handleSuccess | <code>function</code> | <p>Optional function to notify that the invoice pool borrow action is successful.</p> |
+
+<a name="InvoiceFactoringPaymentProps"></a>
+
+## InvoiceFactoringPaymentProps : <code>Object</code>
+<p>Invoice factoring pool payment props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
+| handleSuccess | <code>function</code> | <p>Optional function to notify that the invoice pool payment action is successful.</p> |
+
+<a name="LendSupplyProps"></a>
+
+## LendSupplyProps : <code>Object</code>
+<p>Lend pool supply props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
+| handleSuccess | <code>function</code> | <p>Optional function to notify that the lending pool supply action is successful.</p> |
+
+<a name="LendWithdrawProps"></a>
+
+## LendWithdrawProps : <code>Object</code>
+<p>Lend pool withdraw props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| poolName | <code>POOL\_NAME</code> | <p>The name of the pool.</p> |
+| poolType | <code>POOL\_TYPE</code> | <p>The type of the pool.</p> |
+| handleClose | <code>function</code> | <p>Function to notify to close the widget modal when user clicks the 'x' close button.</p> |
+| handleSuccess | <code>function</code> | <p>Optional function to notify that the lending pool withdraw action is successful.</p> |
+
+<a name="JsonRpcConnectionMap"></a>
+
+## JsonRpcConnectionMap : <code>Object</code>
+<p>Mapping of your JSON-RPC connections indexed by chainId</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| chainId | <code>Object.&lt;number, (string\|Array.&lt;string&gt;\|JsonRpcProvider\|Array.&lt;JsonRpcProvider&gt;)&gt;</code> | <p>Chain id to map the JSON-RPC URL/URLs or JsonRpcProvider/JsonRpcProviders</p> |
+
+<a name="WidgetProps"></a>
+
+## WidgetProps : <code>Object</code>
+<p>Object representing the props passed to web3 provider</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| desiredChainId | <code>desiredChainId</code> \| <code>undefined</code> | <p>Optional desired chain id, will trigger the switch network action if different from the current chain id</p> |
+| jsonRpcUrlMap | [<code>JsonRpcConnectionMap</code>](#JsonRpcConnectionMap) \| <code>undefined</code> | <p>Optional mapping of your JSON-RPC connections indexed by chainId</p> |
+| provider | <code>Eip1193Provider</code> \| <code>JsonRpcProviderl</code> | <p>EIP-1193 provider or JsonRpc Provider</p> |
+
+<a name="InvoiceFactoringBorrowWidgetProps"></a>
+
+## InvoiceFactoringBorrowWidgetProps : <code>Object</code>
+<p>Invoice factoring pool borrow widget props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| InvoiceFactoringBorrowProps | [<code>InvoiceFactoringBorrowProps</code>](#InvoiceFactoringBorrowProps) | <p>Invoice factoring pool borrow props.</p> |
+| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
+
+<a name="InvoiceFactoringPaymentWidgetProps"></a>
+
+## InvoiceFactoringPaymentWidgetProps : <code>Object</code>
+<p>Invoice factoring pool payment widget props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| InvoiceFactoringPaymentProps | [<code>InvoiceFactoringPaymentProps</code>](#InvoiceFactoringPaymentProps) | <p>Invoice factoring pool payment props.</p> |
+| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
+
+<a name="CreditLineBorrowWidgetProps"></a>
+
+## CreditLineBorrowWidgetProps : <code>Object</code>
+<p>Credit line pool borrow widget props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| CreditLineBorrowProps | [<code>CreditLineBorrowProps</code>](#CreditLineBorrowProps) | <p>Credit line pool borrow props.</p> |
+| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
+
+<a name="CreditLinePaymentWidgetProps"></a>
+
+## CreditLinePaymentWidgetProps : <code>Object</code>
+<p>Credit line pool payment widget props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| CreditLinePaymentProps | [<code>CreditLinePaymentProps</code>](#CreditLinePaymentProps) | <p>Credit line pool payment props.</p> |
+| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
+
+<a name="CreditLinePaymentWidgetProps"></a>
+
+## CreditLinePaymentWidgetProps : <code>Object</code>
+<p>Credit line allowance approval widget props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| CreditLineApproveProps | [<code>CreditLineApproveProps</code>](#CreditLineApproveProps) | <p>Credit line allowance approve props.</p> |
+| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
+
+<a name="LendSupplyWidgetProps"></a>
+
+## LendSupplyWidgetProps : <code>Object</code>
+<p>Lend pool supply widget props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| LendSupplyProps | [<code>LendSupplyProps</code>](#LendSupplyProps) | <p>Lend pool supply props.</p> |
+| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
+
+<a name="LendWithdrawWidgetProps"></a>
+
+## LendWithdrawWidgetProps : <code>Object</code>
+<p>Lend pool withdraw widget props</p>
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| LendWithdrawProps | [<code>LendWithdrawProps</code>](#LendWithdrawProps) | <p>Lend pool withdraw props.</p> |
+| WidgetProps | [<code>WidgetProps</code>](#WidgetProps) | <p>Widget general props.</p> |
+