Skip to content

Commit

Permalink
bump readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seunlanlege committed Jan 20, 2024
1 parent ceaa5dd commit 7606800
Showing 1 changed file with 106 additions and 1 deletion.
107 changes: 106 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,110 @@
# Hyperbridge
Hyperbridge is a hyper-scalable, interoperability coprocessor.
Hyperbridge is a hyper-scalable coprocessor for cryptographically secure, cross-chain interoperability.

## Docker

Hyperbridge is available at the official docker repository [`polytopelabs/hyperbridge`](https://hub.docker.com/r/polytopelabs/hyperbridge)

```bash
docker run polytopelabs/hyperbridge:latest --chain=messier
```

## Prebuilt Binaries

You can install a prebuilt binary for the hyperbridge node with the following bash script

```bash
wget -q --show-progress https://github.com/polytope-labs/hyperbridge/releases/download/${latest-tag}/hyperbridge-x86_64-unknown-linux-gnu.tar.gz
tar -xvzf hyperbridge-x86_64-unknown-linux-gnu.tar.gz
# copy to $PATH
cp hyperbridge-x86_64-unknown-linux-gnu/hyperbridge $HOME/.local/bin/
```

or a 1-liner shell script

```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/polytope-labs/hyperbridge/releases/download/${latest-tag}/hyperbridge-installer.sh | sh
```

## Building from source

You can follow the steps below if you'd prefer to build the hyperbridge node from source:


### Install Dependencies

Building the hyperbridge node requires some dependencies

- git
- clang
- curl
- make
- build-essential
- libssl-dev
- llvm
- libudev-dev
- protobuf-compiler

Debian/Ubuntu

```bash
sudo apt install --assume-yes git clang curl libssl-dev llvm libudev-dev make protobuf-compiler
```
Arch

```bash
pacman -Syu --needed --noconfirm curl git clang make protobuf
```
Fedora

```bash
sudo dnf update
sudo dnf install clang curl git openssl-devel make protobuf-compiler
```
Opensuse

```bash
sudo zypper install clang curl git openssl-devel llvm-devel libudev-devel make protobuf
```

### Install rust compiler

If you don't have an already existing rust installation, you can install it using the one-liner below. Follow the prompts displayed to proceed with a default installation.

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

### Install WebAssembly target

Hyperbridge's blockchain runtime compiles to wasm which allows it's code to be forklessly upgraded. In order to build hyperbridge we need the wasm toolchain installed.

```bash
rustup update nightly
rustup target add wasm32-unknown-unknown --toolchain nightly
```

### Clone the repo

Download a local copy of the repo and checkout the latest release tag

```bash
git clone https://github.com/polytope-labs/hyperbridge.git
cd ./hyperbidge
git checkout ${latest-tag}
```

### Build the node

```bash
cargo build --release -p hyperbridge
```

## Running the node

```bash
hyperbridge --chain=messier --enable-offchain-indexing --base-path=$HOME/.hyperbridge --pruning-archive
```

## Running a local tesnet with zombienet
1. Download the zombienet binary for your os from https://github.com/paritytech/zombienet
Expand Down

0 comments on commit 7606800

Please sign in to comment.