Add Jörmungandr Servant Api Type #310
Conversation
|
@Anviking Think about spreading the work over multiple PRs here. You don't have to implement all the endpoint at once. Start with one, and go incrementally 🙏 |
Anviking
force-pushed
the
anviking/219/jörmungandr-network
branch
2 times, most recently
from
15c4cac
to
8f89736
Compare
Anviking
changed the title
Anviking
force-pushed
the
anviking/219/jörmungandr-network
branch
4 times, most recently
from
0472d86
to
b65b5f4
Compare
| data BlockHeader = BlockHeader | ||
| { version :: Word16 | ||
| , contentSize :: Word32 | ||
| , slot :: SlotId | ||
| , chainLength :: Word32 | ||
| , contentHash :: Hash "content" | ||
| , parentHeaderHash :: Hash "parentHeader" | ||
| , parentHeaderHash :: Hash "BlockHeader" |
There was a problem hiding this comment.
To match with the one in Cardano.Primitive.Types (BlockHeader)
| instance FromBinary Block where | ||
| get = getBlock | ||
|
|
||
| instance FromBinary W.Block where |
There was a problem hiding this comment.
The Block type in this module contain more information than the one in Cardano.Wallet.Primitive.Types (W.Block).
| -- TODO: Replace SignedTx with something real | ||
| data SignedTx | ||
|
|
||
| newtype BlockId = BlockId (Hash "block") |
There was a problem hiding this comment.
Could also have ApiT, but the jörmungandr api use the term "BlockId" which this newtype can capture.
Anviking
force-pushed
the
anviking/219/jörmungandr-network
branch
from
b65b5f4
to
e92b8e8
Compare
| :> "block" | ||
| :> Capture "blockId" BlockId | ||
| :> QueryParam "count" Int | ||
| :> Get '[OctetStream] [BlockId] |
There was a problem hiding this comment.
I am not sure OctetStream is the best fit here. We actually know the format of the API we're talking to. So it's not just plain bytes. I'd suggest to define some custom format like Jormungandr or BetterCBOR or any name that fits to describe the format, and makes it clear that we're still expecting things in a particular format (whereas OctetStream conveys the idea of a stream of bytes without any particular structure).
This will also prevent the orphan 👍
Anviking
force-pushed
the
anviking/219/jörmungandr-network
branch
4 times, most recently
from
c78975a
to
5793f43
Compare
- Servant type in the .Api module, with Plain and Binary content types. - I added a FromBinary class in the binary module to play nicely with the Binary content-type
KtorZ
force-pushed
the
anviking/219/jörmungandr-network
branch
from
5793f43
to
586c722
Compare
Issue Number
#219
Overview
FromBinaryclass inCardano.Wallet.Binary.JörmungandrCardano.Wallet.Network.Jörmungandr.Apiwhere theOctetStreamcontent type relies on theFromBinaryclass.Comments
FromBinary, orphans, etc