tristero 0.1.7__py3-none-any.whl → 0.2.1__py3-none-any.whl

tristero/permit2.py

@@ -1,5 +1,6 @@
+from dataclasses import dataclass
 import logging
-from typing import Any, List, Optional, TypeVar, cast
+from typing import Any, List, Literal, Optional, TypeVar, Union, cast
 from eth_account import Account
 from eth_account.datastructures import SignedMessage, SignedTransaction
 from eth_account.signers.base import BaseAccount
@@ -8,11 +9,7 @@ from eth_account.types import TransactionDictType
 from pydantic import BaseModel, ConfigDict, Field, field_validator
 from pydantic.alias_generators import to_camel
 from web3 import AsyncBaseProvider, AsyncWeb3
-from eth_typing import Address, ChecksumAddress
-import time
-import math
 import random
-import web3
 from web3.contract import AsyncContract
 from functools import cache, lru_cache
 import json
@@ -22,11 +19,11 @@ from importlib import resources as impresources
 from web3 import Web3
 from web3.eth import AsyncEth
 
-from .api import (
-    _WRAPPED_GAS_ADDRESSES,
-    get_quote,
-    _PERMIT2_CONTRACT_ADDRESSES,
-    ChainID,
+from tristero.api import get_quote
+
+from .data import (
+    get_permit2_addr,
+    get_wrapped_gas_addr,
 )
 
 logger = logging.getLogger(__name__)
@@ -35,10 +32,10 @@ P = TypeVar("P", bound=AsyncBaseProvider)
 
 PERMIT2_ABI_FILE = impresources.files("tristero.files") / "permit2_abi.json"
 ERC20_ABI_FILE = impresources.files("tristero.files") / "erc20_abi.json"
+
 PERMIT2_ABI = json.loads(PERMIT2_ABI_FILE.read_text())
 ERC20_ABI = json.loads(ERC20_ABI_FILE.read_text())
 
-
 @lru_cache(maxsize=None)
 def get_permit2(eth: AsyncEth, permit2_address: str):
     return eth.contract(
@@ -183,13 +180,13 @@ async def prepare_data_for_signature(
     if not quote.order_data.deadline:
         raise ValueError("Deadline is required in the order_data")
 
-    from_chain = ChainID(str(sell_data.chain_id))
+    from_chain = str(sell_data.chain_id)
 
     deadline = quote.order_data.deadline
 
     # Handle native token address conversion
     token_address = (
-        _WRAPPED_GAS_ADDRESSES[from_chain]
+        get_wrapped_gas_addr(from_chain)
         if sell_data.token.address == "native"
         else sell_data.token.address
     )
@@ -213,7 +210,7 @@ async def prepare_data_for_signature(
     )
 
     # Get Permit2 address
-    permit2_address = _PERMIT2_CONTRACT_ADDRESSES.get(from_chain)
+    permit2_address = get_permit2_addr(from_chain)
     if not permit2_address:
         raise ValueError("Permit2 not deployed on this chain.")
 
@@ -322,7 +319,7 @@ async def sign_permit2(
 async def approve_permit2(
     w3: AsyncWeb3[P],
     account: LocalAccount,
-    chain: ChainID,
+    chain: str,
     token_address: str,
     required_quantity: int,
     maxGas: int = 100000,
@@ -330,7 +327,7 @@ async def approve_permit2(
     wallet_address = account.address
 
     erc20 = get_erc20_contract(w3, token_address)
-    permit2_contract = _PERMIT2_CONTRACT_ADDRESSES.get(chain)
+    permit2_contract = get_permit2(chain)
     current_allowance = await erc20.functions.allowance(
         wallet_address, permit2_contract
     ).call()
@@ -358,28 +355,34 @@ async def approve_permit2(
         logger.debug(f"→ Approval tx hash: {tx_hash.hex()}")
         return tx_hash.hex()
 
+@dataclass
+class Permit2Order:
+    msg: SignatureData
+    sig: SignedMessage
 
-async def create_order(
+async def create_permit2_order(
     w3: AsyncWeb3[P],
     account: LocalAccount,
-    src_chain: ChainID,
+    src_chain: str,
     src_token: str,
-    dst_chain: ChainID,
+    dst_chain: str,
     dst_token: str,
     raw_amount: int,
-    to_address: Optional[str] = None,
-):
-    if not to_address:
-        to_address = account.address
+    dst_address: str | None = None,
+) -> Permit2Order:
+    if not dst_address:
+        dst_address = account.address
     q = await get_quote(
         account.address,
-        to_address,
+        dst_address,
         src_chain,
         src_token,
         dst_chain,
         dst_token,
         raw_amount,
     )
-    await approve_permit2(w3, account, src_chain, src_token, raw_amount)
-    # print("Quote: ", json.dumps(q))
-    return await sign_permit2(w3.eth, account, account.address, raw_amount, q)
+    if q['orderType'] == 'FEATHER':
+        raise Exception('Feather routes unsupported for automatic trades')
+    _ = await approve_permit2(w3, account, src_chain, src_token, raw_amount)
+    msg, sig = await sign_permit2(w3.eth, account, account.address, raw_amount, q)
+    return Permit2Order(msg, sig)

tristero-0.2.1.dist-info/METADATA

@@ -0,0 +1,284 @@
+Metadata-Version: 2.3
+Name: tristero
+Version: 0.2.1
+Summary: Library for trading on Tristero
+Author: pty1
+Author-email: pty1 <pty11@proton.me>
+Requires-Dist: eth-account>=0.8.0
+Requires-Dist: glom>=25.12.0
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: tenacity>=8.0.0
+Requires-Dist: web3>=6.0.0
+Requires-Dist: websockets>=10.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Tristero
+[![PyPI version](https://badge.fury.io/py/tristero.svg)](https://badge.fury.io/py/tristero)
+[![Python Support](https://img.shields.io/pypi/pyversions/tristero.svg)](https://pypi.org/project/tristero/)
+
+This repository is home to Tristero's trading library.
+
+### Installation
+```
+pip install tristero
+```
+
+### Quick Start
+
+Execute a cross-chain swap in just a few lines:
+
+```py
+import os
+from tristero.client import TokenSpec, execute_swap
+from eth_account import Account
+from web3 import AsyncWeb3
+from tristero.api import ChainID
+
+private_key = os.getenv("EVM_PRIVATE_KEY")
+account = Account.from_key(private_key)
+w3 = AsyncWeb3(AsyncWeb3.AsyncHTTPProvider("https://arbitrum-one-rpc.publicnode.com"))
+
+result = await execute_swap(
+    w3=w3,
+    account=account,
+    src_t=TokenSpec(chain_id=ChainID.arbitrum, token_address="0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9"),  # USDT
+    dst_t=TokenSpec(chain_id=ChainID.base, token_address="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"),  # USDC
+    raw_amount=10000000  # Raw token amount (multiply by 10^decimals)
+)
+```
+
+### Usage Examples
+
+#### Permit2 Swap (EVM-to-EVM)
+
+Permit2 swaps enable seamless EVM-to-EVM cross-chain token transfers with gasless approvals and EIP-712 signed orders.
+
+```py
+import os
+from tristero.client import TokenSpec, execute_permit2_swap
+from eth_account import Account
+from web3 import AsyncWeb3
+from tristero.api import ChainID
+
+private_key = os.getenv("EVM_PRIVATE_KEY")
+account = Account.from_key(private_key)
+w3 = AsyncWeb3(AsyncWeb3.AsyncHTTPProvider("https://mainnet.base.org"))
+
+# Example: USDC on Base → USDT on Avalanche
+result = await execute_permit2_swap(
+    w3=w3,
+    account=account,
+    src_t=TokenSpec(chain_id=ChainID.base, token_address="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"),  # USDC on Base
+    dst_t=TokenSpec(chain_id=ChainID.avalanche, token_address="0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7"),  # USDT on Avalanche
+    raw_amount=10 * 10**6  # 10 USDC (6 decimals)
+)
+
+print(f"Swap completed: {result}")
+```
+
+#### Feather Swap (UTXO-to-UTXO)
+
+Feather swaps facilitate cross-chain transfers between UTXO-based chains like Bitcoin and Monero, providing a deposit address for manual fund transfers.
+
+```py
+import asyncio
+from tristero.client import TokenSpec, start_feather_swap, wait_for_feather_completion
+from tristero.api import ChainID
+
+# Example: Bitcoin → Monero
+async def btc_to_xmr_swap():
+    # Start the swap to get a deposit address
+    swap_result = await start_feather_swap(
+        src_t=TokenSpec(chain_id=ChainID.bitcoin, token_address="native"),  # BTC
+        dst_t=TokenSpec(chain_id=ChainID.monero, token_address="native"),   # XMR
+        dst_addr="YOUR_XMR_RECEIVING_ADDRESS",  # Your Monero destination address
+        raw_amount=100000  # Amount in satoshis (0.001 BTC)
+    )
+    
+    print(f"Send {swap_result.data['amount']} satoshis to: {swap_result.deposit_address}")
+    
+    # Wait for swap completion after sending funds
+    result = await wait_for_feather_completion(swap_result.data['id'])
+    print(f"Swap completed: {result}")
+
+# Run the swap
+asyncio.run(btc_to_xmr_swap())
+```
+
+#### Two-Step Permit2 Swap
+
+For more control, you can separate the swap initiation from monitoring:
+
+```py
+from tristero.client import TokenSpec, start_permit2_swap, wait_for_completion_with_retry
+from eth_account import Account
+from web3 import AsyncWeb3
+from tristero.api import ChainID
+
+# Step 1: Start the swap
+account = Account.from_key(os.getenv("EVM_PRIVATE_KEY"))
+w3 = AsyncWeb3(AsyncWeb3.AsyncHTTPProvider("https://arbitrum-one-rpc.publicnode.com"))
+
+order_id = await start_permit2_swap(
+    w3=w3,
+    account=account,
+    src_t=TokenSpec(chain_id=ChainID.arbitrum, token_address="0xaf88d065e77c8cC2239327C5EDb3A432268e5831"),  # USDC
+    dst_t=TokenSpec(chain_id=ChainID.polygon, token_address="0xc2132D05D31c914a87C6611C10748AEb04B58e8F"),  # USDT
+    raw_amount=50 * 10**6  # 50 USDC
+)
+
+print(f"Swap initiated with order ID: {order_id}")
+
+# Step 2: Wait for completion with retry logic
+result = await wait_for_completion_with_retry(order_id, feather=False)
+print(f"Swap completed successfully!")
+```
+
+### 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.
+
+### API Reference
+
+#### Execute Full Swap
+`execute_swap` handles the entire workflow automatically: quoting, signing, submitting, and monitoring.
+```py
+from tristero.client import execute_swap, TokenSpec
+from web3 import AsyncWeb3
+from eth_account.signers.local import LocalAccount
+
+w3 = AsyncWeb3(...)  # Your Web3 provider
+account: LocalAccount = ...  # Your account
+
+result = await execute_swap(
+    w3=w3,
+    account=account,
+    src_t=TokenSpec(chain_id=ChainID.ethereum, token_address="0xA0b8..."),
+    dst_t=TokenSpec(chain_id=ChainID.arbitrum, token_address="0xaf88..."),
+    raw_amount=10*(10**18),
+    retry=True,
+    timeout=300.0  # 5 minutes
+)
+```
+
+#### Execute Permit2 Swap
+`execute_permit2_swap` handles EVM-to-EVM swaps with Permit2 integration.
+```py
+from tristero.client import execute_permit2_swap, TokenSpec
+from web3 import AsyncWeb3
+from eth_account.signers.local import LocalAccount
+
+w3 = AsyncWeb3(...)  # Your Web3 provider
+account: LocalAccount = ...  # Your account
+
+result = await execute_permit2_swap(
+    w3=w3,
+    account=account,
+    src_t=TokenSpec(chain_id=ChainID.base, token_address="0x833589f..."),  # USDC
+    dst_t=TokenSpec(chain_id=ChainID.avalanche, token_address="0x9702230..."),  # USDT
+    raw_amount=10*(10**6),  # 10 USDC (6 decimals)
+    retry=True,
+    timeout=300.0  # 5 minutes
+)
+```
+
+#### Start Feather Swap
+`start_feather_swap` initiates UTXO-based swaps and returns deposit information.
+```py
+from tristero.client import start_feather_swap, TokenSpec
+
+swap_result = await start_feather_swap(
+    src_t=TokenSpec(chain_id=ChainID.bitcoin, token_address="native"),
+    dst_t=TokenSpec(chain_id=ChainID.monero, token_address="native"),
+    dst_addr="YOUR_DESTINATION_ADDRESS",
+    raw_amount=100000  # Amount in smallest unit
+)
+
+deposit_address = swap_result.deposit_address
+order_id = swap_result.data['id']
+```
+
+#### Requesting a quote
+
+`get_quote` requests a quote for a particular swap, letting you see output amounts and gas fees.
+
+```py
+from tristero.api import get_quote, ChainID
+
+quote = await get_quote(
+    from_wallet="0x1234...",           # Source wallet address
+    to_wallet="0x5678...",             # Destination wallet address
+    from_chain_id=ChainID.ethereum,    # Source chain
+    from_address="0xA0b8...",          # Source token address (or "native")
+    to_chain_id=ChainID.arbitrum,      # Destination chain
+    to_address="0xaf88...",            # Destination token address (or "native")
+    amount=10*(10**18),                # Amount in smallest unit (wei)
+)
+```
+
+#### Creating a signed order
+`create_order` creates and signs an order without submitting to be filled.
+
+```py
+from tristero.api import get_quote, ChainID
+
+w3 = AsyncWeb3(...)  # Your Web3 provider
+account: LocalAccount = ...  # Your account
+
+data, sig = await create_order(
+    w3,
+    account,
+    from_chain_id=ChainID.ethereum,
+    from_address="0xA0b8...",
+    to_chain_id=ChainID.arbitrum,
+    to_address="0xaf88...",
+    raw_amount=10*(10**18),
+)
+
+```
+
+#### Submit order
+
+`fill_order` submits a signed order for execution.
+
+```py
+from tristero.api import fill_order
+
+data, sig = ... # from earlier
+
+response = await fill_order(
+    signature=str(sig.signature.to_0x_hex()),
+    domain=data.domain.model_dump(by_alias=True, mode="json"),
+    message=data.message.model_dump(by_alias=True, mode="json"),
+)
+
+order_id = response['id']
+```
+
+#### Monitoring with Built-in Functions
+
+For convenience, use the built-in monitoring functions:
+
+```py
+from tristero.client import wait_for_completion_with_retry
+
+# Monitor Permit2 swap with retry logic
+result = await wait_for_completion_with_retry(order_id, feather=False)
+
+# Monitor Feather swap with retry logic
+result = await wait_for_completion_with_retry(order_id, feather=True)
+```

tristero-0.2.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+tristero/__init__.py,sha256=hMbay3U8ovonIAH4N45Tx_U8q1MrTkS5qLrquWz_19g,624
+tristero/api.py,sha256=IuCxik9GSaekWPBuaCFalYzrVQWpliS8MO8dJn2115c,2967
+tristero/client.py,sha256=BkQBxFjyQ13JSHVOYlodCMbQGXYK2a-GHxQdI_6HEso,5673
+tristero/config.py,sha256=_0PP2gufvq_t-gdKqDrxht2BxoWpNiGXk4m_u57WOYY,530
+tristero/data.py,sha256=gKqoLOg2KQu3shqtHg-AS4kDeb7XOFMy76sIbNBIw1w,887
+tristero/files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tristero/files/chains.json,sha256=04jFywe_V0wrS0tcjdCUHMxIutaLJ_k5ABbbmkyZ9jY,256150
+tristero/files/erc20_abi.json,sha256=jvsJ6aCwhMcmo3Yy1ajt5lPl_nTRg7tv-tGj87xzTOg,12800
+tristero/files/permit2_abi.json,sha256=NV0AUUA9kqFPk56njvRRzUyjBhrBncKIMd3PrSH0LCc,17817
+tristero/permit2.py,sha256=CFj6DQPC8UqCcI0HH8PJHJYk8Hba-Aspokxk229R29I,11517
+tristero/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tristero-0.2.1.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+tristero-0.2.1.dist-info/METADATA,sha256=ysDNK9nnh0L5gcEFD5wgc9nbsGcASVST1RpmLe-mzJc,9007
+tristero-0.2.1.dist-info/RECORD,,

tristero-0.1.7.dist-info/METADATA

@@ -1,157 +0,0 @@
-Metadata-Version: 2.3
-Name: tristero
-Version: 0.1.7
-Summary: Library for trading on Tristero
-Author: pty1
-Author-email: pty1 <pty11@proton.me>
-Requires-Dist: eth-account>=0.8.0
-Requires-Dist: httpx>=0.23.0
-Requires-Dist: pydantic>=2.0.0
-Requires-Dist: tenacity>=8.0.0
-Requires-Dist: web3>=6.0.0
-Requires-Dist: websockets>=10.0
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-
-# Tristero
-[![PyPI version](https://badge.fury.io/py/tristero.svg)](https://badge.fury.io/py/tristero)
-[![Python Support](https://img.shields.io/pypi/pyversions/tristero.svg)](https://pypi.org/project/tristero/)
-
-This repository is home to Tristero's trading library.
-
-### Installation
-```
-pip install tristero
-```
-
-### Quick Start
-
-Execute a cross-chain swap in just a few lines:
-
-```py
-import os
-from tristero.client import TokenSpec, execute_swap
-from eth_account import Account
-from web3 import AsyncWeb3
-from tristero.api import ChainID
-
-private_key = os.getenv("EVM_PRIVATE_KEY")
-account = Account.from_key(private_key)
-w3 = AsyncWeb3(AsyncWeb3.AsyncHTTPProvider("https://arbitrum-one-rpc.publicnode.com"))
-
-result = await execute_swap(
-    w3=w3,
-    account=account,
-    src_t=TokenSpec(chain_id=ChainID.arbitrum, token_address="0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9"),  # USDT
-    dst_t=TokenSpec(chain_id=ChainID.base, token_address="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"),  # USDC
-    raw_amount=10000000  # Raw token amount (multiply by 10^decimals)
-)
-```
-
-### How it works
-
-Tristero swaps happen in two steps:
-- **Quote & Sign** - Request a quote from the server and sign it with your private key
-- **Submit & Fill** - Submit the signed order to be filled at a later date
-
-This library provides both high-level convenience functions and lower-level components for precise control.
-
-### API Reference
-
-#### Execute Full Swap
-`execute_swap` handles the entire workflow automatically: quoting, signing, submitting, and monitoring.
-```py
-from tristero.swap import execute_swap, TokenSpec
-from web3 import AsyncWeb3
-from eth_account.signers.local import LocalAccount
-
-w3 = AsyncWeb3(...)  # Your Web3 provider
-account: LocalAccount = ...  # Your account
-
-result = await execute_swap(
-    w3=w3,
-    account=account,
-    src_t=TokenSpec(chain_id=ChainID.ethereum, token_address="0xA0b8..."),
-    dst_t=TokenSpec(chain_id=ChainID.arbitrum, token_address="0xaf88..."),
-    raw_amount=10*(10**18),
-    retry=True,
-    timeout=300.0  # 5 minutes
-)
-```
-
-#### Requesting a quote
-
-`get_quote` requests a quote for a particular swap, letting you see output amounts and gas fees.
-
-```py
-from tristero.api import get_quote, ChainID
-
-quote = await get_quote(
-    from_wallet="0x1234...",           # Source wallet address
-    to_wallet="0x5678...",             # Destination wallet address
-    from_chain_id=ChainID.ethereum,    # Source chain
-    from_address="0xA0b8...",          # Source token address (or "native")
-    to_chain_id=ChainID.arbitrum,      # Destination chain
-    to_address="0xaf88...",            # Destination token address (or "native")
-    amount=10*(10**18),                # Amount in smallest unit (wei)
-)
-```
-
-#### Creating a signed order
-`create_order` creates and signs an order without submitting to be filled.
-
-```py
-from tristero.api import get_quote, ChainID
-
-w3 = AsyncWeb3(...)  # Your Web3 provider
-account: LocalAccount = ...  # Your account
-
-data, sig = await create_order(
-    w3,
-    account,
-    from_chain_id=ChainID.ethereum,
-    from_address="0xA0b8...",
-    to_chain_id=ChainID.arbitrum,
-    to_address="0xaf88...",
-    raw_amount=10*(10**18),
-)
-
-```
-
-#### Submit order
-
-`fill_order` submits a signed order for execution.
-
-```py
-from tristero.api import fill_order
-
-data, sig = ... # from earlier
-
-response = await fill_order(
-    signature=str(sig.signature.to_0x_hex()),
-    domain=data.domain.model_dump(by_alias=True, mode="json"),
-    message=data.message.model_dump(by_alias=True, mode="json"),
-)
-
-order_id = response['id']
-```
-
-#### Subscribing for updates
-
-Orders can be monitored for changes and status live
-
-```py
-from tristero.api import poll_updates
-import json
-
-ws = await poll_updates(order_id)
-
-async for msg in ws:
-    update = json.loads(msg)
-    print(f"Completed: {update['completed']}")
-    print(f"Failed: {update['failed']}")
-
-    if update["completed"] or update["failed"]:
-        await ws.close()
-        break
-```

tristero-0.1.7.dist-info/RECORD

@@ -1,12 +0,0 @@
-tristero/__init__.py,sha256=Jmbdg3LwOD4rrO0eerQTmn-wO-Sr4xRZ2r_RtM4iNDg,315
-tristero/api.py,sha256=E5CyEbEZjeEpptJ2C5570g-ZD02PWE73USTz5v-uKss,5520
-tristero/client.py,sha256=nro5d9z5cAZOWSgF3s43UcFPMrTqbFk4DxIWo14u7-Y,4086
-tristero/config.py,sha256=_0PP2gufvq_t-gdKqDrxht2BxoWpNiGXk4m_u57WOYY,530
-tristero/files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tristero/files/erc20_abi.json,sha256=jvsJ6aCwhMcmo3Yy1ajt5lPl_nTRg7tv-tGj87xzTOg,12800
-tristero/files/permit2_abi.json,sha256=NV0AUUA9kqFPk56njvRRzUyjBhrBncKIMd3PrSH0LCc,17817
-tristero/permit2.py,sha256=eBSAYTnnDI2NmOJDx5Px5ae7bSjE_FEmkZZn9wx-uZU,11396
-tristero/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tristero-0.1.7.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
-tristero-0.1.7.dist-info/METADATA,sha256=nC7bzXMgELN7Ln80LSu4ArqLGB1YIRSyrHGBjSIpybA,4384
-tristero-0.1.7.dist-info/RECORD,,