This repository provides a quick and easy way to get up and running creating smart contracts. Included are an example contract, associated tests and instructions on how to get started.
- Start writing & testing smart-contracts quickly.
- Quick deployment of contracts to Xian networks
- No configuration of the host system needed.
- One dependency, available on all platforms (Docker)
- Example contract + tests included
- Everyone interested in writing smart contracts on Xian
- Install Docker
- MacOS
- Windows
- Linux
curl -fsSL https://get.docker.com -o get-docker.shsudo sh get-docker.shsudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-composesudo chmod +x /usr/local/bin/docker-compose
- Clone this repository
- Run
make buildfrom cli - Run
make test-shellfrom cli- This will open a command shell inside the container
- To execute your tests :
pytest tests/test.pyfrom the shell
- To exit the test shell type
exit - Happy coding !
- Smart contract develeopment docs available here
- Example tests can be in
tests/test.py, these show :- How to import and register contracts to the test harness
- How to perform actions from different accounts
- How to interrogate the state of the contract
- How to configure the execution environment of the test (Time, Random Number Seed, etc.)
The docker container reads the files in /contracts, any changes you make while the container is running will be reflected in the container environment.
TO-DO !
(Interested in doing a bounty for this ? Talk to us in telegram)
Want to show us what you made, get feedback or need support ? Telegram Discord Forum Github
- Do you have any suggestions on how to improve this tool ?
- Open an issue or message us on any of our comms channels
- Any improvements you'd like to make yourself ?
- PR's welcome - if it's good we'll award a bounty !
- Is there any tooling you'd love to see included (linters, formatters, etc) Let us know ! <3