# tzklar

> Building blocks for Tezos contracts

Latest version **2.0.0** (published 2021-12-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install tzklar
pnpm add tzklar
yarn add tzklar
bun add tzklar
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-12-29 |
| First published | 2021-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 136.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Klarluft |
| Maintainers | michal.wrzosek |

## Links

- npm: https://www.npmjs.com/package/tzklar
- Repository: https://github.com/klarluft/tzklar
- Homepage: https://github.com/klarluft/tzklar#readme
- Issues: https://github.com/klarluft/tzklar/issues
- npm.io page: https://npm.io/package/tzklar

## Dependencies (2)

- [@pinata/sdk](https://npm.io/package/@pinata/sdk.md) ^1.1.23
- [ipfs-unixfs-importer](https://npm.io/package/ipfs-unixfs-importer.md) ^9.0.6

## Recent versions

- 2.0.0 (latest) — 2021-12-29
- 1.1.3 — 2021-12-23
- 1.1.2 — 2021-12-23

## README

# tzKlar

[![npm](https://img.shields.io/npm/v/tzklar)](https://npmjs.com/package/tzklar)

[![tzklar](/tzklar-logo.png)](https://tzklar.com)

**Building blocks for Tezos contracts**

[https://tzklar.com](https://tzklar.com)

## How to install

Install via npm or yarn

```bash
npm install tzklar
yarn add tzklar
```

## How to use

If you need TypeScript types for defining TZIP12, TZIP16 and TZIP21 compliant JSON metadata files:

```typescript
import { ContractMetadata, TokenMetadata } from "tzklar";

const myContractMetadata: ContractMetadata = {
  /* ... */
};

const myTokenMetadata: TokenMetadata = {
  /* ... */
};
```

Also you can check out our documentation page:
https://klarluft.github.io/tzklar/

## Development

To setup development environment:

```bash
yarn
```

If you update TZIP schema.json files and you want to regenerate TypeScript types files, run:

```bash
yarn process-json-schema
```

## About

This repository is part of the [tzKlar](https://tzklar.com) project intended to help others build apps on Tezos.

The project is maintained by [Michal Wrzosek](https://michal.wrzosek.pl) from [Klarluft](https://klarluft.com) company.

---
_Source: https://npm.io/package/tzklar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._