Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and minor edits #101

Merged
merged 1 commit into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions 0_doc/v2/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
* [First Loss Covers](lenders/first-loss-covers.md)
* [Lender Approval and Removal](lenders/lender-approval-removal.md)
* [Deposit and the Lockout Period](lenders/deposit-lockout-period.md)
* [Epoch anb Redemption](lenders/epoch-redemption.md)
* [Epoch and Redemption](lenders/epoch-redemption.md)
* [Automatic Yield Payout and Reinvestment](lenders/automatic-payout-reinvestment.md)
* [Default Handling](lenders/default-handling.md)
* [Pool Closure](lenders/pool-closure.md)
* [Step-by-step Guides](lenders/step-by-step-guides.md)
* [Borrowers](borrowers/borrowers.md)
* [Yield, Fees, and Principal Payment](borrowers/payment.md)
* [Loan Management](borrowers/loan-management.md)
* [FAQ](borrowers/faq.md)
* [Frequently Asked Questions](borrowers/faq.md)
* [Pool Admins](pool-admins/pool-admins.md)
* [Pool Owner and Pool Operators](pool-admins/pool-owner-operators.md)
* [Evaluation Agent](pool-admins/evaluation-agent.md)
Expand Down
26 changes: 13 additions & 13 deletions 0_doc/v2/borrowers/faq.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## FAQ
## Frequently Asked Questions

- Q: How is the payment amount of each billing period calculated?
- A: The exact payment amount will vary depending on the pool configuration, but at the end of every billing period the pool will charge interest based on the APR, outstanding principal, and any drawdowns made. Note that any drawdowns made will add interest to the current billing period, so you may have additional charges due if you pay back then drawdown immediately.
- Q: Is a payment due immediately at the end of a billing cycle?
- A: Each pool has a late payment grace period configured, which is typically around five days but can vary from pool to pool. Payments won’t be considered late until after this grace period after the end of a billing cycle has passed.
- Q: What happens if a payment is missed?
- A: Depending on the pool configuration, a late fee may be issued that must be paid off before subsequent drawdowns can be made. To pay off the fees and due amount, simply enable AutoPay and transfer the amount due into the wallet, or make a payment manually
- Q: How does AutoPay work?
- A: We recommend all partners use Huma’s AutoPay functionality to pay back to the pool. After approving an allowance of the underlying token to the pool, the pool will automatically attempt to pay the minimum amount due at the end of every billing cycle.
- Q: I put money in my wallet but AutoPay isn’t working
- A: AutoPay will attempt to run every five minutes. If it’s been more than five minutes and your AutoPay is still not going through, please contact us to investigate. You may also try to make a manual payment.
- Q: How can I check whether AutoPay is correctly setup on my pool?
- A: Check the pool details page to see whether your wallet is set up for AutoPay correctly. It’s recommended to also sign up for email notifications to receive updates of the AutoPay triggers.
- How is the payment amount of each billing period calculated?
- The exact payment amount will vary depending on the pool configuration, but at the end of every billing period the pool will charge interest based on the APR, outstanding principal, and any drawdowns made. Note that any drawdowns made will add interest to the current billing period, so you may have additional charges due if you pay back then drawdown immediately.
- Is a payment due immediately at the end of a billing cycle?
- Each pool has a late payment grace period configured, which is typically around five days but can vary from pool to pool. Payments won’t be considered late until after this grace period after the end of a billing cycle has passed.
- What happens if a payment is missed?
- Depending on the pool configuration, a late fee may be issued that must be paid off before subsequent drawdowns can be made. To pay off the fees and due amount, simply enable AutoPay and transfer the amount due into the wallet, or make a payment manually
- How does AutoPay work?
- We recommend all partners use Huma’s AutoPay functionality to pay back to the pool. After approving an allowance of the underlying token to the pool, the pool will automatically attempt to pay the minimum amount due at the end of every billing cycle.
- I put money in my wallet but AutoPay isn’t working
- AutoPay will attempt to run every five minutes. If it’s been more than five minutes and your AutoPay is still not going through, please contact us to investigate. You may also try to make a manual payment.
- How can I check whether AutoPay is correctly setup on my pool?
- Check the pool details page to see whether your wallet is set up for AutoPay correctly. It’s recommended to also sign up for email notifications to receive updates of the AutoPay triggers.
6 changes: 3 additions & 3 deletions 0_doc/v2/borrowers/loan-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Once your credit request is approved, you can begin the drawdown process, either

For the last two types of pools, you'll give up your ownership of the receivable during drawdown. Ensure that you have authorized the `ReceivableBackedCreditLine` or the `ReceivableFactoringCredit` contract to perform the transfer from you.

You may also use the SDK to draw down. See the [Using the SDK](https://www.notion.so/Huma-V2-Gitbook-f63276eed2c346f99a4689ebd2873737?pvs=21) section for more details.
You may also use the SDK to draw down. See the [Using the SDK](#using-the-sdk) section for more details.

### Making Payment

Expand Down Expand Up @@ -78,7 +78,7 @@ Alternatively, you can call contract functions directly to execute payments. The

If you specify a payment amount that exceeds the payoff amount on the receivable, the contract will only collect the due amount and the remaining funds will be left untouched. Keep in mind that the pool will maintain ownership of the receivable NFT, even after it's paid off.

You can also utilize the SDK to make repayments. Refer to the [Using the SDK](https://www.notion.so/Huma-V2-Gitbook-f63276eed2c346f99a4689ebd2873737?pvs=21) section for more information.
You can also utilize the SDK to make repayments. Refer to the [Using the SDK](#using-the-sdk) section for more information.

### Credit Closure

Expand All @@ -91,4 +91,4 @@ Your credit will automatically be closed once it's paid off and has passed its m

The Huma SDK provides utilities for interacting with protocol contracts, along with various on-chain and off-chain data storage. It enables you to programmatically perform the borrowing-related actions described above.

Download the SDK as an NPM package from [https://www.npmjs.com/package/@huma-finance/sdk](https://www.npmjs.com/package/@huma-finance/sdk**). You can find the SDK's code at https://github.com/00labs/huma-js/tree/develop/packages/huma-sdk.
Download the SDK as an NPM package from [https://www.npmjs.com/package/@huma-finance/sdk](https://www.npmjs.com/package/@huma-finance/sdk**). You can find the SDK's code at [https://github.com/00labs/huma-js/tree/develop/packages/huma-sdk].
4 changes: 2 additions & 2 deletions 0_doc/v2/borrowers/payment.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ Similar to the above, the borrower may wish to make a payment to show they have

If an account is late (after the late payment grace period), a late payment fee will be charged. This fee is in addition to the regular interest due for all the outstanding principal. The additional charge is calculated using:

$\frac{Pincipal \times LateFeeInBps \times NumberOfDaysBeingLate}{360}$.
$$\frac{Principal \times LateFeeInBps \times NumberOfDaysBeingLate}{360}$$

For instance, if an account with an outstanding principal of $10,000 and an APR of 12% has a `lateFeeInBps` of 18%, the actual charge on the borrower is an annualized 30% for the days when the account is late. It is charged daily to encourage the borrower to pay back as soon as possible.

### Front-Loading Fee Calculation

At the origination of a loan, the borrower may be charged a front-loading fee, also known as an origination fee. This fee is usually a combination of a percentage of the principal amount and a fixed fee. The `frontLoadingFeeFlat` parameter defines the fixed fee, and the `frontLoadingFeeBps` parameter defines the percentage of the principal to be charged. For example, if `frontLoadingFeeFlat = $2,000`, and `frontLoadingFeeBps = 100`. For a loan of $100K, the front-loading fee will be:

$\$2,000 + \$100K \times 100/10,000 = \$2,000 + \$1,000 = \$3,000$.
$$\$2,000 + \$100K \times 100/10,000 = \$2,000 + \$1,000 = \$3,000$$
3 changes: 2 additions & 1 deletion 0_doc/v2/lenders/first-loss-covers.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ Since the first loss cover capital is not deployed, it is unproductive. Typical

A pool cannot be enabled until the minimum coverage for all first loss covers is met. Afterward, the Huma protocol requires the yield produced by the first loss covers to be reinvested into the cover. Also, until the coverage reaches its maximum, all fees generated for the admins (Huma Protocol, Pool Owner, EA) are automatically deposited into the first loss cover. This strategy aligns the admins' interests with the success of the pool.

Below is a diagram showing the order of PnL distribution:
Below is a diagram showing the order of P&L distribution:

![Order of P&L Distribution](../images/lenders/order-of-pnl-distribution.jpg)
2 changes: 1 addition & 1 deletion 0_doc/v2/lenders/lender-approval-removal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Since all pools on the Huma protocol are permissioned, all lenders must get appr

Pool Operators have the discretion to remove a lender. If removed, the lender can no longer supply additional liquidity to the pool. However, the lender’s existing funds will stay in the pool, continuing to generate yield, and can be requested to redeem at any time.

For a detailed walkthrough of the process, refer to the [Step-by-step Guides](https://www.notion.so/Invoice-Financing-by-Request-Huma-72adb4cca5b042128395230b28dab668?pvs=21) section.
For a detailed walkthrough of the process, refer to the [Step-by-step Guides](./step-by-step-guides.md) section.
2 changes: 1 addition & 1 deletion 0_doc/v2/lenders/lenders.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

On Huma, lenders earn a part of the pool's profit by providing liquidity. The V2 Huma protocol defines two tranche types for lenders: senior and junior. A pool might either have a two-tranche structure with both tranches active or a uni-tranche structure with only the junior tranche enabled. If you want to participate in both tranches in a pool where both are active, you must obtain separate approvals.

Lenders in each tranche are split into two groups: one that will automatically receive a yield payout at the end of each epoch, and one that will reinvest all the yield back into the pool. Each tranche can only have up to 100 lenders in the first group. The Pool Owner and Pool Operators decide whether a lender qualifies for automatic yield payout or reinvestment. For more details, refer to the [Automatic Yield Payout and Reinvestment](https://www.notion.so/Huma-V2-Gitbook-f63276eed2c346f99a4689ebd2873737?pvs=21) section.
Lenders in each tranche are split into two groups: one that will automatically receive a yield payout at the end of each epoch, and one that will reinvest all the yield back into the pool. Each tranche can only have up to 100 lenders in the first group. The Pool Owner and Pool Operators decide whether a lender qualifies for automatic yield payout or reinvestment. For more details, refer to the [Automatic Yield Payout and Reinvestment](./automatic-payout-reinvestment.md) section.
3 changes: 0 additions & 3 deletions 0_doc/v2/lenders/step-by-step-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,3 @@
2. You should see the following screen if your redemption request is canceled successfully.

![Transaction Completed](../images/lenders/redemption-cancellation-tx-completed.png)


[comment]: # TODO add "### Withdrawing Funds Redeemed" and "### Withdrawing After Pool Closure"
16 changes: 8 additions & 8 deletions 0_doc/v2/pool-admins/evaluation-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ The Evaluation Agent plays the role of the underwriter for the pool, performing

As the Evaluation Agent of a pool, your responsibilities include reviewing credit requests submitted by borrowers and determining their eligibility to borrow from the pool. If deemed eligible, you must decide on the exact terms of the credit, which includes:

- Credit limit: This is the maximum borrowing amount. The credit limit cannot exceed 4 billion of the underlying asset (stablecoin) of the pool.
- Duration: This is the loan duration, given in payment periods. Duration can be monthly, quarterly, or semi-annually.
- Yield APR: This is the annualized percentage rate of the credit. It determines the yield due for each payment period.
- Late fee APR: This is the pool-level setting that decides the amount of the late fee. If a payment is late, this fee is charged in addition to the regular yield charge. Like yield, it's an annualized rate.
- Minimum principal rate: This pool-level setting determines the amount of principal payment due each payment period. It's a per-payment-period rate. For example, a 10% minimum principal rate means 10% of the principal must be repaid at the end of each payment period.
- Committed loan amount: This is the amount the borrower pledges to borrow. Yield will be charged on this amount if the outstanding principal balance is below it.
- Designated start date: This marks the commencement of the credit term. Borrowing is disallowed before this date and interest starts accumulating from this point forward.
- Revolving: This indicates whether the borrower can reuse the credit after repaying a portion of the principal. For instance, if the approved credit is $1,000, the borrower has taken out $500, and $400 is repaid, the remaining credit will be $500 for non-revolving credit and $900 for revolving credit.
- **Credit limit**: This is the maximum borrowing amount. The credit limit cannot exceed 4 billion of the underlying asset (stablecoin) of the pool.
- **Duration**: This is the loan duration, given in payment periods. Duration can be monthly, quarterly, or semi-annually.
- **Yield APR**: This is the annualized percentage rate of the credit. It determines the yield due for each payment period.
- **Late fee APR**: This is the pool-level setting that decides the amount of the late fee. If a payment is late, this fee is charged in addition to the regular yield charge. Like yield, it's an annualized rate.
- **Minimum principal rate**: This pool-level setting determines the amount of principal payment due each payment period. It's a per-payment-period rate. For example, a 10% minimum principal rate means 10% of the principal must be repaid at the end of each payment period.
- **Committed loan amount**: This is the amount the borrower pledges to borrow. Yield will be charged on this amount if the outstanding principal balance is below it.
- **Designated start date**: This marks the commencement of the credit term. Borrowing is disallowed before this date and interest starts accumulating from this point forward.
- **Revolving**: This indicates whether the borrower can reuse the credit after repaying a portion of the principal. For instance, if the approved credit is $1,000, the borrower has taken out $500, and $400 is repaid, the remaining credit will be $500 for non-revolving credit and $900 for revolving credit.

If you are the EA for a Receivable-backed Credit Line or Receivable Factoring Credit pool, you will also be responsible for evaluating the quality of receivables submitted by the borrower. This evaluation determines whether the receivables can be used for drawdown.

Expand Down