rename ConvexAPI to API

Author: billbsing

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Change log
 
+### 0.2.0
++   Add KeyPair class, now you have to pass a KeyPair object to the `create_account` method.
++   Rename ConvexAPI to API
+
 ### 0.1.4
 +	Add address '#' identifier before each address number.
 

README.md

@@ -12,41 +12,43 @@ First you need to download the Convex-API-py package from the python package ind
 
 You can now access the convex network, and get a balance from an existing account on the network by doing the following:
 
-    >>> from convex_api import ConvexAPI
-    >>> convex_api = ConvexAPI('https://convex.world')
-    >>> convex_api.get_balance(9)
+    >>> from convex_api import API
+    >>> convex = API('https://convex.world')
+    >>> convex.get_balance(9)
     99396961137042
 
 You can create a new emtpy account, with now balance:
 
-    >>> account = convex_api.create_account()
+    >>> key_pair = KeyPair.create()
+    >>> account = convex.create_account(key_pair)
     >>> account.address
     809
 
 You can request some funds to the new account and then get the account information:
 
     >>> convex_api.request_funds(1000000, account)
     1000000
-    >>> convex_api.get_account_info(account)
+    >>> convex.get_account_info(account)
     {'environment': {}, 'address': 809, 'is_library': False, 'is_actor': False, 'memory_size': 42, 'balance': 1000000, 'allowance': 0, 'sequence': 0, 'type': 'user'}
 
 
 You can export the accounts private key encoded as PKCS8 encrypt the key with a password:
 
-    >>> account.export_to_text('secret')
+    >>> account.key_pair.export_to_text('secret')
     '-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIGbMFcGCSqGSIb3DQEFDTBKMCkGCSqGSIb3DQEFDDAcBAiMY42UY4PXHAICCAAw\nDAYIKoZIhvcNAgkFADAdBglghkgBZQMEASoEEJpwDMicGbGj2iSJesktIVYEQBsp\nKMTAHzvUyw8jZRr8WSrmxH7938sjma8XWI6lgd9jwTZzcGamog7p3zatw0Wp+jFK\nKruWAZmIqhBZ/2ezDv8=\n-----END ENCRYPTED PRIVATE KEY-----\n'
 
     >>> account.address
     809
 
 To re-use your account again you need to import the encrypted private key and set the correct account address
 
-    >>> from convex_api import Account
-    >>> account = Account.import_from_file('my_key.dat', 'secret', address=809)
+    >>> from api import Account, KeyPair
+    >>> key_pair = KeyPair.import_from_file('my_key.dat', 'secret')
+    >>> account = Account.create(key_pair, 809)
 
 To create a new address with the same account keys in your new or imported account object, you can do:
 
-    >>> new_account = convex_api.create_account(account)
+    >>> new_account = convex.create_account(key_pair)
     >>> account.address
     809
     >>> new_account.address
@@ -55,37 +57,37 @@ To create a new address with the same account keys in your new or imported accou
 To use account names, where an account name is resolved to a fixed address. You can create or load
 an account based on it's name by doing the following:
 
-    >>> account = convex_api.setup_account('my-account-name', import_account)
+    >>> account = convex.setup_account('my-account-name', key_pair)
     >>> account.address
     934
 
-    >>> convex_api.resolve_account_name('my-account-name')
+    >>> convex.resolve_account_name('my-account-name')
     934
 
-    >>> same_account = convex_api.setup_account('my-account-name', import_account)
+    >>> same_account = convex.setup_account('my-account-name', key_pair)
     >>> same_account.address
     934
 
 To submit a transaction, use ConvexAPI.send(). This will cost a small about of juice, and reduce your balance
 
-    >>> convex_api.request_funds(1000000, account)
+    >>> convex.request_funds(1000000, account)
     1000000
-    >>> convex_api.send('(map inc [1 2 3 4])', account)
+    >>> convex.send('(map inc [1 2 3 4])', account)
     {'value': [2, 3, 4, 5]}
-    >>> convex_api.get_balance(account)
+    >>> convex.get_balance(account)
     996360
 
 To send a query a transaction, this is free and can be performed by any valid account address.
 So for example to query a balance of an account:
 
-    >>> convex_api.query(f'(balance {account.address})', account)
+    >>> convex.query(f'(balance {account.address})', account)
     {'value': 996360}
 
     # this is the same as above
-    >>> convex_api.query(f'(balance {account.address})', account.address)
+    >>> convex.query(f'(balance {account.address})', account.address)
     {'value': 996360}
 
     # get the balance using one of the standard account addresses (#1)
-    >>> convex_api.query(f'(balance {account.address})', 1)
+    >>> convex.query(f'(balance {account.address})', 1)
     {'value': 996360}
 

convex_api/__init__.py

@@ -5,7 +5,7 @@
 """
 
 from convex_api.account import Account                   # noqa: F401
-from convex_api.convex_api import ConvexAPI              # noqa: F401
+from convex_api.api import API                    # noqa: F401
 from convex_api.key_pair import KeyPair                  # noqa: F401
 
 

convex_api/account.py

@@ -15,10 +15,6 @@ def __init__(self, key_pair, address, name=None):
 
         Create a new account with a private key KeyPair.
 
-        You can also use the following static methods to create an Account object:
-
-            * :meth:`.create`
-
         :param KeyPair key_pair: The public/private key of the account
 
         :param int address: address of the account
@@ -28,16 +24,16 @@ def __init__(self, key_pair, address, name=None):
         .. code-block:: python
 
             >>> # import convex-api
-            >>> from convex_api import ConvexAPI, KeyPair, Account
+            >>> from convex_api import API, KeyPair, Account
 
             >>> # setup the network connection
-            >>> convex_api = ConvexAPI('https://convex.world')
+            >>> convex = API('https://convex.world')
 
             >>> # create a random keypair
-            >>> key_pair = KeyPair.create()
+            >>> key_pair = KeyPair()
 
             >>> # create a new account and address
-            >>> account = convex_api.create_account(key_pair)
+            >>> account = convex.create_account(key_pair)
 
             >>> # export the private key to a file
             >>> key_pair.export_to_file('/tmp/my_account.pem', 'my secret password')
@@ -49,7 +45,7 @@ def __init__(self, key_pair, address, name=None):
 
             >>> # now import the account and address for later use
             >>> key_pair = KeyPair.import_from_file('/tmp/my_account.pem', 'my secret password')
-            >>> account = Account.create(key_pair, my_address)
+            >>> account = Account(key_pair, my_address)
 
 
         """
@@ -68,8 +64,8 @@ def sign(self, hash_text):
 
         .. code-block:: python
 
-            >>> # create an account with no address
-            >>> account = Account.create(key_pair)
+            >>> # create an account
+            >>> account = convex.create_account(key_pair)
             >>> # sign a given hash
             >>> sig = account.sign('7e2f1062f5fc51ed65a28b5945b49425aa42df6b7e67107efec357794096e05e')
             >>> print(sig)
@@ -102,7 +98,8 @@ def address(self):
         .. code-block:: python
 
             >>> # create an account with the network
-            >>> account = convex_api.create_account()
+            >>> key_pair = KeyPair()
+            >>> account = convex.create_account(key_pair)
             >>> print(account.address)
             42
 
@@ -121,8 +118,9 @@ def address(self, value):
         .. code-block:: python
 
             >>> # import the account keys
-            >>> account = Account.import_from_mnemonic('my private key words ..')
+            >>> key_pair = KeyPair.import_from_mnemonic('my private key words ..')
 
+            >>> account = convex.create_account(key_pair)
             >>> # set the address that was given to us when we created the account on the network
             >>> account.address = 42
 
@@ -149,7 +147,7 @@ def public_key(self):
         .. code-block:: python
 
             >>> # create an account with the network
-            >>> account = convex_api.create_account(key_pair)
+            >>> account = convex.create_account(key_pair)
 
             >>> # show the public key as a hex string
             >>> print(account.public_key)
@@ -166,29 +164,3 @@ def key_pair(self):
 
         """
         return self._key_pair
-
-    @staticmethod
-    def create(key_pair, address, name=None):
-        """
-
-        Create a new account with a random key and an empty address.
-
-        :param KeyPair key_pair: The public/private key of the account
-
-        :param int address: address of the account
-
-        :param str name: Optional name of the account
-
-        :returns: New Account object
-        :rtype: Account
-
-        .. code-block:: python
-
-            >>> # create an account with no address
-            >>> account = Account.create(key_pair)
-            >> account.is_address
-            False
-
-
-        """
-        return Account(key_pair, address, name)