FOSS/FragmentAPI
0
0
Fork 0
mirror of https://github.com/bohd4nx/FragmentAPI.git synced 2026-07-25 06:14:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: enhance documentation with contributing guidelines and security policy

Browse Source 
refactor: update README configuration parameters and add error handling section
refactor: streamline tonapi imports and add WalletVersion to __all__
chore: update project metadata in pyproject.toml
This commit is contained in:
bohd4nx
2026-05-29 01:27:29 +03:00
parent 6cb6e3fe05
commit f8ad801e0c
6 changed files with 119 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+36 -7
View File
@@ -39,13 +39,13 @@ Requires Python 3.10+.
## Configuration
| Parameter | Type | Default | Description |
| ---------------- | ------------- | -------- | -------------------------------------------------------- |
| `seed` | `str` | — | 24-word TON wallet mnemonic |
| `api_key` | `str` | — | Tonapi key from [tonconsole.com](https://tonconsole.com) |
| `cookies` | `dict \| str` | — | Fragment session cookies |
| `wallet_version` | `str` | `"V5R1"` | `"V4R2"` or `"V5R1"` |
| `timeout` | `float` | `30.0` | HTTP request timeout in seconds |
| Parameter | Type | Default | Description |
| ---------------- | ------------- | -------- | ----------------------------------------------------------- |
| `seed` | `str` | — | 12-, 18-, or 24-word TON wallet mnemonic |
| `api_key` | `str` | — | Tonapi key from [tonconsole.com](https://tonconsole.com) |
| `cookies` | `dict \| str` | — | Fragment session cookies |
| `wallet_version` | `str` | `"V5R1"` | `"V4R2"` or `"V5R1"` (also accepts `WalletVersion` literal) |
| `timeout` | `float` | `30.0` | HTTP request timeout in seconds |
---
@@ -128,12 +128,41 @@ Full runnable examples:
- https://github.com/bohd4nx/pyfragment/tree/master/examples
---
## Error Handling
All exceptions inherit from `FragmentError`. Catch specific ones or the base class:
```python
from pyfragment import (
ConfigurationError, # invalid arguments (amount, months, payment_method, etc.)
UserNotFoundError, # recipient not found on Fragment
WalletError, # insufficient TON/USDT balance
TransactionError, # broadcast failed, duplicate seqno, invalid payload
FragmentAPIError, # Fragment API returned an error response
FragmentPageError, # page fetch or hash extraction failed
AnonymousNumberError, # number not owned, wrong state, login code issues
CookieError, # missing or malformed session cookies
ParseError, # failed to decode Fragment payload
VerificationError, # on-chain verification step failed
OperationError, # generic operation-level failure
UnexpectedError, # unexpected API response structure
)
```
Payload debug/decode helper (thanks):
- https://ton-cell-abi-viewer.vercel.app/
---
## Changelog
See [CHANGELOG.md](https://github.com/bohd4nx/pyfragment/blob/master/CHANGELOG.md) for release history.
---
<div align="center">
### Made with ❤️ by [@bohd4nx](https://t.me/bohd4nx)