Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 8 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -416,16 +416,11 @@ Run: `cd test/fuzz && make fuzz-{PACKAGE-COMPONENT}`
**If you contribute to the RPC endpoints it's important to document your
changes in the [Openapi file](./rpc/openapi/openapi.yaml)**.

To test your changes you must install `nodejs` and run:

```bash
npm i -g dredd
make build-linux build-contract-tests-hooks
make contract-tests
```

**WARNING: these are currently broken due to <https://github.com/apiaryio/dredd>
not supporting complete OpenAPI 3**.

This command will popup a network and check every endpoint against what has
been documented.
**WARNING: contract tests are currently not available. They previously depended
on a local network setup that has been removed due to maintenance issues. The
tests were also broken due to <https://github.com/apiaryio/dredd> not supporting
complete OpenAPI 3**.

The contract tests would check every endpoint against what has been documented
in the OpenAPI specification. Alternative testing approaches should be used to
validate API changes.
12 changes: 0 additions & 12 deletions DOCKER/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,6 @@ docker run -it --rm -v "/tmp:/cometbft" cometbft/cometbft init
docker run -it --rm -v "/tmp:/cometbft" cometbft/cometbft node --proxy_app=kvstore
```

## Local cluster

To run a 4-node network, see the `Makefile` in the root of [the repo](https://github.com/cometbft/cometbft/blob/v0.38.x/Makefile) and run:

```sh
make build-linux
make build-docker-localnode
make localnet-start
```

Note that this will build and use a different image than the ones provided here.

## License

- CometBFT's license is [Apache 2.0](https://github.com/cometbft/cometbft/blob/v0.38.x/LICENSE).
Expand Down
24 changes: 4 additions & 20 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -311,11 +311,6 @@ build-linux:
GOOS=$(GOOS) GOARCH=$(GOARCH) GOARM=$(GOARM) $(MAKE) build
.PHONY: build-linux

#? build-docker-localnode: Build the "localnode" docker image
build-docker-localnode:
@cd networks/local && make
.PHONY: build-docker-localnode

# Runs `make build COMETBFT_BUILD_OPTIONS=cleveldb` from within an Amazon
# Linux (v2)-based Docker build container in order to build an Amazon
# Linux-compatible binary. Produces a compatible binary at ./build/cometbft
Expand All @@ -324,17 +319,6 @@ build_c-amazonlinux:
docker run --rm -it -v `pwd`:/cometbft cometbft/cometbft:build_c-amazonlinux
.PHONY: build_c-amazonlinux

#? localnet-start: Run a 4-node testnet locally
localnet-start: localnet-stop build-docker-localnode
@if ! [ -f build/node0/config/genesis.json ]; then docker run --rm -v $(CURDIR)/build:/cometbft:Z cometbft/localnode testnet --config /etc/cometbft/config-template.toml --o . --starting-ip-address 192.167.10.2; fi
docker compose up -d
.PHONY: localnet-start

#? localnet-stop: Stop testnet
localnet-stop:
docker compose down
.PHONY: localnet-stop

#? build-contract-tests-hooks: Build hooks for dredd, to skip or add information on some steps
build-contract-tests-hooks:
ifeq ($(OS),Windows_NT)
Expand All @@ -344,10 +328,10 @@ else
endif
.PHONY: build-contract-tests-hooks

#? contract-tests: Run a nodejs tool to test endpoints against a localnet
# The command takes care of starting and stopping the network
# prerequisits: build-contract-tests-hooks build-linux
# the two build commands were not added to let this command run from generic containers or machines.
#? contract-tests: Run a nodejs tool to test endpoints against a testnet
# NOTE: Currently not functional due to removal of localnet infrastructure
# prerequisits: build-contract-tests-hooks
# The binary build commands were not added to let this command run from generic containers or machines.
# The binaries should be built beforehand
contract-tests:
dredd
Expand Down
66 changes: 0 additions & 66 deletions docker-compose.yml

This file was deleted.

3 changes: 0 additions & 3 deletions docs/networks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,4 @@ parent:

# Overview

Use [Docker Compose](./docker-compose.md) to spin up CometBFT testnets on your
local machine.

See the `cometbft testnet --help` command for more help initializing testnets.
179 changes: 0 additions & 179 deletions docs/networks/docker-compose.md

This file was deleted.

2 changes: 1 addition & 1 deletion dredd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ dry-run: null
hookfiles: build/contract_tests
language: go
require: null
server: make localnet-start
# server: # localnet functionality has been removed - contract tests not currently available
server-wait: 30
init: false
custom: {}
Expand Down
7 changes: 0 additions & 7 deletions networks/local/Makefile

This file was deleted.

3 changes: 0 additions & 3 deletions networks/local/README.md

This file was deleted.

15 changes: 0 additions & 15 deletions networks/local/localnode/Dockerfile

This file was deleted.

2 changes: 0 additions & 2 deletions networks/local/localnode/config-template.toml

This file was deleted.

Loading
Loading