[#131] TZIP 12 Updates implementing storage views and storage field changes. #151
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sras
force-pushed
the
sras/#131-tzip-12-oc-views
branch
6 times, most recently
from
6424024 to
93a41df
Compare
gromakovsky
reviewed
Dec 25, 2020
| -- possible to originate the contract. | ||
| -- | ||
| -- TODO: once we move the metadata to its own contract, we can | ||
| -- add this info back to the metadata. |
There was a problem hiding this comment.
Hm, can we add it back already?
sras
force-pushed
the
sras/#131-tzip-12-oc-views
branch
3 times, most recently
from
f8043ed to
093e8f4
Compare
sras
force-pushed
the
sras/#131-tzip-12-oc-views
branch
5 times, most recently
from
8171f26 to
54ac0f4
Compare
pasqu4le
reviewed
Jan 4, 2021
pasqu4le
reviewed
Jan 5, 2021
sras
force-pushed
the
sras/#131-tzip-12-oc-views
branch
from
fe4d8b6 to
3cb14ac
Compare
pasqu4le
reviewed
Jan 6, 2021
There was a problem hiding this comment.
LGTM, only a couple nitpick comments and additionally a couple of things in commit messages:
-
registerytypo in 948b84d -
in 3cb14ac it says:
This includes. Some of the major changes are.
seems a bit redundant, it should probably be:
Some of the major changes include:
I'll approve already, feel free to merge with these few little changes
sras
force-pushed
the
sras/#131-tzip-12-oc-views
branch
from
275e74e to
5c2b1a2
Compare
Problem: The token metadata registry entrypoint has been removed from TZIP-12. We have the option to keep the token metadata as annotated bigmap in storage, but we have decided to implement it as an offchain storage view. So we have to remove the metadata registry entrypoint as well as the corresponding field from the storage. Solution: Token metadata registry storage field is removed. The entrypoint is removed as well. The tests that check for token metadata registry field in storage is removed as well.
Problem: We have to add storage views as required by TZIP-12. Solution: Implement the storage views and include them in TZIP-16 metadata. Origination procedures during tests have been changed to remove the token metadata registry contract origination. In addition to this, the procedure to implement the stablecoin-client commands like `getBalance` and `getTokenMetadata` has been changed to follow the metadata URI (currently only tezos-storage scheme is supported), and fetch and execute the views on the storage. This is not currently working because of inability to fetch whole storage. The `morley-metadata` dependency has also been bumped to use the new DSL for buidling metadata. Both the main contract metadata and FA1.2 variant has been updated to use it. Apart from this, some testing infra (`checkView` function) has been moved to `Test.Common` module from the tests for permits that checks the behavior of views. And it has been used in tests for the new storage views.
problem: Earlier we called the contract metadata as TZIP16-metadata to contrast with the token metadata. But now the token metadata has been moved to tzip-16 metadata. So we only have one metadata, and we can call it just "metadata". solution: Remove the old metadata contract, and rename the tzip16-metadata.ligo file as simply 'metadata.ligo'. Make the corresponding change in code, and build configurations.
problem: The morley-metadata repo has got some changes to the metadata record, and is incompatible with the current code. solution: Update the morly-metadata dependency and use the new infra to construct the metadata.
The get-token-metadata stablecoin client call was broken due to the view being run on a `StorageView` instead of `Storage`. But it has been fixed by using a modified version of `StorageView` with empty bigmaps so that it is changed to a `Storage` with with the `GetTokenMetadata` view is interpreted.
Adds back some FA1.2 metadata that was previously disable due to storage constraints. We can add it back since we are storing metadata in external contract.
Problem: We have made some changes in this PR to the contract's interface, so we should update it in changelog. Solution: Update the changelog.
Problem: As part of this PR, we have made some new changes to the morley-metadata dependencies. So we should update their versions and also should use the new infra from them. Solution: Bump the dependencies, and use the infra from them. Some of the major changes include: * Add custom instances for FA2 param. We have change morley-ledgers FA2 parameter not to be bundled with it's generic instance. This is so that we can customize the instance to match with FA2 parameter of this contract. * Port 'checkView' to morley-metadata and use it here This function, since it appeared to be a useful one generally, was moved to morley-metadata repo. * Move tezosStorageSchema to morley-metadata This was just being duplicated here. So we now use this symbol imported from morley-metadata.
sras
force-pushed
the
sras/#131-tzip-12-oc-views
branch
from
5c2b1a2 to
2500dce
Compare
pasqu4le
approved these changes
Jan 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Removes token-metadata-registry entrypoint and storage fields from contract. Add storage views as requried by tzip-12 and move token metadata to TZIP-16 storage view. Update tests and update stablecoin-client to read token-metadata from the TIP-16 metadata.
Related issue(s)
Resolves #131
✅ Checklist for your Pull Request
Related changes (conditional)
Tests
silently reappearing again.
Documentation
not essential.
Stylistic guide (mandatory)