Skip to content

Commit

Permalink
replaces all mentions of covalenth/go-ethereum with bsp-geth
Browse files Browse the repository at this point in the history
Signed-off-by: Pranay Valson <[email protected]>
  • Loading branch information
noslav committed Feb 15, 2022
1 parent 6fd19f3 commit 3ab3d46
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ jobs:
- name: Build & Publish the Docker image
if: ${{ !env.ACT }}
run: |
docker build . --file Dockerfile --tag ghcr.io/covalenthq/go-ethereum-bsp:latest
docker push ghcr.io/covalenthq/go-ethereum-bsp:latest
docker build . --file Dockerfile --tag ghcr.io/covalenthq/bsp-geth:latest
docker push ghcr.io/covalenthq/bsp-geth:latest
# - name: Start containers
# run: docker-compose -f "docker-compose.yml" up --build --remove-orphans --force-recreate --exit-code-from agent
Expand Down
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
![banner](./docs/covalent.jpg)

<div align="center">
<a href="https://github.com/covalenthq/mq-store-agent/releases/latest">
<a href="https://github.com/covalenthq/bsp-geth/releases/latest">
<img alt="Version" src="https://img.shields.io/badge/tag-v1.0.0-yellowgreen" />
</a>
<a href="https://github.com/covalenthq/go-ethereum/blob/main/LICENSE">
<a href="https://github.com/covalenthq/bsp-geth/blob/main/LICENSE">
<img alt="License: " src="https://img.shields.io/badge/license-MIT-green" />
</a>
<a href="https://goreportcard.com/report/github.com/covalenthq/go-ethereum">
<img alt="Go report card" src="https://goreportcard.com/badge/github.com/covalenthq/go-ethereum"/>
<a href="https://goreportcard.com/report/github.com/covalenthq/bsp-geth">
<img alt="Go report card" src="https://goreportcard.com/badge/github.com/covalenthq/bsp-geth"/>
</a>
<a href="http://covalenthq.com/discord">
<img alt="Discord" src="https://img.shields.io/badge/discord-join%20chat-blue.svg" />
</a>
<!-- <a href="https://bestpractices.coreinfrastructure.org/projects/0000">
<img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/covalenthq/go-ethereum">
<img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/covalenthq/bsp-geth">
</a> -->
</div>
<div align="center">
<a href="http://covalenthq.com/discord">
<img alt="Discord" src="https://img.shields.io/discord/715804406842392586.svg" />
</a>
<!-- <a href="https://github.com/covalenthq/go-ethereum/actions/workflows/golangci-lint.yml?query=branch%3Amain+workflow%3Agolangci-lint">
<img alt="Lint Status" src="https://github.com/covalenthq/go-ethereum/actions/workflows/golangci-lint.yml/badge.svg?branch=main" />
<a href="https://github.com/covalenthq/bsp-geth/actions/workflows/golangci-lint.yml?query=branch%3Acovalent+workflow%3Agolangci-lint">
<img alt="Lint Status" src="https://github.com/covalenthq/bsp-geth/actions/workflows/golangci-lint.yml/badge.svg?branch=covalent" />
</a>
<a href="https://github.com/covalenthq/bsp-geth/actions/workflows/docker-image.yml?query=branch%3Acovalent+workflow%3Adocker-image-ci">
<img alt="CI Status" src="https://github.com/covalenthq/bsp-geth/actions/workflows/docker-image.yml/badge.svg?branch=covalent" />
</a>
<a href="https://github.com/covalenthq/bsp-geth/actions/workflows/docker-image.yml?query=branch%3Acovalent+workflow%3Abuild-test">
<img alt="CI Status" src="https://github.com/covalenthq/bsp-geth/actions/workflows/build-test.yml/badge.svg?branch=covalent" />
</a>
<a href="https://github.com/covalenthq/go-ethereum/actions/workflows/docker-image.yml?query=branch%3Amain+workflow%3Adocker-image-ci">
<img alt="CI Status" src="https://github.com/covalenthq/go-ethereum/actions/workflows/docker-image.yml/badge.svg?branch=main" />
</a> -->
<a href="https://twitter.com/@Covalent_HQ">
<img alt="Twitter Follow Covalent" src="https://img.shields.io/twitter/follow/Covalent_HQ"/>
</a>
Expand Down Expand Up @@ -64,13 +67,13 @@ As a result, anyone can run full tracing on the block specimen and accurately re

Production of Block Specimens forms the core of the network’s data objects specification. These objects are created with the aid of three main pieces of open-source software provided by Covalent for the network’s decentralized stack.

1. [Block Specimen Producer (BSP Geth)](https://github.com/covalenthq/go-ethereum) - Operator run & deployed
1. [Block Specimen Producer (BSP Geth)](https://github.com/covalenthq/bsp-geth) - Operator run & deployed

1. [BSP Agent](https://github.com/covalenthq/mq-store-agent) - Operator run & deployed
1. [BSP Agent](https://github.com/covalenthq/bsp-agent) - Operator run & deployed

1. [BSP Proof-chain](https://github.com/covalenthq/cqt-virtnet) - Covalent operated & pre-deployed

Please refer to these [instructions](https://docs.google.com/document/d/1N_HxUi6ZEkub9EHANe49vkL9iQztVA_ACyfHcOZV5y0/edit?usp=sharing) for running the BSP with the mq-store-agent (BSP Agent).
Please refer to these [instructions](https://docs.google.com/document/d/1N_HxUi6ZEkub9EHANe49vkL9iQztVA_ACyfHcOZV5y0/edit?usp=sharing) for running the BSP with the bsp-agent (BSP Agent).

Please refer to this [whitepaper](https://www.covalenthq.com/static/documents/Block%20Specimen%20Whitepaper%20V1.1.pdf) to understand more about its function.

Expand Down Expand Up @@ -134,7 +137,7 @@ The list of all services are -
1. bsp-agent (Specimen decoded, packer, prover and storer)

```bash
git clone [email protected]:covalenthq/go-ethereum.git
git clone [email protected]:covalenthq/bsp-geth.git
cd go-ethereum
docker-compose -f "docker-compose.yml" up
```
Expand Down Expand Up @@ -175,25 +178,25 @@ To inspect the actual block specimen binary files produced, exec into the `bsp-a
```bash
docker ps
docker exec -it <mq-store-agent_container_id> /bin/bash
docker exec -it <bsp-agent_container_id> /bin/bash
./bsp-extractor --binary-file-path "./bin/block-ethereum/" --codec-path "./codec/block-ethereum.avsc" --indent-json 0
```
The docker image for this service can be found [here](https://github.com/covalenthq/go-ethereum/pkgs/container/go-ethereum-bsp)
The docker image for this service can be found [here](https://github.com/covalenthq/bsp-geth/pkgs/container/go-ethereum-bsp)
Run only go-ethereum-bsp with the following, though this will not work if the other services in the docker-compose.yml file aren't also initialized.
```bash
docker pull ghcr.io/covalenthq/go-ethereum-bsp:latest
docker run ghcr.io/covalenthq/go-ethereum-bsp:latest
docker pull ghcr.io/covalenthq/bsp-geth-bsp:latest
docker run ghcr.io/covalenthq/bsp-geth-bsp:latest
```
## <span id="build_run">Build & Run</span>
Clone the `covalenthq/go-ethereum` repo and checkout the branch that contains the block specimen patch aka `covalent`
Clone the `covalenthq/bsp-geth` repo and checkout the branch that contains the block specimen patch aka `covalent`
```bash
git clone [email protected]:covalenthq/go-ethereum.git
git clone [email protected]:covalenthq/bsp-geth.git
cd go-ethereum
git checkout covalent
```
Expand Down
2 changes: 1 addition & 1 deletion docker-compose-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ services:
- 30303/udp

agent:
image: "ghcr.io/covalenthq/mq-store-agent:latest"
image: "ghcr.io/covalenthq/bsp-agent:latest"
container_name: bsp-agent
restart: on-failure
depends_on:
Expand Down
4 changes: 2 additions & 2 deletions docker-compose-testnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ services:
- "8081:8081"

geth:
image: "ghcr.io/covalenthq/go-ethereum-bsp:latest"
image: "ghcr.io/covalenthq/bsp-geth:latest"
container_name: bsp-geth
restart: always
depends_on:
Expand All @@ -51,7 +51,7 @@ services:
- ./data/.ethereum/:/data/.ethereum/

agent:
image: "ghcr.io/covalenthq/mq-store-agent:latest"
image: "ghcr.io/covalenthq/bsp-agent:latest"
container_name: bsp-agent
restart: always
depends_on:
Expand Down
12 changes: 6 additions & 6 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
## <span id="bugs">Reporting Bugs</span>

Please file bugs in the [GitHub Issue
Tracker](https://github.com/covalenthq/go-ethereum). Include at
Tracker](https://github.com/covalenthq/bsp-geth). Include at
least the following:

- What happened
Expand All @@ -33,8 +33,8 @@ too much information will never be a cause for concern.

Contributing to this repo can mean many things such as participating in discussion or proposing code changes. To ensure a smooth workflow for all contributors, the following general procedure for contributing has been established:

1. Either [open](https://github.com/covalenthq/go-ethereum/issues/new/choose)
or [find](https://github.com/covalenthq/go-ethereum/issues) an issue you have identified and would like to contribute to
1. Either [open](https://github.com/covalenthq/bsp-geth/issues/new/choose)
or [find](https://github.com/covalenthq/bsp-geth/issues) an issue you have identified and would like to contribute to
resolving.

2. Participate in thoughtful discussion on that issue.
Expand All @@ -61,15 +61,15 @@ PR, but be aware that for more complex problems/features, if a PR is opened befo
taken place in a github issue, that PR runs a high likelihood of being rejected.

Looking for a good place to start contributing? How about checking out
some [good first issues](https://github.com/covalenthq/go-ethereum/issues).
some [good first issues](https://github.com/covalenthq/bsp-geth/issues).

### <span id="dev_procedure">Development Procedure</span>

1. The latest state of development is on `main`.
2. `main` must never
fail `make lint, make geth, make all `
3. No `--force` onto `main` (except when reverting a broken commit, which should seldom happen).
4. Create your feature branch from `main` either on `github.com/covalenthq/go-ethereum`, or your fork (
4. Create your feature branch from `main` either on `github.com/covalenthq/bsp-geth`, or your fork (
using `git remote add origin`).
5. Before submitting a pull request, begin `git rebase` on top of `main`.

Expand All @@ -86,7 +86,7 @@ on `go mod tidy -v`.

### <span id="testing">Testing</span>

Covalent uses [GitHub Actions](https://github.com/features/actions) for automated [integration testing](https://github.com/covalenthq/go-ethereum/actions).
Covalent uses [GitHub Actions](https://github.com/features/actions) for automated [integration testing](https://github.com/covalenthq/bsp-geth/actions).

### <span id="braching_model_and_release">Branching Model and Release</span>

Expand Down

0 comments on commit 3ab3d46

Please sign in to comment.