ipld/edelweiss

add type ByteString for backwards compat with IPLD schema

Ouverte

#16 ouverte le 11 mars 2022

Voir sur GitHub
 (5 commentaires) (0 réaction) (0 personne assignée)Go (5 forks)auto 404
good first issue

Métriques du dépôt

Stars
 (17 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Comprendre la spécification du schéma IPLD pour ByteString, puis implémenter le type dans Edelweiss avec un encodage/décodage approprié pour les objets chaîne IPLD.
Stack technique
go
Domaine
backenddata
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GoIPLD Schema
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60