Clean up scripts folder

.gitignore

@@ -1,5 +1,5 @@
 build/
-data/
+examples/demo/data
 coverage.out
 release.tar.gz
 .env
@@ -15,6 +15,7 @@ test/keys/
 _test/setup/valkeys/*.json
 _test/keys/
 .DS_Store
+.vscode/
 
 # Don't commit the vendor directory if anyone runs 'go mod vendor'.
 /vendor

Makefile

@@ -96,28 +96,6 @@ get-gaia:
 	@git clone --branch $(GAIA_VERSION) --depth=1 https://github.com/cosmos/gaia.git ./chain-code/gaia
 
 build-gaia:
-	@./scripts/build-gaia
-
-build-akash:
-	@./scripts/build-akash
-
-get-akash:
-	@mkdir -p ./chain-code/
-	@git clone --branch $(AKASH_VERSION) git@github.com:ovrclk/akash.git ./chain-code/akash
-
-get-chains: get-gaia get-akash get-wasmd
-
-get-wasmd:
-	@mkdir -p ./chain-code/
-	@git clone --branch $(WASMD_VERSION) git@github.com:CosmWasm/wasmd.git ./chain-code/wasmd
-
-build-wasmd:
-	@./scripts/build-wasmd
-
-build-chains: build-akash build-gaia build-wasmd
-
-delete-chains: 
-	@echo "Removing the ./chain-code/ directory..."
-	@rm -rf ./chain-code
+	@./examples/demo/scripts/build-gaia
 
 .PHONY: two-chains test test-integration ibctest install build lint coverage clean

cmd/paths.go

@@ -214,9 +214,9 @@ func pathsAddDirCmd(a *appState) *cobra.Command {
 		Short: `Add path configuration data in bulk from a directory. Example dir: 'configs/demo/paths'`,
 		Long: `Add path configuration data in bulk from a directory housing individual path config files. This is useful for spinning up testnets.
 
-		See 'configs/demo/paths' for an example of individual path config files.`,
+		See 'examples/demo/configs/paths' for an example of individual path config files.`,
 		Example: strings.TrimSpace(fmt.Sprintf(`
-$ %s config add-paths configs/paths`, appName)),
+$ %s config add-paths examples/demo/configs/paths`, appName)),
 		RunE: func(cmd *cobra.Command, args []string) (err error) {
 			if err := addPathsFromDirectory(cmd.Context(), cmd.ErrOrStderr(), a, args[0]); err != nil {
 				return err

dev-env

@@ -15,11 +15,12 @@ fi
 cd $RELAYER_DIR
 rm -rf $RELAYER_CONF &> /dev/null
 pwd
-bash scripts/two-chainz-wasmd "skip"
+bash scripts/two-chainz "skip"
 
 echo "waiting for blocks..."
 sleep 3
 
+# creates client, connection, and channel all in one command
 rly tx link demo -d -t 3s
 sleep 2
 echo "Initial balances"
@@ -28,8 +29,10 @@ echo "balance 1 $(rly q bal ibc-1)"
 rly tx transfer ibc-0 ibc-1 100000samoleans "$(rly keys show ibc-1)" channel-0 -d
 rly tx transfer ibc-1 ibc-0 100000samoleans "$(rly keys show ibc-0)" channel-0 -d
 sleep 5
+# relay remaining packets and then finishes as opposed to starting a continuous listening loop with `rly start`
 rly tx relay-packets demo channel-0 -d
 sleep 5
+# relay remaining acknowledgments and then finishes as opposed to starting a continuous listening loop with `rly start`
 rly tx relay-acknowledgements demo channel-0 -d
 sleep 5
 echo "Balances after packets are sent"

docs/demo.md

@@ -19,7 +19,7 @@ $ make get-gaia build-gaia
 
 # two-chainz creates two gaia-based chains with data directories in this repo
 # it also builds and configures the relayer for operations with those chains
-$ ./scripts/two-chainz
+$ ./examples/demo/scripts/two-chainz 
 # NOTE: If you want to stop the two gaia-based chains running in the background use `killall gaiad`
 
 # At this point the relayer --home directory is ready for normal operations between

examples/README.md

@@ -0,0 +1,39 @@
+## Demo/Dev-Environment
+
+The demo environment is a series of bash scripts that:
+
+1) Spins up two IBC enabled blockchains chains (gaia) in your local environment
+2) Creates an IBC connection between both chains
+3) Sends an IBC transaction between both chains
+
+This can be used to learn about the inter workings of IBC. Follow along with the commands inside of the bash scripts to get a better idea.
+
+This can also be used to spin up a quick testing environment.
+
+To run:
+
+```bash
+cd examples/demo/
+./dev-env
+```
+
+This script creates a folder called "data": `examples/demo/data/`. 
+Logs and config info for each chain can be found here.
+
+
+Note: After running, two `gaiad` instances will be running on your machine. 
+To kill ALL `gaiad` instances run:
+```bash
+killall gaiad
+```
+
+---
+
+## Example Config: [examples/config.yaml](./config_EXAMPLE.yaml)
+
+This is an example of a config file with:
+
+- Three chains added: `cosmoshub`, `juno`, and `osmosis`
+- Three paths configured: `cosmoshub-juno`, `cosmoshub-osmosis`, `juno-osmosis`
+    - Path `cosmoshub-juno` does not filter any channels while the other two paths have filters set.
+- All three chains have a wallet/key called "default"