Merge pull request #112 from cryptoalgebra/dev

Algebra Integral 1.0
cryptoalgebra · Feb 12, 2024 · 55dbb56 · 55dbb56
2 parents da2d363 + a88725c
commit 55dbb56
Show file tree

Hide file tree

Showing 97 changed files with 9,233 additions and 9,101 deletions.
diff --git a/docs/Contracts/Plugin/interfaces/plugins/IFarmingPlugin.md b/docs/Contracts/Plugin/interfaces/plugins/IFarmingPlugin.md
@@ -28,7 +28,7 @@ Emitted when new activeIncentive is set
 ### pool
 
 ```solidity
-function pool() external returns (address)
+function pool() external view returns (address)
 ```
 **Selector**: `0x16f0115b`
 

diff --git a/docs/Contracts/Plugin/lens/AlgebraOracleV1TWAP.md b/docs/Contracts/Plugin/lens/AlgebraOracleV1TWAP.md
@@ -62,7 +62,7 @@ Given a tick and a token amount, calculates the amount of token received in exch
 ### getAverageTick
 
 ```solidity
-function getAverageTick(address pool, uint32 period) external view returns (int24 timeWeightedAverageTick)
+function getAverageTick(address pool, uint32 period) external view returns (int24 timeWeightedAverageTick, bool isConnected)
 ```
 **Selector**: `0x57f32330`
 
@@ -82,6 +82,7 @@ It is recommended to check the latest available timestamp using the &#x60;latest
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | timeWeightedAverageTick | int24 | The time-weighted average tick from (block.timestamp - period) to block.timestamp |
+| isConnected | bool | Is oracle currently connected to the pool. If disconnected data can be obsolete |
 
 ### latestTimestamp
 
@@ -140,6 +141,27 @@ Returns the index of last record written in the oracle
 | ---- | ---- | ----------- |
 | [0] | uint16 |  |
 
+### isOracleConnected
+
+```solidity
+function isOracleConnected(address pool) external view returns (bool connected)
+```
+**Selector**: `0x9905d9a5`
+
+Whether or not the oracle is connected to the liquidity pool
+
+*Developer note: Oracle should not be used if disconnected from pool*
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| pool | address |  |
+
+**Returns:**
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| connected | bool |  |
+
 ### oldestIndex
 
 ```solidity

diff --git a/docs/Contracts/Plugin/lens/IAlgebraOracleV1TWAP.md b/docs/Contracts/Plugin/lens/IAlgebraOracleV1TWAP.md
@@ -53,7 +53,7 @@ Given a tick and a token amount, calculates the amount of token received in exch
 ### getAverageTick
 
 ```solidity
-function getAverageTick(address pool, uint32 period) external view returns (int24 timeWeightedAverageTick)
+function getAverageTick(address pool, uint32 period) external view returns (int24 timeWeightedAverageTick, bool isConnected)
 ```
 **Selector**: `0x57f32330`
 
@@ -73,6 +73,7 @@ It is recommended to check the latest available timestamp using the &#x60;latest
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | timeWeightedAverageTick | int24 | The time-weighted average tick from (block.timestamp - period) to block.timestamp |
+| isConnected | bool | Is oracle currently connected to the pool. If disconnected data can be obsolete |
 
 ### latestTimestamp
 
@@ -150,3 +151,24 @@ Returns the index of oldest record available in the oracle
 | ---- | ---- | ----------- |
 | [0] | uint16 |  |
 
+### isOracleConnected
+
+```solidity
+function isOracleConnected(address pool) external view returns (bool connected)
+```
+**Selector**: `0x9905d9a5`
+
+Whether or not the oracle is connected to the liquidity pool
+
+*Developer note: Oracle should not be used if disconnected from pool*
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| pool | address |  |
+
+**Returns:**
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| connected | bool |  |
+