Skip to content

Commit

Permalink
fix: a Ostracon to an Ostracon
Browse files Browse the repository at this point in the history
  • Loading branch information
egonspace committed Aug 25, 2021
1 parent b229947 commit c8cbd4b
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 17 deletions.
10 changes: 5 additions & 5 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ var (
defaultAddrBookPath = filepath.Join(defaultConfigDir, defaultAddrBookName)
)

// Config defines the top level configuration for a Ostracon node
// Config defines the top level configuration for an Ostracon node
type Config struct {
// Top level options use an anonymous struct
BaseConfig `mapstructure:",squash"`
Expand All @@ -75,7 +75,7 @@ type Config struct {
Instrumentation *InstrumentationConfig `mapstructure:"instrumentation"`
}

// DefaultConfig returns a default configuration for a Ostracon node
// DefaultConfig returns a default configuration for an Ostracon node
func DefaultConfig() *Config {
return &Config{
BaseConfig: DefaultBaseConfig(),
Expand Down Expand Up @@ -148,7 +148,7 @@ func (cfg *Config) ValidateBasic() error {
//-----------------------------------------------------------------------------
// BaseConfig

// BaseConfig defines the base configuration for a Ostracon node
// BaseConfig defines the base configuration for an Ostracon node
type BaseConfig struct { //nolint: maligned
// chainID is unexposed and immutable but here for convenience
chainID string
Expand Down Expand Up @@ -226,7 +226,7 @@ type BaseConfig struct { //nolint: maligned
PrivKeyType string `mapstructure:"priv_key_type"`
}

// DefaultBaseConfig returns a default base configuration for a Ostracon node
// DefaultBaseConfig returns a default base configuration for an Ostracon node
func DefaultBaseConfig() BaseConfig {
dbs := metadb.AvailableDBBackends()
defaultDBBackend := DefaultDBBackend
Expand Down Expand Up @@ -254,7 +254,7 @@ func DefaultBaseConfig() BaseConfig {
}
}

// TestBaseConfig returns a base configuration for testing a Ostracon node
// TestBaseConfig returns a base configuration for testing an Ostracon node
func TestBaseConfig() BaseConfig {
cfg := DefaultBaseConfig()
cfg.chainID = "ostracon_test"
Expand Down
2 changes: 1 addition & 1 deletion light/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ consensus algorithm and not the state machine transactions within.
Ostracon light clients allow bandwidth & compute-constrained devices, such as
smartphones, low-power embedded chips, or other blockchains to efficiently
verify the consensus of a Ostracon blockchain. This forms the basis of safe
verify the consensus of an Ostracon blockchain. This forms the basis of safe
and efficient state synchronization for new network nodes and inter-blockchain
communication (where a light client of one Ostracon instance runs in another
chain's state machine).
Expand Down
2 changes: 1 addition & 1 deletion node/node.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func DefaultGenesisDocProviderFunc(config *cfg.Config) GenesisDocProvider {
// Provider takes a config and a logger and returns a ready to go Node.
type Provider func(*cfg.Config, log.Logger) (*Node, error)

// DefaultNewNode returns a Ostracon node with default settings for the
// DefaultNewNode returns an Ostracon node with default settings for the
// PrivValidator, ClientCreator, GenesisDoc, and DBProvider.
// It implements NodeProvider.
func DefaultNewNode(config *cfg.Config, logger log.Logger) (*Node, error) {
Expand Down
2 changes: 1 addition & 1 deletion proto/ostracon/types/types.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion proto/ostracon/types/types.proto
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ message BlockID {

// --------------------------------

// Header defines the structure of a Ostracon block header.
// Header defines the structure of an Ostracon block header.
message Header {
// basic block info
ostracon.version.Consensus version = 1 [(gogoproto.nullable) = false];
Expand Down
2 changes: 1 addition & 1 deletion rpc/client/http/http.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
)

/*
HTTP is a Client implementation that communicates with a Ostracon node over
HTTP is a Client implementation that communicates with an Ostracon node over
JSON RPC and WebSockets.
This is the main implementation you probably want to use in production code.
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/app/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ func startApp(cfg *Config) error {
return nil
}

// startNode starts a Ostracon node running the application directly. It assumes the Ostracon
// startNode starts an Ostracon node running the application directly. It assumes the Ostracon
// configuration is in $OCHOME/config/ostracon.toml.
//
// FIXME There is no way to simply load the configuration from a file, so we need to pull in Viper.
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/pkg/testnet.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ type Testnet struct {
KeyType string
}

// Node represents a Ostracon node in a testnet.
// Node represents an Ostracon node in a testnet.
type Node struct {
Name string
Testnet *Testnet
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/runner/setup.go
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ func MakeGenesis(testnet *e2e.Testnet) (types.GenesisDoc, error) {
return genesis, genesis.ValidateAndComplete()
}

// MakeConfig generates a Ostracon config for a node.
// MakeConfig generates an Ostracon config for a node.
func MakeConfig(node *e2e.Node) (*config.Config, error) {
cfg := config.DefaultConfig()
cfg.Moniker = node.Name
Expand Down
2 changes: 1 addition & 1 deletion test/maverick/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Maverick

A byzantine node used to test Ostracon consensus against a plethora of different faulty misbehaviors. Designed to easily create new faulty misbehaviors to examine how a Ostracon network reacts to the misbehavior. Can also be used for fuzzy testing with different network arrangements.
A byzantine node used to test Ostracon consensus against a plethora of different faulty misbehaviors. Designed to easily create new faulty misbehaviors to examine how an Ostracon network reacts to the misbehavior. Can also be used for fuzzy testing with different network arrangements.

## Misbehaviors

Expand Down
2 changes: 1 addition & 1 deletion test/maverick/node/node.go
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ func DefaultGenesisDocProviderFunc(config *cfg.Config) GenesisDocProvider {
// Provider takes a config and a logger and returns a ready to go Node.
type Provider func(*cfg.Config, log.Logger) (*Node, error)

// DefaultNewNode returns a Ostracon node with default settings for the
// DefaultNewNode returns an Ostracon node with default settings for the
// PrivValidator, ClientCreator, GenesisDoc, and DBProvider.
// It implements NodeProvider.
func DefaultNewNode(config *cfg.Config, logger log.Logger, misbehaviors map[int64]cs.Misbehavior) (*Node, error) {
Expand Down
4 changes: 2 additions & 2 deletions types/block.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const (
MaxOverheadForBlock int64 = 11
)

// Block defines the atomic unit of a Ostracon blockchain.
// Block defines the atomic unit of an Ostracon blockchain.
type Block struct {
mtx tmsync.Mutex

Expand Down Expand Up @@ -329,7 +329,7 @@ func MaxDataBytesNoEvidence(maxBytes int64, valsCount int) int64 {

//-----------------------------------------------------------------------------

// Header defines the structure of a Ostracon block header.
// Header defines the structure of an Ostracon block header.
// NOTE: changes to the Header should be duplicated in:
// - header.Hash()
// - abci.Header
Expand Down

0 comments on commit c8cbd4b

Please sign in to comment.