takunomi-build-bot
98ed37d913
This commit was automatically generated by a script: https://gitfub.space/Jmaa/repo-manager
109 lines
3.3 KiB
Markdown
109 lines
3.3 KiB
Markdown
<!--- WARNING --->
|
|
<!--- THIS IS AN AUTO-GENERATED FILE --->
|
|
<!--- MANUAL CHANGES CAN AND WILL BE OVERWRITTEN --->
|
|
|
|
|
|
|
|
# Partisia Blockchain ABI client
|
|
|
|
|
|
|
|
Unofficial utility library for parsing and processing the Partisia Blockchain ABI Format.
|
|
|
|
The format is specified here: [Partisia Blockchain's ABI format](https://partisiablockchain.gitlab.io/documentation/smart-contracts/smart-contract-binary-formats.html).
|
|
|
|
This library is not officially associated with Partisia Blockchain nor Partisia
|
|
Group ApS.
|
|
|
|
## Example usage
|
|
|
|
This example is based upon the [Token Contract example contract](https://gitlab.com/partisiablockchain/language/example-contracts).
|
|
It assumes a compiled ABI in `token.abi` and a blockchain state stored in `token_state.bin`.
|
|
|
|
```py
|
|
# Imports
|
|
from pbcabi.binaryreader import BinaryReader
|
|
import pbcabi.model
|
|
|
|
# Read ABI
|
|
with open('token.abi', 'rb') as f:
|
|
TOKEN_ABI = pbcabi.model.FileAbi.read_from(BinaryReader(f.read()))
|
|
|
|
with open('token_state.bin', 'rb') as f:
|
|
state_bytes = f.read()
|
|
|
|
# Read structure TokenState from state_bytes
|
|
token_state = TOKEN_ABI.contract.read_state('TokenState', BinaryReader(state_bytes))
|
|
|
|
# Inspect state as mostly Python-native types.
|
|
my_address = BlockchainAddress.from_hex_hash("00e72e44eab933faaf1fd4ce94bb57e08bff98a1ed")
|
|
|
|
print(token_state['name'])
|
|
> MyToken
|
|
print(token_state['balances'][my_address])
|
|
> 213112
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
This project requires [Python](https://www.python.org/) 3.8 or newer.
|
|
|
|
All required libraries can be installed easily using:
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
Full list of requirements:
|
|
- [enforce_typing](https://pypi.org/project/enforce_typing/)
|
|
- [frozendict](https://pypi.org/project/frozendict/)
|
|
|
|
|
|
## Contributing
|
|
|
|
Feel free to submit pull requests. Please follow the [Code Conventions](CONVENTIONS.md) when doing so.
|
|
|
|
|
|
### Testing
|
|
|
|
Testing requires the [pytest](https://docs.pytest.org/en/stable/) library.
|
|
|
|
Run tests with the following command:
|
|
|
|
```sh
|
|
pytest test
|
|
```
|
|
|
|
Test coverage can be run using the [`pytest-cov`](https://pypi.org/project/pytest-cov/) extension:
|
|
|
|
```sh
|
|
pytest --cov=pbcabi test
|
|
```
|
|
|
|
|
|
## License
|
|
|
|
```
|
|
MIT License
|
|
|
|
Copyright (c) 2023-2025 Jon Michael Aanes
|
|
|
|
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.
|
|
```
|