Skip to content

Commit caca99e

Browse files
Debugger022Debugger022
committed
fix: correct typos and grammar
1 parent 03ccef5 commit caca99e

File tree

4 files changed

+105
-105
lines changed

4 files changed

+105
-105
lines changed

‎deployed-contracts/venus-erc4626.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
# VenusERC4626 - Deployed Contracts
22

3-
## Ethereum mainnet
3+
## Ethereum Mainnet
44

55
* VenusERC4626Factory: [`0x39cb747453Be3416E659dAeA169540b6F000c885`](https://etherscan.io/address/0x39cb747453Be3416E659dAeA169540b6F000c885)
66
* VenusERC4626Implementation: [`0x6F0AB9E23f66ceB2b1BA0BB23C0e1f5f089a3cA1`](https://etherscan.io/address/0x6F0AB9E23f66ceB2b1BA0BB23C0e1f5f089a3cA1)
77

8-
## Sepolia (Ethereum testnet)
8+
## Sepolia (Ethereum Testnet)
99

1010
* VenusERC4626Factory: [`0xbf76e9429BA565220d77831A9eC3606434e2106e`](https://sepolia.etherscan.io/address/0xbf76e9429BA565220d77831A9eC3606434e2106e)
1111
* VenusERC4626Implementation: [`0xd1B290832F3094647a063db7C293cD5DF2843255`](https://sepolia.etherscan.io/address/0xd1B290832F3094647a063db7C293cD5DF2843255)
1212

13-
## opBNB mainnet
13+
## opBNB Mainnet
1414

1515
* VenusERC4626Factory: [`0x89A5Ce0A6db7e66E53F148B50D879b700dEB81C8`](https://opbnbscan.com/address/0x89A5Ce0A6db7e66E53F148B50D879b700dEB81C8)
1616
* VenusERC4626Implementation: [`0x2C0E328c118d22A549C8CB758C46775b9560A026`](https://opbnbscan.com/address/0x2C0E328c118d22A549C8CB758C46775b9560A026)
1717

18-
## OpBNB testnet
18+
## opBNB Testnet
1919

2020
* VenusERC4626Factory: [`0x3dEDBD90EFC6E2257887FF36842337dF0739B8A1`](https://testnet.opbnbscan.com/address/0x3dEDBD90EFC6E2257887FF36842337dF0739B8A1)
2121
* VenusERC4626Implementation: [`0x5b97A053a8c153f5BE27b84370FecD3959D8898f`](https://testnet.opbnbscan.com/address/0x5b97A053a8c153f5BE27b84370FecD3959D8898f)
2222

23-
## Arbitrum one
23+
## Arbitrum One
2424

2525
* VenusERC4626Factory: [`0xC1422B928cb6FC9BA52880892078578a93aa5Cc7`](https://arbiscan.io/address/0xC1422B928cb6FC9BA52880892078578a93aa5Cc7)
2626
* VenusERC4626Implementation: [`0xff2C112F0FC927E89eA1f7ec56D0c76263708Bcb`](https://arbiscan.io/address/0xff2C112F0FC927E89eA1f7ec56D0c76263708Bcb)
2727

28-
## Arbitrum sepolia
28+
## Arbitrum Sepolia
2929

3030
* VenusERC4626Factory: [`0xC6C8249a0B44973673f3Af673e530B85038a0480`](https://sepolia.arbiscan.io/address/0xC6C8249a0B44973673f3Af673e530B85038a0480)
3131
* VenusERC4626Implementation: [`0x3442ACDbCc927cC401236C69a14ca909fC5B14ba`](https://sepolia.arbiscan.io/address/0x3442ACDbCc927cC401236C69a14ca909fC5B14ba)
3232

33-
## Zksync mainnet
33+
## zkSync Mainnet
3434

3535
* VenusERC4626Factory: [`0xDC59Dd76Dd7A64d743C764a9aa8C96Ff2Ea8BAc3`](https://explorer.zksync.io/address/0xDC59Dd76Dd7A64d743C764a9aa8C96Ff2Ea8BAc3)
3636
* VenusERC4626Implementation: [`0xBd86974B3a7348AC153aEFEe5Dc5111246a99c11`](https://explorer.zksync.io/address/0xBd86974B3a7348AC153aEFEe5Dc5111246a99c11)
3737

38-
## Zksync sepolia
38+
## zkSync Sepolia
3939

4040
* VenusERC4626Factory: [`0xa30dcc21B8393A4031cD6364829CDfE2b6D7B283`](https://sepolia.explorer.zksync.io/address/0xa30dcc21B8393A4031cD6364829CDfE2b6D7B283)
4141
* VenusERC4626Implementation: [`0x97ab473c81C5E654B71690e3B4225180C687E3eB`](https://sepolia.explorer.zksync.io/address/0x97ab473c81C5E654B71690e3B4225180C687E3eB)
@@ -50,17 +50,17 @@
5050
* VenusERC4626Factory: [`0xc66c4058A8524253C22a9461Df6769CE09F7d61e`](https://sepolia-optimism.etherscan.io/address/0xc66c4058A8524253C22a9461Df6769CE09F7d61e)
5151
* VenusERC4626Implementation: [`0x057E95A55E93DB89610AE2d64653b6384dFE7c0d`](https://sepolia-optimism.etherscan.io/address/0x057E95A55E93DB89610AE2d64653b6384dFE7c0d)
5252

53-
## Base mainnet
53+
## Base Mainnet
5454

55-
* VenusERC4626Factory: [`0x1A430825B31DdA074751D6731Ce7Dca38D012D13`](https:///basescan.org/address/0x1A430825B31DdA074751D6731Ce7Dca38D012D13)
56-
* VenusERC4626Implementation: [`0x1062F74081026eE4777981B75D8DA7e6a5640010`](https:///basescan.org/address/0x1062F74081026eE4777981B75D8DA7e6a5640010)
55+
* VenusERC4626Factory: [`0x1A430825B31DdA074751D6731Ce7Dca38D012D13`](https://basescan.org/address/0x1A430825B31DdA074751D6731Ce7Dca38D012D13)
56+
* VenusERC4626Implementation: [`0x1062F74081026eE4777981B75D8DA7e6a5640010`](https://basescan.org/address/0x1062F74081026eE4777981B75D8DA7e6a5640010)
5757

58-
## Base sepolia
58+
## Base Sepolia
5959

6060
* VenusERC4626Factory: [`0xD13c5527d1a2a8c2cC9c9eb260AC4D9D811a02a4`](https://sepolia.basescan.org/address/0xD13c5527d1a2a8c2cC9c9eb260AC4D9D811a02a4)
6161
* VenusERC4626Implementation: [`0x66A2cC7c0ca012DfBfd7BDC5DC06A315A0269b20`](https://sepolia.basescan.org/address/0x66A2cC7c0ca012DfBfd7BDC5DC06A315A0269b20)
6262

63-
## Unichain mainnet
63+
## Unichain Mainnet
6464

6565
* VenusERC4626Factory: [`0x102fEb723C25c67dbdfDccCa3B1c1a6e1a662D2f`](https://uniscan.xyz/address/0x102fEb723C25c67dbdfDccCa3B1c1a6e1a662D2f)
6666
* VenusERC4626Implementation: [`0xE5b7978b0DB9e6d6026d1C79B8174D47295f8117`](https://uniscan.xyz/address/0xE5b7978b0DB9e6d6026d1C79B8174D47295f8117)

‎technical-reference/reference-isolated-pools/erc4626/venus-erc4626-factory.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Overview
44

5-
`VenusERC4626Factory` is a factory contract for deploying upgradeable VenusERC4626 vaults as BeaconProxy instances. It manages the deployment, registry, and configuration of vaults, and controls access to sensitive operations via AccessControlManager (ACM).
5+
`VenusERC4626Factory` is a factory contract for deploying upgradeable VenusERC4626 vaults as BeaconProxy instances. It manages the deployment, registry, and configuration of vaults, and controls access to sensitive operations via the AccessControlManager (ACM).
66

77
# Solidity API
88

@@ -18,17 +18,17 @@
1818
The Pool Registry contract.
1919

2020
- **`rewardRecipient`** (`address`, public):
21-
The address that will receive the liquidity mining rewards.
21+
The address that receives the liquidity mining rewards.
2222

2323
- **`createdVaults`** (`mapping(address vToken => ERC4626Upgradeable vault)`, public):
24-
Map of vaults created by this factory.
24+
Mapping of vaults created by this factory.
2525

2626
---
2727

2828
### Events
2929

3030
- **`CreateERC4626(VTokenInterface indexed vToken, ERC4626Upgradeable indexed vault)`**
31-
Emitted when a new ERC4626 vault has been created.
31+
Emitted when a new ERC4626 vault is created.
3232

3333
- `vToken`: The vToken used by the vault.
3434
- `vault`: The vault that was created.
@@ -43,25 +43,25 @@
4343
### Errors
4444

4545
- **`VenusERC4626Factory__InvalidVToken()`**
46-
Thrown when the provided vToken is not registered in PoolRegistry.
46+
Thrown when the provided vToken is not registered in the PoolRegistry.
4747

4848
- **`VenusERC4626Factory__ERC4626AlreadyExists()`**
49-
Thrown when a VenusERC4626 vault already exists for the provided vToken.
49+
Thrown when a VenusERC4626 vault already exists for the specified vToken.
5050

5151
---
5252

53-
#### constructor
53+
#### Constructor
5454

5555
**@custom:oz-upgrades-unsafe-allow constructor**
56-
Disables initializers for upgradeable contract pattern.
56+
Disables initializers for the upgradeable contract pattern.
5757

5858
---
5959

6060
### Functions
6161

6262
### initialize
6363

64-
Initializes the VenusERC4626Factory contract with required configuration parameters.
64+
Initializes the VenusERC4626Factory contract with the required configuration parameters.
6565

6666
```solidity
6767
function initialize(
@@ -79,20 +79,20 @@ function initialize(
7979
| -------------------------- | ------- | --------------------------------------------------------- |
8080
| accessControlManager | address | Address of the Access Control Manager (ACM) contract. |
8181
| poolRegistryAddress | address | Address of the Pool Registry contract. |
82-
| rewardRecipientAddress | address | Address that will receive liquidity mining rewards. |
82+
| rewardRecipientAddress | address | Address that receives liquidity mining rewards. |
8383
| venusERC4626Implementation | address | Address of the VenusERC4626 implementation contract. |
8484
| loopsLimitNumber | uint256 | The maximum number of loops for the MaxLoopsLimit helper. |
8585

8686
#### Notes
8787

8888
- Can only be called once.
89-
- Disables initializers for upgradeable contract pattern.
89+
- Disables initializers for the upgradeable contract pattern.
9090

9191
---
9292

9393
### setRewardRecipient
9494

95-
Sets a new reward recipient address.
95+
Sets the reward recipient address.
9696

9797
```solidity
9898
function setRewardRecipient(address newRecipient) external
@@ -106,15 +106,15 @@ function setRewardRecipient(address newRecipient) external
106106

107107
#### Notes
108108

109-
- Controlled by ACM.
110-
- Throws `ZeroAddressNotAllowed` if the new recipient address is zero.
111-
- Emits `RewardRecipientUpdated` event on update.
109+
- Controlled by the ACM.
110+
- Reverts with `ZeroAddressNotAllowed` if the new recipient address is zero.
111+
- Emits the `RewardRecipientUpdated` event on update.
112112

113113
---
114114

115115
### setMaxLoopsLimit
116116

117-
Sets a new maximum loops limit for internal operations.
117+
Sets the maximum loops limit for internal operations.
118118

119119
```solidity
120120
function setMaxLoopsLimit(uint256 loopsLimit) external
@@ -128,8 +128,8 @@ function setMaxLoopsLimit(uint256 loopsLimit) external
128128

129129
#### Notes
130130

131-
- Controlled by ACM.
132-
- Emits `MaxLoopsLimitUpdated` event on success.
131+
- Controlled by the ACM.
132+
- Emits the `MaxLoopsLimitUpdated` event on success.
133133

134134
---
135135

@@ -155,16 +155,16 @@ function createERC4626(address vToken) external returns (ERC4626Upgradeable vaul
155155

156156
#### Notes
157157

158-
- Throws `ZeroAddressNotAllowed` if the vToken address is zero.
159-
- Throws `VenusERC4626Factory__InvalidVToken` if the vToken is not valid.
160-
- Throws `VenusERC4626Factory__ERC4626AlreadyExists` if the vault already exists.
161-
- Emits `CreateERC4626` event on successful creation.
158+
- Reverts with `ZeroAddressNotAllowed` if the vToken address is zero.
159+
- Reverts with `VenusERC4626Factory__InvalidVToken` if the vToken is not valid.
160+
- Reverts with `VenusERC4626Factory__ERC4626AlreadyExists` if the vault already exists.
161+
- Emits the `CreateERC4626` event on successful creation.
162162

163163
---
164164

165165
### computeVaultAddress
166166

167-
Computes the deterministic address of the vault for a given vToken.
167+
Computes the deterministic address of the vault for a specified vToken.
168168

169169
```solidity
170170
function computeVaultAddress(address vToken) public view returns (address)
@@ -180,4 +180,4 @@ function computeVaultAddress(address vToken) public view returns (address)
180180

181181
| Name | Type | Description |
182182
| ------- | ------- | --------------------------- |
183-
| address | address | The computed vault address. |
183+
| address | address | The computed vault address. |

‎technical-reference/reference-isolated-pools/erc4626/venus-erc4626.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Overview
44

5-
`VenusERC4626` is an upgradeable ERC4626-compliant vault that wraps a Venus vToken, enabling standard ERC4626 vault interactions with the Venus Protocol. It manages deposits, withdrawals, minting, redeeming, and reward distribution, with additional access control and loop limit protections.
5+
`VenusERC4626` is an upgradeable, ERC4626-compliant vault that wraps a Venus vToken, enabling standard ERC4626 vault interactions with the Venus Protocol. It manages deposits, withdrawals, minting, redeeming, and reward distribution, with additional access control and loop limit protections.
66

77
# Solidity API
88

@@ -15,10 +15,10 @@
1515
The Venus vToken associated with this ERC4626 vault.
1616

1717
- **`comptroller`** (`IComptroller`, public):
18-
The Venus Comptroller contract, responsible for market operations.
18+
The Venus Comptroller contract responsible for market operations.
1919

2020
- **`rewardRecipient`** (`address`, public):
21-
The recipient of rewards distributed by the Venus Protocol.
21+
The address that receives rewards distributed by the Venus Protocol.
2222

2323
---
2424

@@ -34,7 +34,7 @@
3434
Emitted when the reward recipient address is updated.
3535

3636
- `oldRecipient`: The previous reward recipient address.
37-
- `newRecipient`: The new reward recipient.
37+
- `newRecipient`: The new reward recipient address.
3838

3939
- **`SweepToken(address indexed token, address indexed receiver, uint256 amount)`**
4040
Emitted when tokens are swept from the contract.
@@ -52,10 +52,10 @@
5252
- `errorCode`: The error code returned by Venus.
5353

5454
- **`ERC4626__DepositMoreThanMax()`**
55-
Thrown when a deposit exceeds the maximum allowed limit.
55+
Thrown when a deposit exceeds the maximum allowed.
5656

5757
- **`ERC4626__MintMoreThanMax()`**
58-
Thrown when a mint operation exceeds the maximum allowed limit.
58+
Thrown when a mint operation exceeds the maximum allowed.
5959

6060
- **`ERC4626__WithdrawMoreThanMax()`**
6161
Thrown when a withdrawal exceeds the maximum available assets.
@@ -70,15 +70,15 @@
7070
### Constructor
7171

7272
- **@custom:oz-upgrades-unsafe-allow constructor**
73-
Disables initializers for upgradeable contract pattern.
73+
Disables initializers for the upgradeable contract pattern.
7474

7575
---
7676

7777
### Functions
7878

7979
### initialize
8080

81-
Initializes the VenusERC4626 vault with the associated VToken address.
81+
Initializes the VenusERC4626 vault with the associated vToken address.
8282

8383
```solidity
8484
function initialize(address vToken_) public initializer
@@ -88,11 +88,11 @@ function initialize(address vToken_) public initializer
8888

8989
| Name | Type | Description |
9090
| -------- | ------- | --------------------------------------------------------------------------- |
91-
| vToken\_ | address | The VToken associated with the vault, representing the yield-bearing asset. |
91+
| vToken\_ | address | The vToken associated with the vault, representing the yield-bearing asset. |
9292

9393
#### Notes
9494

95-
- Only the VToken address is set in this function.
95+
- Only the vToken address is set in this function.
9696
- `initialize2` must be called to complete the configuration.
9797

9898
---
@@ -111,8 +111,8 @@ function initialize2(address accessControlManager_, address rewardRecipient_, ui
111111
| ---------------------- | ------- | ----------------------------------------------------------------------- |
112112
| accessControlManager\_ | address | The address of the access control manager contract. |
113113
| rewardRecipient\_ | address | The initial recipient of rewards. |
114-
| loopsLimit\_ | uint256 | The maximum number of loops for certain operations, enhancing security. |
115-
| vaultOwner\_ | address | The owner of the vault. |
114+
| loopsLimit\_ | uint256 | The maximum number of loops for certain operations to enhance security. |
115+
| vaultOwner\_ | address | The address of the vault owner. |
116116

117117
#### Notes
118118

@@ -141,7 +141,7 @@ function setMaxLoopsLimit(uint256 loopsLimit) external
141141

142142
#### Access
143143

144-
- Controlled by Access Control Manager (ACM).
144+
- Controlled by the Access Control Manager (ACM).
145145

146146
---
147147

@@ -165,13 +165,13 @@ function setRewardRecipient(address newRecipient) external
165165

166166
#### Access
167167

168-
- Controlled by ACM.
168+
- Controlled by the ACM.
169169

170170
---
171171

172172
### sweepToken
173173

174-
Sweeps the specified token from the contract and sends it to the owner.
174+
Sweeps the specified token from the contract and sends it to the contract owner.
175175

176176
```solidity
177177
function sweepToken(IERC20Upgradeable token) external onlyOwner
@@ -189,13 +189,13 @@ function sweepToken(IERC20Upgradeable token) external onlyOwner
189189

190190
#### Access
191191

192-
- Only owner.
192+
- Only the owner.
193193

194194
---
195195

196196
### claimRewards
197197

198-
Claims rewards from all reward distributors associated with the VToken and transfers them to the reward recipient.
198+
Claims rewards from all reward distributors associated with the vToken and transfers them to the reward recipient.
199199

200200
```solidity
201201
function claimRewards() external
@@ -323,7 +323,7 @@ function redeem(uint256 shares, address receiver, address owner) public override
323323

324324
### totalAssets
325325

326-
Returns the total amount of assets managed by the vault, including both deposited assets and any accrued rewards.
326+
Returns the total amount of assets managed by the vault, including both deposited assets and accrued rewards.
327327

328328
```solidity
329329
function totalAssets() public view virtual override returns (uint256)
@@ -343,7 +343,7 @@ function totalAssets() public view virtual override returns (uint256)
343343

344344
### maxDeposit
345345

346-
Returns the maximum deposit allowed based on Venus supply caps.
346+
Returns the maximum deposit allowed, based on Venus supply caps.
347347

348348
```solidity
349349
function maxDeposit(address account) public view virtual override returns (uint256)
@@ -363,7 +363,7 @@ function maxDeposit(address account) public view virtual override returns (uint2
363363

364364
#### Notes
365365

366-
- Returns 0 if minting is paused or the supply cap is reached.
366+
- Returns 0 if minting is paused or the supply cap has been reached.
367367

368368
---
369369

@@ -395,7 +395,7 @@ function maxMint(address account) public view virtual override returns (uint256)
395395

396396
### maxWithdraw
397397

398-
Returns the maximum amount that can be withdrawn.
398+
Returns the maximum amount of assets that can be withdrawn.
399399

400400
```solidity
401401
function maxWithdraw(address receiver) public view virtual override returns (uint256)
@@ -415,7 +415,7 @@ function maxWithdraw(address receiver) public view virtual override returns (uin
415415

416416
#### Notes
417417

418-
- Limited by the available cash in the vault.
418+
- This value is limited by the available cash in the vault.
419419

420420
---
421421

0 commit comments

Comments
 (0)