refactor: rename sidechain-cli to xbridge-cli (#116)

## High Level Overview of Change

This PR handles the rename of `sidechain-cli` to `xbridge-cli`, and
removes all other mentions of sidechains.

### Context of Change

`xbridge-cli` is a better name for this tool.

### Type of Change

- [x] Refactor (non-breaking change that only restructures code)

## Test Plan

Tests pass locally. The Docker images haven't been updated yet, so they
won't pass

Author: mvadari

.github/workflows/lint_type_check.yml

@@ -2,7 +2,7 @@ name: Lint and Type Check
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
   workflow_dispatch:
 
@@ -30,7 +30,7 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: "3.11"
-          cache: 'poetry'
+          cache: "poetry"
 
       - name: Display Python version
         run: |
@@ -41,8 +41,8 @@ jobs:
 
       - name: Lint
         run: |
-          poetry run flake8 sidechain_cli tests
+          poetry run flake8 xbridge_cli tests
 
       - name: Type-check
         run: |
-          poetry run mypy --strict --implicit-reexport sidechain_cli
+          poetry run mypy --strict --implicit-reexport xbridge_cli

.github/workflows/test.yml

@@ -63,7 +63,7 @@ jobs:
         env:
           RIPPLED_EXE: docker
           WITNESSD_EXE: docker
-          XCHAIN_CONFIG_DIR: /home/runner/work/sidechain-config
+          XCHAIN_CONFIG_DIR: /home/runner/work/xbridge-config
 
       - name: Debug Test Failure (Chain Outputs)
         if: always() && steps.runTests.outcome == 'failure'
@@ -73,7 +73,7 @@ jobs:
           echo "start of issuing_chain logs"
           cat $XCHAIN_CONFIG_DIR/issuing_chain/debug.log
         env:
-          XCHAIN_CONFIG_DIR: /home/runner/work/sidechain-config
+          XCHAIN_CONFIG_DIR: /home/runner/work/xbridge-config
 
       - name: Debug Test Failure (Witness Outputs)
         if: always() && steps.runTests.outcome == 'failure'
@@ -90,4 +90,4 @@ jobs:
           echo "start of witness4 logs"
           cat $XCHAIN_CONFIG_DIR/witness4/witness.log
         env:
-          XCHAIN_CONFIG_DIR: /home/runner/work/sidechain-config
+          XCHAIN_CONFIG_DIR: /home/runner/work/xbridge-config

.pre-commit-config.yaml

@@ -1,33 +1,33 @@
 # .pre-commit-config.yaml
 repos:
-    - repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v2.3.0
-      hooks:
-        - id: check-yaml
-        - id: end-of-file-fixer
-        - id: trailing-whitespace
-    # Use our local versions of tools so that we stay in sync.
-    - repo: local
-      hooks:
-        - id: isort
-          name: isort
-          entry: poetry run isort
-          language: system
-          types: [python]
-        - id: black
-          name: black
-          entry: poetry run black
-          language: system
-          types: [python]
-        - id: flake8
-          name: flake8
-          entry: poetry run flake8
-          language: system
-          types: [python]
-        - id: mypy
-          name: mypy
-          entry: poetry run mypy
-          args: ["--strict", "--implicit-reexport"]
-          language: system
-          files: sidechain_cli/
-          types: [python]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  # Use our local versions of tools so that we stay in sync.
+  - repo: local
+    hooks:
+      - id: isort
+        name: isort
+        entry: poetry run isort
+        language: system
+        types: [python]
+      - id: black
+        name: black
+        entry: poetry run black
+        language: system
+        types: [python]
+      - id: flake8
+        name: flake8
+        entry: poetry run flake8
+        language: system
+        types: [python]
+      - id: mypy
+        name: mypy
+        entry: poetry run mypy
+        args: ["--strict", "--implicit-reexport"]
+        language: system
+        files: xbridge_cli/
+        types: [python]

README.md

@@ -1,14 +1,16 @@
-# xrpl-sidechain-cli
+# xbridge-cli
 
 ## Install
 
 ```bash
-pip install xrpl-sidechain-cli
+pip install xbridge-cli
 ```
+
 NOTE: if you're looking at the repo before it's published, this won't work. Instead, you'll do this:
+
 ```bash
-git clone https://github.com/xpring-eng/sidechain-cli.git
-cd sidechain-cli
+git clone https://github.com/xpring-eng/xbridge-cli.git
+cd xbridge-cli
 # install poetry
 curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -
 poetry install
@@ -31,14 +33,15 @@ export WITNESSD_EXE={witnessd exe filepath}
 ```
 
 To stop the servers:
+
 ```bash
-sidechain-cli server stop --all
+xbridge-cli server stop --all
 ```
 
 ## Use Commands
 
 ```bash
-sidechain-cli --help
+xbridge-cli --help
 ```
 
 Each subcommand also has a `--help` flag, to tell you what fields you'll need.

pyproject.toml

@@ -1,9 +1,9 @@
 [tool.poetry]
-name = "xrpl-sidechain-cli"
-version = "1.0.0b4"
-description = "A CLI that helps you set up an XRPL sidechain."
+name = "xbridge-cli"
+version = "1.0.0b0"
+description = "A CLI that helps you set up an XRPL-XRPL bridge."
 readme = "README.md"
-repository = "https://github.com/xpring-eng/sidechain-cli"
+repository = "https://github.com/xpring-eng/xbridge-cli"
 authors = ["Mayukha Vadari <mvadari@ripple.com>"]
 keywords = [
   "xrp",
@@ -15,11 +15,11 @@ include = [
   "LICENSE",
 ]
 packages = [
-  { include = "sidechain_cli" },
+  { include = "xbridge_cli" },
 ]
 
 [tool.poetry.scripts]
-sidechain-cli = 'sidechain_cli.main:main'
+xbridge-cli = 'xbridge_cli.main:main'
 
 [tool.poetry.dependencies]
 python = "^3.7.1"
@@ -55,7 +55,7 @@ profile = "black"
 [tool.coverage.run]
 branch = true
 command_line = "-m pytest tests"
-source = ["sidechain_cli"]
+source = ["xbridge_cli"]
 
 [tool.coverage.report]
 show_missing = true

scripts/docker-start.sh

@@ -1,12 +1,12 @@
-rm ~/.config/sidechain-cli/config.json  # TODO: remove once cleanup is better
-sidechain-cli server create-config all --docker
-sidechain-cli server start-all --docker
-sidechain-cli server list
-sidechain-cli explorer
-jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-sidechain-cli bridge build --name=bridge -v
-sidechain-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
-sidechain-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
-sidechain-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose
+rm ~/.config/xbridge-cli/config.json  # TODO: remove once cleanup is better
+xbridge-cli server create-config all --docker
+xbridge-cli server start-all --docker
+xbridge-cli server list
+xbridge-cli explorer
+jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+xbridge-cli bridge build --name=bridge -v
+xbridge-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
+xbridge-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
+xbridge-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose

scripts/iou-start.sh

@@ -1,37 +1,37 @@
-rm ~/.config/sidechain-cli/config.json  # TODO: remove once cleanup is better
-sidechain-cli server create-config all
-sidechain-cli server start-all --rippled-only
-sidechain-cli server list
-sidechain-cli explorer
-jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-sidechain-cli bridge build --name=bridge -v
-sidechain-cli server start-all --witness-only
-sidechain-cli server list
-sidechain-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
-sidechain-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
-sidechain-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose
+rm ~/.config/xbridge-cli/config.json  # TODO: remove once cleanup is better
+xbridge-cli server create-config all
+xbridge-cli server start-all --rippled-only
+xbridge-cli server list
+xbridge-cli explorer
+jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+xbridge-cli bridge build --name=bridge -v
+xbridge-cli server start-all --witness-only
+xbridge-cli server list
+xbridge-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
+xbridge-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
+xbridge-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose
 
 echo "set up IOU bridge"
-sidechain-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
+xbridge-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
 # TODO: set default rippling here
-sidechain-cli server create-config all --config_dir ../sidechain-config2 --currency USD.raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
-jq .LockingChain.DoorAccount.Address ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessSubmitAccounts[]' ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessRewardAccounts[]' ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq .IssuingChain.DoorAccount.Address ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs -L1 sidechain-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --amount 50 -v --to
-jq '.IssuingChain.WitnessSubmitAccounts[]' ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs -L1 sidechain-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --amount 50 -v --to
-jq '.IssuingChain.WitnessRewardAccounts[]' ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs -L1 sidechain-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --amount 50 -v --to
-sidechain-cli server stop --name witness0
-sidechain-cli server stop --name witness1
-sidechain-cli server stop --name witness2
-sidechain-cli server stop --name witness3
-sidechain-cli server stop --name witness4
-sidechain-cli server list
-sidechain-cli server start-all --witness-only --config_dir ../sidechain-config2
-sidechain-cli server list
-sidechain-cli bridge build --name iou_bridge --bootstrap ../sidechain-config2/bridge_bootstrap.json -v
-jq .LockingChain.DoorAccount.Seed ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli trust locking_chain USD.raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
-jq .IssuingChain.DoorAccount.Address ../sidechain-config2/bridge_bootstrap.json | tr -d '"' | xargs -I{} sidechain-cli trust issuing_chain USD.{} snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM
-sidechain-cli bridge transfer --bridge iou_bridge --from_locking --amount 1000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose
+xbridge-cli server create-config all --config_dir ../xbridge-config2 --currency USD.raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
+jq .LockingChain.DoorAccount.Address ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessSubmitAccounts[]' ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessRewardAccounts[]' ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq .IssuingChain.DoorAccount.Address ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs -L1 xbridge-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --amount 50 -v --to
+jq '.IssuingChain.WitnessSubmitAccounts[]' ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs -L1 xbridge-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --amount 50 -v --to
+jq '.IssuingChain.WitnessRewardAccounts[]' ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs -L1 xbridge-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --amount 50 -v --to
+xbridge-cli server stop --name witness0
+xbridge-cli server stop --name witness1
+xbridge-cli server stop --name witness2
+xbridge-cli server stop --name witness3
+xbridge-cli server stop --name witness4
+xbridge-cli server list
+xbridge-cli server start-all --witness-only --config_dir ../xbridge-config2
+xbridge-cli server list
+xbridge-cli bridge build --name iou_bridge --bootstrap ../xbridge-config2/bridge_bootstrap.json -v
+jq .LockingChain.DoorAccount.Seed ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli trust locking_chain USD.raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
+jq .IssuingChain.DoorAccount.Address ../xbridge-config2/bridge_bootstrap.json | tr -d '"' | xargs -I{} xbridge-cli trust issuing_chain USD.{} snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM
+xbridge-cli bridge transfer --bridge iou_bridge --from_locking --amount 1000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose

scripts/start.sh

@@ -1,12 +1,12 @@
-rm ~/.config/sidechain-cli/config.json  # TODO: remove once cleanup is better
-sidechain-cli server create-config all
-sidechain-cli server start-all
-sidechain-cli server list
-sidechain-cli explorer
-jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-sidechain-cli bridge build --name=bridge -v
-sidechain-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
-sidechain-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
-sidechain-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose
+rm ~/.config/xbridge-cli/config.json  # TODO: remove once cleanup is better
+xbridge-cli server create-config all
+xbridge-cli server start-all
+xbridge-cli server list
+xbridge-cli explorer
+jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+xbridge-cli bridge build --name=bridge -v
+xbridge-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
+xbridge-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
+xbridge-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose

scripts/stop.sh

@@ -1,2 +1,2 @@
-sidechain-cli server stop --all
-sidechain-cli server list
+xbridge-cli server stop --all
+xbridge-cli server list

scripts/tutorial.sh

@@ -1,13 +1,13 @@
-rm ~/.config/sidechain-cli/config.json  # TODO: remove once cleanup is better
-sidechain-cli server create-config all
-sidechain-cli server start-all --verbose
-sidechain-cli server list
+rm ~/.config/xbridge-cli/config.json  # TODO: remove once cleanup is better
+xbridge-cli server create-config all
+xbridge-cli server start-all --verbose
+xbridge-cli server list
 read -p "Pausing... (hit enter to continue)"
-sidechain-cli explorer
-jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund locking_chain
-sidechain-cli bridge build --name=bridge -v
-sidechain-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
-sidechain-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
-sidechain-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --tutorial
+xbridge-cli explorer
+jq .LockingChain.DoorAccount.Address $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessSubmitAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+jq '.LockingChain.WitnessRewardAccounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs xbridge-cli fund locking_chain
+xbridge-cli bridge build --name=bridge -v
+xbridge-cli fund locking_chain raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
+xbridge-cli bridge create-account --from_locking --bridge bridge --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi --amount 10 -v
+xbridge-cli bridge transfer --bridge bridge --from_locking --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --tutorial