ObolNetwork / ObolNetwork/charon

`charon publish`

Open
#3,871 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

protocol
Dominant language
Go
Stars
222
Forks
138
Avg merge
2d 6h
Merged PRs (30d)
35

Description

🎯 Problem to be solved

Right now we tell people to run a curl command to publish a lock file they didn't publish at creation time. This is a tad rough around the edges. We could make a simple command for this. It might even become quite useful for cluster mutation.

🛠️ Proposed solution

  • Approved design doc: link
  • Core team consensus on the proposed solution

charon publish cluster that does curl -X POST -H "Content-Type: application/json" -d @.charon/cluster-lock.json https://api.obol.tech/v1/lock under the hood (ish).

🧪 Tests

  • Tested by new automated unit/integration/smoke tests
  • Manually tested on core team/canary/test clusters
  • Manually tested on local compose simnet

👐 Additional acceptance criteria

List any additional acceptance criteria for this issue to be marked as closed.

❌ Out of Scope

Maybe a charon publish operator which pushes performance tests associated with ENRs? Not a now problem.

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 reviewing the proposed charon publish cluster command and the existing cluster-lock publication flow described in the issue. Define and obtain approval for the design before implementing the command around the documented POST request to https://api.obol.tech/v1/lock. Done means the automated tests and the listed canary, test-cluster, and local compose simnet checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.