Skip to content

Commit 65644d0

Browse files
committed
refactor: factory doc edits
1 parent bc4b4d5 commit 65644d0

File tree

4 files changed

+15
-18
lines changed

4 files changed

+15
-18
lines changed

isolated-lending/factories/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Factories
22

3-
Factories are the contracts that deploy interest rate models and VToken proxies. [Pool Registry](../pool-registry.md) uses these factories to create the necessary contracts when a new market is added to a pool.
3+
Factories are the contracts that deploy interest rate models and VToken proxies. [PoolRegistry](../pool-registry.md) uses these factories to create the necessary contracts when a new market is added to a pool.
44

55
There are two contracts for interest rate models:
6-
* [White Paper Interest Rate Model Factory](./white-paper-interest-rate-model-factory.md) deploys a linear interest rate model
7-
* [Jump Rate Model Factory](./jump-rate-model-factory.md) deploys a piecewise linear interest rate model with a steep increase when the utilization is high
6+
* [WhitePaperInterestRateModelFactory](./white-paper-interest-rate-model-factory.md) deploys a linear interest rate model
7+
* [JumpRateModelFactory](./jump-rate-model-factory.md) deploys a piecewise linear interest rate model with a steep increase when the utilization is high
88

9-
[VToken Proxy Factory](./vtoken-proxy-factory.md) deploys an upgradeable proxy for the market itself. Contrary to the Core Pool, Isolated Lending uses a standart OpenZeppelin proxy for all contracts including VTokens. All markets are upgradeable in Venus Isolated Lending.
9+
[VTokenProxyFactory](./vtoken-proxy-factory.md) deploys an upgradeable proxy for the market itself. Contrary to the Core Pool, Isolated Pools uses a standard OpenZeppelin proxy for all contracts including VToken. All markets are upgradeable in Venus Isolated Pools.

isolated-lending/factories/jump-rate-model-factory.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Jump Rate Model Factory
1+
# JumpRateModelFactory
22

3-
A factory for Jump Rate Model, an interest rate model with a steep increase after a certain utilization threshold called `kink` is reached. This rate model uses the following formula for the borrow rate:
3+
A factory for Jump Rate Model, an interest rate model with a steep increase after a certain utilization threshold called __kink__ is reached. This rate model uses the following formula for the borrow rate:
44

55
* $borrow\_rate(u)=a_1 \cdot u + b$, when $u<kink$
66
* $borrow\_rate(u)=a_1 \cdot kink + a_2 \cdot (u-kink) + b$, otherwise

isolated-lending/factories/vtoken-proxy-factory.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# VToken Proxy Factory
1+
# VTokenProxyFactory
22

33
This factory deploys a ERC-1967 compliant transparent proxy and initializes it with the implementation of VToken.
44

@@ -45,12 +45,12 @@ struct RiskManagementInit {
4545
| `underlying_` | address | The underlying BEP-20 token to list |
4646
| `comptroller_` | address | The pool Comptroller |
4747
| `interestRateModel_` | address | Interest rate model to use |
48-
| `initialExchangeRateMantissa_` | uint256 | The VToken to underlying exchange rate to start with |
49-
| `name_` | address | VToken name (usually it's "Venus " + underlying name) |
50-
| `symbol_` | address | VToken symbol (usually it's "v" + underlying symbol) |
51-
| `decimals_` | address | VToken decimals (the convention is to use 8 decimals for vTokens) |
52-
| `admin_` | address | VToken admin (should be Governance). Note that this is **not** the upgradeability administrator |
48+
| `initialExchangeRateMantissa_` | uint256 | The vToken to underlying exchange rate to start with |
49+
| `name_` | address | vToken name (usually it's "Venus " + underlying name) |
50+
| `symbol_` | address | vToken symbol (usually it's "v" + underlying symbol) |
51+
| `decimals_` | address | vToken decimals (the convention is to use 8 decimals for vTokens) |
52+
| `admin_` | address | vToken admin (should be Governance). Note that this is **not** the upgradeability administrator |
5353
| `accessControlManager_` | address | [AccessControlManager](../governance/access-control-manager.md) contract |
5454
| `riskManagement` | RiskManagementInit | Addreses of the [Shortfall](../shortfall.md), [Risk Fund](../risk-fund.md), and [Protocol Share Reserve](../protocol-share-reserve.md) contracts |
5555
| `vTokenProxyAdmin_` | address | The address of the upgradeability admin |
56-
| `tokenImplementation_` | address | VToken implementation contract |
56+
| `tokenImplementation_` | address | voken implementation contract |

isolated-lending/factories/white-paper-interest-rate-model-factory.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# White Paper Interest Rate Model Factory
1+
# WhitePaperInterestRateModelFactory
22

3-
A factory for White Paper Interest Rate Model, a simple model where the borrow rate depends linearly on the utilization:
3+
A factory for WhitePaperInterestRateModel, a simple model where the borrow rate depends linearly on the utilization:
44

55
$borrow\_rate(u) = a \cdot u + b$
66

@@ -23,6 +23,3 @@ function deploy(
2323
| ---- | ---- | ----------- |
2424
| `baseRatePerYear` | uint256 | $b$, the base interest rate which is the y-intercept when utilization rate is 0 |
2525
| `multiplierPerYear` | uint256 | $a_1$, the multiplier of utilization rate that gives the slope of the interest rate |
26-
| `jumpMultiplierPerYear` | uint256 | $a_2$, the multiplier of utilization rate after hitting a specified utilization point |
27-
| `kink_` | uint256 | $kink$, the utilization point at which the jump multiplier is applied |
28-
| `owner_` | address | the address that can adjust the interest rate model parameters |

0 commit comments

Comments
 (0)