Skip to content

Repository files navigation

My Gift Contract

A comprehensive Cardano smart contract project for gifting ADA, built with Aiken and MeshSDK.

Project Structure

  • validators/: Contains the Aiken smart contract code (gift.ak).
  • lib/: Supporting Aiken functions.
  • scripts/: Off-chain interaction scripts (Typescript/MeshSDK).
  • plutus.json: Compiled smart contract blueprint (generated).

Prerequisites

  • Aiken installed.
  • Javascript runtime (Node.js 18+).
  • npm installed.

Setup

  1. Install Dependencies:

    npm install
  2. Environment Variables: Create a .env file in the root directory (copied from .env.example if available) and add your mnemonic:

    MNEMONIC="your 24 word mnemonic here ..."

Development Workflow

1. Compile Smart Contract

Compile the Aiken code to generate the plutus.json blueprint.

aiken build

2. Run Tests

Execute unit tests defined in validators/gift.ak.

aiken check

3. Off-chain Interaction

Run the off-chain script to interact with the contract (e.g., get contract address).

npm start

Documentation

About

A comprehensive Cardano smart contract project for gifting ADA, built with Aiken and MeshSDK.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages