denote alt url for examples, mostly for meeee

Author: jackharrhy

examples/basic_usage.py

@@ -7,7 +7,7 @@
 
 
 async def main(token: str, base_url: str):
-    async with stackcoin.Client(base_url=base_url, token=token) as client:
+    async with stackcoin.Client(token, base_url=base_url) as client:
         # Who am I?
         me = await client.get_me()
         print(f"Logged in as {me.username} with balance {me.balance} STK")
@@ -43,5 +43,7 @@ async def main(token: str, base_url: str):
             print("Token is required")
             exit(1)
 
+    # Can be omitted to hit production (https://stackcoin.world).
+    # Set STACKCOIN_BASE_URL for local development, e.g. http://localhost:4000
     base_url = os.getenv("STACKCOIN_BASE_URL", "https://stackcoin.world")
     asyncio.run(main(token, base_url))

examples/simple_cli.py

@@ -126,18 +126,20 @@ async def main():
             print("Token is required")
             return
 
+    # Can be omitted to hit production (https://stackcoin.world).
+    # Set STACKCOIN_BASE_URL for local development, e.g. http://localhost:4000
     base_url = os.getenv("STACKCOIN_BASE_URL", "https://stackcoin.world")
     ws_url = os.getenv("STACKCOIN_WS_URL",
                         base_url.replace("https://", "wss://")
                                 .replace("http://", "ws://")
                         + "/ws")
 
-    async with stackcoin.Client(base_url=base_url, token=token) as client:
+    async with stackcoin.Client(token, base_url=base_url) as client:
         me = await client.get_me()
         print(f"Connected to {base_url} as {me.username} ({me.balance} STK)")
 
         # Set up gateway for live events
-        gateway = stackcoin.Gateway(ws_url=ws_url, token=token)
+        gateway = stackcoin.Gateway(token, ws_url=ws_url)
 
         @gateway.on("transfer.completed")
         async def on_transfer(event: stackcoin.TransferCompletedEvent):

stackcoin/stackcoin/client.py

@@ -35,16 +35,16 @@ class Client:
 
     Usage::
 
-        async with Client("https://stackcoin.example.com", token="sk-...") as client:
+        async with Client(token="sk-...") as client:
             me = await client.get_me()
             print(me.username, me.balance)
     """
 
     def __init__(
         self,
-        base_url: str,
         token: str,
         *,
+        base_url: str = "https://stackcoin.world",
         timeout: float = 10.0,
     ) -> None:
         self._http = httpx.AsyncClient(

stackcoin/stackcoin/gateway.py

@@ -16,10 +16,7 @@ class Gateway:
 
     Usage::
 
-        gateway = stackcoin.Gateway(
-            ws_url="ws://localhost:4000/ws",
-            token="...",
-        )
+        gateway = stackcoin.Gateway(token="...")
 
         @gateway.on("request.accepted")
         async def handle_accepted(event: stackcoin.RequestAcceptedEvent):
@@ -30,12 +27,12 @@ async def handle_accepted(event: stackcoin.RequestAcceptedEvent):
 
     def __init__(
         self,
-        ws_url: str,
         token: str,
+        *,
+        ws_url: str = "wss://stackcoin.world/ws",
         last_event_id: int = 0,
         on_event_id: Callable[[int], None] | None = None,
     ):
-        # ws_url should be the full websocket URL like "ws://localhost:4000/ws"
         self._ws_url = ws_url.rstrip("/")
         self._token = token
         self._handlers: dict[str, list[EventHandler]] = {}