This repository has been archived by the owner on Aug 18, 2020. It is now read-only.
[CBR-305] SafeCopy instances for InDb types #3381
Merged
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
cleverca22
reviewed
Aug 11, 2018
| bs :: B.ByteString <- SC.safeGet | ||
| pure (InDb (Core.RedeemPublicKey (Ed25519.PublicKey bs))) | ||
| putCopy (InDb (Core.RedeemPublicKey pk)) = SC.contain $ do | ||
| SC.safePut (Ed25519.unPublicKey pk :: B.ByteString) |
There was a problem hiding this comment.
src/Cardano/Wallet/Kernel/DB/InDb.hs:264:17: warning: [-Wdeprecations]
In the use of ‘unPublicKey’ (imported from Crypto.Sign.Ed25519):
Deprecated: "This accessor is deprecated, and will be removed in a future version. Use @'openPublicKey'@ instead."
|
264 | SC.safePut (Ed25519.unPublicKey pk :: B.ByteString)
| ^^^^^^^^^^^^^^^^^^^
<no location info>: error:
Failing due to -Werror.
parsonsmatt
changed the title
|
QuickCheck properties are still missing, but the instances are done. |
Neat, we got test failures 😄 |
erikd
reviewed
Aug 23, 2018
|
|
||
| instance SC.SafeCopy (InDb Core.Coin) where | ||
| getCopy = SC.contain $ do | ||
| w :: Word64 <- SC.safeGet |
erikd
reviewed
Aug 23, 2018
|
|
||
| instance SC.SafeCopy (InDb Txp.TxAux) where | ||
| getCopy = SC.contain $ do | ||
| InDb (tx :: Txp.Tx) <- SC.safeGet |
There was a problem hiding this comment.
I also personally prefer 2 space indent, but this code ....
There was a problem hiding this comment.
Yeah, I'll get the style right before merging it all in. I'm mostly concerned about the correctness issues and failing tests atm
erikd
reviewed
Aug 23, 2018
| @@ -1,4 +1,5 @@ | |||
| {-# OPTIONS_GHC -fno-warn-orphans #-} | |||
There was a problem hiding this comment.
Why does this need to alllow orphans? I don't immediately see it.
There was a problem hiding this comment.
Good catch! We can safely remove that warning :)
edsko
approved these changes
Aug 23, 2018
| putCopy (InDb (AddressMeta isUsed isChange)) = contain $ do | ||
| safePut isUsed | ||
| safePut isChange | ||
|
|
There was a problem hiding this comment.
This instance is superfluous, InDb should only be used to tag types defined in core, anything defined by the wallet itself (that we have control ovr) we can just use deriveSafeCopy.
| {------------------------------------------------------------------------------- | ||
| Wrap core types so that we can make independent serialization decisions | ||
| -------------------------------------------------------------------------------} | ||
|
|
||
| -- | Wrapped type (with potentially different 'SafeCopy' instance) | ||
| -- | Wrapped type (with potentially different 'SC' instance) |
|
Thanks for this @parsonsmatt ! As agreed, I'll take it from here, let's get this thing done and merged :) |
|
Fixed the tests. Am now going to rebase, then force push. |
Also placate hlint, stylish-haskell, stack2nix
|
I recompiled the {-# OPTIONS_GHC -ddump-ds -ddump-to-file #-}and grepped for In other words, none from core! Perfect :) |
|
Merging into |
|
Muchas gracias :) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Some things to keep in mind:
Round-trip QuickCheck tests are missing.
The basic approach to defining instances for types wrapped in
InDbis described in the code:There are a lot of redundant type signatures. This is deliberate, so that changing the definition of a datatype in the future triggers a type-checker error if possible.