Package: ensauction
Access the Ethereum Name Service Auction using this python library.
Note:this is a work in progressUsing this library is not a way to skip learning how ENS works. If you
are registering a name, a small misunderstanding can cause you to loseallyour deposit. Goread about
ENSfirst. Your
funds are your responsibility.Beta-quality warningThis is a preview for developers, and an invitation for contributions.
Please do not use this in production until this warning is removed,
especially when putting funds at risk. Examples of funds being at risk
include: sending ether/tokens to resolved addresses and participating in
name auctions.If you supply the a domain with typebytes, it will be assumed to be
UTF-8 encoded, like inEthereum
contracts.Setuppip install ensauctionAny issues? SeeSetup detailsUsageAll examples in Python 3Auctions for names ending in .ethGet auction statusExample with domain ‘payment.eth’:fromensauction.autoimportethnamesfromensauction.registrarimportStatusstatus=ethnames.status('payment.eth')If you get an error here, like: > UnhandledRequest: No providers
responded to the RPC request:method:eth_getBlockByNumberparams:[‘latest’, False]Then you are not connected to your node. See belowhow to manually
connect to your node.Otherwise, continue…# if you forget to strip out .eth, ens.py will do it for youassertethnames.status('payment')==status# these are the possible statusesassertstatusin(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 directlyassertStatus.Owned==2Start 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 auctionBid on a ‘trading.eth’ with 5211 ETH, and secret “I promise I will not
forget my secret”:fromweb3.autoimportw3ethnames.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 bidYou mustalwaysreveal 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 wonaka “Finalize” auction, which makes you the owner in ENS.ethnames.finalize('gambling')Get detailed information on an auctionFind out the owner of the auction Deed – seedocs on the
differencebetween owning the name and the deeddeed=ethnames.deed('ethfinex')assertdeed.owner()=='0x9A02ed4Ca9AD55b75fF9A05DeBb36D5eb382E184'When was the auction completed? (a timezone-aware datetime object)close_datetime=ethnames.close_at('ethfinex')assertstr(close_datetime)=='2017-06-05 08:10:03+00:00'How much is held on deposit?fromdecimalimportDecimalfromweb3importWeb3deposit=ethnames.deposit('ethfinex')assertWeb3.fromWei(deposit,'ether')==Decimal('0.01')What was the highest bid?top_bid=ethnames.top_bid('ethfinex')assertWeb3.fromWei(top_bid,'ether')==Decimal('201709.02')Setup detailsIf Python 2 is your default, or you’re not sureIn your shellif pip --version | grep "python 2"; then
  python3 -m venv ~/.py3venv
  source ~/.py3venv/bin/activate
fiNow, with Python 3In your shell:pip install ensauctionensauction.pyrequires an up-to-date Ethereum blockchain, preferably
local. If your setup isn’t working, try runninggeth--fastuntil
it’s fully-synced. I highly recommend using the default IPC
communication method, for speed and security.“No matching distribution found for ensauction”If you are seeing something like:Collecting ensauction
  Could not find a version that satisfies the requirement ensauction (from versions: )
No matching distribution found for ensauctionIt is most likely that you are in Python 2. Retry the first Setup
section, to make sure you’re in Python 3Use a custom web3 providerIn Python:from ensauction.registrar import Registrar
from ens import ENS
from web3 import IPCProvider

ns = ENS(IPCProvider('/your/custom/ipc/path'))
reg = Registrar(ns)Developer Setupgit clone git@github.com:carver/ensauction.py.git
cd ensauction.py/

python3 -m venv venv
. venv/bin/activate

pip install -e .
pip install -r requirements-dev.txtTesting SetupRe-run flake on file changes:$ when-changed -s -1 -r ensauction/ tests/ -c "clear; echo; echo \"running flake - $(date)\"; warn()
{
notify-send -t 5000 'Flake8 failure ⚠⚠⚠⚠⚠' 'flake8 on ensauction.py failed'
}
if ! git diff | flake8 --diff | grep "\.py"; then if ! flake8 ensauction/ tests/; then warn; fi else warn; fi; echo done"Why does ensauction.py require python 3?Short versionIt turns out that the distinction betweenstrandbytesis
important. If you want to write code for the future (Ethereum), don’t
use a language from the past.Long versionInteracting with the EVM requires clarity on the bits you’re using. For
example, a sha3 hash expects to receive a series of bytes to process.
Calculating the sha3 hash of a string is (or should be) a Type Error;
the hash algorithm doesn’t know what to do with a series of characters,
aka Unicode code points. As the caller, you need to know which thing
you’re calculating the hash of: 1. a series of bytes:b'[c$o!\x91\xf1\x8f&u\xce\xdb\x8b(\x10.\x95tX'2. the bytes
represented by a string in hex format:'0x5b2063246f2191f18f2675cedb8b28102e957458'3. the bytes generated
by encoding a string using utf-8:Oops, the bytes from #1 cannot be
read using utf-8!4. the bytes generated by encoding a string using
utf-16:'⁛④Ⅿ\uf191⚏칵诛ဨ键塴'Python 3 doesn’t let you ignore a lot of these details. That’s good,
because precision in dealing with the EVM is critical.If you are resistant – I get it, I’ve been there. It is not intuitive
for most people. But it’s seriously worth it tolearn about
encodingif you’re going to develop on top of Ethereum. Your ETH depends on it!Release setupFor Debian-like systems:apt install pandocTo release a new version:makereleasebump=$$VERSION_PART_TO_BUMP$$How to bumpversionThe version format for this repo is{major}.{minor}.{patch}for
stable, and{major}.{minor}.{patch}-{stage}.{devnum}for unstable
(stagecan be alpha or beta).To issue the next version in line, specify which part to bump, likemake release bump=minorormake release bump=devnum.If you are in a beta version,make release bump=stagewill switch to
a stable.To issue an unstable version when the current version is stable, specify
the new version explicitly, likemake releasebump="--new-version4.0.0-alpha.1devnum"