AIngle

This repository contains the core AIngle libraries and binaries.

This is the most recent and well maintained version of AIngle with a refactored state model (you may see references to it as AIngle RSM).

Code Status

This code is in alpha. It is not for production use. The code is guaranteed NOT secure.

We will be frequently and heavily restructuring code APIs and data chains until Beta.

We are currently only supporting Linux at this time. You may or may not be able to successfully build and run AIngle on macOS. You definitely won't be able to on Windows (unless you are using WSL, but even that is untested). We will definitely be rolling out support for these OSes in the future, but in the meantime please use Linux for development!

Making the AIngle binaries available in your shell

There are a number of contexts and purposes you might be running in which yield different ways to access binaries.

Using nix-shell on a local clone

Assuming you have installed the nix shell:

nix-shell --argstr flavor happDev

This nix-shell flavor installs wrapper binaries for aingle and ai that will automatically compile and run the binaries. This is very useful if you are tracking changes in the aingle repo because when you check out a new rev, running aingle will compile automatically to the version at that rev.

Building with cargo if you already have rust installed:

cargo install --path crates/aingle
cargo install --path crates/ai

Usage

$ aingle --help
USAGE:
    aingle [FLAGS] [OPTIONS]

FLAGS:
    -h, --help           Prints help information
    -i, --interactive    Receive helpful prompts to create missing files and directories,
                             useful when running a conductor for the first time
    -V, --version        Prints version information

OPTIONS:
    -c, --config-path <config-path>
            Path to a YAML file containing conductor configuration

Running aingle requires a config file. You can generate one in the default configuration file locations using interactive mode:

$ aingle -i
There is no conductor config YAML file at the path specified (/home/eric/.config/aingle/conductor-config.yml)
Would you like to create a default config file at this location? [Y/n]
Y
Conductor config written.
There is no database set at the path specified (/home/eric/.local/share/aingle/databases)
Would you like to create one now? [Y/n]
Y
Database created.
Conductor ready.

As well as creating the config file this process also instantiates the database. If you provide a config file on first run with just the -c flag aingle will also initialize the environment even if not in interactive mode.

Development Environment

Assuming you have installed the nix shell:

git clone git@github.com:aingle/aingle.git
cd aingle
nix-shell
ai-merge-test

This will compile aingle and run all the tests.

If you get an error while running nix-shell about ngrok having an unfree license, you can fix that by running,

mkdir -p ~/.config/nixpkgs/
echo "{ allowUnfree = true; }" >> ~/.config/nixpkgs/config.nix

We have an all-in-one development environment including (among other things):

• The correct version and sane environment variables of cargo/rust
• Node for working with tryorama
• Scaffolding, build and deployment scripts
• Prebuilt binaries of core for various operating systems (soon)
• Shared libs such as libsodium

It is called AInix and you should use it.

It has plenty of documentation and functionality and can be used across Windows, Mac, and Linux. (Although AIngle itself currently only supports Linux.) It is based on the development tools provided by NixOS.

It is suitable for use in hackathons and 'serious' development for a long-term, production grade development team.

If you want to maintain your own development environment then we can only offer rough advice, because anything we say today could be out of date tomorrow:

• Use a recent stable version of rust
• Use node 12x+ for clientside work
• Install any relevant shared libs like libsodium
• Write your own scaffolding, build and development tools
• Plan for dependency management as we ship new binaries

Application Developer

Read the wasm API docs

Build the adk docs:

cargo doc --manifest-path=crates/adk/Cargo.toml --open

Core Developer

Build the aingle docs:

cargo doc --manifest-path=crates/aingle/Cargo.toml --open

Contribute

• Connect with us on our forum

License

Copyright (C) 2019 - 2021, AIngle