CONTRIBUTING.md

Setup

First clone this repo:

git clone https://github.com/TENK-DAO/smartdeploy
cd smartdeploy

install just

just is a task running for helping executing graphs of dependent tasks.

cargo install just

though it's prefered to use

cargo binstall just

cargo install cargo-binstall 

As this the relesaed binary, skipping having to build it.

At the moment only Unix OSes are supported (sorry!) in the follow steps.

Setup local soroban binary

This will install the correct binaries to ./target/bin.

just setup

Setting up smartdeploy itself

Currently standalone is the default network. (see .env)

You'll need docker installed. Then you can open a separate terminal and run:

just start_docker

To deploy your own Smartdeploy first run:

just clean

Then

just publish_all

This command creates a new smartdeploy contract and publishes all the examples to it. Then deploys a contract with the same name. Lastly a local script is created for each one and this path is visible to the just script.

just soroban --list

should print something like:

Installed Plugins:
    smartdeploy
    increment
    errors

And now that soroban has a plugin system you can invoke it like

just soroban increment --help

or for short

just s increment --help