Index
b'Tezos Example Box\n=================\n\n**Note: Experimental. Currently designed for demo purposes only.**\n\nThis box contains a `Counter` and `SimpleStorage` contract to display the basics of Tezos LIGO integration with Truffle.\n\n\n## Prerequisites\n\n- [Docker](https://docs.docker.com/v17.12/install/)\n - Used for LIGO compilations and running a local sandbox Tezos node.\n- [NodeJS](https://nodejs.org/en/)\n - v8.9.4 to v12.2.0\n\n\n## Installation\n\n1. Install Truffle globally. Make sure you install `truffle@tezos`.\n ```shell\n npm install -g truffle@tezos\n ```\n\n2. Download the box. This also takes care of installing the necessary dependencies.\n ```shell\n truffle unbox tezos-example\n ```\n\n\n## Usage\n\n- Compiling the example smart contracts\n\n ```shell\n truffle compile\n ```\n\n- Starting the local `ganache-cli` sandbox Tezos node\n ```shell\n npm run start-sandbox\n ```\n\n- Migrating contracts\n ```shell\n truffle migrate\n ```\n\n- Running contract tests\n ```shell\n truffle test\n ```\n\n\n## Sandbox Management\n\nAn archive mode `ganache-cli` sandbox Tezos node is provided in this box with RPC exposed at port `8732` and ten accounts generously funded with 100 XTZ. For currently supported configurable options, see the `ganache-cli` [documentation](https://github.com/trufflesuite/ganache-cli/tree/tezos#options).\n\n\n#### Commands\n\n```shell\nnpm run start-sandbox\n```\n\n\n## Interacting with Live Networks\n\n- A test faucet key can be obtained from https://faucet.tzalpha.net/. Once saved, it can be imported inside `truffle-config.js`:\n\n ```javascript\n\n const { mnemonic, secret, password, email } = require("./faucet.json");\n\n module.exports = {\n networks: {\n carthagenet: {\n host: "https://carthagenet.smartpy.io",\n port: 443,\n network_id: "*",\n secret,\n mnemonic,\n password,\n email,\n type: "tezos"\n }\n }\n };\n\n ```\n\n- `truffle@tezos` also supports importing an activated account\'s secret key:\n\n ```javascript\n\n module.exports = {\n networks: {\n carthagenet: {\n host: "https://carthagenet.smartpy.io",\n port: 443,\n network_id: "*",\n secretKey: "edsk...", // private key\n type: "tezos"\n }\n }\n };\n ```\n\n ```shell\n truffle migrate --network carthagenet\n truffle test --network carthagenet\n ```\n'