Merge pull request #3 from joss-aztec/jcf/jun2021update-and-valuation

Document the  jun2021 update and asset valuation

docs/docs/zk-money/assetvaluation.md

@@ -0,0 +1,16 @@
+# Asset Valuation
+
+All dollar valuations seen in zk.money are derived with use of oracles provided by [Chainlink](https://chain.link/).
+
+| Asset | Chainlink Oracle                                                                                     |
+| ----- | ---------------------------------------------------------------------------------------------------- |
+| ETH   | [ethereum/mainnet/crypto-usd/eth-usd](https://data.chain.link/ethereum/mainnet/crypto-usd/eth-usd)   |
+| DAI   | [ethereum/mainnet/stablecoins/dai-usd](https://data.chain.link/ethereum/mainnet/stablecoins/dai-usd) |
+
+## wstETH
+
+Chainlink provides no direct oracle for wstETH, but does provide an [oracle for stETH](https://data.chain.link/ethereum/mainnet/crypto-usd/steth-usd). We use this stETH oracle in conjunction with the `getStETHByWstETH` method on the [Lido contract](https://etherscan.io/address/0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0#readContract) to calculate a wstETH dollar valuation.
+
+## Element fixed yield positions
+
+Over time we interpolate between the asset quantitiy locked in your position and its promised output. The interpolated quanity is then given a dollar valuation with use of Chainlink.

docs/docs/zk-money/june2021update.md

@@ -0,0 +1,27 @@
+# June 2021 Security Update
+
+TL;DR
+
+- This update is not part of the new zk.money migration process.
+- If you're being asked to update your account on [old.zk.money](https://old.zk.money), your alias is currently inaccessible in the new system. We are working to make it recoverable.
+
+If you have not logged into the old system since June 2021 you will be prompted to update your account before being able to login.
+
+### Explanation
+
+In June 2021 zk.money's key signing system was changed in two ways:
+
+1.  The signing message for generating an Aztec account public key was changed to be human readable (priorly a hex string)
+2.  Accounts were required to register a spending key, also derived by signing a human readable message, removing risk of funds being stolen via snooping keys from browser storage. (Priorly viewing and spending was done with a single key, which had to be stored.)
+
+To bring users onto this new system, it was necessary to have each user individually update their account by registering a new public key derived from the new signing message at the same time as transferring their alias and exist funds to this new public key.
+
+Users were (and still are) guided through the necessary steps to perform this update when attempting to log into the system. If today you are being prompted to update your account, it's because you haven't logged in since June 2021.
+
+## How this affects your alias on the new zk.money
+
+If you didn't login to your account between June 2021 and June 2022 your alias is currently in accessible in the new zk.money. The team is currently working on tool to enable users in this situation to transfer their inaccessible alias to a new account.
+
+### Explanation
+
+In June **2022** (roughly one year following the security update) the registrations of all existing aliases were copied into the new Aztec Connect system. The most recent rollup then was #3120, published 01 June 2022 09:59:23 UTC. This means that every migrated alias in the new system is associated with the last Aztec account public key to have registered it for that specific point in time. Aliases that were still associated with a public key generated from the retired signing message are currently inaccessible in the new zk.money because support for signing over the retired message was dropped as an oversight.

docs/docs/zk-money/troubleshooting.md

@@ -4,15 +4,15 @@
 
 Most "Account Not Registered" errors can be resolved with one of two methods:
 
-1) Double-checking your Ethereum address. Please connect to zk.money using the Ethereum address you used to sign up for your alias.
+1. Double-checking your Ethereum address. Please connect to zk.money using the Ethereum address you used to sign up for your alias.
 
-2) Mistyping or misremembering your alias. Remember that your alias is critical to access your account and forgetting or misplacing it means you may not be able to access your funds.
+2. Mistyping or misremembering your alias. Remember that your alias is critical to access your account and forgetting or misplacing it means you may not be able to access your funds.
 
 If either approach does not work, you may belong to one of the below cohorts whose account aliases were not migrated:
 
-1) Users who registered **prior** to July, 2021 but **did not do an account migration in the old system**. From July, 2021 to June, 2022, accounts were required to undergo an account migration that incremented user account nonces by 1. If you did not migrate prior to June, 2022, your alias was not moved to the new system. This includes users who attempted migration on old.zk.money after June, 2022.
+1. Users who registered **prior** to July, 2021 but **did not do an account migration in the old system**. From July, 2021 to June, 2022, accounts were required to undergo [a security update](june2021update.md). If you did not update prior to June, 2022, your alias is inaccessible in the new system. This includes users who attempted migration on old.zk.money after June, 2022.
 
-2) Users who forgot their alias after June, 2022 and had to go through the "Forgot alias" flow on old.zk.money. If you forgot your alias for old.zk.money and recovered your account using the "Forgot alias" flow, including registering a new alias, the new alias will NOT be migrated. Your old (forgotten) alias **has** been migrated if you want to try remembering it in the new system.
+2. Users who forgot their alias after June, 2022 and had to go through the "Forgot alias" flow on old.zk.money. If you forgot your alias for old.zk.money and recovered your account using the "Forgot alias" flow, including registering a new alias, the new alias will NOT be migrated. Your old (forgotten) alias **has** been migrated if you want to try remembering it in the new system.
 
 ###
 
@@ -34,6 +34,6 @@ If you are using Firefox, open the browser console (F12 or right click and selec
 
 ## Frequently Asked Questions
 
-Check the [frequently asked questions page](/how-aztec-works/faq) to see if your problem is addressed there. 
+Check the [frequently asked questions page](/how-aztec-works/faq) to see if your problem is addressed there.
 
 If it isn't, join our [Discord server](https://discord.com/invite/UDtJr9u) and get an answer from the community.

docs/sidebars.js

@@ -116,9 +116,12 @@ const sidebars = {
     "glossary",
   ],
   zkmoneySidebar: [
-    "zk-money/userguide", 
+    "zk-money/userguide",
     "zk-money/fees",
-    "zk-money/troubleshooting"],
+    "zk-money/assetvaluation",
+    "zk-money/troubleshooting",
+    "zk-money/june2021update",
+  ],
 };
 
 module.exports = sidebars;