Giter Club home page Giter Club logo

sirius's Introduction

Sirius: Stellar API for Humans

Sirius is Python SDK for Stellar. This library tries to make Stellar API favorable for human consumption, with no known side effects.

Following are some examples of typical usage of Sirius:

>>> stellar.account('GBS4..6S3K').fetch() 
Account(id=GAEE..IB4V..,seq=28515937145585674,balances=[Balance(9855.9998800 XLM)])

>>> stellar.account('GBS4..6S3K').operations().fetch(limit=1).entries()
[Operation(id=28515937145589761,account=GBS4..6S3K,type=create_account)]

>>> with stellar.new_transaction('SEED..5KEE', memo='awain') as t:
...     t.pay(account='GBS4..6S3K', amount='42.01')
...     # remove existing offer for buying BTC
...     t.remove_offer(offer_id=12891, sell_asset='native', buy_asset=('BTC', 'GADE..ED87'))
...     # add new offer to buy BTC
...     t.add_offer(sell_amount='10.00', sell_asset='native', buy_asset=('BTC', 'GADE..ED87'), price=(1, 10000))
...

Documentation

Pydoc generated documentation can be found at https://hard-codr.github.io/sirius .

Why so Sirius?

Sirius is inspired by very well designed 'requests' HTTP library. Following are some of the reason I created this library.

Comparison with current libraries

Current best known Python SDK does not have required ergonomics, and bit hassle to use.

E.g. to create new account you need to do following:

oldAccountSeed = "SCVLSUGYEAUC4MVWJORB63JBMY2CEX6ATTJ5MXTENGD3IELUQF4F6HUB"
newAccountAddress = "XXX"
amount = '25' # Any amount higher than 20
kp = Keypair.from_seed(oldAccountSeed)
horizon = horizon_livenet()
asset = Asset("XLM")
# create op 
op = CreateAccount({
    'destination': newAccountAddress,
    'starting_balance': amount
})
# create a memo
msg = TextMemo('test-account')
# get sequence of new account address
sequence = horizon.account(kp.address()).get('sequence')
# construct the transaction
tx = Transaction(
    source=kp.address().decode(),
    opts={
        'sequence': sequence,
        #'timeBounds': [],
        'memo': msg,
        #'fee': 100,
        'operations': [
            op,
        ],
    },
)
# build envelope
envelope = Te(tx=tx, opts={"network_id": "PUBLIC"})
# sign 
envelope.sign(kp)
# submit
xdr = envelope.xdr()
response = horizon.submit(xdr)

Whereas in Sirius you can simply do:

old_account_seed = "SCVLSUGYEAUC4MVWJORB63JBMY2CEX6ATTJ5MXTENGD3IELUQF4F6HUB"
new_account_address = "XXX"
amount = '5'
#following statement takes care of retrieving current sequence for account
#and signing and submitting at the end of with-block
with stellar.new_transaction(old_account_seed, memo='test-account') as t:
    t.create_account(new_account_address, amount)
if t.is_success():
    print t.result()
else:
    print t.errors()

If you don't want to use with-statement then you can also chain multiple operation as follows and submit transaction:

account_seed = "SCVLSUGYEAUC4MVWJORB63JBMY2CEX6ATTJ5MXTENGD3IELUQF4F6HUB"
to_account1 = "GDKGNWAE7N2KH6MLY5GGZUZWK775TH2M7YFIYEYRXDEGZ2OEATD3QKB4"
to_account2 = "GDZ4R34MNVITLNZ4KVKBEANJU3UZZFZZLOX7ZVU5AWI7FEL5A6JWDM24"
usd_issuer = "GDUWG5CZ6YJNWOPQB33DOKWVWSNHJAWPWOUNAEBVTM7QRJ66NGFYEFAJ"

trx = stellar.new_transaction(account_seed, 'test-pay')
                .pay(to_account1, "10.01") #by default, payment is done in native asset
                .pay(to_account2, "42.42", asset=('USD', usd_issuer)) #or you can specify asset
                .submit()
if trx.is_success():
    print trx.result()
else:
    print trx.errors()

Sirius also support federated address as the account-id; so you can do:

account_seed = "SCVLSUGYEAUC4MVWJORB63JBMY2CEX6ATTJ5MXTENGD3IELUQF4F6HUB"
usd_issuer = "GDUWG5CZ6YJNWOPQB33DOKWVWSNHJAWPWOUNAEBVTM7QRJ66NGFYEFAJ"

trx = stellar.new_transaction(account_seed, 'test-pay')
                .pay('jed*stellar.org', "10.01") # address in name*domain.com format
                .pay('[email protected]*stellar.org', "42.42", asset=('USD', usd_issuer)) #or email*domain.com format
                .submit()
if trx.is_success():
    print trx.result()
else:
    print trx.errors()

Ease of use

Some of the stellar APIs are confusing to use. For example, to add offer and to remove offer there is the same API, i.e. MANAGE_OFFER with special meaning to the input parameters. Sirius simplifies those API and tries to create self-explanatory APIs and handles needed complexity internally.

Install

To install with pip just type

pip install git+https://github.com/hard-codr/sirius

Planned Features

  1. Write extensive test cases
  2. Error handling
  3. Write functions for key generation
  4. Good documentation
  5. Lots of bug fixes
  6. Write more documentation
  7. Write integration with federation services

sirius's People

Contributors

hard-codr avatar swapi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

sirius's Issues

error while creating account

I am trying import your project and trying to create using following code

from sirius import stellar
old_account_seed = "sxxxxxx"
new_account_address = "Gxxxxxxx"
amount = '1'
#following statement takes care of retrieving current sequence for account
#and signing and submitting at the end of with-block
with stellar.new_transaction(old_account_seed, memo='test-account') as t:
    t.create_account(new_account_address, amount)
if t.is_success():
    print (t.result())
else:
    print (t.errors())

It gives me error

Traceback (most recent call last):
  File "/home/stellar_python/sirius/stellar/test.py", line 8, in <module>
    t.create_account(new_account_address, amount)
  File "/home/stellar_python/sirius/stellar/api.py", line 910, in __exit__
    self.submit()
  File "/home/stellar_python/sirius/stellar/api.py", line 955, in submit
    self.trx_result = post_transaction(self.build())
  File "/home/stellar_python/sirius/stellar/api.py", line 914, in build
    account_seq = self.seq if self.seq else (int(account(self.account).fetch().sequence) + 1)
  File "/home/stellar_python/sirius/stellar/api.py", line 175, in fetch
    return self._map2obj(r)
  File "/home/stellar_python/sirius/stellar/api.py", line 306, in _map2obj
    return Accounts.Account(data)
  File "/homec/stellar_python/sirius/stellar/api.py", line 287, in __init__
    self.signers = [Accounts.Signer(s) for s in data['signers']]
  File "/home/stellar_python/sirius/stellar/api.py", line 287, in <listcomp>
    self.signers = [Accounts.Signer(s) for s in data['signers']]
  File "/home/stellar_python/sirius/stellar/api.py", line 260, in __init__
    self.public_key = data['public_key']
KeyError: 'public_key'

Account generation without using seed

Hello first of all thanks for the amazing job you have done so far ,this is a question and not an issue is there a way to create an account like on stellar term website where one gets an public and private key..everywhere i search i only see the seeds being used ..is it possible to do that?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.