POC legacy mechanism alternative #938
Conversation
| "ExchangeState", | ||
| "FeePoolEternalStorage", | ||
| "FeePoolState", | ||
| "Proxy", |
There was a problem hiding this comment.
So this should be the name of the actual contract label - not just the source - so ProxySynthetix for instance. Though it would be cumbersome to list all possible proxies. Perhaps instead these entries can be a regex?
There was a problem hiding this comment.
Correct, and this is the current functionality. For example, TokenState in this list will cause TokenStateSynthetix, TokenStatesUSD, TokenStateJPY etc to be considered non-upgradeable.
There was a problem hiding this comment.
Ah right sorry I missed the includes. Perhaps it's better to have a pattern match of /^.../ to ensure it starts with not just includes?
There was a problem hiding this comment.
Hmmm... would ReadProxyAddressResolver be upgradeable?
There was a problem hiding this comment.
But a new ReadProxy would be ok if we needed one. So perhaps the whole ReadProxyAddressResolver is best?
Considers the removal of legacy contracts, their compilation, and their inclusion in tests.
In short, a legacy contract is an old contract, that is not supposed to ever be upgraded. This is because of the proxy mechanism used in Synthetix v2, which cannot persist state between upgrades, and thus needs central state to be isoplated in separate contracts. Legacy contracts are compiled when running
npm run test:legacy. This runs the unit tests, but hacks the mocha require statement to go fetch legacy contracts, instead of official ones, which ensures that new contract code will work with these non-upgradeable contracts.The mechanism described above is rather complex, and might be overkill. Instead, we propose an alternative lightweight mechanism which "complains" if a developer attempts to change a contract marked as non-upgradeable.