CI: 2.6.16

dl-solarity · Feb 9, 2024 · d406534 · d406534
1 parent 961b927
commit d406534
Show file tree

Hide file tree

Showing 30 changed files with 715 additions and 377 deletions.
diff --git a/docs/reference/contracts/access-control/MerkleWhitelisted.md b/docs/reference/contracts/access-control/MerkleWhitelisted.md
@@ -52,10 +52,10 @@ The function to check if the leaf belongs to the Merkle tree
 
 Parameters:
 
-| Name         | Type      | Description                                      |
-| :----------- | :-------- | :----------------------------------------------- |
-| leaf_        | bytes32   | the leaf to be checked                           |
-| merkleProof_ | bytes32[] | the path from the leaf to the Merkle tree root   |
+| Name         | Type      | Description                                     |
+| :----------- | :-------- | :---------------------------------------------- |
+| leaf_        | bytes32   | the leaf to be checked                          |
+| merkleProof_ | bytes32[] | the path from the leaf to the Merkle tree root  |
 
 
 Return values:
@@ -78,10 +78,10 @@ The function to check if the user belongs to the Merkle tree
 
 Parameters:
 
-| Name         | Type      | Description                                      |
-| :----------- | :-------- | :----------------------------------------------- |
-| user_        | address   | the user to be checked                           |
-| merkleProof_ | bytes32[] | the path from the user to the Merkle tree root   |
+| Name         | Type      | Description                                     |
+| :----------- | :-------- | :---------------------------------------------- |
+| user_        | address   | the user to be checked                          |
+| merkleProof_ | bytes32[] | the path from the user to the Merkle tree root  |
 
 
 Return values:

diff --git a/docs/reference/contracts/access-control/MultiOwnable.md b/docs/reference/contracts/access-control/MultiOwnable.md
@@ -96,9 +96,9 @@ The function to check the ownership of a user
 
 Parameters:
 
-| Name     | Type    | Description         |
-| :------- | :------ | :------------------ |
-| address_ | address | the user to check   |
+| Name     | Type    | Description        |
+| :------- | :------ | :----------------- |
+| address_ | address | the user to check  |
 
 
 Return values:

diff --git a/docs/reference/contracts/access-control/RBAC.md b/docs/reference/contracts/access-control/RBAC.md
@@ -110,10 +110,10 @@ The function to grant roles to a user
 
 Parameters:
 
-| Name          | Type     | Description                  |
-| :------------ | :------- | :--------------------------- |
-| to_           | address  | the user to grant roles to   |
-| rolesToGrant_ | string[] | roles to grant               |
+| Name          | Type     | Description                 |
+| :------------ | :------- | :-------------------------- |
+| to_           | address  | the user to grant roles to  |
+| rolesToGrant_ | string[] | roles to grant              |
 
 ### revokeRoles (0x4f0d84e3)
 
@@ -129,10 +129,10 @@ The function to revoke roles
 
 Parameters:
 
-| Name           | Type     | Description                     |
-| :------------- | :------- | :------------------------------ |
-| from_          | address  | the user to revoke roles from   |
-| rolesToRevoke_ | string[] | the roles to revoke             |
+| Name           | Type     | Description                    |
+| :------------- | :------- | :----------------------------- |
+| from_          | address  | the user to revoke roles from  |
+| rolesToRevoke_ | string[] | the roles to revoke            |
 
 ### addPermissionsToRole (0x37ff630d)
 
@@ -252,11 +252,11 @@ handles not 2 but 3 states: NO PERMISSION, ALLOWED, DISALLOWED
 
 Parameters:
 
-| Name        | Type    | Description                                           |
-| :---------- | :------ | :---------------------------------------------------- |
-| who_        | address | the user                                              |
-| resource_   | string  | the resource the user has to have the permission of   |
-| permission_ | string  | the permission the user has to have                   |
+| Name        | Type    | Description                                          |
+| :---------- | :------ | :--------------------------------------------------- |
+| who_        | address | the user                                             |
+| resource_   | string  | the resource the user has to have the permission of  |
+| permission_ | string  | the permission the user has to have                  |
 
 
 Return values:

diff --git a/docs/reference/contracts/access-control/extensions/RBACGroupable.md b/docs/reference/contracts/access-control/extensions/RBACGroupable.md
@@ -74,10 +74,10 @@ The function to grant roles to the group
 
 Parameters:
 
-| Name          | Type     | Description                   |
-| :------------ | :------- | :---------------------------- |
-| groupTo_      | string   | the group to grant roles to   |
-| rolesToGrant_ | string[] | the list of roles to grant    |
+| Name          | Type     | Description                  |
+| :------------ | :------- | :--------------------------- |
+| groupTo_      | string   | the group to grant roles to  |
+| rolesToGrant_ | string[] | the list of roles to grant   |
 
 ### revokeGroupRoles (0x30cae168)
 
@@ -93,10 +93,10 @@ The function to revoke roles from the group
 
 Parameters:
 
-| Name           | Type     | Description                      |
-| :------------- | :------- | :------------------------------- |
-| groupFrom_     | string   | the group to revoke roles from   |
-| rolesToRevoke_ | string[] | the list of roles to revoke      |
+| Name           | Type     | Description                     |
+| :------------- | :------- | :------------------------------ |
+| groupFrom_     | string   | the group to revoke roles from  |
+| rolesToRevoke_ | string[] | the list of roles to revoke     |
 
 ### toggleDefaultGroup (0xd41de127)
 
@@ -195,11 +195,11 @@ handles not 2 but 3 states: NO PERMISSION, ALLOWED, DISALLOWED
 
 Parameters:
 
-| Name        | Type    | Description                                           |
-| :---------- | :------ | :---------------------------------------------------- |
-| who_        | address | the user                                              |
-| resource_   | string  | the resource the user has to have the permission of   |
-| permission_ | string  | the permission the user has to have                   |
+| Name        | Type    | Description                                          |
+| :---------- | :------ | :--------------------------------------------------- |
+| who_        | address | the user                                             |
+| resource_   | string  | the resource the user has to have the permission of  |
+| permission_ | string  | the permission the user has to have                  |
 
 
 Return values:

diff --git a/docs/reference/contracts/compound-rate-keeper/AbstractCompoundRateKeeper.md b/docs/reference/contracts/compound-rate-keeper/AbstractCompoundRateKeeper.md
@@ -60,9 +60,9 @@ The function to get future compound rate (the timestamp_ may be equal to the las
 
 Parameters:
 
-| Name       | Type   | Description                               |
-| :--------- | :----- | :---------------------------------------- |
-| timestamp_ | uint64 | the timestamp to calculate the rate for   |
+| Name       | Type   | Description                              |
+| :--------- | :----- | :--------------------------------------- |
+| timestamp_ | uint64 | the timestamp to calculate the rate for  |
 
 
 Return values:

diff --git a/docs/reference/contracts/compound-rate-keeper/presets/OwnableCompoundRateKeeper.md b/docs/reference/contracts/compound-rate-keeper/presets/OwnableCompoundRateKeeper.md
@@ -25,10 +25,10 @@ The initialization function
 
 Parameters:
 
-| Name                  | Type    | Description                                         |
-| :-------------------- | :------ | :-------------------------------------------------- |
-| capitalizationRate_   | uint256 | the compound interest rate with 10\**25 precision   |
-| capitalizationPeriod_ | uint64  | the compounding period in seconds                   |
+| Name                  | Type    | Description                                        |
+| :-------------------- | :------ | :------------------------------------------------- |
+| capitalizationRate_   | uint256 | the compound interest rate with 10\**25 precision  |
+| capitalizationPeriod_ | uint64  | the compounding period in seconds                  |
 
 ### setCapitalizationRate (0x9aad5c9a)
 

diff --git a/docs/reference/contracts/contracts-registry/AbstractContractsRegistry.md b/docs/reference/contracts/contracts-registry/AbstractContractsRegistry.md
@@ -79,9 +79,9 @@ The function that returns an associated contract with the name
 
 Parameters:
 
-| Name  | Type   | Description                |
-| :---- | :----- | :------------------------- |
-| name_ | string | the name of the contract   |
+| Name  | Type   | Description               |
+| :---- | :----- | :------------------------ |
+| name_ | string | the name of the contract  |
 
 
 Return values:
@@ -101,9 +101,9 @@ The function that checks if a contract with a given name has been added
 
 Parameters:
 
-| Name  | Type   | Description                |
-| :---- | :----- | :------------------------- |
-| name_ | string | the name of the contract   |
+| Name  | Type   | Description               |
+| :---- | :----- | :------------------------ |
+| name_ | string | the name of the contract  |
 
 
 Return values:
@@ -138,9 +138,9 @@ The function that returns an implementation of the given proxy contract
 
 Parameters:
 
-| Name  | Type   | Description                |
-| :---- | :----- | :------------------------- |
-| name_ | string | the name of the contract   |
+| Name  | Type   | Description               |
+| :---- | :----- | :------------------------ |
+| name_ | string | the name of the contract  |
 
 
 Return values:

diff --git a/docs/reference/contracts/contracts-registry/pools/AbstractPoolContractsRegistry.md b/docs/reference/contracts/contracts-registry/pools/AbstractPoolContractsRegistry.md
@@ -69,9 +69,9 @@ The function to get implementation of the specific pools
 
 Parameters:
 
-| Name  | Type   | Description             |
-| :---- | :----- | :---------------------- |
-| name_ | string | the name of the pools   |
+| Name  | Type   | Description            |
+| :---- | :----- | :--------------------- |
+| name_ | string | the name of the pools  |
 
 
 Return values:
@@ -91,9 +91,9 @@ The function to get the BeaconProxy of the specific pools (mostly needed in the
 
 Parameters:
 
-| Name  | Type   | Description             |
-| :---- | :----- | :---------------------- |
-| name_ | string | the name of the pools   |
+| Name  | Type   | Description            |
+| :---- | :----- | :--------------------- |
+| name_ | string | the name of the pools  |
 
 
 Return values:
@@ -113,10 +113,10 @@ The function to check if the address is a pool
 
 Parameters:
 
-| Name  | Type    | Description                 |
-| :---- | :------ | :-------------------------- |
-| name_ | string  | the associated pools name   |
-| pool_ | address | the address to check        |
+| Name  | Type    | Description                |
+| :---- | :------ | :------------------------- |
+| name_ | string  | the associated pools name  |
+| pool_ | address | the address to check       |
 
 
 Return values:
@@ -136,9 +136,9 @@ The function to count pools by specified name
 
 Parameters:
 
-| Name  | Type   | Description                 |
-| :---- | :----- | :-------------------------- |
-| name_ | string | the associated pools name   |
+| Name  | Type   | Description                |
+| :---- | :----- | :------------------------- |
+| name_ | string | the associated pools name  |
 
 
 Return values:
@@ -162,11 +162,11 @@ The paginated function to list pools by their name (call `countPools()` to accou
 
 Parameters:
 
-| Name    | Type    | Description                             |
-| :------ | :------ | :-------------------------------------- |
-| name_   | string  | the associated pools name               |
-| offset_ | uint256 | the starting index in the pools array   |
-| limit_  | uint256 | the number of pools                     |
+| Name    | Type    | Description                            |
+| :------ | :------ | :------------------------------------- |
+| name_   | string  | the associated pools name              |
+| offset_ | uint256 | the starting index in the pools array  |
+| limit_  | uint256 | the number of pools                    |
 
 
 Return values:

diff --git a/...contracts/contracts-registry/pools/presets/MultiOwnablePoolContractsRegistry.md b/...contracts/contracts-registry/pools/presets/MultiOwnablePoolContractsRegistry.md
@@ -32,10 +32,10 @@ The function to set new implementation for the registered pools
 
 Parameters:
 
-| Name                | Type      | Description                                       |
-| :------------------ | :-------- | :------------------------------------------------ |
-| names_              | string[]  | the names of registered ProxyBeacons to upgrade   |
-| newImplementations_ | address[] | the addresses of new implementations to be used   |
+| Name                | Type      | Description                                      |
+| :------------------ | :-------- | :----------------------------------------------- |
+| names_              | string[]  | the names of registered ProxyBeacons to upgrade  |
+| newImplementations_ | address[] | the addresses of new implementations to be used  |
 
 ### injectDependenciesToExistingPools (0x24d6780f)
 
@@ -52,11 +52,11 @@ The function to inject dependencies to registered pools (via EIP-6224)
 
 Parameters:
 
-| Name    | Type    | Description                                     |
-| :------ | :------ | :---------------------------------------------- |
-| name_   | string  | the name of ProxyBeacon to identify the pools   |
-| offset_ | uint256 | the start index of the pools array              |
-| limit_  | uint256 | the number of pools to inject dependencies to   |
+| Name    | Type    | Description                                    |
+| :------ | :------ | :--------------------------------------------- |
+| name_   | string  | the name of ProxyBeacon to identify the pools  |
+| offset_ | uint256 | the start index of the pools array             |
+| limit_  | uint256 | the number of pools to inject dependencies to  |
 
 ### injectDependenciesToExistingPoolsWithData (0x52837c41)
 
@@ -74,9 +74,9 @@ The function to inject dependencies to registered pools with data (via EIP-6224)
 
 Parameters:
 
-| Name    | Type    | Description                                             |
-| :------ | :------ | :------------------------------------------------------ |
-| data_   | bytes   | the data to be passed to `setDependencies()` function   |
-| name_   | string  | the name of ProxyBeacon to identify the pools           |
-| offset_ | uint256 | the start index of the pools array                      |
-| limit_  | uint256 | the number of pools to inject dependencies to           |
+| Name    | Type    | Description                                            |
+| :------ | :------ | :----------------------------------------------------- |
+| data_   | bytes   | the data to be passed to `setDependencies()` function  |
+| name_   | string  | the name of ProxyBeacon to identify the pools          |
+| offset_ | uint256 | the start index of the pools array                     |
+| limit_  | uint256 | the number of pools to inject dependencies to          |
diff --git a/...ence/contracts/contracts-registry/pools/presets/OwnablePoolContractsRegistry.md b/...ence/contracts/contracts-registry/pools/presets/OwnablePoolContractsRegistry.md
@@ -32,10 +32,10 @@ The function to set new implementation for the registered pools
 
 Parameters:
 
-| Name                | Type      | Description                                       |
-| :------------------ | :-------- | :------------------------------------------------ |
-| names_              | string[]  | the names of registered ProxyBeacons to upgrade   |
-| newImplementations_ | address[] | the addresses of new implementations to be used   |
+| Name                | Type      | Description                                      |
+| :------------------ | :-------- | :----------------------------------------------- |
+| names_              | string[]  | the names of registered ProxyBeacons to upgrade  |
+| newImplementations_ | address[] | the addresses of new implementations to be used  |
 
 ### injectDependenciesToExistingPools (0x24d6780f)
 
@@ -52,11 +52,11 @@ The function to inject dependencies to registered pools (via EIP-6224)
 
 Parameters:
 
-| Name    | Type    | Description                                     |
-| :------ | :------ | :---------------------------------------------- |
-| name_   | string  | the name of ProxyBeacon to identify the pools   |
-| offset_ | uint256 | the start index of the pools array              |
-| limit_  | uint256 | the number of pools to inject dependencies to   |
+| Name    | Type    | Description                                    |
+| :------ | :------ | :--------------------------------------------- |
+| name_   | string  | the name of ProxyBeacon to identify the pools  |
+| offset_ | uint256 | the start index of the pools array             |
+| limit_  | uint256 | the number of pools to inject dependencies to  |
 
 ### injectDependenciesToExistingPoolsWithData (0x52837c41)
 
@@ -74,9 +74,9 @@ The function to inject dependencies to registered pools with data (via EIP-6224)
 
 Parameters:
 
-| Name    | Type    | Description                                             |
-| :------ | :------ | :------------------------------------------------------ |
-| data_   | bytes   | the data to be passed to `setDependencies()` function   |
-| name_   | string  | the name of ProxyBeacon to identify the pools           |
-| offset_ | uint256 | the start index of the pools array                      |
-| limit_  | uint256 | the number of pools to inject dependencies to           |
+| Name    | Type    | Description                                            |
+| :------ | :------ | :----------------------------------------------------- |
+| data_   | bytes   | the data to be passed to `setDependencies()` function  |
+| name_   | string  | the name of ProxyBeacon to identify the pools          |
+| offset_ | uint256 | the start index of the pools array                     |
+| limit_  | uint256 | the number of pools to inject dependencies to          |