filecoin-project/go-state-types

Impossible to carry non-utf8 market labels over API boundaries

Open

#179 opened on Mar 24, 2023

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

Repository metrics

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

Description

Because the JSON marshaller ignores the Bytes datamodel type, whenever one uses a non-utf8 ([]byte) label it is stripped off during RPC (JSON) transport

https://github.com/filecoin-project/go-state-types/blob/v0.10.0/builtin/v10/market/deal.go#L166-L168 + https://github.com/filecoin-project/go-state-types/blob/v0.10.0/builtin/v10/market/deal.go#L184-L187

@arajasek @magik6k Is this intentional? If not any objections I fix it?

Contributor guide

Research direction
Investigate the JSON marshaller's handling of the `Bytes` data model type in the Filecoin market deal struct, and implement a custom marshal/unmarshal method to preserve non utf8 byte labels during JSON transport.
Tech stack
go
Domain
backend
Issue type
Bug
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.
1-3 hours
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.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75