nspcc-dev / nspcc-dev/neofs-node

Support more convenient JSON format in CLI

Open
#1,323 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement I3 neofs-cli S4 U4
Dominant language
Go
Stars
38
Forks
51
Avg merge
1d 20h
Merged PRs (30d)
38

Description

In current implementation CLI app supports NeoFS (Protocol Buffers) JSON format only. This format is sometimes not convenient. For example, we need to form container identifier field as

"cid": {
  "value":"Uv38ByGCZU8WP18PmmIdcpVmx00QA3xNe7sEB9Hixkk=" # base64-encoded ID
}

Protocol JSON format can't be changed (it's an axiom), but we can provide more convenient format in CLI local layer. For example, identifiers can be presented as protocol strings:

"cid": "6ay4GfhR9RgN28d5ufg63toPetkYHGcpcW7G3b7QWSek" # base8-encoded ID according to NeoFS API protocol

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CLI local layer that handles NeoFS Protocol Buffers JSON and read how identifier fields such as cid are currently encoded and decoded. Define the supported convenient representation using protocol strings while preserving the existing Protocol JSON format, then verify the CLI accepts and emits the intended identifier form.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, distributed-systems
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.