@kiroboio/fct-core/README.md

Kirobo.io FCT Core library

# @kirobo/fct-core
[![npm (tag)](https://img.shields.io/npm/v/@kiroboio/fct-core)](https://www.npmjs.com/package/@kiroboio/fct-core)
![npm (downloads)](https://img.shields.io/npm/dm/@kiroboio/fct-core)

Library for interacting, creating and developing Kirobo Future Conditional Transactions (FCT), written in TypeScript.

## Installation

npm:
```bash
npm install @kiroboio/fct-core
```

yarn:
```bash
yarn add @kiroboio/fct-core
```

pnpm:
```bash
pnpm add @kiroboio/fct-core
```

## Documentation

Full documentation can be found [here](https://kirobo.gitbook.io/fct-core-library/).

## Testing

Before testing make sure to copy the `.env.example` file to `.env` and fill in the required values:
- `RPC_URL_MAINNET` - RPC URL for the mainnet


```bash
npm run test

yarn run test
```

## Build

Creates a `dist` folder with the compiled code.

```bash
npm run build

yarn run build
```