Skip to content

Latest commit

 

History

History
135 lines (107 loc) · 5.14 KB

development-environment.md

File metadata and controls

135 lines (107 loc) · 5.14 KB
Raw

Setting up development environment

Install dependencies

macOS

WARNING: macOS uses ancient version of the make. Akash's environment uses some tricks available in make 4. We recommend use homebrew to installs most up-to-date version of the make. Keep in mind make is keg-only, and you'll need manually add its location to the PATH. Make sure homebrew's make path takes precedence of /usr/bin

brew install curl wget jq direnv coreutils make npm

# Depending on your shell, it may go to .zshrc, .bashrc etc
export PATH="$(brew --prefix)/opt/make/libexec/gnubin:$PATH"

Linux

Debian based

TODO validate

sudo apt update
sudo apt install -y jq curl wget build-essentials ca-certificates npm direnv gcc

Direnv

Both akash provider-services are extensively using direnv to set up and seamlessly update environment while traversing across various directories. It is especially handy for running provider-services examples.

Warning

Some distributions may provider outdated version of direnv. Currently minimum required version is 2.32.x. Latest version can be installed using binary builds

You may enable auto allow by whitelisting specific directories in direnv.toml. To do so use following template to edit ${XDG_CONFIG_HOME:-$HOME/.config}/direnv/direnv.toml

[whitelist]
prefix = [
    "<path to akash sources>",
    "<path to provider-services sources>"
]

Cache

Build environment will create .cache directory in the root of source-tree. We use it to install specific versions of temporary build tools. Refer to make/setup-cache.mk for exact list. It is possible to set custom path to .cache with AKASH_DEVCACHE environment variable.

All tools are referred as makefile targets and set as dependencies thus installed (to .cache/bin) only upon necessity. For example protoc installed only when proto-gen target called.

The structure of the dir:

./cache
    bin/ # build tools
    run/ # work directories for _run examples (provider-services
    versions/ # versions of installed build tools (make targets use them to detect change of version of build tool and install new version if changed)

Add new tool

We will use modevendor as an example. All variables must be capital case.

Following are added to make/init.mk

  1. Add version variable as <NAME>_VERSION ?= <version> to the "# ==== Build tools versions ====" section

    MODVENDOR_VERSION                  ?= v0.3.0

  2. Add variable tracking version file <NAME>_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/<tool>/$(<TOOL>) to the # ==== Build tools version tracking ==== section

    MODVENDOR_VERSION_FILE             := $(AKASH_DEVCACHE_VERSIONS)/modvendor/$(MODVENDOR)

  3. Add variable referencing executable to the # ==== Build tools executables ==== section

    MODVENDOR                          := $(AKASH_DEVCACHE_VERSIONS)/bin/modvendor

  4. Add installation rules. Following template is used followed by the example

    $(<TOOL>_VERSION_FILE): $(AKASH_DEVCACHE)
	@echo "installing <tool> $(<TOOL>_VERSION) ..."
	rm -f $(<TOOL>)      # remove current binary if exists
	# installation procedure depends on distribution type. Check make/setup-cache.mk for various examples
	rm -rf "$(dir $@)"   # remove current version file if exists
	mkdir -p "$(dir $@)" # make new version directory
	touch $@             # create new version file
$(<TOOL>): $(<TOOL>_VERSION_FILE)

    Following are added to make/setup-cache.mk

    $(MODVENDOR_VERSION_FILE): $(AKASH_DEVCACHE)
	@echo "installing modvendor $(MODVENDOR_VERSION) ..."
	rm -f $(MODVENDOR)
	GOBIN=$(AKASH_DEVCACHE_BIN) $(GO) install github.com/goware/modvendor@$(MODVENDOR_VERSION)
	rm -rf "$(dir $@)"
	mkdir -p "$(dir $@)"
	touch $@
$(MODVENDOR): $(MODVENDOR_VERSION_FILE)

Releasing

With following release instructions Akash Network team attempted to unify build and release processes:

  • reproducible builds
  • correct Go toolchains and CGO environment (required for Ledger devices support)

Build is performed by Goreleaser-cross. This project was created and is maintained by Akash Network core member @troian, and it solves cross-compilation for Golang project with CGO on various hosts for various platforms.

Caution

The goreleaser-cross image is roughly 7GB in size. You've been warned!

  1. To start build simply type

    make release

  2. To release with custom docker image names prepend release command with RELEASE_DOCKER_IMAGE variable

    RELEASE_DOCKER_IMAGE=ghcr.io/akash-network/node make release

  3. To build just docker images one case use following command.

    make docker-image

    or one with custom registry

    RELEASE_DOCKER_IMAGE=ghcr.io/akash-network/node make docker-image