Start reviewing Primitive.Types docs
#243
Conversation
| @@ -399,10 +399,10 @@ instance Buildable TxStatus where | |||
| InLedger -> "in ledger" | |||
| Invalidated -> "invalidated" | |||
|
|
|||
| -- | The flow of funds in to or out of a wallet. | |||
| -- | The @Direction@ of a transaction - will the wallet balance decrease or not? | |||
There was a problem hiding this comment.
According to cardano-sl:
A transaction is outgoing when it decreases the wallet’s balance
There was a problem hiding this comment.
The constructor field comments are good. The rhetorical question in the data type comment is not good. I like "The flow of funds in to or out of a wallet", or "The effect of a Transaction on the wallet balance."
| @@ -146,6 +144,8 @@ import qualified Data.Text.Encoding as T | |||
| Wallet Metadata | |||
| -------------------------------------------------------------------------------} | |||
|
|
|||
| -- | @WalletMetadata@ stores additional information that is of interest to the | |||
| -- API. | |||
There was a problem hiding this comment.
interest to the API
It seemed to me like this was the most honest way of describing it as we don't really care about it in the Primitive/ folder
There was a problem hiding this comment.
It's the place where we store information about the wallet which isn't transactional, isn't key related, and isn't updated every time a block is applied. (Actually the WalletState is updated after applying blocks - maybe this field can be easily calculated anyway).
There was a problem hiding this comment.
Interesting point, thanks.
I suspect the same would go for delegation…
Anviking
force-pushed
the
anviking/220/primitive-type-docs
branch
from
02ca8ca to
812c768
Compare
Anviking
changed the title
Primitive.Types docsPrimitive.Types docs
Anviking
force-pushed
the
anviking/220/primitive-type-docs
branch
3 times, most recently
from
ec359de to
1cfb28b
Compare
Anviking
force-pushed
the
anviking/220/primitive-type-docs
branch
from
1cfb28b to
0d18b0e
Compare
|
Looks good :) |
Issue Number
#220
Overview
WalletMetadataandDirectionComments