Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Polishing Documentation and Comments for Better Clarity #3927

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+9 −7
Open

Polishing Documentation and Comments for Better Clarity #3927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25850d2
Update CONTRIBUTING.md
donatik27 Nov 8, 2024
e709535
Update adr-005-plugins.md
donatik27 Nov 8, 2024
068c028
Update edssser.go
donatik27 Nov 8, 2024
7488049
Update adr-002-predevnet-core-to-full-communication.md
donatik27 Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Each stage of the process is aimed at creating feedback cycles which align contr

## PR Naming

PRs should be titled as following:
PRs should be titled as follows:

```txt
pkg: Concise title of PR
Expand All @@ -58,7 +58,7 @@ easy to reference the pull request where a change was introduced.

### Development Procedure

The latest state of development is on `main`, which must never fail `make test`. *Never* force push `main`.
The latest state of development is on `main`, which must never fail `make test`. *Never* force push to `main`.

To begin contributing, create a development branch on your fork.

Expand Down
2 changes: 1 addition & 1 deletion docs/adr/adr-002-predevnet-core-to-full-communication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## Context

After the offsite, there was a bit of confusion on what the default behaviour for running a Celestia Full node should be in the devnet. Since we decided on an architecture where Core nodes will communicate with Celestia Full nodes *exclusively* via RPC (over an HTTP connection, for example), it is necessary that a certain percentage of Celestia Full nodes in the devnet run with either an embedded Core node process or are able to fetch block information from a remote Core endpoint, otherwise there would be no way for the two separate networks (Core network and Celestia network) to communicate.
After the offsite, there was a bit of confusion about what the default behaviour for running a Celestia Full node should be in the devnet. Since we decided on an architecture where Core nodes will communicate with Celestia Full nodes *exclusively* via RPC (over an HTTP connection, for example), it is necessary that a certain percentage of Celestia Full nodes in the devnet run with either an embedded Core node process or are able to fetch block information from a remote Core endpoint, otherwise there would be no way for the two separate networks (Core network and Celestia network) to communicate.

## Decision

Expand Down
4 changes: 2 additions & 2 deletions docs/adr/adr-005-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ func NewBridgeCommand(plugs []node.Plugin) *cobra.Command {
}
```

When starting or initiating a new celestia node, the plugins are passed as settings
When starting or initiating a new сelestia node, the plugins are passed as settings
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for the inconvenience, that was an accidental fix.


```go
// settings store all the non Config values that can be altered for Node with Options.
Expand Down Expand Up @@ -220,7 +220,7 @@ func newPluginService() PluginResult {
}
```

Also, the user must annotate this fxutil.Option with the `"plugins"` group tag
Also, the user must annotate this `"fxutil.Option"` with the `"plugins"` group tag

```go
func (plug *testPlugin) Components(cfg *Config, store Store) fxutil.Option {
Expand Down
6 changes: 4 additions & 2 deletions libs/edssser/edssser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
// Package edssser provides stress testing functionality for EDS (Extended Data Square) store
package edssser

import (
Expand All @@ -14,6 +15,7 @@ import (
"github.com/celestiaorg/celestia-node/store"
)

// Config defines parameters for EDS store stress testing
type Config struct {
EDSSize int
EDSWrites int
Expand All @@ -24,7 +26,7 @@ type Config struct {
OpTimeout time.Duration
}

// EDSsser stand for EDS Store Stresser.
// EDSsser performs stress testing on EDS store operations
type EDSsser struct {
config Config
edsstoreMu sync.Mutex
Expand Down Expand Up @@ -111,10 +113,10 @@ func (ss *EDSsser) dumpStat(stats Stats) (err error) {
return ss.statsFile.Close()
}

// Stats tracks performance metrics during stress testing
type Stats struct {
TotalWritten int
TotalTime, MinTime, MaxTime, AvgTime time.Duration
// Deviation ?
}

func (stats Stats) Finalize() Stats {
Expand Down
Loading