/aiken-hello-world

a simple hello world contract for the Cardano chain

Primary LanguageTypeScript

hello-world

Hello World for learning Aiken following this tutorial. You can find examples of this code locking and unlocking funds on the Cardano Preview Chain.

Auto generated stuff

(everything below was auto generated by the Project initializer)

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

validator {
  fn spend(_datum: Data, _redeemer: Data, _context: Data) -> Bool {
    True
  }
}

Validators are named after their purpose, so one of:

  • spent
  • mint
  • withdraw
  • publish

Building

aiken build

Testing

You can write tests in any module using the test keyword. For example:

test foo() {
  1 + 1 == 2
}

To run all tests, simply do:

aiken check

To run only tests matching the string foo, do:

aiken check -m foo

Documentation

If you're writing a library, you might want to generate an HTML documentation for it.

Use:

aiken docs

Resources

Find more on the Aiken's user manual.