Skip to main content

Official python package for interacting with Stratis (STRAX) full node and Cirrus/Interflux sidechain.

Project description

pystratis

Python package for interacting with Stratis (STRAX) full node and Cirrus/Interflux sidechain.

Installation

From the Python Package Index (PyPi)

pip install pystratis

Most recent (from GitHub)

pip install git+https://github.com/stratisproject/pystratis.git

Install from PyPi with test dependencies

pip install pystratis[test]

Tutorials

Basic examples

Create a wallet

from pystratis.nodes import StraxNode

node = StraxNode()

# Back up the mnemonic phrase, that's the only thing that could restore your wallet.
mnemonic = node.wallet.create(name='MyWallet', password='qwerty12345', passphrase='')

Send funds

from pystratis.nodes import StraxNode
from pystratis.core.networks import StraxMain
from pystratis.core.types import uint256, Money, Address
from pystratis.core import Outpoint, Recipient

node = StraxNode()

# Get first spendable transaction.
s_tx = node.wallet.spendable_transactions(wallet_name='MyWallet').transactions[0]

# Set our own address as recipient of change, use Money arithmetic for amount calculations.
recipient_self = Recipient(destinationAddress=s_tx.address, amount=s_tx.amount - Money(1.0),
                           subtraction_fee_from_amount=True)

recipient_another = Recipient(destinationAddress=Address('<another address>', network=StraxMain()), amount=Money(1.0),
                              subtractFeeFromAmount=False)

# Spend utxo from our transaction.
outpoint = Outpoint(transaction_id=s_tx.transaction_id, index=s_tx.index)

built_transaction = node.wallet.build_transaction(wallet_name='MyWallet', password='qwerty12345', outpoints=[outpoint],
                                                  recipients=[recipient_self, recipient_another], fee_type='high')

node.wallet.send_transaction(built_transaction.hex)

Testing guide

  • Unit tests: pytest -m "not integration_test"
  • Strax integration tests: pytest -m "strax_integration_test"
  • Cirrus integration tests: pytest -m "cirrus_integration_test"
  • Interflux integration tests: pytest -m "interflux_integration_test"
  • Mainnet integration tests: pytest -m "mainnet_test"
  • Integration tests: pytest -m "integration_test"
  • Everything: pytest
  • Coverage: coverage run -m pytest
  • Coverage report: coverage report -m

ReadTheDocs documentation

ReadTheDocs API documentation can be found at http://pystratis.readthedocs.io.

Documentation can be build locally with the following commands:

cd doc_build
make html 
  • Other output options: make help
  • After building, documentation for make html can be found in docs/html/index.html, open with your favorite browser.

Credit

Thanks goes to @TjadenFroyda for his contributions in kickstarting this repository.

ChangeLog

Version 1.1.0.0 (StratisFullNode release/1.1.0.13)

  • Added externalapi route and endpoints
  • Added blockstore/getutxosetforaddress endpoint
  • Added voting/schedulevote-kickmember and voting/polls/tip endpoints
  • Added node/rewind and node/datafolder/chain endpoints
  • Added federationgateway/transfer and federationgateway/transfers/deletesuspended endpoints
  • Added multiple interop endpoints, removed interop/status endpoint
  • Added federation/federationatheight and federation/mineratheight endpoints

Version 1.0.6.0 (StratisFullNode release/1.0.9.6)

  • SignalR added to cirrusminernode

Version 1.0.5.0 (StratisFullNode release/1.0.9.5)

  • Added 'retrieve-filtered-utxos' endpoint for coldstaking

Version 1.0.4.0 (StratisFullNode release/1.0.9.4)

  • No API updates for SFN release/1.0.9.4

Version 1.0.3.0 (StratisFullNode release/1.0.9.3)

  • No API updates for SFN release/1.0.9.3

Version 1.0.2.0 (StratisFullNode release/1.0.9.2)

  • Add optional block_height to LocalCallContractTransactionRequest
  • Added new node definition (cirrusunity3dnode) with unity3d endpoints

Version 1.0.1.0 (StratisFullNode release/1.0.9.1)

  • Updates for SFN release/1.0.9.1
    • Note: wallet.history strax integration test fails due to negative fee returned when address specified.
    • Added contract_swagger and dynamic_contract endpoints

Version 1.0.0.7 (StratisFullNode release/1.0.9.0)

  • Initial pystratis release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pystratis-1.1.0.0.tar.gz (108.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page