@huma-finance/widgets 0.0.80-beta.1079 → 0.0.80-beta.1083

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md CHANGED
@@ -1,6 +1,10 @@
1
1
  ## Functions
2
2
 
3
3
  <dl>
4
+ <dt><a href="#StellarLendAddRedemption">StellarLendAddRedemption()</a></dt>
5
+ <dd><p>Stellar add redemption props – request to withdraw (redeem) shares from a tranche.</p></dd>
6
+ <dt><a href="#StellarLendWithdraw">StellarLendWithdraw()</a></dt>
7
+ <dd><p>Stellar lend pool withdraw props – disburse (pool open) or withdraw after pool closure.</p></dd>
4
8
  <dt><a href="#InvoiceFactoringBorrowWidget">InvoiceFactoringBorrowWidget(props)</a> ⇒</dt>
5
9
  <dd><p>Invoice factoring borrow widget</p></dd>
6
10
  <dt><a href="#InvoiceFactoringPaymentWidget">InvoiceFactoringPaymentWidget(props)</a> ⇒</dt>
@@ -52,6 +56,10 @@ To be used when re-enabling autopay and other pool actions that require allowanc
52
56
  <dd><p>Solana lend withdraw widget</p></dd>
53
57
  <dt><a href="#StellarLendSupplyWidget">StellarLendSupplyWidget(props)</a></dt>
54
58
  <dd><p>Lend pool supply widget for Stellar pools</p></dd>
59
+ <dt><a href="#StellarLendAddRedemptionWidget">StellarLendAddRedemptionWidget(props)</a></dt>
60
+ <dd><p>Lend pool add redemption widget for Stellar pools</p></dd>
61
+ <dt><a href="#StellarLendWithdrawWidget">StellarLendWithdrawWidget(props)</a></dt>
62
+ <dd><p>Lend pool withdraw widget for Stellar pools (disburse when pool open, withdraw_after_pool_closure when closed)</p></dd>
55
63
  <dt><a href="#StellarBorrowWidget">StellarBorrowWidget(props)</a></dt>
56
64
  <dd><p>Borrow widget for Stellar pools</p></dd>
57
65
  <dt><a href="#SolanaEnableAutoRedemptionWidget">SolanaEnableAutoRedemptionWidget(props)</a></dt>
@@ -165,12 +173,48 @@ To be used when re-enabling autopay and other pool actions that require allowanc
165
173
  <dd><p>Lend pool supply widget props for Solana pools</p></dd>
166
174
  <dt><a href="#StellarLendSupplyWidgetProps">StellarLendSupplyWidgetProps</a> : <code>Object</code></dt>
167
175
  <dd><p>Lend pool supply widget props for Stellar pools</p></dd>
176
+ <dt><a href="#StellarLendAddRedemptionWidgetProps">StellarLendAddRedemptionWidgetProps</a> : <code>Object</code></dt>
177
+ <dd><p>Lend pool add redemption widget props for Stellar pools</p></dd>
178
+ <dt><a href="#StellarLendWithdrawWidgetProps">StellarLendWithdrawWidgetProps</a> : <code>Object</code></dt>
179
+ <dd><p>Lend pool withdraw widget props for Stellar pools</p></dd>
168
180
  <dt><a href="#StellarLendSupplyWidgetProps">StellarLendSupplyWidgetProps</a> : <code>Object</code></dt>
169
181
  <dd><p>Borrow widget props for Stellar pools</p></dd>
170
182
  <dt><a href="#SolanaEnableAutoRedemptionWidgetProps">SolanaEnableAutoRedemptionWidgetProps</a> : <code>Object</code></dt>
171
183
  <dd><p>Lend pool supply widget props for Solana pools</p></dd>
172
184
  </dl>
173
185
 
186
+ <a name="StellarLendAddRedemption"></a>
187
+
188
+ ## StellarLendAddRedemption()
189
+ <p>Stellar add redemption props – request to withdraw (redeem) shares from a tranche.</p>
190
+
191
+ **Kind**: global function
192
+ **Properties**
193
+
194
+ | Name | Type | Description |
195
+ | --- | --- | --- |
196
+ | poolInfo | <code>StellarPoolInfo</code> | <p>The metadata of the pool.</p> |
197
+ | poolState | <code>StellarPoolState</code> | <p>The current state config of the pool.</p> |
198
+ | tranche | <code>TrancheType</code> | <p>The tranche to redeem from (junior or senior).</p> |
199
+ | handleClose | <code>function</code> | <p>Function to close the widget modal.</p> |
200
+ | handleSuccess | <code>function</code> | <p>Optional callback when redemption request succeeds.</p> |
201
+
202
+ <a name="StellarLendWithdraw"></a>
203
+
204
+ ## StellarLendWithdraw()
205
+ <p>Stellar lend pool withdraw props – disburse (pool open) or withdraw after pool closure.</p>
206
+
207
+ **Kind**: global function
208
+ **Properties**
209
+
210
+ | Name | Type | Description |
211
+ | --- | --- | --- |
212
+ | poolInfo | <code>StellarPoolInfo</code> | <p>The metadata of the pool.</p> |
213
+ | poolState | <code>StellarPoolState</code> | <p>The current state config of the pool.</p> |
214
+ | tranche | <code>TrancheType</code> | <p>The tranche to withdraw from (junior or senior).</p> |
215
+ | handleClose | <code>function</code> | <p>Function to close the widget modal.</p> |
216
+ | handleSuccess | <code>function</code> | <p>Optional callback when withdraw succeeds.</p> |
217
+
174
218
  <a name="InvoiceFactoringBorrowWidget"></a>
175
219
 
176
220
  ## InvoiceFactoringBorrowWidget(props) ⇒
@@ -466,6 +510,28 @@ To be used when re-enabling autopay and other pool actions that require allowanc
466
510
  | --- | --- | --- |
467
511
  | props | [<code>StellarLendSupplyWidgetProps</code>](#StellarLendSupplyWidgetProps) | <p>Widget props</p> |
468
512
 
513
+ <a name="StellarLendAddRedemptionWidget"></a>
514
+
515
+ ## StellarLendAddRedemptionWidget(props)
516
+ <p>Lend pool add redemption widget for Stellar pools</p>
517
+
518
+ **Kind**: global function
519
+
520
+ | Param | Type | Description |
521
+ | --- | --- | --- |
522
+ | props | [<code>StellarLendAddRedemptionWidgetProps</code>](#StellarLendAddRedemptionWidgetProps) | <p>Widget props</p> |
523
+
524
+ <a name="StellarLendWithdrawWidget"></a>
525
+
526
+ ## StellarLendWithdrawWidget(props)
527
+ <p>Lend pool withdraw widget for Stellar pools (disburse when pool open, withdraw_after_pool_closure when closed)</p>
528
+
529
+ **Kind**: global function
530
+
531
+ | Param | Type | Description |
532
+ | --- | --- | --- |
533
+ | props | [<code>StellarLendWithdrawWidgetProps</code>](#StellarLendWithdrawWidgetProps) | <p>Widget props</p> |
534
+
469
535
  <a name="StellarBorrowWidget"></a>
470
536
 
471
537
  ## StellarBorrowWidget(props)
@@ -1174,6 +1240,18 @@ To be used when re-enabling autopay and other pool actions that require allowanc
1174
1240
  ## StellarLendSupplyWidgetProps : <code>Object</code>
1175
1241
  <p>Lend pool supply widget props for Stellar pools</p>
1176
1242
 
1243
+ **Kind**: global typedef
1244
+ <a name="StellarLendAddRedemptionWidgetProps"></a>
1245
+
1246
+ ## StellarLendAddRedemptionWidgetProps : <code>Object</code>
1247
+ <p>Lend pool add redemption widget props for Stellar pools</p>
1248
+
1249
+ **Kind**: global typedef
1250
+ <a name="StellarLendWithdrawWidgetProps"></a>
1251
+
1252
+ ## StellarLendWithdrawWidgetProps : <code>Object</code>
1253
+ <p>Lend pool withdraw widget props for Stellar pools</p>
1254
+
1177
1255
  **Kind**: global typedef
1178
1256
  <a name="StellarLendSupplyWidgetProps"></a>
1179
1257