Add gRPC gateway endpoints for the RPC APIs. This will allow the RPCs to be available on HTTP.

Add annotations and generate basic openapi spec for docs.

Currently, we have 2 protocols already. By the time this issue is started we might have another one. They are using msgpack encoding right now to exchange messages. Instead they should use protobuf implementation.

Tasks:

1. Define the protobuf messages. These would be similar to the existing structs used.
2. Generate pb files for the proto specs.
3. Update the protocols to use the new types and use the protobuf encoder/decoder to read/write.
4. Update any tests required in the protocols.

• Setup opentelemetry tracing support
• Setup spans for relevant packages
• Use datadog? or other open source tools to start observing the traces

• Ensure user input validation errors provide constructive ways to improve

Implement the topology implementation following the interfaces already defined.

Currently the implementation would be simple as the network is small.

• Commitment has a implication as a cryptographic commitment, which is confusing because the pre-confimration protocol will use commitments to produce privacy.

[todo]

Implement simple CLI to instantiate the node and run the p2p client.

Following integration of settlement layer devnet, an e2e testing framework should be introduced. There's a lot of flavors as to how this idea could be implemented. General idea is to apply high level actions to a system, and test the outcome of such actions against an expected system state. Few Different options:

• System inputs w/ expected outputs can be encoded manually
• Model based testing can be used to generate input/expected output traces that must satisfy a simplified model of the system (compatible with fuzz testing)
• Property based testing can be used to generate i/o traces from properties/invariants defined for the system (compatible with fuzz testing)

Inspiration which I am familiar with:

• https://github.com/flyingmutant/rapid
• https://github.com/cosmos/interchain-security/tree/main/tests/e2e
• https://github.com/ethereum-optimism/optimism/tree/develop/op-e2e
• https://github.com/informalsystems/quint

• Instantiate the metrics registry
• Setup API endpoint to access registry
• Add metrics to the relevant packages

Test slack

It would be nice to check the commitmentSignature and do an ECRecover on the payload, and augment the output of the API to include the address associated with the provider.

e.g, currently if you POST a bid to the bidder api, you get back a payload:

{
      "txHash":"91a89B633194c0D86C539A1A5B14DCCacfD47094",
      "bidAmount":"2000",
      "blockNumber":"890200",
      "receivedBidDigest":"61634fad9081e1b23a00234a52a85386a91fc0fad3fb32d325891bdc4f8a52a9",
      "receivedBidSignature":"be99f499be5483665d569bd52fa8c4c9ed5c3bed2f94fb9949259bf640d8bd365b1d9a4b9ccb3ace86ffdcd1fdadc605b0f49b3adaf1c6a9ffea25585234664f1c",
      "commitmentDigest":"08a98d4c9d45f8431b46d99a23e6e8f82601ccf0773499d4e47bcd857cad92a6",
      "commitmentSignature":"cfc1e4e2ea9cc417027ed5846fa073c8e6031f70f91ffa9b92051b5b7738c0500d8fefb0fc189bce16004b3c0e1c4cfa41260968161adf8b55446ed5c40d1ac51b"
   }

We can augment the response to have "providerAddress": 0xProvider

{
      "providerAddress": 0xProvider
      "txHash":"91a89B633194c0D86C539A1A5B14DCCacfD47094",
      "bidAmount":"2000",
      ..."commitmentSignature":"cfc1e4e2ea9cc417027ed5846fa073c8e6031f70f91ffa9b92051b5b7738c0500d8fefb0fc189bce16004b3c0e1c4cfa41260968161adf8b55446ed5c40d1ac51b"
   }
} 

When starting the node with some of the generated private keys, this error is encountered, and it is suspected to be due to the key starting with a zero byte

• Blocklisting can be handled at the libp2p level which makes it transparent for the protocol handlers. This can be done by protocols either returning some specific error which can include reason and time to blocklist. Also, we can have a top-level interface in the libp2p.Service to blocklist with reason and time.
• Add libp2p.ConnectionGater option. This can use blocklist or other mechanisms to prevent unnecessary protocol traffic on the node.

sweep

currently the Readme.md only has the Receive Commitment section and it is completely missing the send bid section

• Currently, the error we get is simply api access failed.

Add protobuf encoding, similar to pkg/p2p/msgpack.

For protobuf, we don't need to use generics as pb.Message interface already provides similar features.

ReadMsg(context.Context, pb.Message) error
WriteMsg(context.Context, pb.Message) error

Add unit tests for the implementation.

The packages preconf and preconfirmation are hard to distinguish. Please try to come up with unique names