ipld/edelweiss

add type ByteString for backwards compat with IPLD schema

Open

#16 opened on Mar 11, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (5 forks)auto 404
good first issue

Repository metrics

Stars
 (17 stars)
PR merge metrics
 (PR metrics pending)

Description

Edelweiss type String definitionally holds valid Unicode strings only, and encodes/decodes them from IPLD strings with valid UTF8 encodings.

However, there may be pre-existing IPLD schemas that place non-UTF8 byte sequences in IPLD string objects. By design requirement, Edelweiss must provide a way for working with pre-existing schemas.

One way of doing this without violating Edelweiss's type semantics is to introduce a new Edelweiss type, say called ByteString, which:

  • is a list of bytes on the user-facing end
  • encodes/decodes as an IPLD string of arbitrary bytes on the wire

Contributor guide

Research direction
Understand the IPLD schema specification for ByteString, then implement the type in Edelweiss with appropriate encoding/decoding for IPLD string objects.
Tech stack
go
Domain
backenddata
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GoIPLD Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60