Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 2.05 KB

3-installation.md

File metadata and controls

107 lines (72 loc) · 2.05 KB

Installation

The Warden Protocol is composed by different components, each one with its own installation instructions. This document will guide you through the process of installing each one of these components.

Prerequisites

  • Go 1.22 or later
  • just
  • Clone the repository:
git clone https://github.com/warden-protocol/wardenprotocol --depth=1
cd wardenprotocol

Docker

You can run all the services using Docker and Docker Compose.

All you need to run is:

docker compose up

You can also bring up specific services to run in the background, while running the rest locally on your machine for easier debugging.

Wardend (blockchain node)

Build

just install

This will build the chain binary called wardend and install it in your $GOPATH.

Verify the installation by running:

wardend version

If you can't find the wardend binary, make sure your PATH includes the $GOPATH/bin directory (by default $GOPATH is ~/go).

Run

When developing, it's best to use ignite to run the node:

ignite chain serve -p ./warden --home ~/.warden

This will start the node with a default configuration and genesis that contains some accounts and a Keychain pre-configured. Using this method will make it easier to run other services (e.g. Keychains, etc.).

WardenKMS

Build

You can use just:

just build wardenkms
./build/wardenkms

or run it directly:

KEYRING_MNEMONIC="liberty lucky weapon argue blast borrow matrix fabric topple auto tomato age simple obvious mushroom hire edge vault federal climb step element divorce problem" \
  KEYRING_PASSWORD="$USER" \
  go run ./cmd/wardenkms

SpaceWard

SpaceWard is a React app bundled with Vite.

Prerequisites

We use pnpm as the package manager, so make sure you have it installed.

npm install -g pnpm

Run (development)

cd spaceward
pnpm install
just dev

Build (production)

cd spaceward
pnpm run build