Skip to main content

Installation

The Currency Framework can be installed in several ways:

  • Euclid (recommended): Install an empty project in Euclid SDK using the hydra install command.
  • giter8: The Currency Framework is distributed as a g8 template project that can be customized for your organization. This template can be manually built using giter8. For more details, visit the project repository.
  • metagraph-examples: Explore ready-to-use examples of metagraph codebases in the metagraph-examples repo. These examples can also be installed automatically via hydra with the install-template command.
note

It is highly recommended to use the Euclid Development Environment for installation and compilation processes. Euclid simplifies the generation of dependencies and your metagraph JARs. The following steps assume that you are using Euclid.

Installation Using Giter8

note

Manual installation using giter8 necessitates pre-generated Tessellation dependencies. To generate these dependencies, execute the following commands in the tessellation repository on the desired tag:

sbt shared/publishM2 kernel/publishM2 keytool/publishM2 nodeShared/publishM2 dagL1/publishM2 currencyL0/publishM2 currencyL1/publishM2

Ensure Scala and giter8 are installed. Install giter8 with:

./cs install giter8

Then, install the template using the specified tag:

# replace v.2.3.3 with the version to install
g8 Constellation-Labs/currency --tag "v2.3.3"

Compiling the Project

After installing your project and the Tessellation dependencies, compile the project to generate your local JAR files. You can compile as follows:

For metagraph-l0:

sbt currencyL0/assembly

For currency-l1:

sbt currencyL1/assembly

For data-l1:

sbt dataL1/assembly

Installation Using Metagraph Examples

Using Euclid, you can execute the following command to list the available examples:

hydra install-template --list

To install the desired template, execute this command:

# replace 'nft' with the name of the desired template
hydra install-template nft

Compiling the Project

To compile the project using Euclid, you just need to run:

hydra build