Skip to content

Commit b32fa3b

Browse files
author
Igor
committed
fix readme
1 parent 39e9df2 commit b32fa3b

File tree

1 file changed

+52
-2
lines changed

1 file changed

+52
-2
lines changed

README.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,53 @@
1-
This is a modernised version of the py-substrate-interface library, with the ability to use it asynchronously (as well as synchronously). It aims to be almost fully API-compatible with the original library.
1+
# Async Substrate Interface
22

3-
In addition to it's async nature, it is additionally improved with using bt-decode rather than py-scale-codec for significantly faster SCALE decoding.
3+
This project provides an asynchronous interface for interacting with [Substrate](https://substrate.io/)-based blockchains. It is based on the [py-substrate-interface](https://github.com/polkascan/py-substrate-interface) project.
4+
5+
## Features
6+
7+
- Asynchronous API calls
8+
- Support for multiple Substrate-based networks
9+
- Easy integration with existing projects
10+
11+
## Installation
12+
13+
To install the package, use the following command:
14+
15+
```bash
16+
pip install async-substrate-interface
17+
```
18+
19+
## Usage
20+
21+
Here is a basic example of how to use the async-substrate-interface:
22+
23+
```python
24+
import asyncio
25+
from async_substrate_interface import SubstrateInterface
26+
27+
async def main():
28+
substrate = SubstrateInterface(
29+
url="wss://rpc.polkadot.io"
30+
)
31+
32+
result = await substrate.query(
33+
module='System',
34+
storage_function='Account',
35+
params=['5FHneW46xGXgs5mUiveU4sbTyGBzmto4oT9v5TFn5u4tZ7sY']
36+
)
37+
38+
print(result)
39+
40+
asyncio.run(main())
41+
```
42+
43+
## Contributing
44+
45+
Contributions are welcome! Please open an issue or submit a pull request.
46+
47+
## License
48+
49+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
50+
51+
## Contact
52+
53+
For any questions or inquiries, please join the Bittensor Development Discord server: [Church of Rao](https://discord.gg/gavmT4R8sB).

0 commit comments

Comments
 (0)