Skip to content

Latest commit

 

History

History
239 lines (185 loc) · 7.2 KB

human_protocol_sdk.kvstore.kvstore_client.md

File metadata and controls

239 lines (185 loc) · 7.2 KB

human_protocol_sdk.kvstore.kvstore_client module

This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.

Internally, the SDK will use one network or another according to the network ID of the web3. To use this client, you need to create Web3 instance, and configure default account, as well as some middlewares.

Code Example

  • With Signer
from eth_typing import URI
from web3 import Web3
from web3.middleware import construct_sign_and_send_raw_middleware
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.kvstore import KVStoreClient

def get_w3_with_priv_key(priv_key: str):
    w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
    gas_payer = w3.eth.account.from_key(priv_key)
    w3.eth.default_account = gas_payer.address
    w3.middleware_onion.add(
        construct_sign_and_send_raw_middleware(gas_payer),
        "construct_sign_and_send_raw_middleware",
    )
    return (w3, gas_payer)

(w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
kvstore_client = KVStoreClient(w3)
  • Without Signer (For read operations only)
from eth_typing import URI
from web3 import Web3
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.kvstore import KVStoreClient

w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
kvstore_client = KVStoreClient(w3)

Module

class human_protocol_sdk.kvstore.kvstore_client.KVStoreClient(web3, gas_limit=None)

Bases: object

A class used to manage kvstore on the HUMAN network.

__init__(web3, gas_limit=None)

Initializes a KVStore instance.

  • Parameters: web3 (Web3) – The Web3 object

get(address, key)

Gets the value of a key-value pair in the contract.

  • Parameters:
    • address (str) – The Ethereum address associated with the key-value pair
    • key (str) – The key of the key-value pair to get
  • Return type: str
  • Returns: The value of the key-value pair if it exists
  • Example: 
    from eth_typing import URI
from web3 import Web3
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.kvstore import KVStoreClient

w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
kvstore_client = KVStoreClient(w3)

role = kvstore_client.get('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'Role')

get_url(address, key='url')

Gets the URL value of the given entity.

  • Parameters:
    • address (str) – Address from which to get the URL value.
    • key (Optional[str]) – Configurable URL key. url by default.
  • Return url: The URL value of the given address if exists, and the content is valid
  • Example: 
    from eth_typing import URI
from web3 import Web3
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.kvstore import KVStoreClient

w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
kvstore_client = KVStoreClient(w3)

url = kvstore_client.get_url(
    '0x62dD51230A30401C455c8398d06F85e4EaB6309f'
)
linkedin_url = kvstore_client.get_url(
    '0x62dD51230A30401C455c8398d06F85e4EaB6309f',
    'linkedinUrl'
)
  • Return type: str

set(key, value, tx_options=None)

Sets the value of a key-value pair in the contract.

  • Parameters:
    • key (str) – The key of the key-value pair to set
    • value (str) – The value of the key-value pair to set
    • tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters
  • Return type: None
  • Returns: None
  • Example: 
    from eth_typing import URI
from web3 import Web3
from web3.middleware import construct_sign_and_send_raw_middleware
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.kvstore import KVStoreClient

def get_w3_with_priv_key(priv_key: str):
    w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
    gas_payer = w3.eth.account.from_key(priv_key)
    w3.eth.default_account = gas_payer.address
    w3.middleware_onion.add(
        construct_sign_and_send_raw_middleware(gas_payer),
        "construct_sign_and_send_raw_middleware",
    )
    return (w3, gas_payer)

(w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
kvstore_client = KVStoreClient(w3)
kvstore_client.set('Role', 'RecordingOracle')

set_bulk(keys, values, tx_options=None)

Sets multiple key-value pairs in the contract.

  • Parameters:
    • keys (List[str]) – A list of keys to set
    • values (List[str]) – A list of values to set
    • tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters
  • Return type: None
  • Returns: None
  • Example: 
    from eth_typing import URI
from web3 import Web3
from web3.middleware import construct_sign_and_send_raw_middleware
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.kvstore import KVStoreClient

def get_w3_with_priv_key(priv_key: str):
    w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
    gas_payer = w3.eth.account.from_key(priv_key)
    w3.eth.default_account = gas_payer.address
    w3.middleware_onion.add(
        construct_sign_and_send_raw_middleware(gas_payer),
        "construct_sign_and_send_raw_middleware",
    )
    return (w3, gas_payer)

(w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
kvstore_client = KVStoreClient(w3)

keys = ['Role', 'Webhook_url'];
values = ['RecordingOracle', 'http://localhost'];
kvstore_client.set_bulk(keys, values)

set_url(url, key='url', tx_options=None)

Sets a URL value for the address that submits the transaction.

  • Parameters:
    • url (str) – URL to set
    • key (Optional[str]) – Configurable URL key. url by default.
    • tx_options (Optional[TxParams]) – (Optional) Additional transaction parameters
  • Return type: None
  • Returns: None
  • Raises: KVStoreClientError – If an error occurs while validating URL, or handling transaction
  • Example: 
    from eth_typing import URI
from web3 import Web3
from web3.middleware import construct_sign_and_send_raw_middleware
from web3.providers.auto import load_provider_from_uri

from human_protocol_sdk.kvstore import KVStoreClient

def get_w3_with_priv_key(priv_key: str):
    w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
    gas_payer = w3.eth.account.from_key(priv_key)
    w3.eth.default_account = gas_payer.address
    w3.middleware_onion.add(
        construct_sign_and_send_raw_middleware(gas_payer),
        "construct_sign_and_send_raw_middleware",
    )
    return (w3, gas_payer)

(w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
kvstore_client = KVStoreClient(w3)

kvstore_client.set_url('http://localhost')
kvstore_client.set_url('https://linkedin.com/me', 'linkedinUrl')

exception human_protocol_sdk.kvstore.kvstore_client.KVStoreClientError

Bases: Exception

Raises when some error happens when interacting with kvstore.