Skip to content

Commit

Permalink
Removed RELEASES.md, SECURITY.md files and updated URLs in various fi…
Browse files Browse the repository at this point in the history
…le references

The RELEASES.md and SECURITY.md files were removed in this commit. Several URLs found in documentation comments were also broken by adding a space after the 'https://' protocol declaration. The goal of these changes is to ensure that previously existent files and URLs do not cause any confusion or misunderstanding.
  • Loading branch information
aakash4dev committed Jun 26, 2024
1 parent fc8535d commit 53c0cf6
Show file tree
Hide file tree
Showing 84 changed files with 68 additions and 638 deletions.
Empty file removed .changelog/config.toml
Empty file.
Empty file removed .changelog/epilogue.md
Empty file.
Empty file removed .changelog/unreleased/.gitkeep
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file removed .changelog/v0.34.27/summary.md
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file removed .changelog/v0.34.28/summary.md
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file removed .changelog/v0.34.29/summary.md
Empty file.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can find more information about the Switchyard blockchain [here](https://git
To use this project as a library in your blockchain project, update the `go.mod` file as follows:

```go
github.com/tendermint/tendermint => github.com/tendermint/tendermint v0.0.1
github.com/tendermint/tendermint => github.com/airchains-network/tracksbft v0.0.1
```

Alternatively, you can run the following command and then replace all `tendermint/cometbft` library imports in your blockchain project with `tracksbft`:
Expand Down
362 changes: 0 additions & 362 deletions RELEASES.md

This file was deleted.

208 changes: 0 additions & 208 deletions SECURITY.md

This file was deleted.

2 changes: 1 addition & 1 deletion abci/client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ func (r *ReqRes) InvokeCallback() {
// marked done and SetCallback is called before calling GetCallback as that
// will invoke the callback twice and create a potential race condition.
//
// ref: https://github.com/airchains-network/tracksbft/issues/5439
// ref: https:// github.com/airchains-network/tracksbft/issues/5439
func (r *ReqRes) GetCallback() func(*types.Response) {
r.mtx.Lock()
defer r.mtx.Unlock()
Expand Down
2 changes: 1 addition & 1 deletion abci/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 blockchain/v0/pool_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func (p testPeer) simulateInput(input inputData) {
input.pool.AddBlock(input.request.PeerID, block, 123)
// TODO: uncommenting this creates a race which is detected by:
// https://github.com/golang/go/blob/2bd767b1022dd3254bcec469f0ee164024726486/src/testing/testing.go#L854-L856
// see: https://github.com/airchains-network/tracksbft/issues/3390#issue-418379890
// see: https:// github.com/airchains-network/tracksbft/issues/3390#issue-418379890
// input.t.Logf("Added block from peer %v (height: %v)", input.request.PeerID, input.request.Height)
}

Expand Down
2 changes: 1 addition & 1 deletion blockchain/v2/reactor_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ func newTestReactor(p testReactorParams) *BlockchainReactor {
}

// This test is left here and not deleted to retain the termination cases for
// future improvement in [#4482](https://github.com/airchains-network/tracksbft/issues/4482).
// future improvement in [#4482](https:// github.com/airchains-network/tracksbft/issues/4482).
// func TestReactorTerminationScenarios(t *testing.T) {

// config := cfg.ResetTestRoot("blockchain_reactor_v2_test")
Expand Down
2 changes: 1 addition & 1 deletion cmd/cometbft/commands/light.go
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ func runProxy(cmd *cobra.Command, args []string) error {
cfg.MaxOpenConnections = maxOpenConnections
// If necessary adjust global WriteTimeout to ensure it's greater than
// TimeoutBroadcastTxCommit.
// See https://github.com/airchains-network/tracksbft/issues/3435
// See https:// github.com/airchains-network/tracksbft/issues/3435
if cfg.WriteTimeout <= config.RPC.TimeoutBroadcastTxCommit {
cfg.WriteTimeout = config.RPC.TimeoutBroadcastTxCommit + 1*time.Second
}
Expand Down
4 changes: 2 additions & 2 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ type RPCConfig struct {
// How long to wait for a tx to be committed during /broadcast_tx_commit
// WARNING: Using a value larger than 10s will result in increasing the
// global HTTP write timeout, which applies to all connections and endpoints.
// See https://github.com/airchains-network/tracksbft/issues/3435
// See https:// github.com/airchains-network/tracksbft/issues/3435
TimeoutBroadcastTxCommit time.Duration `mapstructure:"timeout_broadcast_tx_commit"`

// Maximum size of request body, in bytes
Expand Down Expand Up @@ -732,7 +732,7 @@ type MempoolConfig struct {
MaxTxBytes int `mapstructure:"max_tx_bytes"`
// Maximum size of a batch of transactions to send to a peer
// Including space needed by encoding (one varint per transaction).
// XXX: Unused due to https://github.com/airchains-network/tracksbft/issues/5796
// XXX: Unused due to https:// github.com/airchains-network/tracksbft/issues/5796
MaxBatchBytes int `mapstructure:"max_batch_bytes"`

// TTLDuration, if non-zero, defines the maximum amount of time a transaction
Expand Down
4 changes: 2 additions & 2 deletions config/toml.go
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ experimental_close_on_slow_client = {{ .RPC.CloseOnSlowClient }}
# How long to wait for a tx to be committed during /broadcast_tx_commit.
# WARNING: Using a value larger than 10s will result in increasing the
# global HTTP write timeout, which applies to all connections and endpoints.
# See https://github.com/airchains-network/tracksbft/issues/3435
# See https:// github.com/airchains-network/tracksbft/issues/3435
timeout_broadcast_tx_commit = "{{ .RPC.TimeoutBroadcastTxCommit }}"
# Maximum size of request body, in bytes
Expand Down Expand Up @@ -378,7 +378,7 @@ max_tx_bytes = {{ .Mempool.MaxTxBytes }}
# Maximum size of a batch of transactions to send to a peer
# Including space needed by encoding (one varint per transaction).
# XXX: Unused due to https://github.com/airchains-network/tracksbft/issues/5796
# XXX: Unused due to https:// github.com/airchains-network/tracksbft/issues/5796
max_batch_bytes = {{ .Mempool.MaxBatchBytes }}
# ttl-duration, if non-zero, defines the maximum amount of time a transaction
Expand Down
8 changes: 4 additions & 4 deletions consensus/state.go
Original file line number Diff line number Diff line change
Expand Up @@ -868,7 +868,7 @@ func (cs *State) handleMsg(mi msgInfo) {
// We probably don't want to stop the peer here. The vote does not
// necessarily comes from a malicious peer but can be just broadcasted by
// a typical peer.
// https://github.com/airchains-network/tracksbft/issues/1281
// https:// github.com/airchains-network/tracksbft/issues/1281
// }

// NOTE: the vote is broadcast to peers by the reactor listening
Expand Down Expand Up @@ -1997,7 +1997,7 @@ func (cs *State) tryAddVote(vote *types.Vote, peerID p2p.ID) (bool, error) {
// 1) bad peer OR
// 2) not a bad peer? this can also err sometimes with "Unexpected step" OR
// 3) tmkms use with multiple validators connecting to a single tmkms instance
// (https://github.com/airchains-network/tracksbft/issues/3839).
// (https:// github.com/airchains-network/tracksbft/issues/3839).
cs.Logger.Info("failed attempting to add vote", "err", err)
return added, ErrAddingVote
}
Expand Down Expand Up @@ -2221,11 +2221,11 @@ func (cs *State) voteTime() time.Time {
now := cmttime.Now()
minVoteTime := now
// TODO: We should remove next line in case we don't vote for v in case cs.ProposalBlock == nil,
// even if cs.LockedBlock != nil. See https://github.com/airchains-network/tracksbft/tree/v0.34.x/spec/.
// even if cs.LockedBlock != nil. See https:// github.com/airchains-network/tracksbft/tree/v0.34.x/spec/.
timeIota := time.Duration(cs.state.ConsensusParams.Block.TimeIotaMs) * time.Millisecond
if cs.LockedBlock != nil {
// See the BFT time spec
// https://github.com/airchains-network/tracksbft/blob/v0.34.x/spec/consensus/bft-time.md
// https:// github.com/airchains-network/tracksbft/blob/v0.34.x/spec/consensus/bft-time.md
minVoteTime = cs.LockedBlock.Time.Add(timeIota)
} else if cs.ProposalBlock != nil {
minVoteTime = cs.ProposalBlock.Time.Add(timeIota)
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/airchains-network/tracksbft
module github.com/tendermint/tendermint

go 1.19

Expand Down
2 changes: 1 addition & 1 deletion libs/os/os_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func TestEnsureDir(t *testing.T) {

// Ensure that using CopyFile does not truncate the destination file before
// the origin is positively a non-directory and that it is ready for copying.
// See https://github.com/airchains-network/tracksbft/issues/6427
// See https:// github.com/airchains-network/tracksbft/issues/6427
func TestTrickedTruncation(t *testing.T) {
tmpDir, err := os.MkdirTemp(os.TempDir(), "pwn_truncate")
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion libs/rand/random.go
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ func (r *Rand) Perm(n int) []int {

// NOTE: This relies on the os's random number generator.
// For real security, we should salt that with some seed.
// See github.com/airchains-network/tracksbft/crypto for a more secure reader.
// See github.com/airchains-network/tracksbft/crypto for a more secure reader.
func cRandBytes(numBytes int) []byte {
b := make([]byte, numBytes)
_, err := crand.Read(b)
Expand Down
2 changes: 1 addition & 1 deletion light/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ func (c *Client) VerifyLightBlockAtHeight(ctx context.Context, height int64, now
// headers are not adjacent, verifySkipping is performed and necessary (not all)
// intermediate headers will be requested. See the specification for details.
// Intermediate headers are not saved to database.
// https://github.com/airchains-network/tracksbft/blob/v0.34.x/spec/consensus/light-client.md
// https:// github.com/airchains-network/tracksbft/blob/v0.34.x/spec/consensus/light-client.md
//
// If the header, which is older than the currently trusted header, is
// requested and the light client does not have it, VerifyHeader will perform:
Expand Down
2 changes: 1 addition & 1 deletion light/provider/http/http.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (
)

var (
// This is very brittle, see: https://github.com/airchains-network/tracksbft/issues/4740
// This is very brittle, see: https:// github.com/airchains-network/tracksbft/issues/4740
regexpMissingHeight = regexp.MustCompile(`height \d+ is not available`)
regexpTooHigh = regexp.MustCompile(`height \d+ must be less than or equal to`)
regexpTimedOut = regexp.MustCompile(`Timeout exceeded`)
Expand Down
2 changes: 1 addition & 1 deletion mempool/v0/clist_mempool.go
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ func (mem *CListMempool) Update(
// 101 -> 102
// Mempool after:
// 100
// https://github.com/airchains-network/tracksbft/issues/3322.
// https:// github.com/airchains-network/tracksbft/issues/3322.
if e, ok := mem.txsMap.Load(tx.Key()); ok {
mem.removeTx(tx, e.(*clist.CElement), false)
}
Expand Down
2 changes: 1 addition & 1 deletion mempool/v0/clist_mempool_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,7 @@ func TestMempoolNoCacheOverflow(t *testing.T) {
}

// This will non-deterministically catch some concurrency failures like
// https://github.com/airchains-network/tracksbft/issues/3509
// https:// github.com/airchains-network/tracksbft/issues/3509
// TODO: all of the tests should probably also run using the remote proxy app
// since otherwise we're not actually testing the concurrency of the mempool here!
func TestMempoolRemoteAppConcurrency(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion mempool/v0/reactor.go
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ func (memR *Reactor) broadcastTxRoutine(peer p2p.Peer) {
}

// NOTE: Transaction batching was disabled due to
// https://github.com/airchains-network/tracksbft/issues/5796
// https:// github.com/airchains-network/tracksbft/issues/5796

if _, ok := memTx.senders.Load(peerID); !ok {
success := p2p.SendEnvelopeShim(peer, p2p.Envelope{ //nolint: staticcheck
Expand Down
Loading

0 comments on commit 53c0cf6

Please sign in to comment.