chipi-stack 2.0.0__py3-none-any.whl

chipi_stack-2.0.0.dist-info/METADATA

@@ -0,0 +1,366 @@
+Metadata-Version: 2.4
+Name: chipi-stack
+Version: 2.0.0
+Summary: Python SDK for Starknet Gasless Transactions via Chipi
+Author-email: Carlos Castillo <carlos@chipipay.com>, Roberto Yamanaka <roberto@chipipay.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/chipi-pay/sdks
+Project-URL: Documentation, https://docs.chipipay.com
+Project-URL: Repository, https://github.com/chipi-pay/sdks
+Project-URL: Issues, https://github.com/chipi-pay/sdks/issues
+Keywords: starknet,blockchain,gasless,transactions,web3,chipi,paymaster
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: starknet-py>=0.23.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: cryptography>=42.0.0
+Requires-Dist: typing-extensions>=4.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.12.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: ruff>=0.3.0; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+# Chipi Python SDK
+
+[![PyPI version](https://badge.fury.io/py/chipi-python.svg)](https://badge.fury.io/py/chipi-python)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Python SDK for executing gasless transactions on Starknet via Chipi's paymaster infrastructure.
+
+## Features
+
+- 🚀 **Gasless Transactions** - Execute transactions without paying gas fees
+- 💼 **Wallet Management** - Create and manage Starknet wallets
+- 🔐 **Session Keys** - SNIP-9 compatible session key support for CHIPI wallets
+- 🔄 **Sync & Async** - Full support for both synchronous and asynchronous operations
+- 📦 **Type Safe** - Built with Pydantic for runtime validation and type safety
+- 🎯 **Simple API** - Easy-to-use interface for all operations
+
+## Installation
+
+```bash
+pip install chipi-python
+```
+
+Or with uv:
+
+```bash
+uv add chipi-python
+```
+
+### Requirements
+
+- Python 3.11 or higher
+- Dependencies:
+  - `starknet-py>=0.23.0` - Starknet interactions
+  - `pydantic>=2.0.0` - Data validation
+  - `httpx>=0.27.0` - HTTP client
+  - `cryptography>=42.0.0` - AES encryption
+
+## Quick Start
+
+### Initialize the SDK
+
+```python
+from chipi_sdk import ChipiSDK, ChipiSDKConfig
+
+# Initialize SDK with your API keys
+sdk = ChipiSDK(
+    config=ChipiSDKConfig(
+        api_public_key="your_public_key",
+        api_secret_key="your_secret_key",  # Optional for server-side
+    )
+)
+```
+
+### Create a Wallet
+
+```python
+from chipi_sdk import CreateWalletParams, WalletType
+
+# Synchronous
+wallet_response = sdk.create_wallet(
+    params=CreateWalletParams(
+        encrypt_key="user_password",
+        external_user_id="user123",
+        wallet_type=WalletType.CHIPI,
+    )
+)
+
+print(f"Wallet created: {wallet_response.wallet_public_key}")
+print(f"Transaction hash: {wallet_response.tx_hash}")
+
+# Async version
+wallet_response = await sdk.acreate_wallet(params=params)
+```
+
+### Execute a Gasless Transaction
+
+```python
+from chipi_sdk import ExecuteTransactionParams, Call
+
+# Transfer tokens without gas fees
+tx_hash = sdk.execute_transaction(
+    params=ExecuteTransactionParams(
+        encrypt_key="user_password",
+        wallet=wallet_data,
+        calls=[
+            Call(
+                contractAddress="0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
+                entrypoint="transfer",
+                calldata=[recipient_address, amount, "0x0"],
+            )
+        ],
+    )
+)
+
+print(f"Transaction executed: {tx_hash}")
+```
+
+### Transfer Tokens (Convenience Method)
+
+```python
+from chipi_sdk import TransferParams, ChainToken
+
+tx_hash = sdk.transfer(
+    params=TransferParams(
+        encrypt_key="user_password",
+        wallet=wallet_data,
+        token=ChainToken.USDC,
+        recipient="0x...",
+        amount="1.5",  # Human-readable amount
+    )
+)
+```
+
+### Session Keys (CHIPI Wallets Only)
+
+```python
+from chipi_sdk import CreateSessionKeyParams, SessionConfig, AddSessionKeyParams
+
+# 1. Create session key locally
+session = sdk.sessions.create_session_key(
+    params=CreateSessionKeyParams(
+        encrypt_key="user_password",
+        duration_seconds=21600,  # 6 hours
+    )
+)
+
+# 2. Register session on-chain (one-time)
+tx_hash = await sdk.sessions.aadd_session_key_to_contract(
+    params=AddSessionKeyParams(
+        encrypt_key="user_password",
+        wallet=wallet_data,
+        session_config=SessionConfig(
+            session_public_key=session.public_key,
+            valid_until=session.valid_until,
+            max_calls=1000,
+            allowed_entrypoints=[],  # Empty = all allowed
+        ),
+    ),
+    bearer_token="your_token",
+)
+
+# 3. Execute transactions with session (no owner key needed!)
+from chipi_sdk import ExecuteWithSessionParams
+
+tx_hash = await sdk.aexecute_transaction_with_session(
+    params=ExecuteWithSessionParams(
+        encrypt_key="user_password",
+        wallet=wallet_data,
+        session=session,
+        calls=[...],
+    )
+)
+```
+
+## Async/Await Support
+
+Every method has both sync and async versions:
+
+```python
+# Synchronous
+wallet = sdk.get_wallet(params=params, bearer_token="token")
+tx_hash = sdk.transfer(params=transfer_params)
+
+# Asynchronous (prefix with 'a')
+wallet = await sdk.aget_wallet(params=params, bearer_token="token")
+tx_hash = await sdk.atransfer(params=transfer_params)
+```
+
+## API Reference
+
+### Main SDK Class
+
+- `ChipiSDK` - Main SDK class with all operations
+
+### Wallet Operations
+
+- `create_wallet()` / `acreate_wallet()` - Create new wallet
+- `get_wallet()` / `aget_wallet()` - Retrieve wallet by user ID
+- `get_token_balance()` / `aget_token_balance()` - Query token balances
+
+### Transaction Operations
+
+- `execute_transaction()` / `aexecute_transaction()` - Execute custom calls
+- `transfer()` / `atransfer()` - Transfer tokens
+- `approve()` / `aapprove()` - Approve token spending
+- `stake_vesu_usdc()` / `astake_vesu_usdc()` - Stake in Vesu protocol
+- `withdraw_vesu_usdc()` / `awithdraw_vesu_usdc()` - Withdraw from Vesu
+- `get_transaction_list()` / `aget_transaction_list()` - Query transaction history
+
+### Session Key Operations (CHIPI Wallets)
+
+- `create_session_key()` - Generate session keypair locally
+- `add_session_key_to_contract()` / `aadd_session_key_to_contract()` - Register session
+- `revoke_session_key()` / `arevoke_session_key()` - Revoke session
+- `get_session_data()` / `aget_session_data()` - Query session status
+- `execute_transaction_with_session()` / `aexecute_transaction_with_session()` - Execute with session
+
+### User Operations
+
+- `create_user()` / `acreate_user()` - Create user
+- `get_user()` / `aget_user()` - Get user by external ID
+
+### SKU Operations
+
+- `get_sku_list()` / `aget_sku_list()` - List SKUs
+- `get_sku()` / `aget_sku()` - Get SKU by ID
+- `create_sku_transaction()` / `acreate_sku_transaction()` - Create SKU transaction
+
+## Error Handling
+
+```python
+from chipi_sdk import (
+    ChipiError,
+    ChipiApiError,
+    ChipiWalletError,
+    ChipiTransactionError,
+    ChipiSessionError,
+)
+
+try:
+    tx_hash = sdk.execute_transaction(params=params)
+except ChipiTransactionError as e:
+    print(f"Transaction failed: {e.message}")
+    print(f"Error code: {e.code}")
+except ChipiApiError as e:
+    print(f"API error: {e.message} (status: {e.status})")
+except ChipiError as e:
+    print(f"General error: {e.message}")
+```
+
+## Configuration
+
+### SDK Config Options
+
+```python
+from chipi_sdk import ChipiSDKConfig
+
+config = ChipiSDKConfig(
+    api_public_key="your_public_key",       # Required
+    api_secret_key="your_secret_key",       # Optional - for server-side
+    alpha_url="https://custom-api.com",     # Optional - custom API URL
+    node_url="https://custom-rpc.com",      # Optional - custom Starknet RPC
+)
+```
+
+### Wallet Types
+
+- `WalletType.CHIPI` - OpenZeppelin account with SNIP-9 session keys (default)
+- `WalletType.READY` - Argent X Account v0.4.0
+
+### Supported Tokens
+
+- USDC (Native)
+- USDC_E (Bridged)
+- USDT
+- ETH
+- STRK
+- DAI
+- WBTC
+- OTHER (custom tokens)
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/chipi-pay/chipi-sdk.git
+cd chipi-sdk/python
+
+# Install with dev dependencies
+pip install -e ".[dev]"
+
+# Or with uv
+uv pip install -e ".[dev]"
+```
+
+### Run Tests
+
+```bash
+pytest tests/
+```
+
+### Format Code
+
+```bash
+black chipi_sdk/
+ruff check chipi_sdk/ --fix
+```
+
+### Type Checking
+
+```bash
+mypy chipi_sdk/
+```
+
+## Examples
+
+See the [examples](https://github.com/chipi-pay/chipi-sdk/tree/main/python/examples) directory for more usage examples.
+
+## Related SDKs
+
+- [TypeScript SDK](https://www.npmjs.com/package/@chipi-stack/backend) - For Node.js/TypeScript projects
+- [React SDK](https://www.npmjs.com/package/@chipi-stack/react) - For React applications
+
+## Documentation
+
+Full documentation is available at [docs.chipipay.com](https://docs.chipipay.com)
+
+## Support
+
+- 📧 Email: carlos@chipipay.com
+- 💬 Discord: [Starknet Discord](https://discord.gg/starknet) (#chipi channel)
+- 🐛 Issues: [GitHub Issues](https://github.com/chipi-pay/chipi-sdk/issues)
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details.
+
+---
+
+Built with ❤️ by the Chipi team

chipi_stack-2.0.0.dist-info/RECORD

@@ -0,0 +1,33 @@
+chipi_sdk/__init__.py,sha256=L_NXPv03kDojMLWd225kaVG5vYZdyaN2_afUjD4O7DE,7757
+chipi_sdk/client.py,sha256=RdRKEgUjD4Ac60rlpbH1G-lbiPTjniII8EwwMlUHhwA,13993
+chipi_sdk/constants.py,sha256=tfBc5pfPcd4DxU5hdx8BpQP_Ey3gnnrYz2BziS6O77A,5077
+chipi_sdk/encryption.py,sha256=fYIPG3eXbG16IV1gCEh9Kks33alVy9CvvRBayWQpWkA,5101
+chipi_sdk/errors.py,sha256=WPHG4vNlY_vx2gH_5N2MEoGMhZAaeW34NYBv62wVsmM,3722
+chipi_sdk/execute_paymaster.py,sha256=AvIRoXv5yf2HLSaJZMLrjx7AwEaCl4m1HhXSMxgUvf8,14833
+chipi_sdk/formatters.py,sha256=J6cDIOi4qciJC6CKLnwYbbiCgEH2cwtycjRXFqkVtKc,3444
+chipi_sdk/py.typed,sha256=2fYELBifmrW34-PPJa0CTNoeda-08ZmdmE8dw_OKb_U,71
+chipi_sdk/sdk.py,sha256=y2Y4RL391yVWosrHxZJ2JfQYFhc5YjK86pSS_2RVX1E,28218
+chipi_sdk/sessions.py,sha256=fBA5XUoZwOYYpYe0M_Wd8hYAlR4o1gBrKEMn_sSdsQg,29551
+chipi_sdk/sku_transactions.py,sha256=r3j4T7nCntdG_Pn_Iv9D0aV1cO0KbNMa1bzQskA3iwM,1646
+chipi_sdk/skus.py,sha256=nNLGzvbmnTnJPIDz0AKtd4clVfBgAe7GIgupkSObGQ4,2508
+chipi_sdk/transactions.py,sha256=m_s0XWBiC4vODImSgodVs332AZ-tIz-irYp0Eceh5Z4,13918
+chipi_sdk/users.py,sha256=NlJ7nPODAzG5W65h11DhcG5IDZJUQYGhh8Sn_LbSv9o,2496
+chipi_sdk/validators.py,sha256=mgDZdzhqBtnnyoUTM8Iem5bCxg-Hjg3IduqFlCG3myU,1771
+chipi_sdk/wallets.py,sha256=XYwBRMMBy8VjhNg5UTv285i0X7l_iJZ9Gku5viAEKLU,15434
+chipi_sdk/x402_client.py,sha256=aql69YBLjPiwfxD-Zm5D56bY1d1gb0OmE0r73b-ZXI0,8330
+chipi_sdk/x402_facilitator.py,sha256=up6PO7FTn6HTXtBpks6mwTpPuo8QPslEsyp7horVs0E,7513
+chipi_sdk/x402_middleware.py,sha256=fzFqChn7NWyCKwRuayh7lGppCzP8Wa3AIkHQa6VoWhQ,9964
+chipi_sdk/models/__init__.py,sha256=DO-BJddsF1hJaDwYaUrU6SRDAR5iShsVXGiHeZg40Js,3109
+chipi_sdk/models/core.py,sha256=GUZE8UzEU_bKUZq3PUCSTsb2-ZQJFwVFCvQQIybrmkI,3088
+chipi_sdk/models/session.py,sha256=20YATTj6DGIbvOy8cAxOSImr_hTR0aZdm-ecOE03B6M,4867
+chipi_sdk/models/sku.py,sha256=hFsWPHy8aFupAGGrvJkcdY2nor58RyWj5SERfxyPR-s,639
+chipi_sdk/models/sku_transaction.py,sha256=XqaU3rpYzfy8dbhFuJfdvPxb7zgETnydPJwwcwou3vE,863
+chipi_sdk/models/transaction.py,sha256=T68TsznIbiS4vW218dG9pTCUn9Byp2knZXTGmCZAk-g,5692
+chipi_sdk/models/user.py,sha256=R1sQucy6eyt8hrAjQ5WEPteZ0rzxfqiioavsY6sdDAU,831
+chipi_sdk/models/wallet.py,sha256=qaFOhjlTt7hM-zDWLj9bEvyZffXdjNFbSyfgAiiN6os,5992
+chipi_sdk/models/x402.py,sha256=UZnMkjHetqfD3gb5JaUkOgfMT4XiheWauLUBIW-iZuM,4205
+chipi_stack-2.0.0.dist-info/licenses/LICENSE,sha256=uNS3IuTaoCCqK375oWjGgJYA5AYH3Z92eLjhw_cB7y8,1071
+chipi_stack-2.0.0.dist-info/METADATA,sha256=_ojpieYLHe15RYFNA67Y7Mi0D3UG9sjUW7EdzWk3Gxc,10030
+chipi_stack-2.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+chipi_stack-2.0.0.dist-info/top_level.txt,sha256=K5WFszW7Is7H5_3h_fxf371ID1WM6NWHrKTEDPh9XPk,10
+chipi_stack-2.0.0.dist-info/RECORD,,

chipi_stack-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

chipi_stack-2.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Chipi Pay
+
+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.

chipi_stack-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+chipi_sdk