IntersectMBO/plutus

Use type-level Nats for `safeEncodeBits`

Open

#6,048 opened on May 17, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (511 forks)batch import
Good first issueInternalPlutus Corestatus: triaged

Repository metrics

Stars
 (1,637 stars)
PR merge metrics
 (Avg merge 6d 1h) (15 merged PRs in 30d)

Description

Right now safeEncodeBits act like a C-assertion. Use instead GHC.TypeLits/DataKinds to enforce safety statically.

Contributor guide

Research direction
Study the current implementation of safeEncodeBits and identify where runtime assertions are used. Then design a type level Nat encoding to enforce safety at compile time.
Tech stack
None
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GHCDataKindsTypeLits
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20