Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toncenter/pytonlib
Python SDK for TON via tonlib
https://github.com/toncenter/pytonlib
Last synced: 11 days ago
JSON representation
Python SDK for TON via tonlib
- Host: GitHub
- URL: https://github.com/toncenter/pytonlib
- Owner: toncenter
- License: gpl-3.0
- Created: 2022-04-26T14:35:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T17:58:17.000Z (4 months ago)
- Last Synced: 2024-09-30T21:35:06.742Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 111 MB
- Stars: 80
- Watchers: 8
- Forks: 21
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ton - toncenter/pytonlib - Tonlib wrapper. (🧑💻 Get Coding / Libraries)
README
# PyTONLib
[](https://pypi.org/project/pytonlib/)
[](https://pypi.org/project/pytonlib/)
This is standalone Python library based on `libtonlibjson`, the functionality is similar to the [ton-http-api](https://github.com/toncenter/ton-http-api)
with the following restrictions:
* a client can connect to only one LiteServer;
* a client is asyncronious;
* no requests cache.
## Installation
### From PyPi
Currently, the library works for Windows, Mac and Linux only on Intel CPUs:
* (Windows) Install OpenSSL v1.1.1 for Win64 from [here](https://slproweb.com/products/Win32OpenSSL.html).
* Install Python 3 package: `pip3 install pytonlib`.
### Docker
In this repo Compose file is provided to deploy the example of service with *pytonlib*:
```bash
docker-compose -f docker-compose.jupyter.yaml build
docker-compose -f docker-compose.jupyter.yaml up -d
```
Jupyter Notebook will be available on port 3100 (http://localhost:3100).
## Examples
We recommend to use IPython or Jupyter Notebook for prototyping because they allow to run `async` code. An example of running `async` code from script could be found in the end of this section.
* Connecting to the first LiteServer in mainnet config:
```python
import requests
import asyncio
from pathlib import Path
from pytonlib import TonlibClient
# downloading mainnet config
ton_config = requests.get('https://ton.org/global.config.json').json()
# create keystore directory for tonlib
keystore_dir = '/tmp/ton_keystore'
Path(keystore_dir).mkdir(parents=True, exist_ok=True)
# init TonlibClient
client = TonlibClient(ls_index=0, # choose LiteServer index to connect
config=ton_config,
keystore=keystore_dir)
# init tonlibjson
await client.init()
```
* Reading blocks info:
```python
masterchain_info = await client.get_masterchain_info()
block_header = await client.get_block_header(**masterchain_info['last'])
shards = await client.get_shards(master_seqno=masterchain_info['last']['seqno'])
```
* Reading Block Transactions for masterchain block:
```python
masterchain_info = await client.get_masterchain_info()
txs = await client.get_block_transactions(**masterchain_info['last'], count=10)
```
* Running async code from script:
```python
import requests
import asyncio
from pathlib import Path
from pytonlib import TonlibClient
async def main():
loop = asyncio.get_running_loop()
ton_config = requests.get('https://ton.org/global.config.json').json()
# create keystore directory for tonlib
keystore_dir = '/tmp/ton_keystore'
Path(keystore_dir).mkdir(parents=True, exist_ok=True)
# init TonlibClient
client = TonlibClient(ls_index=0, # choose LiteServer index to connect
config=ton_config,
keystore=keystore_dir,
loop=loop)
# init tonlibjson
await client.init()
# reading masterchain info
masterchain_info = await client.get_masterchain_info()
# closing session
await client.close()
if __name__ == '__main__':
asyncio.run(main())
```
## Running tests
To run tests in *asyncio* mode use the following command:
```bash
PYTHONPATH=./ pytest --asyncio-mode=strict tests/
```