https://github.com/klarluft/tzklar

Building blocks for Tezos contracts
https://github.com/klarluft/tzklar

Last synced: 5 days ago
JSON representation

Building blocks for Tezos contracts

• Host: GitHub
• URL: https://github.com/klarluft/tzklar
• Owner: klarluft
• License: mit
• Created: 2021-12-23T12:49:44.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2021-12-29T19:20:53.000Z (almost 3 years ago)
• Last Synced: 2024-04-22T23:45:27.979Z (7 months ago)
• Language: TypeScript
• Size: 298 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

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)

---

Check out [tzklar-boilerplate](https://github.com/klarluft/tzklar-boilerplate) repository where you can find fully functional FA2 contract implementation using utilities from this package.

---

## 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

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

[![michal-wrzosek](./michal-wrzosek-avatar.jpg)](https://github.com/michal-wrzosek)

[tzKlar](https://tzklar.com) project is created and maintained by [Michal Wrzosek](https://github.com/michal-wrzosek) from [Klarluft](https://klarluft.com).