Chore: scripts & docs update

README.md

@@ -7,7 +7,7 @@ The oTokens created by Gamma are cash settled European option, means all the opt
 
 ## Documentation
 
-Our docs site is [here](https://opyn.gitbook.io/opyn-v2/get-started/getting-started/). It contains tutorials, explainers, and smart contract documentation. If you'd like to view these docs on github instead, check out [the docs folder](/docs) in the docs repo:
+Our docs site is [here](https://opyn.gitbook.io/opyn/getting-started/introduction). It contains tutorials, explainers, and smart contract documentation. If you'd like to view these docs on github instead, check out [the docs folder](/docs) in the docs repo:
 
 - [Smart contracts documentation](SUMMARY.md)
 - [UML diagrams](/docs/uml)
@@ -44,7 +44,10 @@ In a new terminal, launch an Ethereum RPC client, we use the default ganache-cli
 $ npm run ganache
 ```
 
-Switch back to your other terminal and deploy the contracts, and make sure to to setup the deployments parameters in `./migrations/deployment-config.json` file:
+Switch back to your other terminal and deploy the contracts, and make sure to:
+- Add your infura key in `.infuraKey` file
+- Add your wallet mnemonic in `.secret` file
+- Setup the deployments parameters in `./migrations/deployment-config.json` file
 
 ```sh
 # Local deployment

docs/contracts-documentation/core/Oracle.md

@@ -6,6 +6,10 @@ manages pricers that are used for different assets
 
 ## Functions:
 
+- `migrateOracle(address _asset, uint256[] _expiries, uint256[] _prices) (external)`
+
+- `endMigration() (external)`
+
 - `setAssetPricer(address _asset, address _pricer) (external)`
 
 - `setLockingPeriod(address _pricer, uint256 _lockingPeriod) (external)`
@@ -54,6 +58,26 @@ manages pricers that are used for different assets
 
 - `StablePriceUpdated(address asset, uint256 price)`
 
+### Function `migrateOracle(address _asset, uint256[] _expiries, uint256[] _prices) external`
+
+function to mgirate asset prices from old oracle to new deployed oracle
+
+this can only be called by owner, should be used at the deployment time before setting Oracle module into AddressBook
+
+#### Parameters:
+
+- `_asset`: asset address
+
+- `_expiries`: array of expiries timestamps
+
+- `_prices`: array of prices
+
+### Function `endMigration() external`
+
+end migration process
+
+can only be called by owner, should be called before setting Oracle module into AddressBook
+
 ### Function `setAssetPricer(address _asset, address _pricer) external`
 
 sets the pricer for an asset

docs/contracts-documentation/libs/FixedPointInt256.md

@@ -52,11 +52,11 @@ Examples:
 
 (1)  USDC    decimals = 6
 
-Input:  5 * 1e6 USDC  =>    Output: 5 * 1e27 (FixedPoint 8.0 USDC)
+Input:  5 * 1e6 USDC  =>    Output: 5 * 1e27 (FixedPoint 5.0 USDC)
 
 (2)  cUSDC   decimals = 8
 
-Input:  5 * 1e6 cUSDC =>    Output: 5 * 1e25 (FixedPoint 0.08 cUSDC)
+Input:  5 * 1e6 cUSDC =>    Output: 5 * 1e25 (FixedPoint 0.05 cUSDC)
 
 #### Parameters: