A python wrapper for vsys api.
Project description
pyvsystems
A python wrapper for vsys api.
For more detail, please refer:
PYVSYSTEMS User Guide Specification (English)
Install
Library can be pulled via pip directly:
git+https://github.com/virtualeconomy/pyvsystems.git
Or:
- clone the repo under you workspace
git clone https://github.com/virtualeconomy/pyvsystems.git
- install the package
pip3 install pyvsystems/.
- Then you can
import pyvsystems
in your workspace
Usage
chain object
-
For testnet:
import pyvsystems as pv ts_chain = pv.testnet_chain()
-
For default chain:
import pyvsystems as pv main_chain = pv.default_chain()
-
For custom api node:
import pyvsystems as pv # you can set the request timeout custom_wrapper = pv.create_api_wrapper('http://<full node ip>:9922', api_key='', timeout=None) ts_chain = pv.testnet_chain(custom_wrapper)
-
For completely custom chain:
import pyvsystems as pv custom_wrapper = pv.create_api_wrapper('http://<full node ip>:9922', api_key='', timeout=None)) t_chain = pv.Chain(chain_name='testnet', chain_id='T', address_version=5, api_wrapper=custom_wrapper) custom_wrapper2 = pv.create_api_wrapper('http://<full node ip>:9922', api_key='', timeout=None)) m_chain = pv.Chain(chain_name='mainnet', chain_id='M', address_version=5, api_wrapper=custom_wrapper2) custom_wrapper3 = pv.create_api_wrapper('http://<full node ip>:9922', api_key='', timeout=None)) c_chain = pv.Chain(chain_name='mychain', chain_id='C', address_version=1, api_wrapper=custom_wrapper3)
chain api list
-
look up current block height of the chain:
ts_chain.height()
-
look up the last block info of the chain:
ts_chain.lastblock()
-
look up a block info at n in the chain:
ts_chain.block(n)
-
Get a transaction info by transacion id in the chain:
ts_chain.tx(tx_id)
-
Validate an address of the chain:
ts_chain.validate_address(addr)
address object
- constructed by seed
from pyvsystems import Account my_address = Account(chain=ts_chain, seed='<your seed>', nonce=0)
- constructed by private key
from pyvsystems import Account my_address = Account(chain=ts_chain, private_key='<your base58 private key>')
- constructed by public key
from pyvsystems import Account recipient = Account(chain=ts_chain, public_key='<base58 public key>')
- constructed by wallet address
from pyvsystems import Account recipient = Account(chain=ts_chain, address='<base58 wallet address>')
address api list
- Get balance
# get balance balance = my_address.balance() print("The balance is {}".format(balance)) # get balance after 16 confirmations balance = my_address.balance(confirmations = 16) print("The balance is {}".format(balance))
- Send payment transaction
# send payment (100000000 = 1 VSYS) my_address.send_payment(recipient, amount=100000000)
- Send and cancel lease transaction
# send lease (100000000 = 1 VSYS) response = my_address.lease(recipient, amount=100000000) tx_id = response["id"] # cancel lease my_address.lease_cancel(tx_id)
Sample code for Send Transaction for reference
Sample Code for Smart Contract for reference
Sample Code for Exchange for reference
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size pyvsystems-0.2.1-py3-none-any.whl (33.5 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size pyvsystems-0.2.1.tar.gz (30.1 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for pyvsystems-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3eda939ed920692071b226a9ed2e2c4e7e8b87479c593a72fa313462adb2e3b7 |
|
MD5 | 20c5defe3cb1779c0828684155e4146c |
|
BLAKE2-256 | 68e8f7816f3c8b25051b00b1168a1eb728cb2ebec853cd98f6d7fb277d7daf47 |