oasisprotocol / oasisprotocol/oasis-core

Strict checking of node yaml config

Open
#2,447 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

golang s:good first issue
Dominant language
Go
Stars
369
Forks
151
Avg merge
1d 3h
Merged PRs (30d)
6

Description

Node initialization should fail when yaml cofiguration contains any entries that do not map to defined flags (similarly as node fails when an invalid flag is passed).

This would prevent missconfigurations when using yaml config format, which are currently sometimes hard to detect due to absence of strict checking.

Not sure if viper supports this.

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 at node initialization and the YAML configuration/flag parsing path, then check whether Viper supports rejecting unknown configuration entries. Done means YAML entries without defined flags fail initialization in the same way as invalid command-line flags.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, yaml
Domain
backend, blockchain
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.