def main():
parser = OptionParser(
usage=
'usage: %prog [options] [txid:n]',
description="Adds one or more utxos to the list that can be used to make "
"commitments for anti-snooping. Note that this utxo, and its "
"PUBkey, will be revealed to makers, so consider the privacy "
"implication. "
"It may be useful to those who are having trouble making "
"coinjoins due to several unsuccessful attempts (especially "
"if your joinmarket wallet is new). "
"'Utxo' means unspent transaction output, it must not "
"already be spent. "
"The options -w, -r and -R offer ways to load these utxos "
"from a file or wallet. "
"If you enter a single utxo without these options, you will be "
"prompted to enter the private key here - it must be in "
"WIF compressed format. "
"BE CAREFUL about handling private keys! "
"Don't do this in insecure environments. "
"Also note this ONLY works for standard (p2pkh) utxos."
)
parser.add_option(
'-r',
'--read-from-file',
action='store',
type='str',
dest='in_file',
help='name of plain text csv file containing utxos, one per line, format: '
'txid:N, WIF-compressed-privkey'
)
parser.add_option(
'-R',
'--read-from-json',
action='store',
type='str',
dest='in_json',
help='name of json formatted file containing utxos with private keys, as '
'output from "python wallet-tool.py -u -p walletname showutxos"'
)
parser.add_option(
'-w',
'--load-wallet',
action='store',
type='str',
dest='loadwallet',
help='name of wallet from which to load utxos and use as commitments.'
)
parser.add_option(
'-g',
'--gap-limit',
action='store',
type='int',
dest='gaplimit',
default = 6,
help='Only to be used with -w; gap limit for Joinmarket wallet, default 6.'
)
parser.add_option(
'-M',
'--max-mixdepth',
action='store',
type='int',
dest='maxmixdepth',
default=5,
help='Only to be used with -w; number of mixdepths for wallet, default 5.'
)
parser.add_option(
'-d',
'--delete-external',
action='store_true',
dest='delete_ext',
help='deletes the current list of external commitment utxos',
default=False
)
parser.add_option(
'-v',
'--validate-utxos',
action='store_true',
dest='validate',
help='validate the utxos and pubkeys provided against the blockchain',
default=False
)
parser.add_option(
'-o',
'--validate-only',
action='store_true',
dest='vonly',
help='only validate the provided utxos (file or command line), not add',
default=False
)
(options, args) = parser.parse_args()
load_program_config()
utxo_data = []
if options.delete_ext:
other = options.in_file or options.in_json or options.loadwallet
if len(args) > 0 or other:
if raw_input("You have chosen to delete commitments, other arguments "
"will be ignored; continue? (y/n)") != 'y':
print "Quitting"
sys.exit(0)
c, e = btc.get_podle_commitments()
print pformat(e)
if raw_input(
"You will remove the above commitments; are you sure? (y/n): ") != 'y':
print "Quitting"
sys.exit(0)
btc.update_commitments(external_to_remove=e)
print "Commitments deleted."
sys.exit(0)
#Three options (-w, -r, -R) for loading utxo and privkey pairs from a wallet,
#csv file or json file.
if options.loadwallet:
os.chdir('..') #yuck (see earlier comment about package)
wallet = Wallet(options.loadwallet,
options.maxmixdepth,
options.gaplimit)
os.chdir(os.path.join(os.getcwd(), 'cmttools'))
jm_single().bc_interface.sync_wallet(wallet)
unsp = {}
for u, av in wallet.unspent.iteritems():
addr = av['address']
key = wallet.get_key_from_addr(addr)
wifkey = btc.wif_compressed_privkey(key, vbyte=get_p2pk_vbyte())
unsp[u] = {'address': av['address'],
'value': av['value'], 'privkey': wifkey}
for u, pva in unsp.iteritems():
utxo_data.append((u, pva['privkey']))
elif options.in_file:
with open(options.in_file, "rb") as f:
utxo_info = f.readlines()
for ul in utxo_info:
ul = ul.rstrip()
if ul:
u, priv = get_utxo_info(ul)
if not u:
quit(parser, "Failed to parse utxo info: " + str(ul))
utxo_data.append((u, priv))
elif options.in_json:
if not os.path.isfile(options.in_json):
print "File: " + options.in_json + " not found."
sys.exit(0)
with open(options.in_json, "rb") as f:
try:
utxo_json = json.loads(f.read())
except:
print "Failed to read json from " + options.in_json
sys.exit(0)
for u, pva in utxo_json.iteritems():
utxo_data.append((u, pva['privkey']))
elif len(args) == 1:
u = args[0]
priv = raw_input(
'input private key for ' + u + ', in WIF compressed format : ')
u, priv = get_utxo_info(','.join([u, priv]))
if not u:
quit(parser, "Failed to parse utxo info: " + u)
utxo_data.append((u, priv))
else:
quit(parser, 'Invalid syntax')
if options.validate or options.vonly:
if not validate_utxo_data(utxo_data):
quit(parser, "Utxos did not validate, quitting")
if options.vonly:
sys.exit(0)
#We are adding utxos to the external list
assert len(utxo_data)
add_external_commitments(utxo_data)
def test_tx_commitments_used(setup_podle, consume_tx, age_required, cmt_age):
tries = jm_single().config.getint("POLICY","taker_utxo_retries")
#remember and reset at the end
taker_utxo_age = jm_single().config.getint("POLICY", "taker_utxo_age")
jm_single().config.set("POLICY", "taker_utxo_age", str(age_required))
#Don't want to wait too long, but must account for possible
#throttling with !auth
jm_single().maker_timeout_sec = 12
amount = 0
wallets = make_wallets(3,
wallet_structures=[[1,2,1,0,0],[1,2,0,0,0],[2,2,1,0,0]],
mean_amt=1)
#the sendpayment bot uses the last wallet in the list
wallet = wallets[2]['wallet']
#make_wallets calls grab_coins which mines 1 block per individual payout,
#so the age of the coins depends on where they are in that list. The sendpayment
#is the last wallet in the list, and we choose the non-tx utxos which are in
#mixdepth 1 and 2 (2 and 1 utxos in each respectively). We filter for those
#that have sufficient age, so to get 1 which is old enough, it will be the oldest,
#which will have an age of 2 + 1 (the first utxo spent to that wallet).
#So if we need an age of 6, we need to mine 3 more blocks.
blocks_reqd = cmt_age - 3
jm_single().bc_interface.tick_forward_chain(blocks_reqd)
yigen_procs = []
for i in range(2):
ygp = local_command([python_cmd, yg_cmd,\
str(wallets[i]['seed'])], bg=True)
time.sleep(2) #give it a chance
yigen_procs.append(ygp)
time.sleep(5)
destaddr = btc.privkey_to_address(
binascii.hexlify(os.urandom(32)),
magicbyte=get_p2pk_vbyte())
addr_valid, errormsg = validate_address(destaddr)
assert addr_valid, "Invalid destination address: " + destaddr + \
", error message: " + errormsg
log.debug('starting sendpayment')
jm_single().bc_interface.sync_wallet(wallet)
log.debug("Here is the whole wallet: \n" + str(wallet.unspent))
#Trigger PING LAG sending artificially
joinmarket.irc.PING_INTERVAL = 3
mcs = [IRCMessageChannel(c) for c in get_irc_mchannels()]
mcc = MessageChannelCollection(mcs)
if consume_tx:
#add all utxo in mixdepth 0 to 'used' list of commitments,
utxos = wallet.get_utxos_by_mixdepth()[0]
for u, addrval in utxos.iteritems():
priv = wallet.get_key_from_addr(addrval['address'])
podle = btc.PoDLE(u, priv)
for i in range(tries):
#loop because we want to use up all retries of this utxo
commitment = podle.generate_podle(i)['commit']
btc.update_commitments(commitment=commitment)
#Now test a sendpayment from mixdepth 0 with all the depth 0 utxos
#used up, so that the other utxos in the wallet get used.
taker = sendpayment.SendPayment(mcc, wallet, destaddr, amount, 2,
5000, 3, 0, True,
weighted_order_choose)
try:
log.debug('starting message channels')
mcc.run()
finally:
if any(yigen_procs):
for ygp in yigen_procs:
#NB *GENTLE* shutdown is essential for
#test coverage reporting!
ygp.send_signal(signal.SIGINT)
ygp.wait()
#wait for block generation
time.sleep(5)
received = jm_single().bc_interface.get_received_by_addr(
[destaddr], None)['data'][0]['balance']
jm_single().config.set("POLICY", "taker_utxo_age", str(taker_utxo_age))
if cmt_age < age_required:
assert received == 0, "Coins arrived but shouldn't"
else:
assert received != 0, "sendpayment failed - coins not arrived, " +\
"received: " + str(received)
def test_tx_commitments_used(setup_podle, consume_tx, age_required, cmt_age):
tries = jm_single().config.getint("POLICY", "taker_utxo_retries")
#remember and reset at the end
taker_utxo_age = jm_single().config.getint("POLICY", "taker_utxo_age")
jm_single().config.set("POLICY", "taker_utxo_age", str(age_required))
#Don't want to wait too long, but must account for possible
#throttling with !auth
jm_single().maker_timeout_sec = 12
amount = 0
wallets = make_wallets(3,
wallet_structures=[[1, 2, 1, 0, 0], [1, 2, 0, 0, 0],
[2, 2, 1, 0, 0]],
mean_amt=1)
#the sendpayment bot uses the last wallet in the list
wallet = wallets[2]['wallet']
#make_wallets calls grab_coins which mines 1 block per individual payout,
#so the age of the coins depends on where they are in that list. The sendpayment
#is the last wallet in the list, and we choose the non-tx utxos which are in
#mixdepth 1 and 2 (2 and 1 utxos in each respectively). We filter for those
#that have sufficient age, so to get 1 which is old enough, it will be the oldest,
#which will have an age of 2 + 1 (the first utxo spent to that wallet).
#So if we need an age of 6, we need to mine 3 more blocks.
blocks_reqd = cmt_age - 3
jm_single().bc_interface.tick_forward_chain(blocks_reqd)
yigen_procs = []
for i in range(2):
ygp = local_command([python_cmd, yg_cmd,\
str(wallets[i]['seed'])], bg=True)
time.sleep(2) #give it a chance
yigen_procs.append(ygp)
time.sleep(5)
destaddr = btc.privkey_to_address(binascii.hexlify(os.urandom(32)),
magicbyte=get_p2pk_vbyte())
addr_valid, errormsg = validate_address(destaddr)
assert addr_valid, "Invalid destination address: " + destaddr + \
", error message: " + errormsg
log.debug('starting sendpayment')
jm_single().bc_interface.sync_wallet(wallet)
log.debug("Here is the whole wallet: \n" + str(wallet.unspent))
#Trigger PING LAG sending artificially
joinmarket.irc.PING_INTERVAL = 3
mcs = [IRCMessageChannel(c) for c in get_irc_mchannels()]
mcc = MessageChannelCollection(mcs)
if consume_tx:
#add all utxo in mixdepth 0 to 'used' list of commitments,
utxos = wallet.get_utxos_by_mixdepth()[0]
for u, addrval in utxos.iteritems():
priv = wallet.get_key_from_addr(addrval['address'])
podle = btc.PoDLE(u, priv)
for i in range(tries):
#loop because we want to use up all retries of this utxo
commitment = podle.generate_podle(i)['commit']
btc.update_commitments(commitment=commitment)
#Now test a sendpayment from mixdepth 0 with all the depth 0 utxos
#used up, so that the other utxos in the wallet get used.
taker = sendpayment.SendPayment(mcc, wallet, destaddr, amount, 2, 5000, 3,
0, True, weighted_order_choose)
try:
log.debug('starting message channels')
mcc.run()
finally:
if any(yigen_procs):
for ygp in yigen_procs:
#NB *GENTLE* shutdown is essential for
#test coverage reporting!
ygp.send_signal(signal.SIGINT)
ygp.wait()
#wait for block generation
time.sleep(5)
received = jm_single().bc_interface.get_received_by_addr(
[destaddr], None)['data'][0]['balance']
jm_single().config.set("POLICY", "taker_utxo_age", str(taker_utxo_age))
if cmt_age < age_required:
assert received == 0, "Coins arrived but shouldn't"
else:
assert received != 0, "sendpayment failed - coins not arrived, " +\
"received: " + str(received)
def test_external_commitment_used(setup_podle):
tries = jm_single().config.getint("POLICY","taker_utxo_retries")
#Don't want to wait too long, but must account for possible
#throttling with !auth
jm_single().maker_timeout_sec = 12
amount = 50000000
wallets = make_wallets(3,
wallet_structures=[[1,0,0,0,0],[1,0,0,0,0],[1,1,0,0,0]],
mean_amt=1)
#the sendpayment bot uses the last wallet in the list
wallet = wallets[2]['wallet']
yigen_procs = []
for i in range(2):
ygp = local_command([python_cmd, yg_cmd,\
str(wallets[i]['seed'])], bg=True)
time.sleep(2) #give it a chance
yigen_procs.append(ygp)
#A significant delay is needed to wait for the yield generators to sync
time.sleep(10)
destaddr = btc.privkey_to_address(
binascii.hexlify(os.urandom(32)),
magicbyte=get_p2pk_vbyte())
addr_valid, errormsg = validate_address(destaddr)
assert addr_valid, "Invalid destination address: " + destaddr + \
", error message: " + errormsg
log.debug('starting sendpayment')
jm_single().bc_interface.sync_wallet(wallet)
#Trigger PING LAG sending artificially
joinmarket.irc.PING_INTERVAL = 3
mcs = [IRCMessageChannel(c) for c in get_irc_mchannels()]
mcc = MessageChannelCollection(mcs)
#add all utxo in mixdepth 0 to 'used' list of commitments,
utxos = wallet.get_utxos_by_mixdepth()[0]
for u, addrval in utxos.iteritems():
priv = wallet.get_key_from_addr(addrval['address'])
podle = btc.PoDLE(u, priv)
for i in range(tries):
#loop because we want to use up all retries of this utxo
commitment = podle.generate_podle(i)['commit']
btc.update_commitments(commitment=commitment)
#create a new utxo, notionally from an external source; to make life a little
#easier we'll pay to another mixdepth, but this is OK because
#taker does not source from here currently, only from the utxos chosen
#for the transaction, not the whole wallet. So we can treat it as if
#external (don't access its privkey).
utxos = wallet.get_utxos_by_mixdepth()[1]
ecs = {}
for u, addrval in utxos.iteritems():
priv = wallet.get_key_from_addr(addrval['address'])
ecs[u] = {}
ecs[u]['reveal']={}
for j in range(tries):
P, P2, s, e, commit = generate_single_podle_sig(
binascii.unhexlify(priv), j)
if 'P' not in ecs[u]:
ecs[u]['P'] = P
ecs[u]['reveal'][j] = {'P2':P2, 's':s, 'e':e}
btc.update_commitments(external_to_add=ecs)
#Now the conditions described above hold. We do a normal single
#sendpayment.
taker = sendpayment.SendPayment(mcc, wallet, destaddr, amount, 2,
5000, 3, 0, True,
weighted_order_choose)
try:
log.debug('starting message channels')
mcc.run()
finally:
if any(yigen_procs):
for ygp in yigen_procs:
#NB *GENTLE* shutdown is essential for
#test coverage reporting!
ygp.send_signal(signal.SIGINT)
ygp.wait()
#wait for block generation
time.sleep(5)
received = jm_single().bc_interface.get_received_by_addr(
[destaddr], None)['data'][0]['balance']
assert received == amount, "sendpayment failed - coins not arrived, " +\
"received: " + str(received)
#Cleanup - remove the external commitments added
btc.update_commitments(external_to_remove=ecs)
def test_external_commitment_used(setup_podle):
tries = jm_single().config.getint("POLICY", "taker_utxo_retries")
#Don't want to wait too long, but must account for possible
#throttling with !auth
jm_single().maker_timeout_sec = 12
amount = 50000000
wallets = make_wallets(3,
wallet_structures=[[1, 0, 0, 0, 0], [1, 0, 0, 0, 0],
[1, 1, 0, 0, 0]],
mean_amt=1)
#the sendpayment bot uses the last wallet in the list
wallet = wallets[2]['wallet']
yigen_procs = []
for i in range(2):
ygp = local_command([python_cmd, yg_cmd,\
str(wallets[i]['seed'])], bg=True)
time.sleep(2) #give it a chance
yigen_procs.append(ygp)
#A significant delay is needed to wait for the yield generators to sync
time.sleep(10)
destaddr = btc.privkey_to_address(binascii.hexlify(os.urandom(32)),
magicbyte=get_p2pk_vbyte())
addr_valid, errormsg = validate_address(destaddr)
assert addr_valid, "Invalid destination address: " + destaddr + \
", error message: " + errormsg
log.debug('starting sendpayment')
jm_single().bc_interface.sync_wallet(wallet)
#Trigger PING LAG sending artificially
joinmarket.irc.PING_INTERVAL = 3
mcs = [IRCMessageChannel(c) for c in get_irc_mchannels()]
mcc = MessageChannelCollection(mcs)
#add all utxo in mixdepth 0 to 'used' list of commitments,
utxos = wallet.get_utxos_by_mixdepth()[0]
for u, addrval in utxos.iteritems():
priv = wallet.get_key_from_addr(addrval['address'])
podle = btc.PoDLE(u, priv)
for i in range(tries):
#loop because we want to use up all retries of this utxo
commitment = podle.generate_podle(i)['commit']
btc.update_commitments(commitment=commitment)
#create a new utxo, notionally from an external source; to make life a little
#easier we'll pay to another mixdepth, but this is OK because
#taker does not source from here currently, only from the utxos chosen
#for the transaction, not the whole wallet. So we can treat it as if
#external (don't access its privkey).
utxos = wallet.get_utxos_by_mixdepth()[1]
ecs = {}
for u, addrval in utxos.iteritems():
priv = wallet.get_key_from_addr(addrval['address'])
ecs[u] = {}
ecs[u]['reveal'] = {}
for j in range(tries):
P, P2, s, e, commit = generate_single_podle_sig(
binascii.unhexlify(priv), j)
if 'P' not in ecs[u]:
ecs[u]['P'] = P
ecs[u]['reveal'][j] = {'P2': P2, 's': s, 'e': e}
btc.update_commitments(external_to_add=ecs)
#Now the conditions described above hold. We do a normal single
#sendpayment.
taker = sendpayment.SendPayment(mcc, wallet, destaddr, amount, 2, 5000, 3,
0, True, weighted_order_choose)
try:
log.debug('starting message channels')
mcc.run()
finally:
if any(yigen_procs):
for ygp in yigen_procs:
#NB *GENTLE* shutdown is essential for
#test coverage reporting!
ygp.send_signal(signal.SIGINT)
ygp.wait()
#wait for block generation
time.sleep(5)
received = jm_single().bc_interface.get_received_by_addr(
[destaddr], None)['data'][0]['balance']
assert received == amount, "sendpayment failed - coins not arrived, " +\
"received: " + str(received)
#Cleanup - remove the external commitments added
btc.update_commitments(external_to_remove=ecs)
