tristero 0.3.0__tar.gz → 0.3.2__tar.gz

{tristero-0.3.0 → tristero-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tristero
-Version: 0.3.0
+Version: 0.3.2
 Summary: Library for trading on Tristero
 Author-email: pty1 <pty11@proton.me>
 Requires-Python: >=3.10
@@ -22,6 +22,23 @@ Dynamic: license-file
 
 This repository is home to Tristero's trading library.
 
+
+### How it works
+
+Tristero supports two primary swap mechanisms:
+
+#### Permit2 Swaps (EVM-to-EVM)
+- **Quote & Approve** - Request a quote and approve tokens via Permit2 (gasless approval)
+- **Sign & Submit** - Sign an EIP-712 order and submit for execution
+- **Monitor** - Track swap progress via WebSocket updates
+
+#### Feather Swaps (UTXO-based)
+- **Quote & Deposit** - Request a quote to receive a deposit address
+- **Manual Transfer** - Send funds to the provided deposit address
+- **Monitor** - Track swap completion via WebSocket updates
+
+This library provides both high-level convenience functions and lower-level components for precise control.
+
 ### Installation
 ```
 pip install tristero
@@ -181,18 +198,82 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-### How it works
 
-Tristero supports two primary swap mechanisms:
+#### Feather: Start (get deposit address)
 
-#### Permit2 Swaps (EVM-to-EVM)
-- **Quote & Approve** - Request a quote and approve tokens via Permit2 (gasless approval)
-- **Sign & Submit** - Sign an EIP-712 order and submit for execution
-- **Monitor** - Track swap progress via WebSocket updates
+Feather swaps are deposit-based: you start an order to receive a `deposit_address`, send funds to it manually, then optionally wait for completion.
 
-#### Feather Swaps (UTXO-based)
-- **Quote & Deposit** - Request a quote to receive a deposit address
-- **Manual Transfer** - Send funds to the provided deposit address
-- **Monitor** - Track swap completion via WebSocket updates
+Submit only:
 
-This library provides both high-level convenience functions and lower-level components for precise control.
+```py
+import asyncio
+
+from tristero import ChainID, TokenSpec, start_feather_swap
+
+
+async def main() -> None:
+    # Example: ETH (native) -> XMR (native)
+    src_t = TokenSpec(chain_id=ChainID.ethereum, token_address="native")
+    dst_t = TokenSpec(chain_id=ChainID.monero, token_address="native")
+
+    # Replace with your own destination address on the destination chain.
+    dst_addr = "YOUR_XMR_ADDRESS"
+
+    swap = await start_feather_swap(
+        src_t=src_t,
+        dst_t=dst_t,
+        dst_addr=dst_addr,
+        raw_amount=100_000_000_000_000_000,  # 0.1 ETH in wei
+    )
+
+    order_id = (
+        (swap.data or {}).get("id")
+        or (swap.data or {}).get("order_id")
+        or (swap.data or {}).get("orderId")
+        or ""
+    )
+
+    print("order_id:", order_id)
+    print("deposit_address:", swap.deposit_address)
+
+
+asyncio.run(main())
+```
+
+Submit + wait (WebSocket):
+
+```py
+import asyncio
+
+from tristero import ChainID, OrderType, TokenSpec, start_feather_swap, wait_for_completion
+
+
+async def main() -> None:
+    src_t = TokenSpec(chain_id=ChainID.ethereum, token_address="native")
+    dst_t = TokenSpec(chain_id=ChainID.monero, token_address="native")
+    dst_addr = "YOUR_XMR_ADDRESS"
+
+    swap = await start_feather_swap(
+        src_t=src_t,
+        dst_t=dst_t,
+        dst_addr=dst_addr,
+        raw_amount=100_000_000_000_000_000,
+    )
+
+    order_id = (
+        (swap.data or {}).get("id")
+        or (swap.data or {}).get("order_id")
+        or (swap.data or {}).get("orderId")
+        or ""
+    )
+    if not order_id:
+        raise RuntimeError(f"Feather swap response missing order id: {swap.data}")
+
+    print("deposit_address:", swap.deposit_address)
+    print("Waiting for completion...")
+    completion = await wait_for_completion(order_id, order_type=OrderType.FEATHER)
+    print(completion)
+
+
+asyncio.run(main())
+```

{tristero-0.3.0 → tristero-0.3.2}/README.md

@@ -4,6 +4,23 @@
 
 This repository is home to Tristero's trading library.
 
+
+### How it works
+
+Tristero supports two primary swap mechanisms:
+
+#### Permit2 Swaps (EVM-to-EVM)
+- **Quote & Approve** - Request a quote and approve tokens via Permit2 (gasless approval)
+- **Sign & Submit** - Sign an EIP-712 order and submit for execution
+- **Monitor** - Track swap progress via WebSocket updates
+
+#### Feather Swaps (UTXO-based)
+- **Quote & Deposit** - Request a quote to receive a deposit address
+- **Manual Transfer** - Send funds to the provided deposit address
+- **Monitor** - Track swap completion via WebSocket updates
+
+This library provides both high-level convenience functions and lower-level components for precise control.
+
 ### Installation
 ```
 pip install tristero
@@ -163,18 +180,82 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-### How it works
 
-Tristero supports two primary swap mechanisms:
+#### Feather: Start (get deposit address)
 
-#### Permit2 Swaps (EVM-to-EVM)
-- **Quote & Approve** - Request a quote and approve tokens via Permit2 (gasless approval)
-- **Sign & Submit** - Sign an EIP-712 order and submit for execution
-- **Monitor** - Track swap progress via WebSocket updates
+Feather swaps are deposit-based: you start an order to receive a `deposit_address`, send funds to it manually, then optionally wait for completion.
 
-#### Feather Swaps (UTXO-based)
-- **Quote & Deposit** - Request a quote to receive a deposit address
-- **Manual Transfer** - Send funds to the provided deposit address
-- **Monitor** - Track swap completion via WebSocket updates
+Submit only:
 
-This library provides both high-level convenience functions and lower-level components for precise control.
+```py
+import asyncio
+
+from tristero import ChainID, TokenSpec, start_feather_swap
+
+
+async def main() -> None:
+    # Example: ETH (native) -> XMR (native)
+    src_t = TokenSpec(chain_id=ChainID.ethereum, token_address="native")
+    dst_t = TokenSpec(chain_id=ChainID.monero, token_address="native")
+
+    # Replace with your own destination address on the destination chain.
+    dst_addr = "YOUR_XMR_ADDRESS"
+
+    swap = await start_feather_swap(
+        src_t=src_t,
+        dst_t=dst_t,
+        dst_addr=dst_addr,
+        raw_amount=100_000_000_000_000_000,  # 0.1 ETH in wei
+    )
+
+    order_id = (
+        (swap.data or {}).get("id")
+        or (swap.data or {}).get("order_id")
+        or (swap.data or {}).get("orderId")
+        or ""
+    )
+
+    print("order_id:", order_id)
+    print("deposit_address:", swap.deposit_address)
+
+
+asyncio.run(main())
+```
+
+Submit + wait (WebSocket):
+
+```py
+import asyncio
+
+from tristero import ChainID, OrderType, TokenSpec, start_feather_swap, wait_for_completion
+
+
+async def main() -> None:
+    src_t = TokenSpec(chain_id=ChainID.ethereum, token_address="native")
+    dst_t = TokenSpec(chain_id=ChainID.monero, token_address="native")
+    dst_addr = "YOUR_XMR_ADDRESS"
+
+    swap = await start_feather_swap(
+        src_t=src_t,
+        dst_t=dst_t,
+        dst_addr=dst_addr,
+        raw_amount=100_000_000_000_000_000,
+    )
+
+    order_id = (
+        (swap.data or {}).get("id")
+        or (swap.data or {}).get("order_id")
+        or (swap.data or {}).get("orderId")
+        or ""
+    )
+    if not order_id:
+        raise RuntimeError(f"Feather swap response missing order id: {swap.data}")
+
+    print("deposit_address:", swap.deposit_address)
+    print("Waiting for completion...")
+    completion = await wait_for_completion(order_id, order_type=OrderType.FEATHER)
+    print(completion)
+
+
+asyncio.run(main())
+```

{tristero-0.3.0 → tristero-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tristero"
-version = "0.3.0"
+version = "0.3.2"
 description = "Library for trading on Tristero"
 readme = "README.md"
 authors = [

{tristero-0.3.0 → tristero-0.3.2}/src/tristero.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tristero
-Version: 0.3.0
+Version: 0.3.2
 Summary: Library for trading on Tristero
 Author-email: pty1 <pty11@proton.me>
 Requires-Python: >=3.10
@@ -22,6 +22,23 @@ Dynamic: license-file
 
 This repository is home to Tristero's trading library.
 
+
+### How it works
+
+Tristero supports two primary swap mechanisms:
+
+#### Permit2 Swaps (EVM-to-EVM)
+- **Quote & Approve** - Request a quote and approve tokens via Permit2 (gasless approval)
+- **Sign & Submit** - Sign an EIP-712 order and submit for execution
+- **Monitor** - Track swap progress via WebSocket updates
+
+#### Feather Swaps (UTXO-based)
+- **Quote & Deposit** - Request a quote to receive a deposit address
+- **Manual Transfer** - Send funds to the provided deposit address
+- **Monitor** - Track swap completion via WebSocket updates
+
+This library provides both high-level convenience functions and lower-level components for precise control.
+
 ### Installation
 ```
 pip install tristero
@@ -181,18 +198,82 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
-### How it works
 
-Tristero supports two primary swap mechanisms:
+#### Feather: Start (get deposit address)
 
-#### Permit2 Swaps (EVM-to-EVM)
-- **Quote & Approve** - Request a quote and approve tokens via Permit2 (gasless approval)
-- **Sign & Submit** - Sign an EIP-712 order and submit for execution
-- **Monitor** - Track swap progress via WebSocket updates
+Feather swaps are deposit-based: you start an order to receive a `deposit_address`, send funds to it manually, then optionally wait for completion.
 
-#### Feather Swaps (UTXO-based)
-- **Quote & Deposit** - Request a quote to receive a deposit address
-- **Manual Transfer** - Send funds to the provided deposit address
-- **Monitor** - Track swap completion via WebSocket updates
+Submit only:
 
-This library provides both high-level convenience functions and lower-level components for precise control.
+```py
+import asyncio
+
+from tristero import ChainID, TokenSpec, start_feather_swap
+
+
+async def main() -> None:
+    # Example: ETH (native) -> XMR (native)
+    src_t = TokenSpec(chain_id=ChainID.ethereum, token_address="native")
+    dst_t = TokenSpec(chain_id=ChainID.monero, token_address="native")
+
+    # Replace with your own destination address on the destination chain.
+    dst_addr = "YOUR_XMR_ADDRESS"
+
+    swap = await start_feather_swap(
+        src_t=src_t,
+        dst_t=dst_t,
+        dst_addr=dst_addr,
+        raw_amount=100_000_000_000_000_000,  # 0.1 ETH in wei
+    )
+
+    order_id = (
+        (swap.data or {}).get("id")
+        or (swap.data or {}).get("order_id")
+        or (swap.data or {}).get("orderId")
+        or ""
+    )
+
+    print("order_id:", order_id)
+    print("deposit_address:", swap.deposit_address)
+
+
+asyncio.run(main())
+```
+
+Submit + wait (WebSocket):
+
+```py
+import asyncio
+
+from tristero import ChainID, OrderType, TokenSpec, start_feather_swap, wait_for_completion
+
+
+async def main() -> None:
+    src_t = TokenSpec(chain_id=ChainID.ethereum, token_address="native")
+    dst_t = TokenSpec(chain_id=ChainID.monero, token_address="native")
+    dst_addr = "YOUR_XMR_ADDRESS"
+
+    swap = await start_feather_swap(
+        src_t=src_t,
+        dst_t=dst_t,
+        dst_addr=dst_addr,
+        raw_amount=100_000_000_000_000_000,
+    )
+
+    order_id = (
+        (swap.data or {}).get("id")
+        or (swap.data or {}).get("order_id")
+        or (swap.data or {}).get("orderId")
+        or ""
+    )
+    if not order_id:
+        raise RuntimeError(f"Feather swap response missing order id: {swap.data}")
+
+    print("deposit_address:", swap.deposit_address)
+    print("Waiting for completion...")
+    completion = await wait_for_completion(order_id, order_type=OrderType.FEATHER)
+    print(completion)
+
+
+asyncio.run(main())
+```