How do you use the Diamond Pattern for escrow upgrades?

Question

I am creating a contract with the diamond pattern so I can evolve and add new features to my contract.

Contract facets:

1. Contract A: an ERC721 that takes care of minting its own NFTs
2. Contract B: Business logic that takes user NFTs and mints new NFTs
3. Contract C: Utility contract with essential function calls

I want to store the user's NFT and return it back to the user on returning the minted NFT. However, if I upgrade any contract, all NFTs held will be unusable by the new contract.

How should I implement such a vault account implementation?

Answer 1

When you upgrade one of your "facet"s, you are updating the code for that specific part of your "diamond"s functionality, this means that the logic may be different but the data remains inside of your diamond.

For example, if you update one part of your diamond, such as "Contract B", the minting mechanism will be altered, however, the data that tracks who owns which NFT will still exist inside your diamond wherever you decide to store that data.

Here is a diagram from the official ERC-2535 EIP:

Swapping out Facet B for a newer version won't affect the data stored inside DiamondStorage2.