refactor: pre-beta-release cleanup (#39)

* use XCHAIN_CONFIG_DIR in scripts

* make tutorial easier to use

* clean up verbosity in create_account

* add print output command

* switch to beta version of xrpl-py

Author: mvadari

poetry.lock

@@ -25,7 +25,7 @@ sidechain-cli = 'sidechain_cli.main:main'
 python = "^3.7.1"
 click = "^8.1.3"
 tabulate = "^0.8.9"
-xrpl-py = { git = "https://github.com/XRPLF/xrpl-py.git", branch = "sidechain-2.5" }
+xrpl-py = "^1.7.0b0"
 httpx = "^0.18.1"
 websockets = "^10.3"
 Jinja2 = "^3.1.2"

pyproject.toml

@@ -2,11 +2,11 @@ rm ~/.config/sidechain-cli/config.json  # TODO: remove once cleanup is better
 sidechain-cli server start-all
 sidechain-cli server list
 sidechain-cli bridge create --name=bridge --chains locking_chain issuing_chain --witness witness0 --witness witness1 --witness witness2 --witness witness3 --witness witness4
-jq .locking_chain_door.id ../sidechain-config/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund --chain locking_chain --account
-sidechain-cli bridge build --bridge bridge --bootstrap ../sidechain-config/bridge_bootstrap.json
+jq .locking_chain_door.id $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | tr -d '"' | xargs sidechain-cli fund --chain locking_chain --account
+sidechain-cli bridge build --bridge bridge --bootstrap $XCHAIN_CONFIG_DIR/bridge_bootstrap.json
 sidechain-cli fund --chain locking_chain --account raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
 sidechain-cli fund --chain issuing_chain --account rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi
 sidechain-cli fund --chain issuing_chain --account rGzx83BVoqTYbGn7tiVAnFw7cbxjin13jL
-jq -c '.witness_reward_accounts[]' ../sidechain-config/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain locking_chain --account
-jq -c '.witness_reward_accounts[]' ../sidechain-config/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain issuing_chain --account
+jq -c '.witness_reward_accounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain locking_chain --account
+jq -c '.witness_reward_accounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain issuing_chain --account
 sidechain-cli bridge transfer --bridge bridge --src_chain locking_chain --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --verbose

scripts/start.sh

@@ -1,13 +1,13 @@
 rm ~/.config/sidechain-cli/config.json  # TODO: remove once cleanup is better
 sidechain-cli server start-all --verbose
 sidechain-cli server list
-read -p "Pausing..."
+read -p "Pausing... (hit enter to continue)"
 sidechain-cli bridge create --name=bridge --chains locking_chain issuing_chain --witness witness0 --witness witness1 --witness witness2 --witness witness3 --witness witness4 --verbose
-cat ../sidechain-config/bridge_bootstrap.json | jq .locking_chain_door.id | tr -d '"' | xargs sidechain-cli fund --chain locking_chain --account
-sidechain-cli bridge build --bridge bridge --bootstrap ../sidechain-config/bridge_bootstrap.json --verbose
+cat $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | jq .locking_chain_door.id | tr -d '"' | xargs sidechain-cli fund --chain locking_chain --account
+sidechain-cli bridge build --bridge bridge --bootstrap $XCHAIN_CONFIG_DIR/bridge_bootstrap.json --verbose
 sidechain-cli fund --chain locking_chain --account raFcdz1g8LWJDJWJE2ZKLRGdmUmsTyxaym
 sidechain-cli fund --chain issuing_chain --account rJdTJRJZ6GXCCRaamHJgEqVzB7Zy4557Pi
 sidechain-cli fund --chain issuing_chain --account rGzx83BVoqTYbGn7tiVAnFw7cbxjin13jL
-jq -c '.witness_reward_accounts[]' ../sidechain-config/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain locking_chain --account
-jq -c '.witness_reward_accounts[]' ../sidechain-config/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain issuing_chain --account
+jq -c '.witness_reward_accounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain locking_chain --account
+jq -c '.witness_reward_accounts[]' $XCHAIN_CONFIG_DIR/bridge_bootstrap.json | xargs -L1 sidechain-cli fund --chain issuing_chain --account
 sidechain-cli bridge transfer --bridge bridge --src_chain locking_chain --amount 10000000 --from snqs2zzXuMA71w9isKHPTrvFn1HaJ --to snyEJjY2Xi5Dxdh81Jy9Mj3AiYRQM --tutorial

scripts/tutorial.sh

@@ -69,10 +69,13 @@ def _submit_tx(
     help="The account to fund on the opposite chain.",
 )
 @click.option(
-    "--verbose", is_flag=True, help="Whether or not to print more verbose information."
+    "-v",
+    "--verbose",
+    help="Whether or not to print more verbose information. Also supports `-vv`.",
+    count=True,
 )
 def create_xchain_account(
-    from_chain: str, bridge: str, from_seed: str, to_account: str, verbose: bool = False
+    from_chain: str, bridge: str, from_seed: str, to_account: str, verbose: int = 0
 ) -> None:
     """
     Create an account on the opposite chain via a cross-chain transfer.
@@ -83,11 +86,9 @@ def create_xchain_account(
         bridge: The bridge across which to create the account.
         from_seed: The seed of the account that the funds come from.
         to_account: The chain to fund an account on.
-        verbose: Whether or not to print more verbose information.
+        verbose: Whether or not to print more verbose information. Add more v's for
+            more verbosity.
     """  # noqa: D301
-    # tutorial = True
-    print_level = 2
-
     bridge_config = get_config().get_bridge(bridge)
     from_chain_config = get_config().get_chain(from_chain)
     from_client = from_chain_config.get_client()
@@ -116,7 +117,7 @@ def create_xchain_account(
         destination=to_account,
         amount=create_account_amount,
     )
-    submit_tx(fund_tx, from_client, from_wallet.seed, print_level)
+    submit_tx(fund_tx, from_client, from_wallet.seed, verbose)
 
     # wait for attestations
     time_count = 0.0
@@ -147,9 +148,9 @@ def create_xchain_account(
                     if element["Destination"] != to_account:
                         continue
                     attestation_count += 1
-                    if print_level > 1:
+                    if verbose > 1:
                         click.echo(pformat(element))
-                    if print_level > 0:
+                    if verbose > 0:
                         click.secho(
                             f"Received {attestation_count} attestations",
                             fg="bright_green",
@@ -169,5 +170,5 @@ def create_xchain_account(
             click.secho("Error: Timeout on attestations.", fg="red")
             return
 
-    if verbose:
+    if verbose > 0:
         click.echo(pformat(to_client.request(AccountInfo(account=to_account)).result))

sidechain_cli/misc/create_account.py

@@ -4,6 +4,7 @@
 
 from sidechain_cli.server.config import create_server_configs
 from sidechain_cli.server.list import list_servers
+from sidechain_cli.server.print import print_server_output
 from sidechain_cli.server.request import get_server_status, request_server
 from sidechain_cli.server.start import (
     restart_server,
@@ -27,6 +28,7 @@ def server() -> None:
 server.add_command(create_server_configs, name="create-config")
 
 server.add_command(list_servers, name="list")
+server.add_command(print_server_output, name="print")
 
 server.add_command(get_server_status, name="status")
 server.add_command(request_server, name="request")

sidechain_cli/server/__init__.py

@@ -0,0 +1,22 @@
+"""Config-related rippled commands."""
+
+import os
+
+import click
+
+from sidechain_cli.utils.config_file import CONFIG_FOLDER
+
+
+@click.command(name="print")
+@click.option("--name", help="The name of the server.")
+def print_server_output(name: str) -> None:
+    """
+    Print the stdout/stderr output of a server.
+
+    Args:
+        name: Name of the server.
+    """
+    file_loc = os.path.join(CONFIG_FOLDER, f"{name}.out")
+    with open(file_loc) as f:
+        for line in f:
+            click.echo(line.strip())

sidechain_cli/server/print.py

@@ -142,7 +142,7 @@ def start_server(name: str, exe: str, config: str, verbose: bool = False) -> Non
     required=True,
     prompt=True,
     type=click.Path(exists=True),
-    help="The folder in which to store config files.",
+    help="The folder in which config files are storeds.",
 )
 @click.option(
     "--rippled_exe",