TxSubmission2 protocol #2807

coot · 2020-12-11T09:25:11Z

This series of patches introduce 'Hello' protocol transformer. It is included
under Protocol.Trans module name space (similar to monad transformers). The
TxSubmission2 protocol is TxSubmission wrapped in Hello transformer.

TxSubmission2 protocol will be used from version NodeToNodeV_6.

typed-protocols: fmapPeerPipelined
ouroboros-network: Hello protocol wrapper
tx-submission: expose more codec functions
TxSubmission2: protocol
TxSubmission2: tests
tx-submission: missing case in id codec

This patch fixes a bug in codecTxSubmissionId, it also adds a test which
would discoverit. KMsgThx is not used anywhere hance the bug wasn't
discovered.
TxSubmission2: use in node-to-node v6 protocol

dcoutts

Mostly just name suggestions.

But also an important one about the encoding for the hello codec.

dcoutts · 2020-12-11T12:23:33Z

typed-protocols/src/Network/TypedProtocol/Pipelined.hs

@@ -16,6 +16,7 @@ module Network.TypedProtocol.Pipelined
  , Nat (Zero, Succ)
  , natToInt
  , unsafeIntToNat
+  , fmapPeerPipelined


If we're adding something like this, we should do it consistently for the non-pipelined case too.

We want to publish this package too.

Sure, so you'd like to export an id function? ;)

fmapPeer :: (Peer ps pr st m a -> Peer ps' pr st' m b) -> Peer ps pr st m a -> Peer ps' pr st' m b fmapPeer f = f

But what we can do is to add 'Functor' instances to both 'Peer' and 'PeerPipelined'.

Fair point, that wouldn't make sense. If we can do Functor instances though then yes we should do that.

An Applicative instance be useful too. It would give poor man's multiplexer in IO, but a much nicer one using Concurrently wrapper from async. But that's for another PR.

Hmm, writing pure :: a -> m a requires to know which state is the final one, some protocols might not even have a single final state.

Also ap is only possible for some protocols. it's type signature is similar to connect.

ouroboros-network/src/Ouroboros/Network/Protocol/Trans/Hello/Type.hs

ouroboros-network/src/Ouroboros/Network/Protocol/Trans/Hello/Codec.hs

ouroboros-network/src/Ouroboros/Network/Protocol/Trans/Hello/Util.hs

The comment was addressed.

Protocol transformer which transforms initial agency.

This will allow to define the codec of TxSubmission2 protocol the using TxSubmission codec.

This patch provides a type alias for tx-submission protocol wrapped using the Hello protocol transformer. Codec and protocol limits are provided also in terms of the original codec / protocol limits.

By exposing some of TxSubmission test utilities this patch provides a test suite for TxSubmission2 protocol.

Includes a test.

dcoutts

LGTM!

dcoutts · 2020-12-19T22:20:39Z

typed-protocols/src/Network/TypedProtocol/Pipelined.hs

@@ -16,6 +16,7 @@ module Network.TypedProtocol.Pipelined
  , Nat (Zero, Succ)
  , natToInt
  , unsafeIntToNat
+  , fmapPeerPipelined


Fair point, that wouldn't make sense. If we can do Functor instances though then yes we should do that.

typed-protocols/src/Network/TypedProtocol/Core.hs

dcoutts · 2020-12-19T22:22:55Z

ouroboros-network/src/Ouroboros/Network/Protocol/Trans/Hello/Codec.hs

+               -> Message (Hello ps stIdle) st st'
+               -> CBOR.Encoding
+    encodeHello (ClientAgency TokHello) MsgHello =
+      encodeListLen 1 <> encodeWord helloTag


Or we could generalise over the whole hello Encoding, not just a Word. Doesn't matter at the moment.

Unfortunately not, it would need to go through Codec.Cbor.Term.Term or something like that: the decoder is in CPS style.

coot · 2020-12-20T07:46:15Z

bors merge

iohk-bors · 2020-12-20T08:15:58Z

Build succeeded:

Note that this does not incorporate the latest changes in cardano-ledger-specs. Notable changes: * IntersectMBO/ouroboros-network#2807 * IntersectMBO/ouroboros-network#2811 * IntersectMBO/ouroboros-network#2832

Note that this does not incorporate the latest changes in cardano-ledger-specs. Notable changes: * IntersectMBO/ouroboros-network#2807 * IntersectMBO/ouroboros-network#2811 * IntersectMBO/ouroboros-network#2832 network tracers: moved ToObject TxSubmission instance network tracers: added ToObjcet TxSubmission2 instance

Note that this does not incorporate the latest changes in cardano-ledger-specs. Notable changes: * IntersectMBO/ouroboros-network#2807 * IntersectMBO/ouroboros-network#2811 * IntersectMBO/ouroboros-network#2832 network tracers: moved ToObject TxSubmission instance network tracers: added ToObjcet TxSubmission2 instance Update cabal.project index-state value

2274: Update dependencies r=kderme a=mrBliss Note that this does not incorporate the latest changes in cardano-ledger-specs. Notable changes: * IntersectMBO/ouroboros-network#2807 * IntersectMBO/ouroboros-network#2811 * IntersectMBO/ouroboros-network#2832 Co-authored-by: Thomas Winant <thomas@well-typed.com> Co-authored-by: Hamish Mackenzie <Hamish.K.Mackenzie@gmail.com>

Note that this does not incorporate the latest changes in cardano-ledger-specs. Notable changes: * IntersectMBO/ouroboros-network#2807 * IntersectMBO/ouroboros-network#2811 * IntersectMBO/ouroboros-network#2832 network tracers: moved ToObject TxSubmission instance network tracers: added ToObjcet TxSubmission2 instance Update cabal.project index-state value

2274: Update dependencies r=kderme a=mrBliss Note that this does not incorporate the latest changes in cardano-ledger-specs. Notable changes: * IntersectMBO/ouroboros-network#2807 * IntersectMBO/ouroboros-network#2811 * IntersectMBO/ouroboros-network#2832 Co-authored-by: Thomas Winant <thomas@well-typed.com> Co-authored-by: Hamish Mackenzie <Hamish.K.Mackenzie@gmail.com>

coot added networking tx-submission Issues related to tx-submission protocol labels Dec 11, 2020

coot requested a review from dcoutts December 11, 2020 09:25

coot force-pushed the coot/hello-protocol-wrapper branch from 57a0917 to cfacdd8 Compare December 11, 2020 09:32

coot force-pushed the coot/hello-protocol-wrapper branch from cfacdd8 to 6f4abf2 Compare December 11, 2020 09:55

dcoutts previously requested changes Dec 11, 2020

View reviewed changes

coot force-pushed the coot/hello-protocol-wrapper branch from 6f4abf2 to 42105ea Compare December 11, 2020 16:08

coot requested a review from dcoutts December 11, 2020 16:22

coot force-pushed the coot/hello-protocol-wrapper branch from 42105ea to 07733ba Compare December 11, 2020 16:28

coot added 8 commits December 11, 2020 18:09

typed-protocols: fmapPeerPipelined

5c7b20c

typed-protocols: Functor instances for Peer and PeerPipelined

6859c52

Hello protocol transformer

9164e71

Protocol transformer which transforms initial agency.

tx-submission: expose more codec functions

df35473

This will allow to define the codec of TxSubmission2 protocol the using TxSubmission codec.

tx-submission-2: protocol

07e7772

This patch provides a type alias for tx-submission protocol wrapped using the Hello protocol transformer. Codec and protocol limits are provided also in terms of the original codec / protocol limits.

tx-submission-2: tests

e5be0e6

By exposing some of TxSubmission test utilities this patch provides a test suite for TxSubmission2 protocol.

tx-submission: missing case in id codec

c978180

Includes a test.

tx-submission-2: use in node-to-node v6 protocol

c2d6245

coot force-pushed the coot/hello-protocol-wrapper branch from 07733ba to c2d6245 Compare December 11, 2020 17:09

dcoutts approved these changes Dec 19, 2020

View reviewed changes

iohk-bors bot merged commit 1c4b3c7 into master Dec 20, 2020

iohk-bors bot deleted the coot/hello-protocol-wrapper branch December 20, 2020 08:16

mrBliss mentioned this pull request Jan 12, 2021

Update dependencies IntersectMBO/cardano-node#2274

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TxSubmission2 protocol #2807

TxSubmission2 protocol #2807

coot commented Dec 11, 2020

dcoutts left a comment

dcoutts Dec 11, 2020

coot Dec 11, 2020

coot Dec 11, 2020

dcoutts Dec 19, 2020

coot Dec 20, 2020

coot Dec 20, 2020

coot Dec 20, 2020

dcoutts left a comment

dcoutts Dec 19, 2020

dcoutts Dec 19, 2020

coot Dec 20, 2020

coot commented Dec 20, 2020

iohk-bors bot commented Dec 20, 2020

TxSubmission2 protocol #2807

TxSubmission2 protocol #2807

Conversation

coot commented Dec 11, 2020

dcoutts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcoutts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coot commented Dec 20, 2020

iohk-bors bot commented Dec 20, 2020