correct document

Author: overcat

docs/api.rst

@@ -155,6 +155,12 @@ Manage Data
 .. autoclass:: stellar_base.operation.ManageData
    :members:
 
+Bump Sequence
+^^^^^^^^^^^^^
+
+.. autoclass:: stellar_base.operation.BumpSequence
+   :members:
+
 Federation
 ==========
 

docs/index.rst

@@ -26,18 +26,17 @@ methods.
 
    api
 
-Snippets
+Examples
 --------
-Find examples here.
+Find examples `here`_.
 
-.. toctree::
-   :maxdepth: 2
-
-   snippets
 
 
 Indices
 -------
 
 * :ref:`genindex`
 * :ref:`modindex`
+
+
+.. _here: https://github.com/StellarCN/py-stellar-base/tree/master/examples

docs/install.rst

@@ -27,7 +27,7 @@ You can install it from source code via pip:
 
 .. code-block:: bash
 
-    pip install git+git://github.com/StellarCN/py-stellar-base
+    pip install -U git+git://github.com/StellarCN/py-stellar-base
 
 And you can always clone `the repository <https://github.com/StellarCN/py-stellar-base>`_ directly, and install it locally:
 

docs/quickstart.rst

@@ -57,15 +57,15 @@ your secret phrase:
 
 .. code-block:: python
 
-   kp = Keypair.deterministic(m, lang='chinese')
+   kp = Keypair.deterministic(secret_phrase, lang='chinese')
 
 You can even create multiple key pairs from the same phrase, using a different
 index with each call. For example:
 
 .. code-block:: python
 
-   kp1 = Keypair.deterministic(m, lang='chinese', index=1)
-   kp2 = Keypair.deterministic(m, lang='chinese', index=2)
+   kp1 = Keypair.deterministic(secret_phrase, lang='chinese', index=1)
+   kp2 = Keypair.deterministic(secret_phrase, lang='chinese', index=2)
 
 From the generated :class:`Keypair <stellar_base.keypair.Keypair>` object, you
 can easily access your public and private key.
@@ -146,7 +146,6 @@ account of your own, here's an example of how to do so:
 .. code-block:: python
 
    from stellar_base.keypair import Keypair
-   from stellar_base.asset import Asset
    from stellar_base.operation import CreateAccount, Payment
    from stellar_base.transaction import Transaction
    from stellar_base.transaction_envelope import TransactionEnvelope as Te
@@ -161,11 +160,11 @@ account of your own, here's an example of how to do so:
    # new account in the create account operation. You'll need the seed in order
    # to sign off on the transaction. This is the source account.
    old_account_seed = "SCVLSUGYEAUC4MVWJORB63JBMY2CEX6ATTJ5MXTENGD3IELUQF4F6HUB"
-   old_account_keypair = Keypair.from_seed(oldAccountSeed)
+   old_account_keypair = Keypair.from_seed(old_account_seed)
 
    # This is the new account ID (the StrKey representation of your newly
    # created public key). This is the destination account.
-   new_account_addr = "GXXX"
+   new_account_addr = "GABRGTDZEDCQ5W663U2EI5KWRSU3EAWJCSI57H7XAMUO5BQRIGNNZGTY"
 
    amount = '1' # Your new account minimum balance (in XLM) to transfer over
    # create the CreateAccount operation
@@ -174,7 +173,7 @@ account of your own, here's an example of how to do so:
        starting_balance=amount
    )
    # create a memo
-   memo = TextMemo('Transferring to my new account!')
+   memo = TextMemo('Hello, StellarCN!')
 
    # Get the current sequence of the source account by contacting Horizon. You
    # should also check the response for errors!
@@ -186,7 +185,7 @@ account of your own, here's an example of how to do so:
    # Create a transaction with our single create account operation, with the
    # default fee of 100 stroops as of this writing (0.00001 XLM)
    tx = Transaction(
-       source=kp.address().decode(),
+       source=old_account_keypair.address().decode(),
        sequence=sequence,
        memo=memo,
        operations=[
@@ -235,11 +234,11 @@ Like so:
 
 .. code-block:: python
 
-   print("Balances: {}'.format(address.balances))
-   print("Sequence Number: {}'.format(address.sequence))
-   print("Flags: {}'.format(address.flags))
-   print("Signers: {}'.format(address.signers))
-   print("Data: {}'.format(address.data))
+   print('Balances: {}'.format(address.balances))
+   print('Sequence Number: {}'.format(address.sequence))
+   print('Flags: {}'.format(address.flags))
+   print('Signers: {}'.format(address.signers))
+   print('Data: {}'.format(address.data))
 
 
 Most Recent Payments
@@ -268,7 +267,7 @@ signature.
 
 .. code-block:: python
 
-   address.payments(sse=True, limit=100)
+   address.payments(sse=True)
 
 Other Account Attributes
 ------------------------
@@ -309,7 +308,7 @@ way:
    builder = Builder(secret=seed)
    # builder = Builder(secret=seed, network='public') for LIVENET
 
-   bob_address = 'GXXX'
+   bob_address = 'GABRGTDZEDCQ5W663U2EI5KWRSU3EAWJCSI57H7XAMUO5BQRIGNNZGTY'
    builder.append_payment_op(bob_address, '100', 'XLM')
    builder.add_text_memo('For beers') # string length <= 28 bytes
    builder.sign()
@@ -341,7 +340,7 @@ this, you use :meth:`import_from_xdr
 .. code-block:: python
 
    # This is the transaction that you need to add your signature to
-   xdr_string = 'GXXX'
+   xdr_string = 'AAAAAAMTTHkgxQ7b3t00RHVWjKmyAskUkd+f9wMo7oYRQZrcAAAAZAAAAIHlSBzvAAAAAAAAAAAAAAABAAAAAAAAAAoAAAAFaGVsbG8AAAAAAAABAAAAB3N0ZWxsYXIAAAAAAAAAAAA='
    builder = Builder(secret=seed)
    builder.import_from_xdr(xdr_string)
    builder.sign()
@@ -404,7 +403,7 @@ In this example, Alice is sending Bob 100 CNY.
 
    # Construct a transaction
    tx = Transaction(
-       source=Alice.address().decode(),
+       source=alice_kp.address().decode(),
        sequence=sequence,
        # time_bounds = {'minTime': 1531000000, 'maxTime': 1531234600},
        memo=msg,

docs/snippets.rst

@@ -1,7 +1,17 @@
-from stellar_base import Keypair
+from stellar_base.keypair import Keypair
+from stellar_base.utils import StellarMnemonic
+
+
+def generate_random_keypair():
+    print("Generate random keypair")
+    key_pair = Keypair.random()
+    print("Public key / Account address:\n", key_pair.address().decode())
+    print("Seed / Your secret to keep it on local:\n",
+          key_pair.seed().decode())
 
 
 def create_keypair_determinist_english():
+    print("Create keypair determinist english")
     mnemonic = ('illness spike retreat truth genius clock brain pass '
                 'fit cave bargain toe')
     key_pair = Keypair.deterministic(mnemonic)
@@ -10,5 +20,20 @@ def create_keypair_determinist_english():
           key_pair.seed().decode())
 
 
+def create_multiple_keypair():
+    print("Create multiple keypair")
+    sm = StellarMnemonic()
+    secret_phrase = sm.generate()
+    kp0 = Keypair.deterministic(secret_phrase, index=0)
+    kp1 = Keypair.deterministic(secret_phrase, index=1)
+    kp2 = Keypair.deterministic(secret_phrase, index=2)
+    for key_pair in (kp0, kp1, kp2):
+        print("Public key / Account address:\n", key_pair.address().decode())
+        print("Seed / Your secret to keep it on local:\n",
+              key_pair.seed().decode())
+
+
 if __name__ == "__main__":
+    generate_random_keypair()
     create_keypair_determinist_english()
+    create_multiple_keypair()

examples/create_keypair.py

@@ -0,0 +1,20 @@
+from stellar_base.builder import Builder
+
+alice_seed = 'SB4675LMYLBWMKENDBAO6ZTVPLI6AISE3VZZDZASUFWW2T4MEGKX7NEI'
+bob_address = 'GCRNOBFLTGLGSYOWCYINZA7JAAAZ5CXMSNM7QUYFYOHHIEZY4R6665MA'
+
+selling_code = 'XLM'
+selling_issuer = None
+
+buying_code = 'XCN'
+buying_issuer = 'GCNY5OXYSY4FKHOPT2SPOQZAOEIGXB5LBYW3HVU3OWSTQITS65M5RCNY'
+
+price = '5.5'  # or price = {'n': 55, 'd': 10}
+amount = '12.5'
+
+builder = Builder(secret=alice_seed, horizon='https://horizon-testnet.stellar.org') \
+             .append_manage_offer_op(selling_code, selling_issuer, buying_code, \
+              buying_issuer, amount, price)
+
+builder.sign()
+builder.submit()

examples/create_offer.py

@@ -0,0 +1,11 @@
+from stellar_base.builder import Builder
+
+alice_secret = 'SCB6JIZUC3RDHLRGFRTISOUYATKEE63EP7MCHNZNXQMQGZSLZ5CNRTKK'
+bob_address = 'GA7YNBW5CBTJZ3ZZOWX3ZNBKD6OE7A7IHUQVWMY62W2ZBG2SGZVOOPVH'
+
+builder = Builder(secret=alice_secret)
+builder.add_text_memo("Hello, Stellar!").append_payment_op(
+    destination=bob_address, amount='12.25', asset_code='XLM')
+builder.sign()
+response = builder.submit()
+print(response)

examples/payment.py

@@ -16,8 +16,9 @@ class Asset(object):
 
     :param str code: The asset code, in the formats specified in `Stellar's
         guide on assets`_.
-    :param str issuer: The strkey encoded issuer of the asset. Note if the
+    :param issuer: The strkey encoded issuer of the asset. Note if the
         currency is the native currency (XLM (Lumens)), no issuer is necessary.
+    :type issuer: str, None
 
     .. _Stellar's guide on assets:
         https://www.stellar.org/developers/guides/concepts/assets.html

stellar_base/asset.py

@@ -148,7 +148,8 @@ def append_payment_op(self,
         :param str destination: Account address that receives the payment.
         :param str amount: The amount of the currency to send in the payment.
         :param str asset_code: The asset code for the asset to send.
-        :param str asset_issuer: The address of the issuer of the asset.
+        :param asset_issuer: The address of the issuer of the asset.
+        :type asset_issuer: str, None
         :param str source: The source address of the payment.
         :return: This builder instance.
 
@@ -174,12 +175,14 @@ def append_path_payment_op(self,
             payment.
         :param str send_code: The asset code for the source asset deducted from
             the source account.
-        :param str send_issuer: The address of the issuer of the source asset.
+        :param send_issuer: The address of the issuer of the source asset.
+        :type send_issuer: str, None
         :param str send_max: The maximum amount of send asset to deduct
             (excluding fees).
         :param str dest_code: The asset code for the final destination asset
             sent to the recipient.
-        :param str dest_issuer: Account address that receives the payment.
+        :param dest_issuer: Account address that receives the payment.
+        :type dest_issuer: str, None
         :param str dest_amount: The amount of destination asset the destination
             account receives.
         :param list path: A list of asset tuples, each tuple containing a
@@ -350,12 +353,14 @@ def append_manage_offer_op(self,
 
         :param str selling_code: The asset code for the asset the offer creator
             is selling.
-        :param str selling_issuer: The issuing address for the asset the offer
+        :param selling_issuer: The issuing address for the asset the offer
             creator is selling.
+        :type selling_issuer: str, None
         :param str buying_code: The asset code for the asset the offer creator
             is buying.
-        :param str buying_issuer: The issuing address for the asset the offer
+        :param buying_issuer: The issuing address for the asset the offer
             creator is selling.
+        :type buying_issuer: str, None
         :param str amount: Amount of the asset being sold. Set to 0 if you want
             to delete an existing offer.
         :param price: Price of 1 unit of selling in terms of buying. You can pass
@@ -388,12 +393,14 @@ def append_create_passive_offer_op(self,
 
         :param str selling_code: The asset code for the asset the offer creator
             is selling.
-        :param str selling_issuer: The issuing address for the asset the offer
+        :param selling_issuer: The issuing address for the asset the offer
             creator is selling.
+        :type selling_issuer: str, None
         :param str buying_code: The asset code for the asset the offer creator
             is buying.
-        :param str buying_issuer: The issuing address for the asset the offer
+        :param buying_issuer: The issuing address for the asset the offer
             creator is selling.
+        :type buying_issuer: str, None
         :param str amount: Amount of the asset being sold. Set to 0 if you want
             to delete an existing offer.
         :param price: Price of 1 unit of selling in terms of buying. You can pass
@@ -445,7 +452,7 @@ def append_manage_data_op(self, data_name, data_value, source=None):
         :param str data_name: String up to 64 bytes long. If this is a new Name
             it will add the given name/value pair to the account. If this Name
             is already present then the associated value will be modified.
-        :param bytes data_value: If not present then the existing
+        :param str data_value: If not present then the existing
             Name will be deleted. If present then this value will be set in the
             DataEntry. Up to 64 bytes long.
         :param str source: The source account on which data is being managed.