ctl-scaffold

ctl-scaffold

Welcome to your new CTL project!

Development

To start working on this project, enter the Nix environment by running nix develop. Please make sure to use Nix v2.8 or later.

Please also see our

• Documentation

• PureScript API documentation for CTL

• Discord server

If you encounter problems and/or want to report a bug, you can open an issue here.

Please search for existing issues beforehand!

Testing

Here are a few tips on how to get started with testing your code.

Testing with Plutip

Plutip is a tool that manages local disposable cardano-node clusters that we use to test contracts locally.

• run npm run test from Nix shell

Testing with Blockfrost

Blockfrost.io is an alternative CTL backend that can be used as a subscription service.

• populate the variables in test/blockfrost.env following this guide
• run npm run blockfrost-test (no Nix shell required, but the correct versions of Spago and PureScript compiler must be used)

Testing with a headless browser

Headless browser test suite allows to run user contracts with real wallet browser extensions automatically.

• Start the CTL runtime services: npm run start-runtime
• run npm run e2e-serve from Nix shell to start a web server
• run npm run e2e-test from Nix shell to run the test suite