diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml index 85670e399..e6df9b1e9 100644 --- a/.github/workflows/docker-image.yml +++ b/.github/workflows/docker-image.yml @@ -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 diff --git a/README.md b/README.md index 41557f063..775ded943 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,35 @@ ![banner](./docs/covalent.jpg)
- + Version - + License: - - Go report card + + Go report card Discord
Discord - Twitter Follow Covalent @@ -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. @@ -134,7 +137,7 @@ The list of all services are - 1. bsp-agent (Specimen decoded, packer, prover and storer) ```bash - git clone git@github.com:covalenthq/go-ethereum.git + git clone git@github.com:covalenthq/bsp-geth.git cd go-ethereum docker-compose -f "docker-compose.yml" 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 /bin/bash +docker exec -it /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 ``` ## Build & Run -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 git@github.com:covalenthq/go-ethereum.git +git clone git@github.com:covalenthq/bsp-geth.git cd go-ethereum git checkout covalent ``` diff --git a/docker-compose-ci.yml b/docker-compose-ci.yml index eece844b9..e25400536 100644 --- a/docker-compose-ci.yml +++ b/docker-compose-ci.yml @@ -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: diff --git a/docker-compose-testnet.yml b/docker-compose-testnet.yml index d5f12998b..40ca76d7f 100644 --- a/docker-compose-testnet.yml +++ b/docker-compose-testnet.yml @@ -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: @@ -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: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ae5b7bf2b..6a518a4f0 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -15,7 +15,7 @@ ## Reporting Bugs 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 @@ -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. @@ -61,7 +61,7 @@ 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). ### Development Procedure @@ -69,7 +69,7 @@ some [good first issues](https://github.com/covalenthq/go-ethereum/issues). 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`. @@ -86,7 +86,7 @@ on `go mod tidy -v`. ### Testing -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). ### Branching Model and Release