ensauction 0.1.0a1

Get auction status

Example with domain ‘payment.eth’:

from ensauction.auto import ethnames
from ensauction.registrar import Status

status = ethnames.status('payment.eth')

Then you are not connected to your node. See below how to manually connect to your node.

Otherwise, continue…

# if you forget to strip out .eth, ens.py will do it for you
assert ethnames.status('payment') == status

# these are the possible statuses

assert status in (
  Status.Open,
  Status.Auctioning,
  Status.Owned,
  Status.Forbidden,
  Status.Revealing,
  Status.NotYetAvailable
  )


# if you get the integer status from another source, you can compare it directly

assert Status.Owned == 2

Start auctions

# start one auction (which tips people off that you're interested)

ethnames.start('you_saw_him_repressin_me_didnt_ya')


# start many auctions (which provides a bit of cover)

ethnames.start(['exchange', 'tickets', 'payment', 'trading', 'registry'])

Bid on auction

Bid on a ‘trading.eth’ with 5211 ETH, and secret “I promise I will not forget my secret”:

from web3.auto import w3

ethnames.bid(
      'trading',
      Web3.toWei('5211', 'ether'),
      "I promise I will not forget my secret",
      transact={'from': w3.eth.accounts[0]}
      )

(if you want to “mask” your bid, set a higher value in the transact dict)

Reveal your bid

You must always reveal your bid, whether you won or lost. Otherwise you will lose the full deposit.

Example of revealing your bid on ‘registry.eth’ with 0.01 ETH, and secret “For real, though: losing your secret means losing ether”:

ethnames.reveal(
      'registry',
      Web3.toWei('0.01', 'ether'),
      "For real, though: losing your secret means losing ether",
      transact={'from': w3.eth.accounts[0]}
      )

Claim the name you won

aka “Finalize” auction, which makes you the owner in ENS.

ethnames.finalize('gambling')

Get detailed information on an auction

Find out the owner of the auction Deed – see docs on the difference between owning the name and the deed

deed = ethnames.deed('ethfinex')

assert deed.owner() == '0x9A02ed4Ca9AD55b75fF9A05DeBb36D5eb382E184'

When was the auction completed? (a timezone-aware datetime object)

close_datetime = ethnames.close_at('ethfinex')

assert str(close_datetime) == '2017-06-05 08:10:03+00:00'

How much is held on deposit?

from decimal import Decimal
from web3 import Web3

deposit = ethnames.deposit('ethfinex')

assert Web3.fromWei(deposit, 'ether') == Decimal('0.01')

What was the highest bid?

top_bid = ethnames.top_bid('ethfinex')

assert Web3.fromWei(top_bid, 'ether') == Decimal('201709.02')

How to bumpversion

The version format for this repo is {major}.{minor}.{patch} for stable, and {major}.{minor}.{patch}-{stage}.{devnum} for unstable (stage can be alpha or beta).

To issue the next version in line, specify which part to bump, like make release bump=minor or make release bump=devnum.

If you are in a beta version, make release bump=stage will switch to a stable.

To issue an unstable version when the current version is stable, specify the new version explicitly, like make release bump="--new-version 4.0.0-alpha.1 devnum"