ergpy

A python-jvm wrapper for interacting with the Ergo blockchain.

Usage

Requires Java 8 or higher to be installed on system

pip install ergpy

There are helper methods created to do simple transactions
- Please checkout the examples.py (on github) to see how to use them.
- Simple Send is available
  - Allows sending ERG to one address or multiple addresses in ONE transactions
- Get wallet addresses is available
  - This gives derivations of wallet addresses given the mnemonic
  - If specified 2, a list of two addresses will be printed in the console
- Get Box Info is available
  - Given the index and address, the selected box will be printed
- Send Token is available
  - Allows sending token(s) to one or multiple addresses
  - The token id paramter must be given as a 2D array
  - Remember that tokens/nfts are seen as the same when transacting with them
- Create NFT is available
  - Allows creating NFTs
  - One mint is one transaction
  - There are helper methods as well to get the sha-256 hash required while minting
    - SHA256 caster
      - Put the hash as a string and this will be converted into bytes
    - String Hasher
      - Input a string and this will be converted into a hash (only for testing purposes)
    - File Hasher
      - Input the file name and the hash will be generateed
- Create Token is available
  - Allows a token to be minted
- Custom
  - A bit more customization is available using methods from appkit.py
  - To truly have custom transactions appkit.py must be edited

Github usage

git clone https://github.com/mgpai22/ergpy && cd ergpy

pip3 install -r requirements.txt

python -m stubgenj --convert-strings --classpath "./ergpy/ergo.jar" org.ergoplatform java

If using an ide such as pycharm , make sure the root folder is ergpy
- This allows code completion via stubgenj to work properly
This method is recommended for developer as it allows for direction customizations in appkit.py

Roadmap

This is the begining of python support for Ergo! Contributions are essential for this to continue.
Ergoscript support.
Better documentation and packaging (first time creating a package).
- Would love some help with this!

Credits

MrStahlfelge
- Showcased jpype usage with appkit
Ergopad
- Borrowed/Modified some of their code

Metadata

Release files for ergpy 0.1.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ergpy 0.1.9.1
File	Size	Uploaded	Provenance
ergpy-0.1.9.1.tar.gz	50.2 MB	Dec 4, 2023	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for ergpy 0.1.9.1
File	Interpreter	ABI	Platform	Reset
ergpy-0.1.9.1-py3-none-any.whl 50.2 MB Dec 4, 2023 Without provenance	Python 3	none	any	Details

Total release size: 100.4 MB

Release files / ergpy-0.1.9.1.tar.gz

Download URL	ergpy-0.1.9.1.tar.gz
Size	50.2 MB
Tags	Source
SHA-256 checksum How to use checksums	`41bad6e44ccaf4823a62c72752696c4bfca18f3188fe999c0c12f72bed7b6445`
BLAKE2b-256 checksum How to use checksums	`50686c3e35d294c799ab7501b151be20e8d25af832965dd29c75f975065028cf`
Upload date	Dec 4, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.13`

Release files / ergpy-0.1.9.1-py3-none-any.whl

Download URL	ergpy-0.1.9.1-py3-none-any.whl
Size	50.2 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`54f354d3256747685231c6ae00341cfa479dbbf254e60379301358338267bfc7`
BLAKE2b-256 checksum How to use checksums	`02610dec86bd96bad2ed697bb3dad5ec8fbbaed0242e6afd511fe916076526be`
Upload date	Dec 4, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.13`

Security for ergpy 0.1.9.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.