oasis-core

(โ˜… 369)

Performant and Confidentiality-Preserving Smart Contracts + Blockchains

  • .dockerignore
  • .gitbook.yaml
  • .gitignore
  • .gitlint
  • .goreleaser.yml
  • .markdownlint.yml
  • .punch_config.py
  • .punch_version.py
  • .rustfmt.toml
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • codecov.yml
  • common.mk
  • CONTRIBUTING.md
  • GOVERNANCE.md
  • LICENSE
  • LICENSE-docs
  • Makefile
  • README.md
  • rust-toolchain.toml
  • towncrier.toml

# Installation Guide

1. Get the code
git clone https://github.com/oasisprotocol/oasis-core

Downloads the entire project code from GitHub to your computer.

cd oasis-core

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f docker/aesmd/Dockerfile -t oasis-core .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 oasis-core

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd go

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

โœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation