Python client library for Stellar
Still a work in progress, but usable.
import stellarIf you don't have a wallet already, or if you feel a bit paranoid, this is where you need to start.
account, secret = stellar.generate_keypair()remote = stellar.Remote('ws://live.stellar.org:9001')amount = stellar.Amount(100) # 100 STR
res = remote.send_payment(secret, account, destination, amount)(NB: Obviously this whole scenario is just fiction, because you can't really do anything with an account that hasn't been funded.)
Remote is the primary interface in stellar-py, and this is what you'll be using the most.
remote = stellar.Remote(url, async=False, callback=None)This creates a Remote object, connected to a stellard server located at url.
If async is True, then all methods that can be asynchronous, by default are so.
This can be overridden in the individual method. If asynchronous, they return an
aplus promise for further processing, otherwise they return the actual value.
If a callback is provided, network connectivity changes will be communicated to it.
def callback(status):
if status:
# connected to network
else:
# disconnected from networkget_account_currencies(account, async=None, **kwargs)
get_account_info(account, async=None)
get_account_lines(account, async=None, **kwargs)
get_account_offers(account, async=None)get_book_offers(taker_gets, taker_pays, async=None, **kwargs)get_ledger(async=None, **kwargs)get_transaction_entry(tx_hash, ledger_index, async=None)
get_tx(transaction, async=None, **kwargs)
get_tx_history(start, async=None)cancel_offer(secret, account, offer_sequence, async=None)
create_offer(secret, account, taker_gets, taker_pays, async=None, **kwargs)
merge_accounts(secret, account, destination, async=None)
send_payment(secret, account, destination, amount, async=None, **kwargs)
set_options(secret, account, async=None, **kwargs)
set_regular_key(secret, account, regular_key, async=None)
set_trust(secret, account, amount, async=None, **kwargs)subscribe(async=None, **kwargs)
unsubscribe(async=None, **kwargs)
add_callback(tx_type, callback)get_static_path(source_account, destination_account, destination_amount, async=None)
create_find_path(source_account, destination_account, destination_amount, callback, async=None)
close_find_path(async=None)get_fee(async=None)
get_sequence_number(account, async=None)
submit_transaction(tx_blob, async=None)
cancel(promise)Amount is a helper class for dealing with amounts and currencies.
100 STR:
amount = stellar.Amount(100)100 USD from issuer:
amount = stellar.Amount(100, 'USD', issuer)Everything that can be done locally is done locally. Key pairs are generated locally, for that extra safety, and the transactions are generated and signed locally. No secret keys are sent across the network.
The two key operations are
account, secret = stellar.generate_keypair()
tx_blob = stellar.sign(tx_json, secret)This is where we find the functions to generate all of the different transaction
types on the Stellar network. For a description of what the parameters are,
and what they do, check the official documentation over at
https://www.stellar.org/api/#api-submit. Optional parameters are provided
through kwargs. All amounts are in stellar.Amounts
tx_json = account_merge(account, destination, sequence, fee)
tx_json = account_set(account, sequence, fee, **kwargs)
tx_json = offer_cancel(account, offer_sequence, sequence, fee)
tx_json = offer_create(account, taker_gets, taker_pays, sequence, fee, **kwargs)
tx_json = payment(account, destination, amount, sequence, fee, **kwargs)
tx_json = set_regular_key(account, regular_key, sequence, fee)
tx_json = trust_set(account, amount, sequence, fee, **kwargs)