polyswarmclient

Subpackages

• polyswarmclient.ethereum
  • polyswarmclient.ethereum.bountiesclient
    • polyswarmclient.ethereum.bountiesclient.base
    • polyswarmclient.ethereum.bountiesclient.transaction
  • polyswarmclient.ethereum.transaction
    • polyswarmclient.ethereum.transaction.base
    • polyswarmclient.ethereum.transaction.noncemanager
  • polyswarmclient.ethereum.balanceclient
  • polyswarmclient.ethereum.bloom
  • polyswarmclient.ethereum.offersclient
  • polyswarmclient.ethereum.relayclient
  • polyswarmclient.ethereum.stakingclient
  • polyswarmclient.ethereum.verifiers
• polyswarmclient.fast
  • polyswarmclient.fast.balanceclient
  • polyswarmclient.fast.bountiesclient
  • polyswarmclient.fast.offersclient
  • polyswarmclient.fast.relayclient
  • polyswarmclient.fast.stakingclient
  • polyswarmclient.fast.transaction
• polyswarmclient.filters
  • polyswarmclient.filters.bountyfilter
  • polyswarmclient.filters.confidencefilter
  • polyswarmclient.filters.filter
• polyswarmclient.liveness
  • polyswarmclient.liveness.exceptions
  • polyswarmclient.liveness.liveness
  • polyswarmclient.liveness.local
• polyswarmclient.producer
  • polyswarmclient.producer.base
  • polyswarmclient.producer.job
  • polyswarmclient.producer.jobprocessor
• polyswarmclient.ratelimit
  • polyswarmclient.ratelimit.abstractratelimit
  • polyswarmclient.ratelimit.redis

Submodules

• polyswarmclient.abstractambassador
• polyswarmclient.abstractarbiter
• polyswarmclient.abstractmicroengine
• polyswarmclient.abstractscanner
• polyswarmclient.backoff_wrapper
• polyswarmclient.bidstrategy
• polyswarmclient.config
• polyswarmclient.corpus
• polyswarmclient.events
• polyswarmclient.exceptions
• polyswarmclient.log_formatter
• polyswarmclient.parameters
• polyswarmclient.request_rate_limit
• polyswarmclient.utils

Package Contents

class polyswarmclient.BidStrategyBase(min_bid_multiplier=None, max_bid_multiplier=None)

class polyswarmclient.NonceManager(client, chain)

Manages the nonce for some Ethereum chain

static find_gaps(nonces)

Finds any gaps between base nonce and the last nonce in the given nonces list.

Parameters

nonces (list[int]) – list of nonces being checked

Returns

(list[int]): Any missing nonces between base_nonce and the last given nonce

exception polyswarmclient.RateLimitedError

Bases: polyswarmclient.exceptions.PolyswarmClientException

Hit the rate limit from polyswarmd

class polyswarmclient.LocalLivenessRecorder

Bases: polyswarmclient.liveness.liveness.LivenessRecorder

Record liveness data in a tempfile

write_sync(self, content)

Write the given content to the file at the given path.

Parameters

content – content to write into the file

class polyswarmclient.BackoffWrapper(func, **kwargs)

Uses a generator to create backoff times

This is for use in functions that don’t return. In our use case, listen_for_events is not supposed to return, but exists as a long running Task. Using the decorator, the backoff time grows forever, because the function is only called one time. So each error causes a longer and longer timeout.

This adds an ability to reset the backoff, so your long running function can reduce the timeout after success

reset(self)

class polyswarmclient.RequestRateLimit(event, lock)

polyswarmclient.logger

polyswarmclient.MAX_ARTIFACTS = 256

polyswarmclient.RATE_LIMIT_SLEEP = 2.0

polyswarmclient.MAX_BACKOFF = 32

class polyswarmclient.Client(polyswarmd_addr, keyfile, password, api_key=None, tx_error_fatal=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?

run(self, chains=None)

Run the main event loop

Parameters

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

clear_sub_clients(self)

create_ethereum_sub_clients(self, chains)

create_fast_sub_clients(self, chains)

static to_wei(amount, unit='ether')

static from_wei(amount, unit='ether')

static _check_status_for_rate_limit(status)

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