Added sharePrice view function

pods-finance · Nov 8, 2022 · 820fbfd · 820fbfd
1 parent 61504ab
commit 820fbfd
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/abi/STETHVault.json b/abi/STETHVault.json
@@ -1319,6 +1319,19 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "sharePrice",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "sharePriceDecimals",

diff --git a/contracts/vaults/STETHVault.sol b/contracts/vaults/STETHVault.sol
@@ -48,6 +48,14 @@ contract STETHVault is BaseVault {
         sharePriceDecimals = _asset.decimals();
     }
 
+    /**
+     * @notice Return the stETH price per share
+     * @dev Each share is considered to be 10^(assets.decimals())
+     */
+    function sharePrice() external view returns (uint256) {
+        return totalAssets().mulDiv(10**sharePriceDecimals, totalSupply(), Math.Rounding.Down);
+    }
+
     function _afterRoundStart() internal override {
         uint256 supply = totalSupply();
 

diff --git a/test/vaults/STETHVault.ts b/test/vaults/STETHVault.ts
@@ -306,7 +306,7 @@ describe('STETHVault', () => {
   })
 
   describe('Events', () => {
-    it('endSharePrice should be consistent with the vault state', async () => {
+    it.only('endSharePrice should be consistent with the vault state', async () => {
       // This test will only work if InvestRatio = 50%
       const assetAmount = ethers.utils.parseEther('100')
 
@@ -334,6 +334,7 @@ describe('STETHVault', () => {
       await asset.connect(yieldGenerator).transfer(investor.address, ethers.utils.parseEther('100'))
       const endRoundTx2 = await vault.connect(vaultController).endRound()
       await expect(endRoundTx2).to.emit(vault, 'SharePrice').withArgs('2', '1050000000000000000', '1614695121951219512')
+      expect(await vault.sharePrice()).to.be.equal('1614695121951219512')
     })
   })