Skip to main content

Convex api

Project description

Convex API

Checked with pyright

Documentation

Quick Start

First you need to download the Convex-API-py package from the python package index PyPi.

pip install convex-api

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 API
>>> convex = API('https://convex.world')
>>> convex.get_balance(9)
99396961137042

You can create a new emtpy account, with now balance:

>>> 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.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.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 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.create_account(key_pair)
>>> account.address
809
>>> new_account.address
934

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.setup_account('my-account-name', key_pair)
>>> account.address
934

>>> convex.resolve_account_name('my-account-name')
934

>>> 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.request_funds(1000000, account)
1000000
>>> convex.send('(map inc [1 2 3 4])', account)
{'value': [2, 3, 4, 5]}
>>> 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.query(f'(balance {account.address})', account)
{'value': 996360}

# this is the same as above
>>> convex.query(f'(balance {account.address})', account.address)
{'value': 996360}

# get the balance using one of the standard account addresses (#1)
>>> convex.query(f'(balance {account.address})', 1)
{'value': 996360}

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

convex-api-py-0.3.1.tar.gz (37.2 kB view details)

Uploaded Source

Built Distribution

convex_api_py-0.3.1-py2.py3-none-any.whl (50.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file convex-api-py-0.3.1.tar.gz.

File metadata

  • Download URL: convex-api-py-0.3.1.tar.gz
  • Upload date:
  • Size: 37.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for convex-api-py-0.3.1.tar.gz
Algorithm Hash digest
SHA256 f139655c453ff13ce4822971b1fedfa3804fd25612c1ebfeaa82413200040e59
MD5 ae54e31c76c3a018fac50e52198d29b3
BLAKE2b-256 bf61c1c70c4e1c49b406ac01817651924b5188b855160dad1bfc2c7340138df9

See more details on using hashes here.

File details

Details for the file convex_api_py-0.3.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for convex_api_py-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5900afcd3a0ae6ea1789d3defb9befb7fdf3c7ce65e869b3f11401b03c271ecc
MD5 42a7287928ac65290002cd4df6a18b85
BLAKE2b-256 22798e0b16098fcb82d84dbf6c74cfdc5fa0d7982f4d466776aed5d691a17ffa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page