cardano-ts

cardano-ts is a library designed to facilitate interactions with the Cardano blockchain. This library aims to provide developers with an easy-to-use interface for building applications on top of Cardano, leveraging the robust features of the Cardano network.

This library is maintained by the Mynth team. Mynth is connecting Cardano and building highways to other networks, offering stableswaps, cross-chain interoperability and a scalable native Cardano stablecoin called MyUSD.

Requirements

• Node.js version 20.11.1 or higher.

Installation

To install cardano-ts, run the following command in your project directory:

npm install cardano-ts

Usage

After installation, you can import cardano-ts into your project to start interacting with the Cardano blockchain.

Example:

import { Wallet } from "cardano-ts";

// Example usage will go here

Building and Development

Run the following command to build the project:

npm run build

This command compiles the TypeScript source code and outputs the JavaScript to the dist directory, ready for deployment to npmjs.

Linting

To enforce code quality, cardano-ts uses ESLint and Prettier. Run the following commands to lint and format your code:

npm run lint
npm run prettier

Testing

To run tests, execute:

npm test

This command runs all tests and outputs the results.

Contributing

If you’d like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcomed.

License

cardano-ts is licensed under the MIT License, permitting unrestricted use, distribution, and modification.