2021-04-14 11:42:20 +00:00
|
|
|
|
## Aqua
|
2021-02-01 13:17:46 +00:00
|
|
|
|
|
2021-04-30 08:51:55 +00:00
|
|
|
|
[![release](https://github.com/fluencelabs/aqua/actions/workflows/release.yml/badge.svg)](https://github.com/fluencelabs/aqua/actions/workflows/release.yml)
|
|
|
|
|
|
2021-04-14 11:42:20 +00:00
|
|
|
|
Aqua is a new-gen language for distributed systems.
|
2021-02-01 13:17:46 +00:00
|
|
|
|
|
2021-04-14 11:42:20 +00:00
|
|
|
|
Aqua programs are executed on many peers, sequentially
|
2021-04-13 13:02:36 +00:00
|
|
|
|
or in parallel, forming a single-use coordination network.
|
2021-03-19 09:40:27 +00:00
|
|
|
|
|
2021-04-14 11:42:20 +00:00
|
|
|
|
Aqua's runtime is heterogeneous: it includes browsers, servers, devices, all involved in solving a single task.
|
|
|
|
|
Therefore, Aqua scripts are compiled into several targets at once, with AIR and Typescript as a default.
|
2021-03-19 09:40:27 +00:00
|
|
|
|
|
2021-04-16 17:15:45 +00:00
|
|
|
|
## Using Aqua
|
|
|
|
|
|
2021-08-03 14:23:28 +00:00
|
|
|
|
Please refer to [Aqua Book](https://doc.fluence.dev/aqua-book/) to learn how to use Aqua.
|
2021-04-16 17:15:45 +00:00
|
|
|
|
|
2021-04-13 13:02:36 +00:00
|
|
|
|
## Compiler CLI
|
2021-03-19 09:40:27 +00:00
|
|
|
|
|
2021-04-14 11:42:20 +00:00
|
|
|
|
To build the Aqua compiler, clone the repo & run `sbt assembly`,
|
2021-04-16 17:15:45 +00:00
|
|
|
|
or simply download the latest JAR file from the [releases](https://github.com/fluencelabs/aqua/releases) page.
|
2021-03-19 09:40:27 +00:00
|
|
|
|
|
2021-04-14 11:42:20 +00:00
|
|
|
|
It requires `java` to run Aqua compiler from the command line:
|
2021-03-19 09:40:27 +00:00
|
|
|
|
|
|
|
|
|
```commandline
|
2021-06-22 08:32:27 +00:00
|
|
|
|
java -jar aqua-cli-%version_number%.jar -i path/to/input/dir -o path/to/output/dir
|
2021-03-19 09:40:27 +00:00
|
|
|
|
```
|
2021-04-13 13:02:36 +00:00
|
|
|
|
|
|
|
|
|
Input directory should contain files with `aqua` scripts.
|
|
|
|
|
|
|
|
|
|
## Repository structure
|
|
|
|
|
|
|
|
|
|
- **[types](./types)** – data types, arrows, stream types definitions and variance
|
|
|
|
|
- **[parser](./parser)** - parser, takes source text and produces a source AST
|
|
|
|
|
- **[model](./model)** - middle-end, internal representation of the code, optimizations and transfromations
|
|
|
|
|
- **[semantics](./semantics)** - rules to convert source AST into the model
|
2021-04-13 13:05:31 +00:00
|
|
|
|
- **[linker](./linker)** - checks dependencies between modules, builds and combines an abstract dependencies tree
|
2021-08-03 14:23:28 +00:00
|
|
|
|
- **[backend](./backend)** - compilation backend interface
|
|
|
|
|
- **[compiler](./compiler)** - compiler as a pure function made from _linker_, _semantics_ and _backend_
|
2021-04-13 13:02:36 +00:00
|
|
|
|
- **[backend/air](./backend/air)** – generates AIR code from the middle-end model
|
|
|
|
|
- **[backend/ts](./backend/ts)** - generates AIR code and Typescript wrappers for use with Fluence JS SDK
|
|
|
|
|
- **[cli](./cli)** - CLI interface
|