johann1999/tezos-client repository overview

⁠Tezos Smart Contract Client

This API represents the interface to the endpoints on the Smart Contract deployed on a Tezos Testnet. The goal is to let the EDC Logger trigger HTTP requests to write hashed Logs to the blockchain. In this version, no security functionality is implemented yet to verify integrity of off-chain data.

⁠Swagger Documentation

The documentation can be viewed on http://localhost:3000/docs⁠ when server runs.

⁠Tezos Testnet Explorer

Check blockchain operations by direct requests via this API or on Better Call Dev⁠.

⁠Configuration

Please make sure that faucet⁠ and contractConfig⁠ is replaced with your tezos credentials. However, you can work with the provided faucet account for smaller requests.

⁠Using the docker image

Build Docker image:

docker build --tag tezos-client .

Run container:

docker run -d --env SERVER_IP=<Server IP> -p 3000:3000 --name tezos-api tezos-client

Stop container:

docker stop tezos-api

⁠Set up locally

Install required Node modules

npm install

You can start the server in development mode with following command:

npm run serve

All changes in files will result in a server restart.