Merge pull request #155 from VenusProtocol/docs/ven-2352

Author: 0xlucian

SUMMARY.md

@@ -127,6 +127,7 @@
     * [BinanceOracle](technical-reference/reference-oracle/oracles/binance-oracle.md)
     * [TwapOracle](technical-reference/reference-oracle/oracles/twap-oracle.md)
     * [PythOracle](technical-reference/reference-oracle/oracles/pyth-oracle.md)
+    * [WstETHOracle](technical-reference/reference-oracle/oracles/wstethoracle.md)
 * [Governance](technical-reference/reference-governance/README.md)
   * [AccessControlManager](technical-reference/reference-governance/access-control-manager.md)
   * [GovernorBravoDelegate](technical-reference/reference-governance/governor-bravo-delegate.md)

deployed-contracts/oracles.md

@@ -27,6 +27,7 @@
 * Bound Validator:[`0x1Cd5f336A1d28Dff445619CC63d3A0329B4d8a58`](https://etherscan.io/address/0x1Cd5f336A1d28Dff445619CC63d3A0329B4d8a58)
 * Chainlink Oracle:[`0x94c3A2d6B7B2c051aDa041282aec5B0752F8A1F2`](https://etherscan.io/address/0x94c3A2d6B7B2c051aDa041282aec5B0752F8A1F2)
 * RedStone Oracle:[`0x0FC8001B2c9Ec90352A46093130e284de5889C86`](https://etherscan.io/address/0x0FC8001B2c9Ec90352A46093130e284de5889C86)
+* WSTETH Oracle:[`0x987F64F99cA9441D9BD141a34E195818961cCBa6`](https://etherscan.io/address/0x987F64F99cA9441D9BD141a34E195818961cCBa6)
 * Resilient Oracle:[`0xd2ce3fb018805ef92b8C5976cb31F84b4E295F94`](https://etherscan.io/address/0xd2ce3fb018805ef92b8C5976cb31F84b4E295F94)
 * DefaultProxyAdmin:[`0x567e4cc5e085d09f66f836fa8279f38b4e5866b9`](https://etherscan.io/address/0x567e4cc5e085d09f66f836fa8279f38b4e5866b9)
 
@@ -35,6 +36,7 @@
 * Bound Validator:[`0x60c4Aa92eEb6884a76b309Dd8B3731ad514d6f9B`](https://sepolia.etherscan.io/address/0x60c4Aa92eEb6884a76b309Dd8B3731ad514d6f9B)
 * Chainlink Oracle:[`0x102F0b714E5d321187A4b6E5993358448f7261cE`](https://sepolia.etherscan.io/address/0x102F0b714E5d321187A4b6E5993358448f7261cE)
 * RedStone Oracle:[`0x4e6269Ef406B4CEE6e67BA5B5197c2FfD15099AE`](https://sepolia.etherscan.io/address/0x4e6269Ef406B4CEE6e67BA5B5197c2FfD15099AE)
+*  WSTETH Oracle:[`0x92E7F73B0d57902fDC453E8aef990EdEe827b0BF`](https://sepolia.etherscan.io/address/0x92E7F73B0d57902fDC453E8aef990EdEe827b0BF)
 * Resilient Oracle:[`0x8000eca36201dddf5805Aa4BeFD73d1EB4D23264`](https://sepolia.etherscan.io/address/0x8000eca36201dddf5805Aa4BeFD73d1EB4D23264)
 * DefaultProxyAdmin:[`0x01435866babd91311b1355cf3af488cca36db68e`](https://sepolia.etherscan.io/address/0x01435866babd91311b1355cf3af488cca36db68e)
 

risk/resilient-price-oracle.md

@@ -28,22 +28,28 @@ In implementing the Resilient Price Oracle, several safety measures have been ad
 
 <figure><img src="../.gitbook/assets/17b75928-d6a2-4207-9a0b-89d1d41690d4.png" alt=""><figcaption></figcaption></figure>
 
+
+### Pricing for Liquid Staked Tokens
+For LSTs (Liquid Staked Tokens) pricing, best practice suggests oracles quote the smart contract of the LST to derive its value in underlying token units and then multiply that by the USD price of the underlying. In Venus we use dedicated oracles for each LST asset in order to calculate the price as follows:
+*  convert the LST to the underlying tokens (using the exchange rate provided by the LST contract)
+*  convert the underlying token calculated in the previous step to USD, using a “traditional” oracle based on market price
+
+{% hint style="warning" %}
+It is worth mentioning that with this approach we assume 1:1 price ratio between the LST and the underlying asset (e.g. 1 ETH = 1 STETH). The primary risks involved with the above approach are related to smart contract vulnerabilities and other counterparty risks that could affect the redemption processes of the LSTs. In scenarios where there is substantial counterparty risk, notably if the underlying tokens are not redeemable against the LSTs, the direct smart contract pricing might become unreliable. Under such circumstances, it is prudent to switch to price oracles that derive quotes from secondary market prices, thereby maintaining pricing accuracy and reliability.
+{% endhint %}
+
 ### Further Reading
 
 For more detailed information, refer to the following resources:
 
-**Audit reports**
+#### Audit reports
 
-* [Peckshield audit report](https://github.com/VenusProtocol/oracle/blob/develop/audits/013\_oracles\_peckshield\_20230424.pdf)
-* [Certik audit report](https://github.com/VenusProtocol/oracle/blob/develop/audits/024\_oracles\_certik\_20230522.pdf)
-* [Hacken audit report](https://github.com/VenusProtocol/oracle/blob/develop/audits/016\_oracles\_hacken\_20230426.pdf)
+* [Resilient Price Oracle](../security-and-audits.md#oracles)
+* [Resilient Price Oracle upgrade](../security-and-audits.md#oracles-upgrade-2023-07-24)
+* [WstETH oracle](../security-and-audits.md#oracle-for-wsteth)
 
-**References**
+#### References
 
 * [Repository](https://github.com/VenusProtocol/oracle)
-* [Simulation pre/post upgrade](https://github.com/VenusProtocol/vips/pull/4/)
-* [Deployment on testnet](https://github.com/VenusProtocol/oracle/tree/develop/deployments/bsctestnet)
 * [Community post about Venus V4, introducing Resilient Price Feeds](https://community.venus.io/t/proposing-venus-v4/3188#price-feed-redundancy-6)
 * [Venus Stars blog post about Binance Oracle](https://venusstars.io/community/index.php/2023/05/09/venus-enhances-resilience-binance-oracle-feeds/)
-* [Community discussion about Pyth Oracle](https://community.venus.io/t/vip-xx-integrate-with-pyth-as-an-oracle/2723/6)
-* [RedStone’s proposal to be added to the interface](https://community.venus.io/t/adding-redstone-oracles-to-the-venus-oracle-interface/3620)

security-and-audits.md

@@ -8,6 +8,20 @@ We firmly believe that the true test of a smart contract's security lies in its
 
 ## Audits
 
+### Oracle for wstETH
+
+**Scope**: [Oracle for wstETH](https://github.com/VenusProtocol/oracle/blob/develop/contracts/oracles/WstETHOracle.sol), using the exchange rate `wstETH/stETH` from the `stETH` contract on Ethereum, assuming 1:1 for the conversion rate `stETH:ETH`, and converting `ETH` to `USD` using the Resilient Oracles.
+
+- [Certik audit audit report (2024/01/26)](https://github.com/VenusProtocol/oracle/blob/e99feb67f4677168632f5bedd70034fba8dc55db/audits/090_wstETHOracle_certik_20240126.pdf)
+
+<details>
+<summary>Detailed scope</summary>
+
+- Pull request [#155](https://github.com/VenusProtocol/oracle/pull/155) in the `oracle` repo
+    - contracts/oracles/WstETHOracle.sol
+
+</details>
+
 ### Token converters
 
 **Scope**: [Token converter contracts](https://github.com/VenusProtocol/protocol-reserve/pull/9). These contracts will allow the protocol to convert the income generated to the needed tokens, following the [Tokenomics](https://snapshot.org/#/venus-xvs.eth/proposal/0xc9d270ccecb7b91c75b95b8d9af24fc7c20cd38c0c0c44888ed4e7724f4e7ce9). Enabled in [VIP-245](https://app.venus.io/#/governance/proposal/245) and [VIP-248](https://app.venus.io/#/governance/proposal/248).

technical-reference/reference-oracle/oracles/wstethoracle.md

@@ -0,0 +1,75 @@
+# WstETHOracle
+This oracle returns the USD price of wstETH asset.
+Price is based on assumption that 1 stETH = 1 ETH.
+
+# Solidity API
+
+### STETH
+
+Address of stETH
+
+```solidity
+contract IStETH STETH
+```
+
+- - -
+
+### WSTETH_ADDRESS
+
+Address of wstETH
+
+```solidity
+address WSTETH_ADDRESS
+```
+
+- - -
+
+### WETH_ADDRESS
+
+Address of WETH
+
+```solidity
+address WETH_ADDRESS
+```
+
+- - -
+
+### RESILIENT_ORACLE
+
+Address of Resilient Oracle
+
+```solidity
+contract OracleInterface RESILIENT_ORACLE
+```
+
+- - -
+
+### constructor
+
+Constructor for the implementation contract.
+
+```solidity
+constructor(address wstETHAddress, address wETHAddress, address stETHAddress, address resilientOracleAddress) public
+```
+
+- - -
+
+### getPrice
+
+Gets the USD price of wstETH asset
+
+```solidity
+function getPrice(address asset) public view returns (uint256)
+```
+
+#### Parameters
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| asset | address | Address of wstETH |
+
+#### Return Values
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| [0] | uint256 | wstETH Price in USD scaled by 1e18 |
+
+- - -