flexvaults 0.1.5__tar.gz

flexvaults-0.1.5/.gitignore

@@ -0,0 +1,34 @@
+# dependencies
+node_modules/
+
+# build outputs
+dist/
+.next/
+out/
+build/
+*.compiled.css
+packages/sdk/src/compiled.css
+
+# turbo
+.turbo/
+
+# testing
+coverage/
+
+# env
+.env*
+
+# misc
+.DS_Store
+*.pem
+*.log
+
+# typescript
+*.tsbuildinfo
+
+# IDE
+.idea/
+.vscode/
+
+# vercel
+.vercel

flexvaults-0.1.5/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: flexvaults
+Version: 0.1.5
+Summary: Python SDK for Flexvaults - manage deposits, withdrawals, locks, and transfers
+Project-URL: Homepage, https://github.com/oasisprotocol/flexvaults-sdk
+Project-URL: Repository, https://github.com/oasisprotocol/flexvaults-sdk
+Project-URL: Issues, https://github.com/oasisprotocol/flexvaults-sdk/issues
+Author-email: Oasis Protocol Foundation <security@oasisprotocol.org>
+License-Expression: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: eth-account>=0.13.0
+Requires-Dist: eth-typing>=5.0.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.34.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: respx>=0.22.0; extra == 'dev'
+Requires-Dist: ruff>=0.7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# flexvaults
+
+Python SDK for Flexvaults - manage deposits, withdrawals, locks, and transfers on the Oasis Sapphire network.
+
+## Installation
+
+```bash
+pip install flexvaults
+```
+
+## Quick Start
+
+```python
+import asyncio
+from flexvaults import FlexvaultsClient, DepositQuoteRequest
+
+async def main():
+    async with FlexvaultsClient(base_url="https://api.example.com") as client:
+        # Get a deposit quote
+        quote = await client.get_deposit_quote(
+            DepositQuoteRequest(
+                user_address="0xYourAddress",
+                token_id="0xTokenId",
+                amount=1000000,
+            )
+        )
+        print(f"Deposit to: {quote.deposit_address}")
+
+        # Check balance
+        balance = await client.get_balance("0xYourAddress", "0xTokenId")
+        print(f"Balance: {balance.balance}")
+
+asyncio.run(main())
+```
+
+## EIP-712 Signing
+
+```python
+from eth_account import Account
+from flexvaults import (
+    sign_lock_message,
+    SignLockParams,
+    LockMessage,
+    get_accounting_contract,
+    create_lock_expiry,
+)
+
+account = Account.from_key("0xYourPrivateKey")
+
+signature = sign_lock_message(
+    SignLockParams(
+        account=account,
+        network="testnet",
+        verifying_contract=get_accounting_contract("testnet"),
+        message=LockMessage(
+            user_address=account.address,
+            service_address="0xServiceAddress",
+            token_id="0xTokenId",
+            amount=1000000,
+            expiry=create_lock_expiry(60),
+        ),
+    )
+)
+```
+
+## API Reference
+
+### Client
+
+- `FlexvaultsClient(base_url, timeout=30.0, headers=None)` - Main API client
+  - `get_deposit_quote(request)` - Get deposit quote
+  - `include_deposit(request)` - Include deposit proof
+  - `get_balance(user_address, token_id)` - Get token balance
+  - `get_batch_balances(request)` - Get multiple token balances
+  - `get_token_info(token_id)` - Get token information
+  - `lock_funds(request)` - Lock funds for a service
+  - `unlock_funds(request)` - Unlock specific lock
+  - `unlock_all_expired(request)` - Unlock all expired locks
+  - `get_locked_funds(user_address, service_address=None)` - Get locked funds
+  - `get_total_locked_balance(user_address, token_id)` - Get total locked balance
+  - `get_expired_locks(user_address)` - Get expired locks
+  - `transfer_funds(request)` - Transfer tokens
+  - `transfer_locked_funds(request)` - Transfer locked tokens
+  - `request_withdrawal(request)` - Request withdrawal
+  - `get_pending_withdrawals(user_address)` - Get pending withdrawals
+  - `get_withdrawal_info(index)` - Get withdrawal info
+
+### Signing
+
+- `sign_lock_message(params)` - Sign lock message
+- `sign_transfer_message(params)` - Sign transfer message
+- `sign_transfer_locked_message(params)` - Sign transfer locked message
+- `sign_withdraw_message(params)` - Sign withdrawal message
+- `create_lock_expiry(minutes_from_now=60)` - Create expiry timestamp
+
+### Utilities
+
+- `format_token_amount(amount, decimals=18)` - Format wei to human-readable
+- `parse_token_amount(amount, decimals=18)` - Parse human-readable to wei
+- `shorten_address(address, chars=4)` - Shorten Ethereum address
+- `is_expired(expiry)` - Check if timestamp is expired
+- `format_time_remaining(expiry_timestamp)` - Format time remaining
+- `format_relative_time(timestamp)` - Format relative time (e.g., "5m ago")
+
+## License
+
+Apache-2.0

flexvaults-0.1.5/README.md

@@ -0,0 +1,107 @@
+# flexvaults
+
+Python SDK for Flexvaults - manage deposits, withdrawals, locks, and transfers on the Oasis Sapphire network.
+
+## Installation
+
+```bash
+pip install flexvaults
+```
+
+## Quick Start
+
+```python
+import asyncio
+from flexvaults import FlexvaultsClient, DepositQuoteRequest
+
+async def main():
+    async with FlexvaultsClient(base_url="https://api.example.com") as client:
+        # Get a deposit quote
+        quote = await client.get_deposit_quote(
+            DepositQuoteRequest(
+                user_address="0xYourAddress",
+                token_id="0xTokenId",
+                amount=1000000,
+            )
+        )
+        print(f"Deposit to: {quote.deposit_address}")
+
+        # Check balance
+        balance = await client.get_balance("0xYourAddress", "0xTokenId")
+        print(f"Balance: {balance.balance}")
+
+asyncio.run(main())
+```
+
+## EIP-712 Signing
+
+```python
+from eth_account import Account
+from flexvaults import (
+    sign_lock_message,
+    SignLockParams,
+    LockMessage,
+    get_accounting_contract,
+    create_lock_expiry,
+)
+
+account = Account.from_key("0xYourPrivateKey")
+
+signature = sign_lock_message(
+    SignLockParams(
+        account=account,
+        network="testnet",
+        verifying_contract=get_accounting_contract("testnet"),
+        message=LockMessage(
+            user_address=account.address,
+            service_address="0xServiceAddress",
+            token_id="0xTokenId",
+            amount=1000000,
+            expiry=create_lock_expiry(60),
+        ),
+    )
+)
+```
+
+## API Reference
+
+### Client
+
+- `FlexvaultsClient(base_url, timeout=30.0, headers=None)` - Main API client
+  - `get_deposit_quote(request)` - Get deposit quote
+  - `include_deposit(request)` - Include deposit proof
+  - `get_balance(user_address, token_id)` - Get token balance
+  - `get_batch_balances(request)` - Get multiple token balances
+  - `get_token_info(token_id)` - Get token information
+  - `lock_funds(request)` - Lock funds for a service
+  - `unlock_funds(request)` - Unlock specific lock
+  - `unlock_all_expired(request)` - Unlock all expired locks
+  - `get_locked_funds(user_address, service_address=None)` - Get locked funds
+  - `get_total_locked_balance(user_address, token_id)` - Get total locked balance
+  - `get_expired_locks(user_address)` - Get expired locks
+  - `transfer_funds(request)` - Transfer tokens
+  - `transfer_locked_funds(request)` - Transfer locked tokens
+  - `request_withdrawal(request)` - Request withdrawal
+  - `get_pending_withdrawals(user_address)` - Get pending withdrawals
+  - `get_withdrawal_info(index)` - Get withdrawal info
+
+### Signing
+
+- `sign_lock_message(params)` - Sign lock message
+- `sign_transfer_message(params)` - Sign transfer message
+- `sign_transfer_locked_message(params)` - Sign transfer locked message
+- `sign_withdraw_message(params)` - Sign withdrawal message
+- `create_lock_expiry(minutes_from_now=60)` - Create expiry timestamp
+
+### Utilities
+
+- `format_token_amount(amount, decimals=18)` - Format wei to human-readable
+- `parse_token_amount(amount, decimals=18)` - Parse human-readable to wei
+- `shorten_address(address, chars=4)` - Shorten Ethereum address
+- `is_expired(expiry)` - Check if timestamp is expired
+- `format_time_remaining(expiry_timestamp)` - Format time remaining
+- `format_relative_time(timestamp)` - Format relative time (e.g., "5m ago")
+
+## License
+
+Apache-2.0

flexvaults-0.1.5/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "flexvaults"
+version = "0.1.5"
+description = "Python SDK for Flexvaults - manage deposits, withdrawals, locks, and transfers"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+authors = [
+    { name = "Oasis Protocol Foundation", email = "security@oasisprotocol.org" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.27.0",
+    "eth-account>=0.13.0",
+    "eth-typing>=5.0.0",
+    "pydantic>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.24.0",
+    "pytest-httpx>=0.34.0",
+    "respx>=0.22.0",
+    "mypy>=1.11.0",
+    "ruff>=0.7.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/oasisprotocol/flexvaults-sdk"
+Repository = "https://github.com/oasisprotocol/flexvaults-sdk"
+Issues = "https://github.com/oasisprotocol/flexvaults-sdk/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/flexvaults"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP"]

flexvaults-0.1.5/src/flexvaults/__init__.py

@@ -0,0 +1,168 @@
+from .client import (
+    AccountingApiError,
+    FlexvaultsClient,
+    HttpClient,
+    NetworkError,
+    ValidationError,
+)
+from .signatures import (
+    LOCK_TYPES,
+    TRANSFER_LOCKED_TYPES,
+    TRANSFER_TYPES,
+    WITHDRAW_TYPES,
+    EIP712Domain,
+    LockMessage,
+    SignLockParams,
+    SignTransferLockedParams,
+    SignTransferParams,
+    SignWithdrawParams,
+    TransferLockedMessage,
+    TransferMessage,
+    WithdrawMessage,
+    create_domain,
+    create_lock_expiry,
+    sign_lock_message,
+    sign_transfer_locked_message,
+    sign_transfer_message,
+    sign_withdraw_message,
+)
+from .types import (
+    NETWORK_CONFIG,
+    SUPPORTED_CHAINS,
+    SUPPORTED_TOKENS,
+    Address,
+    BalanceResponse,
+    BatchBalancesRequest,
+    BatchBalancesResponse,
+    Bytes32,
+    ChainConfig,
+    DepositQuoteRequest,
+    DepositQuoteResponse,
+    ExpiredLocksResponse,
+    HexString,
+    IncludeDepositRequest,
+    IncludeDepositResponse,
+    LockedFundsResponse,
+    LockFundsRequest,
+    LockInfo,
+    Network,
+    NetworkConfig,
+    PendingWithdrawal,
+    PendingWithdrawalsResponse,
+    SupportedToken,
+    TokenBalance,
+    TokenConfig,
+    TokenInfoResponse,
+    TotalLockedBalanceResponse,
+    TransactionData,
+    TransactionSubmissionResponse,
+    TransferFundsRequest,
+    TransferLockedFundsRequest,
+    UnlockAllExpiredRequest,
+    UnlockFundsRequest,
+    WithdrawalInfoResponse,
+    WithdrawalRequest,
+    get_accounting_contract,
+    get_all_tokens,
+    get_api_url,
+    get_chain_by_id,
+    get_chain_id,
+    get_explorer_address_url,
+    get_token_by_id,
+    get_token_config,
+    is_valid_token,
+    normalize_address,
+    normalize_hex,
+)
+from .utils import (
+    format_relative_time,
+    format_time_remaining,
+    format_timestamp,
+    format_token_amount,
+    is_expired,
+    parse_token_amount,
+    shorten_address,
+)
+
+__version__ = "0.1.5"
+
+__all__ = [
+    "__version__",
+    "Address",
+    "Bytes32",
+    "HexString",
+    "Network",
+    "NetworkConfig",
+    "NETWORK_CONFIG",
+    "get_chain_id",
+    "get_accounting_contract",
+    "get_api_url",
+    "normalize_hex",
+    "normalize_address",
+    "TokenConfig",
+    "SupportedToken",
+    "SUPPORTED_TOKENS",
+    "get_token_config",
+    "get_token_by_id",
+    "is_valid_token",
+    "ChainConfig",
+    "SUPPORTED_CHAINS",
+    "get_chain_by_id",
+    "get_explorer_address_url",
+    "get_all_tokens",
+    "DepositQuoteRequest",
+    "IncludeDepositRequest",
+    "LockFundsRequest",
+    "UnlockFundsRequest",
+    "UnlockAllExpiredRequest",
+    "TransferFundsRequest",
+    "TransferLockedFundsRequest",
+    "WithdrawalRequest",
+    "BatchBalancesRequest",
+    "TransactionData",
+    "DepositQuoteResponse",
+    "IncludeDepositResponse",
+    "TransactionSubmissionResponse",
+    "BalanceResponse",
+    "TokenBalance",
+    "BatchBalancesResponse",
+    "TokenInfoResponse",
+    "LockInfo",
+    "LockedFundsResponse",
+    "ExpiredLocksResponse",
+    "TotalLockedBalanceResponse",
+    "PendingWithdrawal",
+    "PendingWithdrawalsResponse",
+    "WithdrawalInfoResponse",
+    "FlexvaultsClient",
+    "HttpClient",
+    "AccountingApiError",
+    "NetworkError",
+    "ValidationError",
+    "EIP712Domain",
+    "create_domain",
+    "LOCK_TYPES",
+    "TRANSFER_TYPES",
+    "TRANSFER_LOCKED_TYPES",
+    "WITHDRAW_TYPES",
+    "LockMessage",
+    "TransferMessage",
+    "TransferLockedMessage",
+    "WithdrawMessage",
+    "SignLockParams",
+    "sign_lock_message",
+    "create_lock_expiry",
+    "SignTransferParams",
+    "sign_transfer_message",
+    "SignTransferLockedParams",
+    "sign_transfer_locked_message",
+    "SignWithdrawParams",
+    "sign_withdraw_message",
+    "format_token_amount",
+    "parse_token_amount",
+    "shorten_address",
+    "format_timestamp",
+    "is_expired",
+    "format_time_remaining",
+    "format_relative_time",
+]

flexvaults-0.1.5/src/flexvaults/client/__init__.py

@@ -0,0 +1,11 @@
+from .errors import AccountingApiError, NetworkError, ValidationError
+from .flexvaults_client import FlexvaultsClient
+from .http_client import HttpClient
+
+__all__ = [
+    "AccountingApiError",
+    "NetworkError",
+    "ValidationError",
+    "HttpClient",
+    "FlexvaultsClient",
+]

flexvaults-0.1.5/src/flexvaults/client/errors.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+
+class AccountingApiError(Exception):
+    def __init__(
+        self,
+        message: str,
+        status_code: int,
+        detail: str | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+        self.detail = detail
+
+
+class NetworkError(Exception):
+    def __init__(
+        self,
+        message: str,
+        cause: Exception | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.__cause__ = cause
+
+
+class ValidationError(Exception):
+    def __init__(
+        self,
+        message: str,
+        field: str | None = None,
+    ) -> None:
+        super().__init__(message)
+        self.field = field