https://github.com/oxheadalpha/tezos-contract-metadata

TZIP-{016,012,021} Contract Metadata in OCaml
https://github.com/oxheadalpha/tezos-contract-metadata

Last synced: 4 days ago
JSON representation

TZIP-{016,012,021} Contract Metadata in OCaml

• Host: GitHub
• URL: https://github.com/oxheadalpha/tezos-contract-metadata
• Owner: oxheadalpha
• License: mit
• Created: 2021-09-07T19:51:35.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-28T22:19:59.000Z (almost 3 years ago)
• Last Synced: 2023-03-12T03:03:27.749Z (over 1 year ago)
• Language: OCaml
• Size: 234 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tezos Contract Metadata

> TZIP-{016,012,021} Contract Metadata in OCaml, see

> [gitlab.com/tezos/tzip#current-tzips](https://gitlab.com/tezos/tzip#current-tzips).

## Build

Get dependencies:

```

opam switch create . 4.12.0

eval $(opam env)

opam install --deps-only tezos-contract-metadata.opam

opam install ocamlformat.0.19.0 merlin # For development.

```

Then

```

dune build @check

```

Linting:

```

dune build @fmt --auto-promote

```

## Test

```

opam install --deps-only tezos-contract-metadata-test.opam

dune test

```

Note that some tests are in src/test to allow a lwt.unix dependency.  Since

some users of ths lib might want to use js_of_ocaml.lwt, we don't want to depend

on some any lwt in src/lib.

## History

This library was initially part of the Octez merge-request

[!2447](https://gitlab.com/tezos/tezos/-/merge_requests/2447) (*Add TZIP-016

(Contract Metadata) implementation (library + tezos-client)*, `@smondet`).  And

has been continuously in use in a couple of projects, including

[tzcomet.io](https://tzcomet.io/).