Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oxheadalpha/tzcomet

Contract Metadata Viewer on Tezos
https://github.com/oxheadalpha/tzcomet

michelson ocaml smart-contracts tezos tyxml

Last synced: 3 months ago
JSON representation

Contract Metadata Viewer on Tezos

Awesome Lists containing this project

README

        

# TZComet: Tezos Contract Metadata

… currently running at  …

Part of the development happens in a *“monorepo”*:
[oxheadalpha/flextesa-tzcomet-monorepo](https://gitlab.com/oxheadalpha/flextesa-tzcomet-monorepo/-/tree/main).

## Build

./please.sh ensure setup # Creates an opam switch
./please.sh build all

⬑ if all goes well, last command should print out a link to open the app, like
`file://$PWD/_build/default/website/index.html`.

## Note

The module Tzcomet_jsonm was copied from:

- repository:
- branch: jsoo-friendly
- commit: a092b96d20302ffa50c1f10c2ac6bf81c7cff9cf

This fork of Jsonm fixes the stack overflow error that can occur when parsing large objects in JSOO.

## Deployment

This of course, requires push access to
[oxheadalpha/TZComet](https://github.com/oxheadalpha/TZComet/) for it to impact
[tzcomet.io](https://tzcomet.io) (but one can make it happen in their own fork
and it will be at `.github.io/TZComet`).

First time, create a local `gh-pages` branch:

git branch gh-pages -t origin/gh-pages

To deploy the current working directory to `/staging`:

./please.sh deploy togithub
# Current branch is now gh-pages
git push origin gh-pages
git checkout master # or back to where you were

(this calls does trigger the build).

To deploy `origin/master` to production:

prod=true ./please.sh deploy togithub
# And push like for /staging

## See Also

- Agora [post](https://forum.tezosagora.org/t/contract-metadata-on-tezos/2258)
introducing the specification.
- The
[TZIP-16](https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-16/tzip-16.md)
specification.