2. Aiken CLI Interaction

Overview

This feature enables users to configure their blockchain provider settings by selecting a network and entering a Blockchain Provider API key (Blockfrost, Maestro). Additionally, users can build a validator into a Plutus JSON file and run unit tests to ensure the validator functions correctly without errors or bugs.

User Story

As a user, I want to configure my blockchain provider by selecting a network and entering an API key (Blockfrost, Maestro). Furthermore I can build a validator into a Plutus JSON file and run unit tests to verify its correctness, ensuring there are no errors or bugs before deployment.

User Flow

Setup Blockchain Provider

1

User navigates to the Development page in the extension.

2

User selects a blockchain network from the dropdown menu

  • Preprod

  • Preview

3

User enters the Blockchain Provider API key in the provided field.

4

The system saves the data in the extension storage for future use

Build Validator

1

User navigates to the Development page in the extension

2

The user selects the current working folder that uses the Aiken validator for the project

3

User clicks "Build"

4

System generates the Plutus JSON file.

Test Validator

1

User navigates to the Development page in the extension

2

The user selects the current working folder that uses the Aiken validator for the project

3

User clicks "Test"

4

The system will check for syntax errors and execute all unit tests defined in the validator.

User Flow Diagrams

Setup Blockchain Provider

Build Validator

Test Validator

Troubleshooting & Common Issues

Issue

Possible Cause

Solution

Cannot build/test Aiken project

Incorrect project path

Verify the path to the Aiken source code folder

Cannot connect to blockchain provider

API key may be incorrect or expired

Verify the API key of the blockchain provider again

Demo

Screenshot

Video

🔹 For any issues, please refer to the Troubleshooting Section or open an Issue on GitHub.

Last updated