/tzklar

Building blocks for Tezos contracts

Primary LanguageTypeScriptMIT LicenseMIT

tzKlar

npm

tzklar

Building blocks for Tezos contracts

https://tzklar.com

Check out 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

npm install tzklar
yarn add tzklar

How to use

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

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:

yarn

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

yarn process-json-schema

About

klarluft michal-wrzosek

tzKlar project is created and maintained by Michal Wrzosek from Klarluft.