Skip to main content

Set up your project

Before we start, please make sure you have the following prerequisites in place:

Set up PostgreSQL database

Set up PostgreSQL database

Rell requires PostgreSQL 11. The IDE can work without it but can't run a node. A console or a remote postchain app can run without a database.

The default database configuration for Rell is:

  • database: postchain
  • user: postchain
  • password: postchain

Install​

  1. Install Homebrew: Homebrew installation guide

  2. Install PostgreSQL:

brew install postgresql
brew services start postgresql
createuser -s postgres
  1. Prepare the PostgreSQL database:
psql -U postgres -c "CREATE DATABASE postchain WITH TEMPLATE = template0 LC_COLLATE = 'en_US.UTF-8' LC_CTYPE = 'en_US.UTF-8' ENCODING 'UTF-8';" -c "CREATE ROLE postchain LOGIN ENCRYPTED PASSWORD 'postchain'; GRANT ALL ON DATABASE postchain TO postchain;"

If you get an error saying that peer authentication failed, you need to change the authentication method from peer to md5. You can change it in the pg_hba.conf file of your psql database.

Install Chromia CLI

Install Chromia CLI

This topic contains instructions to install and update the Chromia CLI.

Prerequisite​

Install​

Before installing the Chromia CLI, ensure you have installed the Java Development Kit (open JDK) and have at least Java 17. For more information, see JDK installation guide.

You can download and install the latest Chromia CLI from here or via a package manager:

brew tap chromia/core https://gitlab.com/chromaway/core-tools/homebrew-chromia.git
brew install chromia/core/chr

Update​

You can download and install the latest Chromia CLI from here, or if you have installed the Chromia CLI via a package manager, you can update it with the following:

brew update
brew upgrade chr

Docker​

Docker can run a standalone Linux container with the Chromia CLI pre-installed. Make sure that you have set up the PostgreSQL database.

To use the published Docker images, you must first have Docker installed and configured on your host machine. Please refer to the Docker documentation on how to install Docker on Windows, Mac, and Linux.

Start the Docker container with Chromia CLI pre-installed​

To run the latest version of the Chromia CLI, use the docker run command and specify the CLI Docker image name and chr.

docker run --rm -v $(pwd):/usr/app registry.gitlab.com/chromaway/core-tools/chromia-cli/chr:<latest version> chr

See the Docker command line reference for information about updating or uninstalling the Docker image.

#!/bin/bash

# Allocate a pseudo-TTY one when run in interactive mode
if [ -t 0 ] && [ -t 1 ] ; then TTY="--tty"; else TTY=""; fi

docker run \
  # Sets the network to host to not need to change the database hostname (linux only)
  --network=host \
  # Set timezone based on system settings (linux only)
  -e TZ=$(cat /etc/timezone) \
  # Sets process ownership to current user
  --user $(id -u):$(id -g) \
  --mount type=bind,source="/etc/passwd",target=/etc/passwd,readonly \
  --mount type=bind,source="/etc/group",target=/etc/group,readonly \
  # Configures ssh-agent (only needed if chr install is called on non-public repositores)
  -e SSH_AUTH_SOCK=$SSH_AUTH_SOCK \
  --volume "$SSH_AUTH_SOCK:$SSH_AUTH_SOCK" \
  --mount type=bind,source="${HOME}/.ssh",target=${HOME}/.ssh,readonly \
  --mount type=bind,source="${HOME}/.config/jgit",target=${HOME}/.config/jgit \
  # Mounts current folder into the container (Use `Get-Location` on PowerShell)
  --mount type=bind,source="$(pwd)",target=/usr/app \
  --interactive ${TTY} \
  --rm \
  registry.gitlab.com/chromaway/core-tools/chromia-cli/chr:${CHR_VERSION:-latest} chr "$@"

We will start by setting up a new project using Chromia CLI.

chr create-rell-dapp rell-marketplace --template=plain-multi
cd rell-marketplace

To finalize the stetup, we add the FT4 library to our project. Open your chromia.yml file and add ft4 to a new libs section and configure the public key as the admin key for out dapp:

chromia.yml
blockchains:
  rell-marketplace:
    module: main
libs:
  ft4:
    registry: https://bitbucket.org/chromawallet/ft3-lib
    tagOrBranch: v0.6.0r
    path: rell/src/lib/ft4
    rid: x"5A3613FE75047A110E381029C6A542E31A9085F57F13D0D6C5EC460BA2252823"
    insecure: false

To install FT4, we run:

chr install

That's the basic setup for using FT4. In the upcoming lessons, we will use this to create assets, transfer tokens, and register user accounts.