diff --git a/packages/contracts/src/escrow/aiken-workspace/.github/workflows/tests.yml b/packages/contracts/src/escrow/aiken-workspace/.github/workflows/tests.yml new file mode 100644 index 00000000..74b642a3 --- /dev/null +++ b/packages/contracts/src/escrow/aiken-workspace/.github/workflows/tests.yml @@ -0,0 +1,20 @@ +name: Tests + +on: + push: + branches: ["main"] + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - uses: aiken-lang/setup-aiken@v0.1.0 + with: + version: v1.0.24-alpha + + - run: aiken fmt --check + - run: aiken check -D + - run: aiken build diff --git a/packages/contracts/src/escrow/aiken-workspace/.gitignore b/packages/contracts/src/escrow/aiken-workspace/.gitignore new file mode 100644 index 00000000..ff7811b1 --- /dev/null +++ b/packages/contracts/src/escrow/aiken-workspace/.gitignore @@ -0,0 +1,6 @@ +# Aiken compilation artifacts +artifacts/ +# Aiken's project working directory +build/ +# Aiken's default documentation export +docs/ diff --git a/packages/contracts/src/escrow/aiken-workspace/aiken.lock b/packages/contracts/src/escrow/aiken-workspace/aiken.lock new file mode 100644 index 00000000..4dddde5c --- /dev/null +++ b/packages/contracts/src/escrow/aiken-workspace/aiken.lock @@ -0,0 +1,26 @@ +# This file was generated by Aiken +# You typically do not need to edit this file + +[[requirements]] +name = "aiken-lang/stdlib" +version = "1.8.0" +source = "github" + +[[requirements]] +name = "sidan-lab/aiken-utils" +version = "0.0.4-beta" +source = "github" + +[[packages]] +name = "aiken-lang/stdlib" +version = "1.8.0" +requirements = [] +source = "github" + +[[packages]] +name = "sidan-lab/aiken-utils" +version = "0.0.4-beta" +requirements = [] +source = "github" + +[etags] diff --git a/packages/contracts/src/escrow/aiken-workspace/aiken.toml b/packages/contracts/src/escrow/aiken-workspace/aiken.toml new file mode 100644 index 00000000..2bf9fa9b --- /dev/null +++ b/packages/contracts/src/escrow/aiken-workspace/aiken.toml @@ -0,0 +1,19 @@ +name = "meshjs/escrow" +version = "0.0.0" +license = "Apache-2.0" +description = "Aiken contracts for project 'meshjs/escrow'" + +[repository] +user = "meshjs" +project = "escrow" +platform = "github" + +[[dependencies]] +name = "aiken-lang/stdlib" +version = "1.8.0" +source = "github" + +[[dependencies]] +name = "sidan-lab/aiken-utils" +version = "0.0.4-beta" +source = "github" diff --git a/packages/contracts/src/escrow/aiken-workspace/lib/escrow/types.ak b/packages/contracts/src/escrow/aiken-workspace/lib/escrow/types.ak new file mode 100644 index 00000000..e69de29b diff --git a/packages/contracts/src/escrow/aiken-workspace/lib/escrow/validators/escrow.ak b/packages/contracts/src/escrow/aiken-workspace/lib/escrow/validators/escrow.ak new file mode 100644 index 00000000..e69de29b diff --git a/packages/contracts/src/escrow/aiken-workspace/plutus.json b/packages/contracts/src/escrow/aiken-workspace/plutus.json index e69de29b..6364462c 100644 --- a/packages/contracts/src/escrow/aiken-workspace/plutus.json +++ b/packages/contracts/src/escrow/aiken-workspace/plutus.json @@ -0,0 +1,14 @@ +{ + "preamble": { + "title": "meshjs/escrow", + "description": "Aiken contracts for project 'meshjs/escrow'", + "version": "0.0.0", + "plutusVersion": "v2", + "compiler": { + "name": "Aiken", + "version": "v1.0.24-alpha+982eff4" + }, + "license": "Apache-2.0" + }, + "validators": [] +} \ No newline at end of file diff --git a/packages/contracts/src/escrow/aiken-workspace/readme.md b/packages/contracts/src/escrow/aiken-workspace/readme.md index e69de29b..90c64a6f 100644 --- a/packages/contracts/src/escrow/aiken-workspace/readme.md +++ b/packages/contracts/src/escrow/aiken-workspace/readme.md @@ -0,0 +1,55 @@ +# escrow + +Write validators in the `validators` folder, and supporting functions in the `lib` folder using `.ak` as a file extension. + +For example, as `validators/always_true.ak` + +```gleam +validator { + fn spend(_datum: Data, _redeemer: Data, _context: Data) -> Bool { + True + } +} +``` + +## Building + +```sh +aiken build +``` + +## Testing + +You can write tests in any module using the `test` keyword. For example: + +```gleam +test foo() { + 1 + 1 == 2 +} +``` + +To run all tests, simply do: + +```sh +aiken check +``` + +To run only tests matching the string `foo`, do: + +```sh +aiken check -m foo +``` + +## Documentation + +If you're writing a library, you might want to generate an HTML documentation for it. + +Use: + +```sh +aiken docs +``` + +## Resources + +Find more on the [Aiken's user manual](https://aiken-lang.org). diff --git a/packages/contracts/src/escrow/aiken-workspace/validators/escrow.ak b/packages/contracts/src/escrow/aiken-workspace/validators/escrow.ak new file mode 100644 index 00000000..e69de29b diff --git a/packages/contracts/src/escrow/aiken-workspace/validators/tests/escrow.ak b/packages/contracts/src/escrow/aiken-workspace/validators/tests/escrow.ak new file mode 100644 index 00000000..e69de29b