N2c local submission mini-protocol rejection structured reason

Open
  • Is something wrong?
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
haskell
Domain
distributed-systems, networking

Research direction

Start by reading the current N2c local submission mini-protocol and its CDDL, then inspect how rejection errors are represented between the Pallas library and Mithril nodes. Trace the existing type and optional text message through all affected components. Done means the protocol consistently supports the structured reasons for invalid, already received, expired, and other errors.

Written by the indexing model from the issue text.

Description

enhancement

When submitting a message on the n2c local submission mini-protocol, if an error occurs (KES signature is invalid, already expired message, ...) it is reported to the client. Today, the error is a type and optionally an error message in text. We would like to create more structured optional explanation of the errors. This would require modifications of the CIP, Pallas library, Mithril nodes.

Current CDDL:

reason = invalid
       / alreadyReceived
       / expired
       / other
 
invalid         = [0, tstr]
alreadyReceived = [1]
expired         = [2]
other           = [3, tstr]
Dominant language
Haskell
Stars
2
Forks
5
Avg merge
13h 24m
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from IntersectMBO/dmq-node

All issues in IntersectMBO/dmq-node

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.