Skip to content

Commit

Permalink
Remove protoc dependency and update README (#769)
Browse files Browse the repository at this point in the history
* Remove protoc dependency

* Update badges

* Remove protoc from CI
  • Loading branch information
austinabell authored Oct 20, 2020
1 parent fc05e12 commit 6535480
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 129 deletions.
15 changes: 8 additions & 7 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,16 @@ commands:
curl file gcc g++ git make openssh-client \
autoconf automake cmake libtool libcurl4-openssl-dev libssl-dev \
libelf-dev libdw-dev binutils-dev zlib1g-dev libiberty-dev wget \
xz-utils pkg-config python clang ocl-icd-opencl-dev libgflags-dev
xz-utils pkg-config python clang ocl-icd-opencl-dev libgflags-dev libhwloc-dev
rustup component add clippy rustfmt
git submodule update --init
PROTOC_ZIP=protoc-3.7.1-linux-x86_64.zip
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.7.1/$PROTOC_ZIP
sudo unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
sudo unzip -o $PROTOC_ZIP -d /usr/local 'include/*'
rm -f $PROTOC_ZIP
sudo apt-get install -y libhwloc-dev
# TODO enable when protoc used again
# PROTOC_ZIP=protoc-3.7.1-linux-x86_64.zip
# curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.7.1/$PROTOC_ZIP
# sudo unzip -o $PROTOC_ZIP -d /usr/local bin/protoc
# sudo unzip -o $PROTOC_ZIP -d /usr/local 'include/*'
# rm -f $PROTOC_ZIP
save_cargo_package_cache:
description: Save cargo package cache for subsequent jobs
steps:
Expand Down
25 changes: 13 additions & 12 deletions .github/workflows/ci-rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ jobs:
sudo apt install ocl-icd-opencl-dev
sudo apt-get install -y libhwloc-dev
- name: Install Protoc
uses: arduino/setup-protoc@master
with:
version: "3.9.1"
# TODO enable when protoc needed again
# - name: Install Protoc
# uses: arduino/setup-protoc@master
# with:
# version: "3.9.1"

- name: Toolchain setup
uses: actions-rs/toolchain@v1
Expand Down Expand Up @@ -81,10 +82,10 @@ jobs:
- name: Install OpenCL
run: sudo apt install ocl-icd-opencl-dev

- name: Install Protoc
uses: arduino/setup-protoc@master
with:
version: "3.9.1"
# - name: Install Protoc
# uses: arduino/setup-protoc@master
# with:
# version: "3.9.1"

- uses: actions-rs/toolchain@v1
with:
Expand Down Expand Up @@ -124,10 +125,10 @@ jobs:
- name: Install OpenCL
run: sudo apt install ocl-icd-opencl-dev

- name: Install Protoc
uses: arduino/setup-protoc@master
with:
version: "3.9.1"
# - name: Install Protoc
# uses: arduino/setup-protoc@master
# with:
# version: "3.9.1"

- name: Build documentation
run: cargo doc --no-deps --all-features
Expand Down
103 changes: 3 additions & 100 deletions Cargo.lock

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

14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
</p>


![](https://github.com/ChainSafe/forest/workflows/Rust%20CI/badge.svg?event=push&branch=main)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord)](https://discord.gg/Q6A3YA2)
[![](https://img.shields.io/twitter/follow/espadrine.svg?label=Follow&style=social)](https://twitter.com/chainsafeth)
[<img alt="build status" src="https://img.shields.io/github/workflow/status/ChainSafe/forest/Rust%20CI/main?style=for-the-badge" height="20">](https://github.com/dtolnay/serde-repr/actions?query=branch%3Amaster)
[<img alt="Apache License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" height="20">](https://opensource.org/licenses/Apache-2.0)
[<img alt="MIT License" src="https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge" height="20">](https://opensource.org/licenses/MIT)
[<img alt="Discord" src="https://img.shields.io/discord/593655374469660673.svg?style=for-the-badge&label=Discord&logo=discord" height="20">](https://discord.gg/Q6A3YA2)
[<img alt="Twitter" src="https://img.shields.io/twitter/follow/espadrine.svg?style=for-the-badge&label=Twitter&color=1DA1F2" height="20">](https://twitter.com/chainsafeth)


Forest is an implementation of [Filecoin](https://filecoin.io/) written in Rust. The implementation will take a modular approach to building a full Filecoin node in two parts — (i) building Filecoin’s security critical systems in Rust from the [Filecoin Protocol Specification](https://filecoin-project.github.io/specs/), specifically the virtual machine, blockchain, and node system, and (ii) integrating functional components for storage mining and storage & retrieval markets to compose a fully functional Filecoin node implementation.
Expand All @@ -23,7 +23,7 @@ Our crates:
| `encoding` | Forest encoding and decoding |
| `ipld` | IPLD data model for content-addressable data |
| `node` | Networking synchronization and storage |
| `vm` | State transition and actor, message and address definitions |
| `vm` | State transition and actors, message and address definitions |

## Dependencies
rustc >= 1.40.0
Expand All @@ -39,7 +39,7 @@ make install
forest
```

> `protoc` and `OpenCL` are also required to build. Installation for protoc can be found [here](http://google.github.io/proto-lens/installing-protoc.html).
> `OpenCL`, `hwloc` and a compatible assembly linker (ex. `clang`) are also required to build Filecoin proofs.
### Config

Expand Down
3 changes: 0 additions & 3 deletions blockchain/beacon/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,5 @@ base64 = "0.12.1"
async-std = { version = "1.6.3", features = ["unstable", "attributes"] }
serde_json = "1.0"

[build-dependencies]
protoc-rust-grpc = "0.8"

[features]
json = ["base64", "forest_json_utils"]

0 comments on commit 6535480

Please sign in to comment.