tranche 0.1.0__py3-none-any.whl

core.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    tranche.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 02:20
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Third-party packages ###
+from click import group
+
+### Local modules ###
+from src.commands import clean, cluster, mine, nodekeys, ping_pong, remove_deprecated, setup
+
+
+@group
+def cli() -> None:
+    """tranche"""
+
+
+cli.add_command(clean, "clean")
+cli.add_command(cluster, "cluster")
+cli.add_command(mine, "mine")
+cli.add_command(nodekeys, "nodekeys")
+cli.add_command(ping_pong, "ping-pong")
+cli.add_command(remove_deprecated, "remove-deprecated")
+cli.add_command(setup, "setup")
+
+
+if __name__ == "__main__":
+    cli()

src/__init__.py

@@ -0,0 +1,41 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/__init__.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Local modules ###
+from src.commands import clean, cluster, nodekeys
+from src.schemas import (
+    ClusterEnum,
+    BlockchainInfo,
+    ImageAlias,
+    MutexOption,
+    NewAddress,
+    NodeInfo,
+    Service,
+    ServiceName,
+)
+
+
+__all__ = [
+    "ClusterEnum",
+    "BlockchainInfo",
+    "ImageAlias",
+    "NewAddress",
+    "MutexOption",
+    "NodeInfo",
+    "Service",
+    "ServiceName",
+    "clean",
+    "cluster",
+    "nodekeys",
+]
+
+__version__ = "0.1.0"

src/commands/__init__.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/__init__.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Local modules ###
+from src.commands.clean import clean
+from src.commands.cluster import cluster
+from src.commands.mine import mine
+from src.commands.nodekeys import nodekeys
+from src.commands.ping_pong import ping_pong
+from src.commands.remove_deprecated import remove_deprecated
+from src.commands.setup import setup
+
+__all__ = ["clean", "cluster", "mine", "nodekeys", "ping_pong", "remove_deprecated", "setup"]

src/commands/clean.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/clean.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from re import match
+
+### Third-party packages ###
+from click import Context, command, pass_context
+from docker import DockerClient, from_env
+from docker.errors import NotFound
+from docker.models.networks import Network
+from rich.progress import track
+
+### Local modules ###
+from src.configs import NETWORK
+
+
+@command
+@pass_context
+def clean(context: Context) -> None:
+    """Remove all active "tranche-*" containers, drop network."""
+    client: DockerClient = from_env()
+    if client.ping():
+        for container in track(client.containers.list(), description="Remove active containers."):
+            if match(r"tranche-*", container.name) is not None:
+                container.stop()
+                container.remove()
+        try:
+            tranche_network: Network = client.networks.get(NETWORK)
+            tranche_network.remove()
+        except NotFound:
+            pass
+
+
+__all__ = ["clean"]

src/commands/cluster.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/cluster.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from re import match
+from time import sleep
+from typing import Dict, List
+
+### Third-party packages ###
+from click import command, option
+from docker import DockerClient, from_env
+from docker.errors import APIError
+from docker.models.containers import Container
+from pydantic import TypeAdapter
+from rich.progress import track
+
+### Local modules ###
+from src.configs import CLUSTERS, IMAGES, NETWORK
+from src.schemas import MutexOption, NewAddress, Service, ServiceName
+
+
+@command
+@option("--duo", alternatives=["uno"], cls=MutexOption, is_flag=True, type=bool)
+@option("--uno", alternatives=["duo"], cls=MutexOption, is_flag=True, type=bool)
+def cluster(duo: bool, uno: bool) -> None:
+    """Deploy cluster, either with one or two LND nodes."""
+    duo = duo or (not duo and not uno)  # defaults to duo network
+    cluster: Dict[ServiceName, Service] = (CLUSTERS["duo"], CLUSTERS["uno"])[uno]
+    client: DockerClient = from_env()
+    if client.ping():
+        try:
+            client.networks.create(NETWORK, check_duplicate=True)
+        except APIError:
+            pass
+        for name, service in track(cluster.items(), description="Deploy specified local cluster"):
+            image_name: str = IMAGES[service.alias]
+            ports: Dict[str, str] = dict(
+                map(lambda item: (item[0], item[1]), [port.split(":") for port in service.ports])
+            )
+            client.containers.run(
+                image_name,
+                command=service.command,
+                detach=True,
+                environment=service.env_vars,
+                name=name,
+                network=NETWORK,
+                ports=ports,
+            )
+        sleep(3)  # wait until lnd ready
+        mining_targets: List[str] = []
+        for container in track(client.containers.list(), description="Generate addresses"):
+            if match(r"tranche-lnd|tranche-ping|tranche-pong", container.name) is not None:
+                new_address: NewAddress = TypeAdapter(NewAddress).validate_json(
+                    container.exec_run(
+                        """
+                        lncli
+                            --macaroonpath=/home/lnd/.lnd/data/chain/bitcoin/regtest/admin.macaroon
+                            --rpcserver=localhost:10001
+                            --tlscertpath=/home/lnd/.lnd/tls.cert
+                        newaddress p2wkh
+                        """
+                    ).output
+                )
+                mining_targets.append(new_address.address)
+        bitcoind: Container = client.containers.get("tranche-bitcoind")
+        for address in track(mining_targets, description="Mine initial capital for parties."):
+            bitcoind.exec_run(
+                """
+                bitcoin-cli -regtest -rpcuser=tranche -rpcpassword=tranche generatetoaddress 101 %s
+                """
+                % address
+            )
+
+
+__all__ = ["cluster"]

src/commands/mine.py

@@ -0,0 +1,114 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/nodekeys.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from re import match
+from typing import List
+
+### Third-party packages ###
+from apscheduler.schedulers.background import BackgroundScheduler
+from click import argument, command
+from docker import DockerClient, from_env
+from docker.errors import NotFound
+from docker.models.containers import Container
+from pydantic import TypeAdapter
+from rich.json import JSON
+from rich.layout import Layout
+from rich.live import Live
+from rich.panel import Panel
+from rich.progress import track
+
+### Local modules ###
+from src.schemas import BlockchainInfo, NewAddress, NodeInfo
+
+
+@command
+@argument("blockcount", default=1, type=int)
+@argument("blocktime", default=5, type=int)
+def mine(blockcount: int, blocktime: int) -> None:
+    """Scheduled mining with "blockcount" and "blocktime"."""
+    client: DockerClient = from_env()
+    if client.ping():
+        mining_targets: List[str] = []
+        for container in track(client.containers.list(), description="Generate mining treasuries"):
+            if match(r"tranche-lnd|tranche-ping|tranche-pong", container.name) is not None:
+                new_address: NewAddress = TypeAdapter(NewAddress).validate_json(
+                    container.exec_run(
+                        """
+                        lncli
+                            --macaroonpath=/home/lnd/.lnd/data/chain/bitcoin/regtest/admin.macaroon
+                            --rpcserver=localhost:10001
+                            --tlscertpath=/home/lnd/.lnd/tls.cert
+                        newaddress p2wkh
+                        """
+                    ).output
+                )
+                mining_targets.append(new_address.address)
+        bitcoind: Container
+        try:
+            bitcoind = client.containers.get("tranche-bitcoind")
+        except NotFound:
+            print('!! Unable to find "tranche-bitcoind" container.')
+            return
+        scheduler: BackgroundScheduler = BackgroundScheduler()
+        for address in mining_targets:
+            scheduler.add_job(
+                bitcoind.exec_run,
+                "interval",
+                [
+                    """
+                    bitcoin-cli
+                        -regtest
+                        -rpcuser=tranche
+                        -rpcpassword=tranche
+                    generatetoaddress %d %s
+                    """
+                    % (blockcount, address)
+                ],
+                seconds=blocktime,
+            )
+        scheduler.start()
+        pane: Layout = Layout()
+        pane.split_row(
+            Layout(name="bitcoind", size=30),
+            Layout(name="lightning", size=70),
+        )
+        with Live(pane, refresh_per_second=4, transient=True) as live:
+            while True:
+                info: BlockchainInfo = TypeAdapter(BlockchainInfo).validate_json(
+                    bitcoind.exec_run(
+                        """
+                        bitcoin-cli -regtest -rpcuser=tranche -rpcpassword=tranche getblockchaininfo
+                        """
+                    ).output
+                )
+                pane["bitcoind"].update(Panel(JSON.from_data(info.model_dump()), title="bitcoind"))
+
+                node_infos: List[NodeInfo] = []
+                for container in client.containers.list():
+                    if match("tranche-lnd|tranche-ping|tranche-pong", container.name) is not None:
+                        node_info: NodeInfo = TypeAdapter(NodeInfo).validate_json(
+                            container.exec_run(
+                                """
+                                lncli
+                                    --macaroonpath=/home/lnd/.lnd/data/chain/bitcoin/regtest/admin.macaroon
+                                    --rpcserver=localhost:10001
+                                    --tlscertpath=/home/lnd/.lnd/tls.cert
+                                getinfo
+                                """
+                            ).output
+                        )
+                        node_infos.append(node_info)
+                # if
+
+
+__all__ = ["mine"]

src/commands/nodekeys.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/nodekeys.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from re import match
+
+### Third-party packages ###
+from click import command
+from docker import DockerClient, from_env
+from pydantic import TypeAdapter
+from rich.progress import track
+
+### Local modules ###
+from src.schemas import NodeInfo
+
+
+@command
+def nodekeys() -> None:
+    """Fetch nodekeys from active LND containers."""
+    client: DockerClient = from_env()
+    if client.ping():
+        for container in track(client.containers.list(), description="Fetch LND nodekeys."):
+            if match(r"tranche-lnd|tranche-ping|tranche-pong", container.name) is not None:
+                info: NodeInfo = TypeAdapter(NodeInfo).validate_json(
+                    container.exec_run(
+                        """
+                        lncli
+                            --macaroonpath=/home/lnd/.lnd/data/chain/bitcoin/regtest/admin.macaroon
+                            --rpcserver=localhost:10001
+                            --tlscertpath=/home/lnd/.lnd/tls.cert
+                        getinfo
+                        """
+                    ).output
+                )
+                print(f"<Nodekey: '{container.name}', '{info.identity_pubkey}'>")
+
+
+__all__ = ["nodekeys"]

src/commands/ping_pong.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/ping_pong.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 06:18
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Third-party packages ###
+from click import command
+
+
+@command
+def ping_pong() -> None:
+    """For "duo" cluster, create channels between LND nodes."""
+
+
+__all__ = ["ping_pong"]

src/commands/remove_deprecated.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/remove_deprecated.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 06:24
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from typing import Set
+
+### Third-party packages ###
+from click import command
+from docker import DockerClient, from_env
+from rich.progress import track
+
+### Local modules ###
+from src.configs import DEPRECATED
+
+
+@command
+def remove_deprecated() -> None:
+    """Remove images deprecated by workspace."""
+    client: DockerClient = from_env()
+    if client.ping():
+        docker_images: Set[str] = {image.tags[0] for image in client.images.list()}
+        for registry_id in track(DEPRECATED, description="Remove images deprecated by workspace."):
+            if registry_id in docker_images:
+                client.images.remove(registry_id)
+                print(f"<Image: '{ registry_id }'> removed.")
+    else:
+        print("!! Unable to connect to docker daemon.")
+
+
+__all__ = ["remove_deprecated"]

src/commands/setup.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/commands/setup.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 06:18
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from typing import Set
+
+### Third-party packages ###
+from click import command
+from docker import DockerClient, from_env
+from rich.progress import track
+
+### Local modules ###
+from src.configs import IMAGES
+
+
+@command
+def setup() -> None:
+    """Download docker images used by command-line interface."""
+    client: DockerClient = from_env()
+    if client.ping():
+        docker_images: Set[str] = {image.tags[0] for image in client.images.list()}
+        for registry_id in track(IMAGES.values(), description="Download required images..."):
+            if registry_id in docker_images:
+                print(f"<Image: '{ registry_id }'> already exists in local docker images.")
+            else:
+                repository, tag = registry_id.split(":")
+                client.images.pull(repository=repository, tag=tag)
+                print(f"<Image: '{ registry_id }'> downloaded.")
+    else:
+        print("!! Unable to connect to docker daemon.")
+
+
+__all__ = ["setup"]

src/configs.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/configs.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from pydantic import TypeAdapter
+from typing import Any, Dict, List, Optional
+from yaml import Loader, load
+
+### Local modules ###
+from src.schemas import ClusterEnum, ImageAlias, Service, ServiceName
+
+CLUSTERS: Dict[ClusterEnum, Dict[ServiceName, Service]]
+DEPRECATED: List[str]
+IMAGES: Dict[ImageAlias, str]
+NETWORK: str
+with open("./src/constants.yaml", "rb") as f:
+    constants: Optional[Dict[str, Any]] = load(f, Loader=Loader)
+    if constants:
+        CLUSTERS = TypeAdapter(Dict[ClusterEnum, Dict[ServiceName, Service]]).validate_python(
+            constants["clusters"]
+        )
+        DEPRECATED = constants.get("deprecated", [])
+        IMAGES = TypeAdapter(Dict[ImageAlias, str]).validate_python(constants["images"])
+        NETWORK = constants.get("network", "tranche")
+
+__all__ = ["CLUSTERS", "DEPRECATED", "IMAGES", "NETWORK"]

src/constants.yaml

@@ -0,0 +1,160 @@
+clusters:
+  duo:
+    tranche-bitcoind:
+      alias: bitcoind
+      command:
+        - -server=1
+        - -regtest=1
+        - -rpcauth=tranche:79c479f35a9b741e66f2658870f86f25$9c299f4e7b2abdedb7ae64cbe5f9ab356ec7234573ba31495aa10f7ca116ab52
+        - -debug=1
+        - -zmqpubrawblock=tcp://0.0.0.0:28334
+        - -zmqpubrawtx=tcp://0.0.0.0:28335
+        - -zmqpubhashblock=tcp://0.0.0.0:28336
+        - -txindex=0
+        - -dnsseed=0
+        - -upnp=0
+        - -rpcbind=0.0.0.0
+        - -rpcallowip=0.0.0.0/0
+        - -rpcport=18443
+        - -rpcworkqueue=128
+        - -rest
+        - -listen=1
+        - -listenonion=0
+        - -fallbackfee=0.0002
+        - -blockfilterindex=1
+        - -peerblockfilters=1
+        - -datadir=/home/bitcoin/.bitcoin
+        - -prune=600
+      ports:
+        - 18443:18443
+        - 28334:28334
+        - 28335:28335
+    tranche-ping:
+      alias: lnd
+      command:
+        - --noseedbackup
+        - --trickledelay=5000
+        - --externalip=tranche-ping
+        - --tlsextradomain=tranche-ping
+        - --listen=0.0.0.0:9735
+        - --rpclisten=0.0.0.0:10001
+        - --restlisten=0.0.0.0:8080
+        - --bitcoin.active
+        - --bitcoin.regtest
+        - --bitcoin.node=bitcoind
+        - --bitcoind.rpchost=tranche-bitcoind
+        - --bitcoind.rpcuser=tranche
+        - --bitcoind.rpcpass=tranche
+        - --bitcoind.zmqpubrawblock=tcp://tranche-bitcoind:28334
+        - --bitcoind.zmqpubrawtx=tcp://tranche-bitcoind:28335
+      ports:
+        - 9735:9735
+        - 10001:10001
+    tranche-pong:
+      alias: lnd
+      ports:
+        - 9735:9736
+        - 10001:10002
+      command:
+        - --noseedbackup
+        - --trickledelay=5000
+        - --externalip=tranche-pong
+        - --tlsextradomain=tranche-pong
+        - --listen=0.0.0.0:9735
+        - --rpclisten=0.0.0.0:10001
+        - --restlisten=0.0.0.0:8080
+        - --bitcoin.active
+        - --bitcoin.regtest
+        - --bitcoin.node=bitcoind
+        - --bitcoind.rpchost=tranche-bitcoind
+        - --bitcoind.rpcuser=tranche
+        - --bitcoind.rpcpass=tranche
+        - --bitcoind.zmqpubrawblock=tcp://tranche-bitcoind:28334
+        - --bitcoind.zmqpubrawtx=tcp://tranche-bitcoind:28335
+    tranche-postgres:
+      alias: postgres
+      env_vars:
+        - POSTGRES_HOST_AUTH_METHOD=trust
+      ports:
+        - 5432:5432
+    tranche-redis:
+      alias: redis
+      ports:
+        - 6379:6379
+  uno:
+    tranche-bitcoind:
+      alias: bitcoind
+      command:
+        - -server=1
+        - -regtest=1
+        - -rpcauth=tranche:79c479f35a9b741e66f2658870f86f25$9c299f4e7b2abdedb7ae64cbe5f9ab356ec7234573ba31495aa10f7ca116ab52
+        - -debug=1
+        - -zmqpubrawblock=tcp://0.0.0.0:28334
+        - -zmqpubrawtx=tcp://0.0.0.0:28335
+        - -zmqpubhashblock=tcp://0.0.0.0:28336
+        - -txindex=0
+        - -dnsseed=0
+        - -upnp=0
+        - -rpcbind=0.0.0.0
+        - -rpcallowip=0.0.0.0/0
+        - -rpcport=18443
+        - -rpcworkqueue=128
+        - -rest
+        - -listen=1
+        - -listenonion=0
+        - -fallbackfee=0.0002
+        - -blockfilterindex=1
+        - -peerblockfilters=1
+        - -datadir=/home/bitcoin/.bitcoin
+        - -prune=600
+      ports:
+        - 18443:18443
+        - 28334:28334
+        - 28335:28335
+    tranche-lnd:
+      alias: lnd
+      command:
+        - --noseedbackup
+        - --trickledelay=5000
+        - --externalip=tranche-lnd
+        - --tlsextradomain=tranche-lnd
+        - --listen=0.0.0.0:9735
+        - --rpclisten=0.0.0.0:10001
+        - --restlisten=0.0.0.0:8080
+        - --bitcoin.active
+        - --bitcoin.regtest
+        - --bitcoin.node=bitcoind
+        - --bitcoind.rpchost=tranche-bitcoind
+        - --bitcoind.rpcuser=tranche
+        - --bitcoind.rpcpass=tranche
+        - --bitcoind.zmqpubrawblock=tcp://tranche-bitcoind:28334
+        - --bitcoind.zmqpubrawtx=tcp://tranche-bitcoind:28335
+      ports:
+        - 9735:9735
+        - 10001:10001
+    tranche-postgres:
+      alias: postgres
+      env_vars:
+        - POSTGRES_HOST_AUTH_METHOD=trust
+      ports:
+        - 5432:5432
+    tranche-redis:
+      alias: redis
+      ports:
+        - 6379:6379
+deprecated:
+  - polarlightning/bitcoind:24.0
+  - polarlightning/lnd:0.16.0-beta
+  - polarlightning/lnd:0.16.1-beta
+  - polarlightning/lnd:0.16.2-beta
+  - polarlightning/lnd:0.16.4-beta
+  - polarlightning/lnd:0.17.0-beta.rc1
+  - polarlightning/lnd:0.17.0-beta.rc2
+  - polarlightning/lnd:0.17.0-beta
+  - polarlightning/lnd:0.17.1-beta
+images:
+  bitcoind: polarlightning/bitcoind:25.0
+  lnd: polarlightning/lnd:0.17.2-beta
+  postgres: postgres:latest
+  redis: redis:latest
+network: tranche

src/schemas/__init__.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/__init__.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Local modules ###
+from src.schemas.blockchain_info import BlockchainInfo
+from src.schemas.cluster_enum import ClusterEnum
+from src.schemas.mutex_option import MutexOption
+from src.schemas.image_alias import ImageAlias
+from src.schemas.new_address import NewAddress
+from src.schemas.node_info import NodeInfo
+from src.schemas.service import Service, ServiceName
+
+
+__all__ = [
+    "ClusterEnum",
+    "BlockchainInfo",
+    "ImageAlias",
+    "NewAddress",
+    "MutexOption",
+    "NodeInfo",
+    "Service",
+    "ServiceName",
+]

src/schemas/blockchain_info.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/blockchain_info.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Third-party packages ###
+from pydantic import BaseModel, StrictInt, StrictStr
+
+
+class BlockchainInfo(BaseModel):
+    blocks: StrictInt
+    chain: StrictStr
+    size_on_disk: StrictInt
+    time: StrictInt
+
+
+__all__ = ["BlockchainInfo"]

src/schemas/cluster_enum.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/cluster_enum.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from typing import Literal
+
+ClusterEnum = Literal["duo", "uno"]
+
+__all__ = ["ClusterEnum"]

src/schemas/image_alias.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/image_alias.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from typing import Literal
+
+ImageAlias = Literal["bitcoind", "lnd", "postgres", "redis"]
+
+__all__ = ["ImageAlias"]

src/schemas/mutex_option.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/mutex_option.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from typing import Any, List, Mapping, Tuple
+
+### Third-party packages ###
+from click import Context, Option, UsageError
+
+
+class MutexOption(Option):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        self.alternatives: list = kwargs.pop("alternatives")
+        assert self.alternatives, "'alternatives' parameter required."
+        kwargs["help"] = (
+            kwargs.get("help", "")
+            + f"Option is mutually exclusive with {', '.join(self.alternatives)}."
+        ).strip()
+        super(MutexOption, self).__init__(*args, **kwargs)
+
+    def handle_parse_result(
+        self, context: Context, options: Mapping[str, Any], arguments: List[str]
+    ) -> Tuple[Any, List[str]]:
+        current_opt: bool = self.name in options
+        for mutex_option in self.alternatives:
+            if mutex_option in options:
+                if current_opt:
+                    raise UsageError(
+                        f"Illegal usage: '{self.name}' is mutually exclusive with {mutex_option}."
+                    )
+                else:
+                    self.prompt = None
+        return super(MutexOption, self).handle_parse_result(context, options, arguments)
+
+
+__all__ = ["MutexOption"]

src/schemas/new_address.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/new_address.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Third-party packages ###
+from pydantic import BaseModel, StrictStr
+
+
+class NewAddress(BaseModel):
+    address: StrictStr
+
+
+__all__ = ["NewAddress"]

src/schemas/node_info.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/node_info.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Third-party packages ###
+from pydantic import BaseModel, StrictStr
+
+
+class NodeInfo(BaseModel):
+    identity_pubkey: StrictStr
+
+
+__all__ = ["NodeInfo"]

src/schemas/service.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3.8
+# coding:utf-8
+# Copyright (C) 2022-2023 All rights reserved.
+# FILENAME:    ~~/src/schemas/service.py
+# VERSION: 	   0.1.0
+# CREATED: 	   2023-12-01 05:31
+# AUTHOR: 	   Sitt Guruvanich <aekasitt.g+github@siamintech.co.th>
+# DESCRIPTION:
+#
+# HISTORY:
+# *************************************************************
+
+### Standard packages ###
+from typing import List, Literal
+
+### Third-party packages ###
+from pydantic import BaseModel, StrictStr
+
+### Local modules ###
+from src.schemas.image_alias import ImageAlias
+
+
+class Service(BaseModel):
+    alias: ImageAlias
+    command: List[StrictStr] = []
+    env_vars: List[StrictStr] = []
+    ports: List[StrictStr]
+
+
+ServiceName = Literal[
+    "tranche-bitcoind",
+    "tranche-lnd",
+    "tranche-ping",
+    "tranche-pong",
+    "tranche-postgres",
+    "tranche-redis",
+]
+
+__all__ = ["Service", "ServiceName"]

tranche-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2022-2023, Sitt Guruvanich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tranche-0.1.0.dist-info/METADATA

@@ -0,0 +1,50 @@
+Metadata-Version: 2.1
+Name: tranche
+Version: 0.1.0
+Summary: Command line interface used for generating local Lightning test environment
+License: MIT
+Author: Sitt Guruvanich
+Author-email: aekasitt.g+github@siamintech.co.th
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: APScheduler (>=3.10.4,<4.0.0)
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: docker (>=6.1.3,<7.0.0)
+Requires-Dist: pydantic (>=2.5.2,<3.0.0)
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Requires-Dist: rich (>=13.7.0,<14.0.0)
+Requires-Dist: types-pyyaml (>=6.0.12.12,<7.0.0.0)
+Description-Content-Type: text/markdown
+
+# Tranche
+
+[![Bitcoin-only](https://img.shields.io/badge/bitcoin-only-FF9900?logo=bitcoin)](https://twentyone.world)
+[![LN](https://img.shields.io/badge/lightning-792EE5?logo=lightning)](https://mempool.space/lightning)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+[![Tranche Banner](static/tranche-banner.svg)](static/tranche-banner.svg)
+
+### Known issues
+```python
+docker.errors.DockerException: Error while fetching server API version: ('Connection aborted.', FileNotFoundError(2, 'No such file or directory'))
+```
+
+See the following issue for Mac OSX troubleshooting.
+
+[docker from_env and pull is broken on mac](https://github.com/docker/docker-py/issues/3059#issuecomment-1294369344)
+
+Recommneded fix is to run the following command:
+
+```sh
+sudo ln -s "$HOME/.docker/run/docker.sock" /var/run/docker.sock
+```
+
+## License
+
+This project is licensed under the terms of the MIT license.

tranche-0.1.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+core.py,sha256=Taf2Ahwh0Jsom_sbcULWrxhxLvzGqlQplha7J4lYtAs,846
+src/__init__.py,sha256=ihGnKXv63GFC4ie2LO7_PQ4AwY820kTVYck8leVziVo,793
+src/commands/__init__.py,sha256=VC3PPfjanvD99ctC3eNjgQpzOnKnFucZ36cLNGVFwr8,759
+src/commands/clean.py,sha256=FNwKUEowWAOOWfT66FJYAi9LySlclOVTEWDVXI3YnAo,1274
+src/commands/cluster.py,sha256=PhU9bBpAoJC25aK_36n815ApONLWJ7jXHFkKSwbS68Q,3272
+src/commands/mine.py,sha256=MBvm63VGF9qi2g17odQEm9HjJt3oQIdF_Zv9g85WHxQ,4398
+src/commands/nodekeys.py,sha256=AvSalJBwtdNSx7sLoKcfvu1H2aUuuE3HyYkW91JJLKc,1546
+src/commands/ping_pong.py,sha256=Rq-zSOY6oIyglVcahHCMG5NRSSV_lIHWN94LJDvpGvg,525
+src/commands/remove_deprecated.py,sha256=xMZURzbOCvwdFdhlCs3cf8Bk7z6vfyxtouVaAer3SvE,1183
+src/commands/setup.py,sha256=KngvRJUsZrgupPiaxntc7LY9TdZKCJvvbdG-l0oYNH0,1340
+src/configs.py,sha256=vHUNDyBiVz1jnzwd7RYvKpKS95vYFvyajXNe5Qi1eE4,1205
+src/constants.yaml,sha256=T9Ak0BIw3V8kXC3aWtRyvTZB14ST9SL5eaEZhYClk3A,4637
+src/schemas/__init__.py,sha256=3JEcuwGspGR-KkPF-ZEJnlfVyWP6DkNk9wbzHzmSx0A,869
+src/schemas/blockchain_info.py,sha256=YOYL0gb_ok2DNooBx8jbh8uMVPi6rGM_AM7WOwPOM8k,588
+src/schemas/cluster_enum.py,sha256=enbm-VpeYOXoUjImIovVJ4cXpL-AswUgJ-tXgmlQ8BI,463
+src/schemas/image_alias.py,sha256=c52FAuENjkKIFCYtnCRzv042J3xSUU8Os6zl1bioHoc,486
+src/schemas/mutex_option.py,sha256=3NOxMHzvegmqk9RhJTzPGbfBEZaLBmAFSDg5qXXANpw,1583
+src/schemas/new_address.py,sha256=Mi2CN70_tl4PokX5p3gsommxBqExCJl7lUHYvjHlbN4,497
+src/schemas/node_info.py,sha256=_vq4d8FmTcHU7gYvaYhqfavBk4djLrgB3dfHL282zEc,499
+src/schemas/service.py,sha256=1nn8hTJNwvCQIjpdWTzhXErC34nuIKWZqyhs2aQ2ZfI,881
+tranche-0.1.0.dist-info/LICENSE,sha256=wRkcd6H2Z5ZmlmlV59AAOAkBBPSelLaGwgy-T047U60,1078
+tranche-0.1.0.dist-info/METADATA,sha256=1w-coxcbElLFVHh0UN8hYSd7XAFHLdeErbs8p_A2W_I,1860
+tranche-0.1.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+tranche-0.1.0.dist-info/entry_points.txt,sha256=8Hu2Rscx-Kbq0SIv9PpNMlQt3q510h5Or0u1vry43YI,36
+tranche-0.1.0.dist-info/RECORD,,

tranche-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.8.1
+Root-Is-Purelib: true
+Tag: py3-none-any

tranche-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+tranche=core:cli
+