README.md

⛓️

Cardano Sidechains Tooling

Helpful tools for sidechain builders.

Read the Docs · Report Bug · Request Feature

Table of Contents

• About
• Getting Started
  • Installation
• Usage
  • Reference
• Contributing
• License
• Contact

About

This project contains helpful tools for Cardano sidechain builders.

(back to top)

Getting Started

The project hosts CLI tooling to assist sidechain builders with common tasks. If you're new to Cardano sidechains, then go ahead and visit the documentation linked above to learn more.

(back to top)

Installation

1. Download the packaged binaries for sc-evm-cli, sidechain-cli and trustless-sidechain-cli on the releases page >>>

2. Extract the packages using your preferred tar and zip utility.

3. Add binaries to your shell's path for greater convenience.

(back to top)

Usage

./sc-evm-cli <subcommand> <arguments...>

./sidechain-cli <subcommand> <arguments...>

node <trustless-sidechain-ctl-directory>/main.js <subcommand> <arguments>

Note for macOS users

When you execute a command for the first time, you will get a warning pop-up complaining that the ABI cannot be executed because the developer cannot be verified.
The workaround is this:

1. Press cancel on the pop-up
2. Stop the CLI process with command-C
3. Go to System settings → Privacy & Security tab to allow the app
4. Click Allow anyway
5. Repeat for one more library.

Reference

sc-evm-cli reference guide >>>

sidechain-cli reference guide >>>

trustless-sidechain-cli reference guide >>>

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. See CONTRIBUTING.md for more information.

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE.md for more information.

(back to top)

Contact

See "Communication channels" in CONTRIBUTING.md.

(back to top)