Skip to main content

🐳 Library including all the common functionalities used in Python projects

Project description

ocean-keeper

Wraps keeper contracts and web3 functions.

How to

The main class is Keeper and all contracts are accessible directly from the keeper instance. Each deployed contract has a python wrapper class exposing the main functions and validating inputs. It is possible to access the Web3 Contract functions directly by using the contract_concise attribute of the wrapper instance.

import os
from ocean_keeper import Keeper
from ocean_keeper.contract_handler import ContractHandler
from ocean_keeper.web3_provider import Web3Provider
from ocean_keeper.utils import get_account

# Init the web3 instance
Web3Provider.init_web3('http://localhost:8545')  # Assume running with local parity node
# set the contract handler path to abi files
ContractHandler.set_artifacts_path(os.path.expanduser('~/.ocean/keeper-contracts/artifacts'))
# get keeper instance
keeper = Keeper.get_instance()
# Do stuff with keeper and it's contracts
account = get_account(0)
keeper.did_registry.register('0x10101010101010101010', '', 'http://localhost:5000/api/v1/assets', account)

Account can be specified using the following environment variables:

  • PARITY_ADDRESS: the ethereum address
  • PARITY_PASSWORD: the password to decrypt key in the PARITY_ENCRYPTED_KEY or PARITY_KEYFILE
  • PARITY_KEY: the private key of this account (matches the PARITY_ADDRESS), password is not required when this is specified
  • PARITY_ENCRYPTED_KEY: the encrypted key in a json str (same content of the PARITY_KEYFILE)
  • PARITY_KEYFILE: path to the json file that has the encrypted key specified in json document

Note: The keys are loaded in this order: PARITY_KEY, PARITY_ENCRYPTED_KEY, PARITY_KEYFILE. If PARITY_KEY is specified the password and other environment variables are ignored.

For more details refer to the keeper-contracts repo at https://github.com/oceanprotocol/keeper-contracts

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

ocean-keeper-0.3.3.tar.gz (69.5 kB view hashes)

Uploaded Source

Built Distribution

ocean_keeper-0.3.3-py2.py3-none-any.whl (46.8 kB view hashes)

Uploaded Python 2 Python 3

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