update integral v1.2.1 docs

Author: IliaAzhel

docs/Contracts/Core/AlgebraCommunityVault.md

@@ -8,9 +8,9 @@ Algebra community fee vault
 Community fee from pools is sent here, if it is enabled
 
 *Developer note: Role system is used to withdraw tokens
-Version: Algebra Integral*
+Version: Algebra Integral 1.2.1*
 
-**Inherits:** [IAlgebraCommunityVault](interfaces/IAlgebraCommunityVault.md)
+**Inherits:** [IAlgebraCommunityVault](interfaces/vault/IAlgebraCommunityVault.md)
 ## Modifiers
 ### onlyAdministrator
 
@@ -118,13 +118,14 @@ Address of Algebra fee manager
 ### constructor
 
 ```solidity
-constructor(address _algebraFeeManager) public
+constructor(address _factory, address _algebraFeeManager) public
 ```
 
 
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
+| _factory | address |  |
 | _algebraFeeManager | address |  |
 
 ### withdraw

docs/Contracts/Core/AlgebraFactory.md

@@ -7,9 +7,9 @@ Algebra factory
 
 Is used to deploy pools and its plugins
 
-*Developer note: Version: Algebra Integral*
+*Developer note: Version: Algebra Integral 1.2.1*
 
-**Inherits:** [IAlgebraFactory](interfaces/IAlgebraFactory.md) [Ownable2Step](https://docs.openzeppelin.com/contracts/4.x/) [AccessControlEnumerable](https://docs.openzeppelin.com/contracts/4.x/)
+**Inherits:** [IAlgebraFactory](interfaces/IAlgebraFactory.md) [Ownable2Step](https://docs.openzeppelin.com/contracts/4.x/) [AccessControlEnumerable](https://docs.openzeppelin.com/contracts/4.x/) [ReentrancyGuard](https://docs.openzeppelin.com/contracts/4.x/)
 
 ## Public variables
 ### POOLS_ADMINISTRATOR_ROLE
@@ -21,22 +21,22 @@ bytes32 constant POOLS_ADMINISTRATOR_ROLE = 0xb73ce166ead2f8e9add217713a7989e4ed
 role that can change communityFee and tickspacing in pools
 
 
-### poolDeployer
+### CUSTOM_POOL_DEPLOYER
 ```solidity
-address immutable poolDeployer
+bytes32 constant CUSTOM_POOL_DEPLOYER = 0xc9cf812513d9983585eb40fcfe6fd49fbb6a45815663ec33b30a6c6c7de3683b
 ```
-**Selector**: `0x3119049a`
+**Selector**: `0x07810754`
 
-Returns the current poolDeployerAddress
+role that can call `createCustomPool` function
 
 
-### communityVault
+### poolDeployer
 ```solidity
-address immutable communityVault
+address immutable poolDeployer
 ```
-**Selector**: `0x53e97868`
+**Selector**: `0x3119049a`
 
-Returns the current communityVaultAddress
+Returns the current poolDeployerAddress
 
 
 ### defaultCommunityFee
@@ -83,6 +83,17 @@ contract IAlgebraPluginFactory defaultPluginFactory
 
 Return the current pluginFactory address
 
+*Developer note: This contract is used to automatically set a plugin address in new liquidity pools*
+
+### vaultFactory
+```solidity
+contract IAlgebraVaultFactory vaultFactory
+```
+**Selector**: `0xd8a06f73`
+
+Return the current vaultFactory address
+
+*Developer note: This contract is used to automatically set a vault address in new liquidity pools*
 
 ### poolByPair
 ```solidity
@@ -94,9 +105,19 @@ Returns the pool address for a given pair of tokens, or address 0 if it does not
 
 *Developer note: tokenA and tokenB may be passed in either token0/token1 or token1/token0 order*
 
+### customPoolByPair
+```solidity
+mapping(address => mapping(address => mapping(address => address))) customPoolByPair
+```
+**Selector**: `0x23da36cc`
+
+Returns the custom pool address for a customDeployer and a given pair of tokens, or address 0 if it does not exist
+
+*Developer note: tokenA and tokenB may be passed in either token0/token1 or token1/token0 order*
+
 ### POOL_INIT_CODE_HASH
 ```solidity
-bytes32 constant POOL_INIT_CODE_HASH = 0x177d5fbf994f4d130c008797563306f1a168dc689f81b2fa23b4396931014d91
+bytes32 constant POOL_INIT_CODE_HASH = 0xa18736c3ee97fe3c96c9428c0cc2a9116facec18e84f95f9da30543f8238a782
 ```
 **Selector**: `0xdc6fd8ab`
 
@@ -162,7 +183,7 @@ function defaultConfigurationForPool() external view returns (uint16 communityFe
 ```
 **Selector**: `0x25b355d6`
 
-Returns the default communityFee and tickspacing
+Returns the default communityFee, tickspacing, fee and communityFeeVault for pool
 
 **Returns:**
 
@@ -194,12 +215,35 @@ Deterministically computes the pool address given the token0 and token1
 | ---- | ---- | ----------- |
 | pool | address | The contract address of the Algebra pool |
 
+### computeCustomPoolAddress
+
+```solidity
+function computeCustomPoolAddress(address deployer, address token0, address token1) public view returns (address customPool)
+```
+**Selector**: `0x1ba89df4`
+
+Deterministically computes the custom pool address given the customDeployer, token0 and token1
+
+*Developer note: The method does not check if such a pool has been created*
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| deployer | address |  |
+| token0 | address | first token |
+| token1 | address | second token |
+
+**Returns:**
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| customPool | address | The contract address of the Algebra pool |
+
 ### createPool
 
 ```solidity
-function createPool(address tokenA, address tokenB) external returns (address pool)
+function createPool(address tokenA, address tokenB, bytes data) external returns (address pool)
 ```
-**Selector**: `0xe3433615`
+**Selector**: `0x321935c6`
 
 Creates a pool for the given two tokens
 
@@ -210,13 +254,40 @@ The call will revert if the pool already exists or the token arguments are inval
 | ---- | ---- | ----------- |
 | tokenA | address | One of the two tokens in the desired pool |
 | tokenB | address | The other of the two tokens in the desired pool |
+| data | bytes | Data for plugin creation |
 
 **Returns:**
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | pool | address | The address of the newly created pool |
 
+### createCustomPool
+
+```solidity
+function createCustomPool(address deployer, address creator, address tokenA, address tokenB, bytes data) external returns (address customPool)
+```
+**Selector**: `0xdbbf3db4`
+
+Creates a custom pool for the given two tokens using `deployer` contract
+
+*Developer note: tokenA and tokenB may be passed in either order: token0/token1 or token1/token0.
+The call will revert if the pool already exists or the token arguments are invalid.*
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| deployer | address | The address of plugin deployer, also used for custom pool address calculation |
+| creator | address | The initiator of custom pool creation |
+| tokenA | address | One of the two tokens in the desired pool |
+| tokenB | address | The other of the two tokens in the desired pool |
+| data | bytes | The additional data bytes |
+
+**Returns:**
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| customPool | address | The address of the newly created custom pool |
+
 ### setDefaultCommunityFee
 
 ```solidity
@@ -277,6 +348,21 @@ function setDefaultPluginFactory(address newDefaultPluginFactory) external
 | ---- | ---- | ----------- |
 | newDefaultPluginFactory | address | address of new plugin factory |
 
+### setVaultFactory
+
+```solidity
+function setVaultFactory(address newVaultFactory) external
+```
+**Selector**: `0x3ea7fbdb`
+
+
+
+*Developer note: updates vaultFactory address*
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| newVaultFactory | address | address of new vault factory |
+
 ### startRenounceOwnership
 
 ```solidity

docs/Contracts/Core/AlgebraPool.md

@@ -7,10 +7,24 @@ Algebra concentrated liquidity pool
 
 This contract is responsible for liquidity positions, swaps and flashloans
 
-*Developer note: Version: Algebra Integral*
+*Developer note: Version: Algebra Integral 1.2.1*
 
 **Inherits:** [AlgebraPoolBase](base/AlgebraPoolBase.md) [TickStructure](base/TickStructure.md) ReentrancyGuard [Positions](base/Positions.md) SwapCalculation [ReservesManager](base/ReservesManager.md)
 
+## Structs
+### SwapEventParams
+
+
+
+```solidity
+struct SwapEventParams {
+  uint160 currentPrice;
+  int24 currentTick;
+  uint128 currentLiquidity;
+}
+```
+
+
 ## Functions
 ### initialize
 
@@ -234,11 +248,27 @@ function setPluginConfig(uint8 newConfig) external
 ```
 **Selector**: `0xbca57f81`
 
-Set new plugin config
+Set new plugin config. Only factory owner or POOLS_ADMINISTRATOR_ROLE role
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| newConfig | uint8 | In the new configuration of the plugin, each bit of which is responsible for a particular hook. |
+
+### setCommunityVault
+
+```solidity
+function setCommunityVault(address newCommunityVault) external
+```
+**Selector**: `0xd8544cf3`
+
+Set new community fee vault address. Only factory owner or POOLS_ADMINISTRATOR_ROLE role
+
+*Developer note: Community fee vault receives collected community fees.
+**accumulated but not yet sent to the vault community fees once will be sent to the `newCommunityVault` address***
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| newConfig | uint8 | In the new configuration of the plugin, each bit of which is responsible for a particular hook. Only factory owner or POOLS_ADMINISTRATOR_ROLE role |
+| newCommunityVault | address | The address of new community fee vault |
 
 ### setFee
 
@@ -254,3 +284,25 @@ Called by the plugin if dynamic fee is enabled
 | ---- | ---- | ----------- |
 | newFee | uint16 | The new fee value |
 
+### sync
+
+```solidity
+function sync() external
+```
+**Selector**: `0xfff6cae9`
+
+Forces balances to match reserves. Excessive tokens will be distributed between active LPs
+
+*Developer note: Only plugin can call this function*
+
+### skim
+
+```solidity
+function skim() external
+```
+**Selector**: `0x1dd19cb4`
+
+Forces balances to match reserves. Excessive tokens will be sent to msg.sender
+
+*Developer note: Only plugin can call this function*
+

docs/Contracts/Core/AlgebraPoolDeployer.md

@@ -7,28 +7,27 @@ Algebra pool deployer
 
 Is used by AlgebraFactory to deploy pools
 
-*Developer note: Version: Algebra Integral*
+*Developer note: Version: Algebra Integral 1.2.1*
 
 **Inherits:** [IAlgebraPoolDeployer](interfaces/IAlgebraPoolDeployer.md)
 
 ## Functions
 ### constructor
 
 ```solidity
-constructor(address _factory, address _communityVault) public
+constructor(address _factory) public
 ```
 
 
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | _factory | address |  |
-| _communityVault | address |  |
 
 ### getDeployParameters
 
 ```solidity
-function getDeployParameters() external view returns (address _plugin, address _factory, address _communityVault, address _token0, address _token1)
+function getDeployParameters() external view returns (address _plugin, address _factory, address _token0, address _token1)
 ```
 **Selector**: `0x04889e26`
 
@@ -42,16 +41,15 @@ Get the parameters to be used in constructing the pool, set transiently during p
 | ---- | ---- | ----------- |
 | _plugin | address |  |
 | _factory | address |  |
-| _communityVault | address |  |
 | _token0 | address |  |
 | _token1 | address |  |
 
 ### deploy
 
 ```solidity
-function deploy(address plugin, address token0, address token1) external returns (address pool)
+function deploy(address plugin, address token0, address token1, address deployer) external returns (address pool)
 ```
-**Selector**: `0xd9181cd3`
+**Selector**: `0xfd82b73a`
 
 
 
@@ -62,6 +60,7 @@ function deploy(address plugin, address token0, address token1) external returns
 | plugin | address | The pool associated plugin (if any) |
 | token0 | address | The first token of the pool by address sort order |
 | token1 | address | The second token of the pool by address sort order |
+| deployer | address |  |
 
 **Returns:**