https://github.com/logicalmechanism/assist

A library of specialized Aiken functions for smart contracts on Cardano.
https://github.com/logicalmechanism/assist

Last synced: about 2 months ago
JSON representation

A library of specialized Aiken functions for smart contracts on Cardano.

• Host: GitHub
• URL: https://github.com/logicalmechanism/assist
• Owner: logicalmechanism
• License: apache-2.0
• Created: 2023-05-16T16:33:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-24T19:33:24.000Z (2 months ago)
• Last Synced: 2024-04-24T21:02:08.214Z (2 months ago)
• Language: Gleam
• Size: 9.01 MB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Lists

• awesome-aiken - Logical Mechanism/assist - A collection of specialized Aiken functions. (Libraries)

README

        
# Aiken Assist Library

The **Aiken Assist Library** is a collection of specialized Aiken functions designed for smart contracts on Cardano. This library extends the default functionality and provides routines that facilitate quick development.

## Getting Started

To start using the library, follow these steps:

1. Open your `aiken.toml` file.

2. Add the following code to bottom of the `aiken.toml` file:

```toml

[[dependencies]]

name = "logicalmechanism/assist"

version = "v0.4.4"

source = "github"

```

3. Save the `aiken.toml` file.

4. Compile your project by running the command `aiken check` in your project directory.

```bash

rm -fr build || true

aiken check

```

- Stay up to date by updating the version to the newest tag when applicable, i.e. `v0.4.2` -> `v0.4.x`.

## Usage

To use the **Aiken Assist Library** in your project, import the desired submodules into your `.ak` file. For example:

```aiken

use assist/signing

use assist/count

```

Assist modules can be found in the documentation.

## Documentation

You can generate the library's documentation locally by running the command `aiken docs` in your project directory. Alternatively, you can view the [online documentation](https://www.logicalmechanism.io/docs/index.html) for detailed information on the library's functions and usage.

## Contributing

Want to contribute? See [CONTRIBUTING.md](./CONTRIBUTING.md) to know how.

## Contact

For any questions or feedback, please contact the project maintainer at `[email protected]`.

## License

The **Aiken Assist Library** is released under the Apache2 License. See the `LICENSE` file for more details.