ipld/edelweiss

add type ByteString for backwards compat with IPLD schema

Aberta

#16 aberto em 11 de mar. de 2022

Ver no GitHub
 (5 comentários) (0 reação) (0 responsável)Go (5 forks)auto 404
good first issue

Métricas do repositório

Stars
 (17 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Entenda a especificação do esquema IPLD para ByteString e, em seguida, implemente o tipo no Edelweiss com codificação/decodificação adequada para objetos de string IPLD.
Pilha de tecnologia
go
Domain
backenddata
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GoIPLD Schema
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60