PolySwarm Client Source-Based Documentation

API Reference

This page contains auto-generated API reference documentation 1.

conftest

balancemanager

Submodules

balancemanager.__main__

Module Contents

balancemanager.__main__.logger

balancemanager.__main__.validate_optional_transfer_amount(ctx, param, value)

balancemanager.__main__.validate_transfer_amount(ctx, param, value)

balancemanager.__main__.polyswarm_client(func)

balancemanager.__main__.cli(log, client_log, log_format)

Entrypoint for the balance manager driver

Parameters

• log (str) – Log level for balancemanger module logs

• client_log (str) – Log level for all polyswarmclient module logs

• log_format (str) – Choose either json, or text log format

balancemanager.__main__.deposit(polyswarmd_addr, keyfile, password, api_key, testing, insecure_transport, denomination, all, amount)

Entrypoint to deposit NCT into a sidechain

Parameters

• polyswarmd_addr (str) – Address for the polyswarmd server

• keyfile (str) – Path to the keyfile

• password (str) – Password to unlock keyfile

• api_key (str) – ApiKey to access polyswarmd

• testing (int) – Number of tests to run

• insecure_transport (bool) – Flag to allow use of http instead of https

• denomination (str) – Choose to interpret amount as nct, nct-gwei, or nct-wei

• all (bool) – Choose to deposit the entire homechain balance

• amount (float) – Amount of Nectar (NCT) to transfer

balancemanager.__main__.withdraw(polyswarmd_addr, keyfile, password, api_key, testing, insecure_transport, denomination, all, amount)

Entrypoint to withdraw NCT from a sidechain into the homechain

Parameters

• polyswarmd_addr (str) – Address for the polyswarmd server

• keyfile (str) – Path to the keyfile

• password (str) – Password to unlock keyfile

• api_key (str) – ApiKey to access polyswarmd

• testing (int) – Number of tests to run

• insecure_transport (bool) – Flag to allow use of http instead of https

• denomination (str) – Choose to interpret amount as nct, nct-gwei, or nct-wei

• all (bool) – Choose to withdraw the entire sidechain balance

• amount (float) – Amount of Nectar (NCT) to transfer (if not all)

balancemanager.__main__.maintain(polyswarmd_addr, keyfile, password, api_key, testing, insecure_transport, denomination, maximum, withdraw_target, confirmations, minimum, refill_amount)

Entrypoint to withdraw NCT from a sidechain into the homechain

Parameters

• polyswarmd_addr (str) – Address for the polyswarmd server

• keyfile (str) – Path to the keyfile

• password (str) – Password to unlock keyfile

• api_key (str) – ApiKey to access polyswarmd

• testing (int) – Number of tests to run

• insecure_transport (bool) – Flag to allow use of http instead of https

• denomination (str) – Choose to interpret amount as nct, nct-gwei, or nct-wei

• maximum (int) – Maximum balance to before starting a withdrawal from sidechain

• withdraw_target (int) – Target value after performing a withdrawal

• confirmations (int) – Number of confirmations to wait to confirm a transfer occurred

• minimum (float) – Value of NCT on sidechain where you want to transfer more NCT

• refill_amount (float) – Value of NCT to transfer anytime the balance falls below the minimum

Package Contents

balancemanager.logger

balancemanager.RELAY_LEEWAY = 5

balancemanager.convert(client, denomination, amount)

Convert the amount from it's original precision to 18 decimals

class balancemanager.BalanceManager(client, denomination, transfer_all, amount, testing=0, chains=None)

Bases: object

Balance manager is used for single transfer events in either direction. Create a client, choose a chain and amount then run it.

run(self)

Starts the client on whichever chain this uses.

run_oneshot(self)

Runs run_task once

class balancemanager.Deposit(client, denomination, transfer_all, amount, testing=0)

Bases: balancemanager.BalanceManager

Deposit only version of Balance Manager

class balancemanager.Withdraw(client, denomination, transfer_all, amount, testing=0)

Bases: balancemanager.BalanceManager

Withdraw only version of Balance Manager

class balancemanager.Maintainer(client, denomination, confirmations, minimum, refill_amount, maximum, withdraw_target, testing=0)

Bases: object

This class maintains a balance on the sidechain. It requires a base setup of a minimum balance. Optionally, it can take a maximum balance, so that earnings can automatically be transferred back to the homechain.

run(self)

Starts the client. Have to run with both chains, or lots of nonce errors

polyswarmclient

Submodules

polyswarmclient.abstractambassador

Module Contents

polyswarmclient.abstractambassador.logger

polyswarmclient.abstractambassador.MAX_TRIES = 10

polyswarmclient.abstractambassador.BOUNTY_QUEUE_SIZE = 10

polyswarmclient.abstractambassador.MAX_BOUNTIES_IN_FLIGHT = 10

polyswarmclient.abstractambassador.MAX_BOUNTIES_PER_BLOCK = 1

polyswarmclient.abstractambassador.BLOCK_DIVISOR = 1

class polyswarmclient.abstractambassador.QueuedBounty(artifact_type, amount, ipfs_uri, duration, api_key=None)

Bases: object

__repr__(self)

class polyswarmclient.abstractambassador.AbstractAmbassador(client, testing=0, chains=None, watchdog=0, submission_rate=0)

Bases: abc.ABC

classmethod connect(cls, polyswarmd_addr, keyfile, password, api_key=None, testing=0, insecure_transport=False, chains=None, watchdog=0, submission_rate=0)

Connect the Ambassador to a Client.

Parameters

• polyswarmd_addr (str) – URL of polyswarmd you are referring to.

• keyfile (str) – Keyfile filename.

• password (str) – Password associated with Keyfile.

• api_key (str) – Your PolySwarm API key.

• testing (int) – Number of testing bounties to use.

• insecure_transport (bool) – Allow insecure transport such as HTTP?

• chains (set(str)) – Set of chains you are acting on.

Returns

Ambassador instantiated with a Client.

Return type

AbstractAmbassador

run(self)

Run the Client on all of our chains.

polyswarmclient.abstractarbiter

Module Contents

polyswarmclient.abstractarbiter.logger

polyswarmclient.abstractarbiter.MAX_STAKE_RETRIES = 10

class polyswarmclient.abstractarbiter.AbstractArbiter(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: object

classmethod connect(cls, polyswarmd_addr, keyfile, password, api_key=None, testing=0, insecure_transport=False, scanner=None, chains=None, artifact_types=None)

Connect the Arbiter to a Client.

Parameters

• polyswarmd_addr (str) – URL of polyswarmd you are referring to.

• keyfile (str) – Keyfile filename.

• password (str) – Password associated with Keyfile.

• api_key (str) – Your PolySwarm API key.

• testing (int) – Number of testing bounties to use.

• insecure_transport (bool) – Allow insecure transport such as HTTP?

• scanner (AbstractScanner) – Scanner for scanning artifacts

• chains (set(str)) – Set of chains you are acting on.

• artifact_types (list(ArtifactType)) – List of artifact types you support

Returns

Arbiter instantiated with a Client.

Return type

AbstractArbiter

run(self)

Run the Client on the Arbiter’s chains.

polyswarmclient.abstractmicroengine

Module Contents

polyswarmclient.abstractmicroengine.logger

class polyswarmclient.abstractmicroengine.AbstractMicroengine(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: object

classmethod connect(cls, polyswarmd_addr, keyfile, password, api_key=None, testing=0, insecure_transport=False, scanner=None, chains=None, artifact_types=None)

Connect the Microengine to a Client.

Parameters

• polyswarmd_addr (str) – URL of polyswarmd you are referring to.

• keyfile (str) – Keyfile filename.

• password (str) – Password associated with Keyfile.

• api_key (str) – Your PolySwarm API key.

• testing (int) – Number of testing bounties to use.

• insecure_transport (bool) – Allow insecure transport such as HTTP?

• scanner (Scanner) – Scanner instance to use.

• chains (set(str)) – Set of chains you are acting on.

• artifact_types (list(ArtifactType)) – List of artifact types you support

Returns

Microengine instantiated with a Client.

Return type

AbstractMicroengine

run(self)

Run the Client on the Microengine’s chains.

polyswarmclient.abstractscanner

Module Contents

polyswarmclient.abstractscanner.logger

class polyswarmclient.abstractscanner.ScanResult(bit=False, verdict=False, confidence=1.0, metadata='')

Bases: object

Results from scanning one artifact

__repr__(self)

class polyswarmclient.abstractscanner.AbstractScanner

Bases: abc.ABC

Base Scanner class. To be overwritten with other scanning logic.

polyswarmclient.balanceclient

Module Contents

polyswarmclient.balanceclient.logger

class polyswarmclient.balanceclient.BalanceClient(client)

Bases: object

polyswarmclient.bloom

Module Contents

polyswarmclient.bloom.FILTER_BITS

polyswarmclient.bloom.HASH_FUNCS = 8

polyswarmclient.bloom.logger

polyswarmclient.bloom.w3

polyswarmclient.bloom.get_chunks_for_bloom(value_hash)

Bloom filter helper function. Turn a value hash into

a series of chunks.

Parameters

value_hash (bytes) – Hash of to be encoded into the Bloom filter.

Yields

chunk (bytes) – Chunks of the value hash.

polyswarmclient.bloom.chunk_to_bloom_bits(chunk)

Bloom filter helper function. Turn a chunk into a series of

actual bytes.

Parameters

chunk (bytes) – Byte encoded chunk.

polyswarmclient.bloom.get_bloom_bits(value)

Bloom filter helper function. Get the Bloom bits of a

given value.

Parameters

value (bytes) – Value to be encoded into the Bloom filter.

class polyswarmclient.bloom.BloomFilter(value=0)

Bases: numbers.Number

value

__int__(self)

add(self, value)

Add a single byte value to the Bloom filter.

Parameters

value (bytes) – Byte encoded value to add to Bloom filter.

extend(self, iterable)

Add an iterable of byte values to the bloom filter.

Parameters

iterable (Iterable[bytes]) – Iterable of byte values.

classmethod from_iterable(cls, iterable)

Instantiate a bloom filter from a given iterable.

Parameters

iterable (Iterable[bytes]) – Iterable of byte values.

Returns

Instantiated BloomFilter.

Return type

BloomFilter

__contains__(self, value)

__index__(self)

_combine(self, other)

__or__(self, other)

__add__(self, other)

_icombine(self, other)

__ior__(self, other)

__iadd__(self, other)

polyswarmclient.bountiesclient

Module Contents

polyswarmclient.bountiesclient.logger

class polyswarmclient.bountiesclient.PostBountyTransaction(client, artifact_type, amount, bounty_fee, artifact_uri, num_artifacts, duration, bloom)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.bountiesclient.PostAssertionTransaction(client, bounty_guid, bid, assertion_fee, mask, commitment)

Bases: polyswarmclient.transaction.AbstractTransaction

get_body(self)

get_path(self)

has_required_event(self, transaction_events)

class polyswarmclient.bountiesclient.RevealAssertionTransaction(client, bounty_guid, index, nonce, verdicts, metadata)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.bountiesclient.PostVoteTransaction(client, bounty_guid, votes, valid_bloom)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.bountiesclient.SettleBountyTransaction(client, bounty_guid)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.bountiesclient.BountiesClient(client)

Bases: object

polyswarmclient.config

Module Contents

polyswarmclient.config.logger

polyswarmclient.config.validate_apikey(ctx, param, value)

Validates the API key passed in through click parameters

polyswarmclient.config.init_logging(loggers, log_format, loglevel=logging.WARNING)

Logic to support JSON logging.

class polyswarmclient.config.LoggerConfig(loggers, log_format, log_level=logging.WARNING)

LEVELS

configure(self)

set_level(self, new_level)

polyswarmclient.corpus

Module Contents

polyswarmclient.corpus.logger

polyswarmclient.corpus.MALICIOUS_BOOTSTRAP_URL

polyswarmclient.corpus.ARCHIVE_PASSWORD

class polyswarmclient.corpus.DownloadToFileSystemCorpus(base_dir=None)

Bases: object

mal_path

benign_path

download_and_unpack(self)

_get_pth_listing(self, p)

get_malicious_file_list(self)

get_benign_file_list(self)

download_truth(self)

polyswarmclient.events

Module Contents

polyswarmclient.events.logger

class polyswarmclient.events.Callback

Bases: object

Abstract callback class which is the parent to a number of child callback classes to be used in different scenarios.

Note

Classes which extend Callback are expected to impliment the run method.

register(self, f)

Register a function to this Callback.

Parameters

f (function) – Function to register.

remove(self, f)

Remove a function previously assigned to this Callback.

Parameters

f (function) – Function to remove.

class polyswarmclient.events.OnRunCallback

Bases: polyswarmclient.events.Callback

Called upon entering the event loop for the first time, use for initialization

class polyswarmclient.events.OnNewBlockCallback

Bases: polyswarmclient.events.Callback

Called upon receiving a new block, scheduled events triggered separately

class polyswarmclient.events.OnNewBountyCallback

Bases: polyswarmclient.events.Callback

Called upon receiving a new bounty

class polyswarmclient.events.OnNewAssertionCallback

Bases: polyswarmclient.events.Callback

Called upon receiving a new assertion

class polyswarmclient.events.OnRevealAssertionCallback

Bases: polyswarmclient.events.Callback

Called upon receiving a new assertion reveal

class polyswarmclient.events.OnNewVoteCallback

Bases: polyswarmclient.events.Callback

Called upon receiving a new arbiter vote

class polyswarmclient.events.OnQuorumReachedCallback

Bases: polyswarmclient.events.Callback

Called upon a bounty reaching quorum

class polyswarmclient.events.OnSettledBountyCallback

Bases: polyswarmclient.events.Callback

Called upon a bounty being settled

class polyswarmclient.events.OnInitializedChannelCallback

Bases: polyswarmclient.events.Callback

Called upon a channel being initialized

class polyswarmclient.events.Schedule

Bases: object

Generic Schedule class. Uses a PriorityQueue data structure to store Events.

empty(self)

Return True if the queue is empty.

Returns

Is the queue empty.

Return type

boolean

peek(self)

Return True if the queue is empty.

Returns

Tuple at the front of the queue if the queue is full, else None.

Return type

(block, event)

get(self)

Pop the lowest valued block in the queue.

Returns

The lowest valued block in the PriorityQueue.

Return type

(block, event)

put(self, block, event)

Add a tuple (block, event) to the PriorityQueue. Block signifies the priority of the event.

class polyswarmclient.events.Event(guid)

Bases: object

Generic Event class. Stores GUID and can compare for equality and order Events.

Parameters

guid (str) – GUID of the event.

__eq__(self, other)

__lt__(self, other)

class polyswarmclient.events.RevealAssertion(guid, index, nonce, verdicts, metadata)

Bases: polyswarmclient.events.Event

An assertion scheduled to be publically revealed

Parameters

• guid (str) – GUID of the bounty being asserted on

• index (int) – Index of the assertion to reveal

• nonce (str) – Secret nonce used to reveal assertion

• verdicts (List[bool]) – List of verdicts for each artifact in the bounty

• metadata (str) – Optional metadata

class polyswarmclient.events.OnRevealAssertionDueCallback

Bases: polyswarmclient.events.Callback

Called when an assertion is needing to be revealed

class polyswarmclient.events.VoteOnBounty(guid, votes, valid_bloom)

Bases: polyswarmclient.events.Event

A scheduled vote from an arbiter :param guid: GUID of the bounty being voted on :type guid: str :param votes: List of votes for each artifact in the bounty :type votes: List[bool] :param valid_bloom: Is the bloom filter submitted with the bounty valid :type valid_bloom: bool

class polyswarmclient.events.OnVoteOnBountyDueCallback

Bases: polyswarmclient.events.Callback

Called when a bounty is needing to be voted on

class polyswarmclient.events.SettleBounty(guid)

Bases: polyswarmclient.events.Event

A bounty scheduled to be settled :param guid: GUID of the bounty being asserted on :type guid: str

class polyswarmclient.events.OnSettleBountyDueCallback

Bases: polyswarmclient.events.Callback

Called when a bounty is needing to be settled

polyswarmclient.log_formatter

Module Contents

class polyswarmclient.log_formatter.ExtraTextFormatter

Bases: logging.Formatter

Custom formatter that adds extra fields to the message string

format(self, record)

Takes a LogRecord and sets record.message = record.msg % record.args This one does some extra work. It searches the record dict for some extra keys we use in the client. (specified as extra= in the logger statement) If it finds one, it grabs the dict and adds an extra %s arg to record.msg, and the dict value to the record.args tuple.

class polyswarmclient.log_formatter.JSONFormatter

Bases: pythonjsonlogger.jsonlogger.JsonFormatter

Class to add custom JSON fields to our logger. Presently just adds a timestamp if one isn’t present and the log level. INFO: https://github.com/madzak/python-json-logger#customizing-fields

add_fields(self, log_record, record, message_dict)

polyswarmclient.offersclient

Module Contents

polyswarmclient.offersclient.logger

class polyswarmclient.offersclient.OffersClient(client)

Bases: object

OffersClient to handle offers. Presently stores a given client and parameters.

polyswarmclient.parameters

Module Contents

class polyswarmclient.parameters.Parameters(p)

Bases: object

Trivial wrapper around a dict but protected via a RWLock to allow updates

polyswarmclient.producer

Module Contents

polyswarmclient.producer.logger

polyswarmclient.producer.KEY_TIMEOUT = 20

class polyswarmclient.producer.Producer(client, redis_uri, queue, time_to_post)

polyswarmclient.relayclient

Module Contents

polyswarmclient.relayclient.logger

class polyswarmclient.relayclient.RelayDepositTransaction(client, amount)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.relayclient.RelayWithdrawTransaction(client, amount)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.relayclient.RelayClient(client)

Bases: object

polyswarmclient.stakingclient

Module Contents

polyswarmclient.stakingclient.logger

class polyswarmclient.stakingclient.StakeDepositTransaction(client, amount)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.stakingclient.StakeWithdrawTransaction(client, amount)

Bases: polyswarmclient.transaction.AbstractTransaction

get_path(self)

get_body(self)

has_required_event(self, transaction_events)

class polyswarmclient.stakingclient.StakingClient(client)

Bases: object

polyswarmclient.transaction

Module Contents

polyswarmclient.transaction.logger

polyswarmclient.transaction.LOG_MSG_ENGINE_TOO_SLOW = PLEASE REVIEW YOUR SCANNING LOGIC. Bounty inactive errors indicate that the microengine received the bounty, but was unable to respond to the bounty within the time window. Such errors are considered fatal during testing so you can easily identify them. If your engine is unable to respond within the time window on the live PolySwarm network, you risk losing the bid amount of the bounty at hand. We strongly encourage you to review your artifact scan process to identify areas where engine speed can be improved.

class polyswarmclient.transaction.NonceManager(client, chain)

Manages the nonce for some Ethereum chain

all_finished(self)

Check that all tasks have finished

mark_update_nonce(self)

Call this when the nonce is out of sync. This sets the update flag to true. The next acquire after being set will trigger an update

class polyswarmclient.transaction.AbstractTransaction(client, verifiers)

Used to verify and post groups of transactions that make up a specific action.

For instance, when approving some funds to move, and calling a contract function that will consumer them.

has_required_event(self, transaction_events)

Checks for existence of events in transaction logs, ensuring successful completion

Returns

True if the required event was in the list, false otherwise

get_path(self)

Get the path of the route to build this transaction

Returns

Polyswarmd path to get the transaction data

Return type

str

get_body(self)

Build the payload to send to polyswarmd :returns: Dict payload

verify(self, transactions)

Check the given transactions against known expectations

Parameters

transactions (list) –

Returns

True if transactions match expectations. False otherwise

Return type

(bool)

polyswarmclient.utils

Module Contents

polyswarmclient.utils.logger

polyswarmclient.utils.TASK_TIMEOUT = 1.0

polyswarmclient.utils.MAX_WAIT

polyswarmclient.utils.MAX_WORKERS = 4

polyswarmclient.utils.to_string(value)

polyswarmclient.utils.sha3_256(x)

polyswarmclient.utils.sha3(seed)

polyswarmclient.utils.int_to_bytes(i)

polyswarmclient.utils.int_from_bytes(b)

polyswarmclient.utils.bool_list_to_int(bs)

polyswarmclient.utils.int_to_bool_list(i, expected_size)

polyswarmclient.utils.guid_as_string(guid)

polyswarmclient.utils.calculate_commitment(account, verdicts, nonce=None)

polyswarmclient.utils.configure_event_loop()

polyswarmclient.utils.asyncio_join()

Gather all remaining tasks, assumes loop is not running

polyswarmclient.utils.asyncio_stop()

Stop the main event loop

polyswarmclient.utils.exit(exit_status)

Exit the program entirely.

polyswarmclient.utils.check_response(response)

Check the status of responses from polyswarmd

Parameters

response – Response dict parsed from JSON from polyswarmd

Returns

True if successful else False

Return type

(bool)

polyswarmclient.utils.is_valid_ipfs_uri(ipfs_uri)

Ensure that a given ipfs_uri is valid by checking length and base58 encoding.

Parameters

ipfs_uri (str) – ipfs_uri to validate

Returns

is this valid?

Return type

bool

polyswarmclient.verifiers

Module Contents

polyswarmclient.verifiers.logger

polyswarmclient.verifiers.UNKNOWN_PARAMETER = XXX

class polyswarmclient.verifiers.DecodedTransaction(to, value, data, abi, signature, parameters)

This is a decoded representation of the transaction object returned by polyswarmd.

classmethod from_transaction(cls, transaction, abi)

Parse a transaction from data returned from polyswarmd.

Parameters

• transaction (dict) – Transaction to be simplified

• abi (str, list[str]) – ABI of the expected function call

Returns

If valid, returns a SimplifiedTransaction

Return type

DecodedTransaction

Raises

ValueError – If invalid transaction is provided

__repr__(self)

class polyswarmclient.verifiers.AbstractTransactionVerifier(parameters)

Verifier is used to verify the details of a single transaction.

ABI = ['', []]

verify(self, transaction)

Called when a list of transactions were returned from polyswarmd. This function will verify the transactions, and determines if the transactions are expected.

Parameters

transaction – Transaction representation returned from polyswarmd

Returns

True if valid and expected

__repr__(self)

class polyswarmclient.verifiers.NctApproveVerifier(amount)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['approve', ['address', 'uint256']]

verify(self, transaction)

class polyswarmclient.verifiers.NctTransferVerifier(amount)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['transfer', ['address', 'uint256']]

verify(self, transaction)

class polyswarmclient.verifiers.PostBountyVerifier(artifact_type, amount, artifact_uri, num_artifacts, duration, bloom)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['postBounty', ['uint128', 'uint256', 'uint256', 'string', 'uint256', 'uint256', 'uint256[8]']]

verify(self, transaction)

class polyswarmclient.verifiers.PostAssertionVerifier(bounty_guid, bid, mask, commitment)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['postAssertion', ['uint128', 'uint256', 'uint256', 'uint256']]

verify(self, transaction)

class polyswarmclient.verifiers.RevealAssertionVerifier(bounty_guid, index, nonce, verdicts, metadata)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['revealAssertion', ['uint128', 'uint256', 'uint256', 'uint256', 'string']]

verify(self, transaction)

class polyswarmclient.verifiers.PostVoteVerifier(bounty_guid, votes, valid_bloom)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['voteOnBounty', ['uint128', 'uint256', 'bool']]

verify(self, transaction)

class polyswarmclient.verifiers.SettleBountyVerifier(bounty_guid)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['settleBounty', ['uint128']]

verify(self, transaction)

class polyswarmclient.verifiers.StakingDepositVerifier(amount)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['deposit', ['uint256']]

verify(self, transaction)

class polyswarmclient.verifiers.StakingWithdrawVerifier(amount)

Bases: polyswarmclient.verifiers.AbstractTransactionVerifier

ABI = ['withdraw', ['uint256']]

verify(self, transaction)

Package Contents

class polyswarmclient.BalanceClient(client)

Bases: object

class polyswarmclient.BountiesClient(client)

Bases: object

class polyswarmclient.StakingClient(client)

Bases: object

class polyswarmclient.OffersClient(client)

Bases: object

OffersClient to handle offers. Presently stores a given client and parameters.

class polyswarmclient.RelayClient(client)

Bases: object

class polyswarmclient.NonceManager(client, chain)

Manages the nonce for some Ethereum chain

all_finished(self)

Check that all tasks have finished

mark_update_nonce(self)

Call this when the nonce is out of sync. This sets the update flag to true. The next acquire after being set will trigger an update

polyswarmclient.asyncio_join()

Gather all remaining tasks, assumes loop is not running

polyswarmclient.asyncio_stop()

Stop the main event loop

polyswarmclient.configure_event_loop()

polyswarmclient.exit(exit_status)

Exit the program entirely.

polyswarmclient.MAX_WAIT

polyswarmclient.check_response(response)

Check the status of responses from polyswarmd

Parameters

response – Response dict parsed from JSON from polyswarmd

Returns

True if successful else False

Return type

(bool)

polyswarmclient.is_valid_ipfs_uri(ipfs_uri)

Ensure that a given ipfs_uri is valid by checking length and base58 encoding.

Parameters

ipfs_uri (str) – ipfs_uri to validate

Returns

is this valid?

Return type

bool

polyswarmclient.logger

polyswarmclient.w3

polyswarmclient.REQUEST_TIMEOUT = 300.0

polyswarmclient.MAX_ARTIFACTS = 256

polyswarmclient.RATE_LIMIT_SLEEP = 2.0

class polyswarmclient.Client(polyswarmd_addr, keyfile, password, api_key=None, tx_error_fatal=False, insecure_transport=False)

Bases: object

Client to connected to a Ethereum wallet as well as a polyswarmd instance.

Parameters

• polyswarmd_addr (str) – URI of polyswarmd you are referring to.

• keyfile (str) – Keyfile filename.

• password (str) – Password associated with keyfile.

• api_key (str) – Your PolySwarm API key.

• tx_error_fatal (bool) – Transaction errors are fatal and exit the program

• insecure_transport (bool) – Allow insecure transport such as HTTP?

class __GetArtifacts(client, ipfs_uri, api_key=None)

Bases: object

run(self, chains=None)

Run the main event loop

Parameters

chains (set(str)) – Set of chains to operate on. Defaults to {‘home’, ‘side’}

sign_transactions(self, transactions)

Sign a set of transactions

Parameters

transactions (List[Transaction]) – The transactions to sign

Returns

The signed transactions

Return type

List[Transaction]

static to_wei(amount, unit='ether')

static from_wei(amount, unit='ether')

get_artifacts(self, ipfs_uri, api_key=None)

Get an iterator to return artifacts.

Parameters

• ipfs_uri (str) – URI where artificats are located

• api_key (str) – Override default API key

Returns

__GetArtifacts iterator

schedule(self, expiration, event, chain)

Schedule an event to execute on a particular block

Parameters

• expiration (int) – Which block to execute on

• event (Event) – Event to trigger on expiration block

• chain (str) – Which chain to operate on

ambassador

Submodules

ambassador.__main__

Module Contents

ambassador.__main__.logger

ambassador.__main__.choose_backend(backend)

Resolves amabassador name string to implementation

Parameters

backend (str) – Name of the backend to load, either one of the predefined implementations or the name of a module to load (module:ClassName syntax or default of module:Ambassador)

Returns

Ambassador class of the selected implementation

Return type

(Class)

Raises

(Exception) – If backend is not found

ambassador.__main__.main(log, client_log, polyswarmd_addr, keyfile, password, api_key, backend, testing, insecure_transport, chains, watchdog, log_format, submission_rate)

Entrypoint for the ambassador driver

Parameters

• log (str) – Logging level for all app logs

• client_log (str) – Logging level for all polyswarmclient logs

• polyswarmd_addr (str) – Address of polyswarmd

• keyfile (str) – Path to private key file to use to sign transactions

• password (str) – Password to decrypt the encrypted private key

• backend (str) – Backend implementation to use

• api_key (str) – API key to use with polyswarmd

• testing (int) – Mode to process N bounties then exit (optional)

• insecure_transport (bool) – Connect to polyswarmd without TLS

• chains (List[str]) – Chain(s) to operate on

• watchdog (int) – Number of blocks to look back and see if bounties are being submitted

• log_format (str) – Format to output logs in. text or json

ambassador.eicar

Module Contents

ambassador.eicar.logger

ambassador.eicar.EICAR

ambassador.eicar.NOT_EICAR = this is not malicious

ambassador.eicar.ARTIFACTS = [None, None]

ambassador.eicar.BOUNTY_TEST_DURATION_BLOCKS

class ambassador.eicar.Ambassador(client, testing=0, chains=None, watchdog=0, submission_rate=30)

Bases: polyswarmclient.abstractambassador.AbstractAmbassador

Ambassador which submits the EICAR test file

ambassador.filesystem

Module Contents

ambassador.filesystem.logger

ambassador.filesystem.ARTIFACT_DIRECTORY

ambassador.filesystem.ARTIFACT_BLACKLIST

ambassador.filesystem.BOUNTY_TEST_DURATION_BLOCKS

class ambassador.filesystem.Ambassador(client, testing=0, chains=None, watchdog=0, submission_rate=30)

Bases: polyswarmclient.abstractambassador.AbstractAmbassador

Ambassador which submits artifacts from a directory

microengine

Submodules

microengine.__main__

Module Contents

microengine.__main__.logger

microengine.__main__.choose_backend(backend)

Resolves microengine name string to implementation

Parameters

backend (str) – Name of the backend to load, either one of the predefined implementations or the name of a module to load (module:ClassName syntax or default of module:Microengine)

Returns

Microengine class of the selected implementation

Return type

(Class)

Raises

(Exception) – If backend is not found

microengine.__main__.main(log, client_log, polyswarmd_addr, keyfile, password, api_key, backend, testing, insecure_transport, chains, log_format, artifact_type)

Entrypoint for the microengine driver

Parameters

• log (str) – Logging level for all app logs

• client_log (str) – Logging level for all polyswarmclient logs

• polyswarmd_addr (str) – Address of polyswarmd

• keyfile (str) – Path to private key file to use to sign transactions

• password (str) – Password to decrypt the encrypted private key

• backend (str) – Backend implementation to use

• api_key (str) – API key to use with polyswarmd

• testing (int) – Mode to process N bounties then exit (optional)

• insecure_transport (bool) – Connect to polyswarmd without TLS

• chains (list[str]) – List of chains on which to scan artifacts

• log_format (str) – Format to output logs in. text or json

• artifact_type (list[str]) – List of artifact types to scan

microengine.clamav

Module Contents

microengine.clamav.logger

microengine.clamav.CLAMD_HOST

microengine.clamav.CLAMD_PORT

microengine.clamav.CLAMD_TIMEOUT = 30.0

class microengine.clamav.Scanner

Bases: polyswarmclient.abstractscanner.AbstractScanner

class microengine.clamav.Microengine(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractmicroengine.AbstractMicroengine

Microengine which scans samples through clamd.

Parameters

• client (Client) – Client to use

• testing (int) – How many test bounties to respond to

• chains (set[str]) – Chain(s) to operate on

microengine.eicar

Module Contents

microengine.eicar.logger

microengine.eicar.EICAR

class microengine.eicar.Scanner

Bases: polyswarmclient.abstractscanner.AbstractScanner

class microengine.eicar.Microengine(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractmicroengine.AbstractMicroengine

Microengine which tests for the EICAR test file.

Parameters

• client (Client) – Client to use

• testing (int) – How many test bounties to respond to

• chains (set[str]) – Chain(s) to operate on

microengine.multi

Module Contents

microengine.multi.logger

microengine.multi.BACKENDS

class microengine.multi.Scanner

Bases: polyswarmclient.abstractscanner.AbstractScanner

class microengine.multi.Microengine(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractmicroengine.AbstractMicroengine

Microengine which aggregates multiple sub-microengines

microengine.producer

Module Contents

microengine.producer.logger

microengine.producer.REDIS_ADDR

microengine.producer.QUEUE

microengine.producer.TIME_TO_POST_ASSERTION = 4

microengine.producer.KEY_TIMEOUT = 20

class microengine.producer.Microengine(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractmicroengine.AbstractMicroengine

microengine.scratch

Module Contents

microengine.scratch.logger

class microengine.scratch.Scanner

Bases: polyswarmclient.abstractscanner.AbstractScanner

class microengine.scratch.Microengine(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractmicroengine.AbstractMicroengine

Scratch microengine is the same as the default behavior.

Parameters

• client (Client) – Client to use

• testing (int) – How many test bounties to respond to

• chains (set[str]) – Chain(s) to operate on

microengine.yara

Module Contents

microengine.yara.logger

microengine.yara.RULES_DIR

class microengine.yara.Scanner

Bases: polyswarmclient.abstractscanner.AbstractScanner

class microengine.yara.Microengine(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractmicroengine.AbstractMicroengine

Microengine which matches samples against yara rules

arbiter

Subpackages

arbiter.verbatimdb

Submodules

arbiter.verbatimdb.__main__

Module Contents

arbiter.verbatimdb.__main__.main(malicious, benign, output, log_format)

arbiter.verbatimdb.db

Module Contents

arbiter.verbatimdb.db.generate_db(db_file, malicious_dir, benign_dir)

arbiter.verbatimdb.db.insert(cursor, path, result)

Submodules

arbiter.__main__

Module Contents

arbiter.__main__.logger

arbiter.__main__.choose_backend(backend)

Resolves arbiter name string to implementation

Parameters

backend (str) – Name of the backend to load, either one of the predefined implementations or the name of a module to load (module:ClassName syntax or default of module:Arbiter)

Returns

Arbiter class of the selected implementation

Return type

(Class)

Raises

(Exception) – If backend is not found

arbiter.__main__.main(log, client_log, polyswarmd_addr, keyfile, password, api_key, backend, testing, insecure_transport, chains, log_format, artifact_type)

Entrypoint for the arbiter driver

Parameters

• log (str) – Logging level for all app logs

• client_log (str) – Logging level for all polyswarmclient logs

• polyswarmd_addr (str) – Address of polyswarmd

• keyfile (str) – Path to private key file to use to sign transactions

• password (str) – Password to decrypt the encrypted private key

• backend (str) – Backend implementation to use

• api_key (str) – API key to use with polyswarmd

• testing (int) – Mode to process N bounties then exit (optional)

• insecure_transport (bool) – Connect to polyswarmd without TLS

• chains (List[str]) – Chain(s) to operate on

• log_format (str) – Format to output logs in. text or json

• artifact_type (list[str]) – List of artifact types to scan

arbiter.clamav

Module Contents

arbiter.clamav.logger

class arbiter.clamav.Arbiter(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractarbiter.AbstractArbiter

Arbiter which scans samples through clamd.

Re-uses the scanner from the clamav microengine

Parameters

• client (Client) – Client to use

• testing (int) – How many test bounties to respond to

• chains (set[str]) – Chain(s) to operate on

arbiter.producer

Module Contents

arbiter.producer.logger

arbiter.producer.REDIS_ADDR

arbiter.producer.QUEUE

arbiter.producer.TIME_TO_POST_VOTE = 4

class arbiter.producer.Arbiter(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractarbiter.AbstractArbiter

arbiter.verbatim

Module Contents

arbiter.verbatim.logger

arbiter.verbatim.ARTIFACT_DIRECTORY

arbiter.verbatim.EICAR

class arbiter.verbatim.Arbiter(client, testing=0, scanner=None, chains=None, artifact_types=None)

Bases: polyswarmclient.abstractarbiter.AbstractArbiter

Arbiter which matches hashes to a database of known samples

worker

Submodules

worker.__main__

Module Contents

worker.__main__.logger

worker.__main__.choose_backend(backend)

Resolves scanner name string to implementation

Parameters

• backend (str) – Name of the backend to load, either one of the predefined implementations or the name of a module

• load (to) –

• (module – ClassName syntax or default of module:Scanner)

Returns

Scanner class of the selected implementation

Return type

(Class)

Raises

(Exception) – If backend is not found

worker.__main__.main(log, client_log, redis_addr, queue, backend, tasks, download_limit, scan_limit, api_key, testing, log_format)

Entrypoint for the worker driver

Parameters

• log (str) – Logging level for all app logs

• client_log (str) – Logging level for all polyswarmclient logs

• redis_addr (str) – Address of redis

• backend (str) – Backend implementation to use

• queue (str) – Name of queue to listen on

• tasks (int) – Number of simultaneous tasks this worker runs

• download_limit (int) – Number of simultaneous downloads this worker can handle

• scan_limit (int) – Number of simultaneous scans this worker can handle

• api_key (str) – API key to use with polyswarmd

• testing (int) – Mode to process N bounties then exit (optional)

• log_format (str) – Format to output logs in. text or json

Package Contents

worker.logger

worker.REQUEST_TIMEOUT = 5.0

exception worker.ApiKeyException

Bases: Exception

exception worker.ExpiredException

Bases: Exception

class worker.Worker(redis_addr, queue, task_count=1, download_limit=1, scan_limit=1, api_key=None, testing=0, scanner=None)

Bases: object

run(self)

1

Created with sphinx-autoapi

polyswarm-client is a convenient library on which to build PolySwarm market participants.

Here you’ll find auto-generated documentation based on the polyswarm-client source code.

Consulting these low level details is unnecessary for developing a successful PolySwarm participant. Most users will instead want to consult the PolySwarm Documentation.

Developers interested in low level polyswarm-client details can do so by navigating to “API Reference” on the left.