def check_contend(self, slot_id, tx_fee):
if tx_fee < DEFAULT_CONTEND_SLOT_FEE:
msg = 'Transaction fee must be >= %d' % DEFAULT_CONTEND_SLOT_FEE
pyvee.throw_error(msg, InvalidParameterException)
return False
if slot_id >= 60 or slot_id < 0:
msg = 'Slot id must be in 0 to 59'
pyvee.throw_error(msg, InvalidParameterException)
return False
balance_detail = self.get_info()
min_effective_balance = MIN_CONTEND_SLOT_BALANCE + tx_fee
if balance_detail["effective"] < min_effective_balance:
msg = 'Insufficient VEE balance. (The effective balance must be >= %d)' % min_effective_balance
pyvee.throw_error(msg, InvalidParameterException)
return False
slot_info = self.chain.slot_info(slot_id)
if not slot_info or slot_info.get("mintingAverageBalance") is None:
msg = 'Failed to get slot minting average balance'
pyvee.throw_error(msg, NetworkException)
return False
elif slot_info["mintingAverageBalance"] >= balance_detail[
"mintingAverage"]:
msg = 'The minting average balance of slot %d is greater than or equals to yours. ' \
'You will contend this slot failed.' % slot_id
pyvee.throw_error(msg, InsufficientBalanceException)
return False
return True
def contend(self,
slot_id,
tx_fee=DEFAULT_CONTEND_SLOT_FEE,
fee_scale=DEFAULT_FEE_SCALE,
timestamp=0):
if not self.privateKey:
msg = 'Private key required'
pyvee.throw_error(msg, MissingPrivateKeyException)
elif CHECK_FEE_SCALE and fee_scale != DEFAULT_FEE_SCALE:
msg = 'Wrong fee scale (currently, fee scale must be %d).' % DEFAULT_FEE_SCALE
pyvee.throw_error(msg, InvalidParameterException)
elif self.check_contend(slot_id, tx_fee):
if timestamp == 0:
timestamp = int(time.time() * 1000000000)
sData = struct.pack(">B", CONTEND_SLOT_TX_TYPE) + \
struct.pack(">I", slot_id) + \
struct.pack(">Q", tx_fee) + \
struct.pack(">H", fee_scale) + \
struct.pack(">Q", timestamp)
signature = bytes2str(sign(self.privateKey, sData))
data = json.dumps({
"senderPublicKey": self.publicKey,
"fee": tx_fee,
"feeScale": fee_scale,
"slotId": slot_id,
"timestamp": timestamp,
"signature": signature
})
return self.wrapper.request('/spos/broadcast/contend', data)
def balance_detail(self):
try:
resp = self.wrapper.request('/addresses/balance/details/%s' %
self.address)
logging.debug(resp)
return resp
except Exception as ex:
msg = "Failed to get balance detail. ({})".format(ex)
pyvee.throw_error(msg, NetworkException)
return None
def balance(self, confirmations=0):
try:
confirmations_str = '' if confirmations == 0 else '/%d' % confirmations
resp = self.wrapper.request('/addresses/balance/%s%s' %
(self.address, confirmations_str))
logging.debug(resp)
return resp['balance']
except Exception as ex:
msg = "Failed to get balance. ({})".format(ex)
pyvee.throw_error(msg, NetworkException)
return 0
def get_tx_history(self, limit=100, type_filter=PAYMENT_TX_TYPE):
if not self.address:
msg = 'Address required'
pyvee.throw_error(msg, MissingAddressException)
elif limit > MAX_TX_HISTORY_LIMIT:
msg = 'Too big sequences requested (Max limitation is %d).' % MAX_TX_HISTORY_LIMIT
pyvee.throw_error(msg, InvalidParameterException)
else:
url = '/transactions/address/{}/limit/{}'.format(
self.address, limit)
resp = self.wrapper.request(url)
if isinstance(resp, list) and type_filter:
resp = [tx for tx in resp[0] if tx['type'] == type_filter]
return resp
def lease_cancel(self,
lease_id,
tx_fee=DEFAULT_CANCEL_LEASE_FEE,
fee_scale=DEFAULT_FEE_SCALE,
timestamp=0):
decode_lease_id = base58.b58decode(lease_id)
if not self.privateKey:
msg = 'Private key required'
pyvee.throw_error(msg, MissingPrivateKeyException)
elif tx_fee < DEFAULT_CANCEL_LEASE_FEE:
msg = 'Transaction fee must be > %d' % DEFAULT_CANCEL_LEASE_FEE
pyvee.throw_error(msg, InvalidParameterException)
elif len(decode_lease_id) != LEASE_TX_ID_BYTES:
msg = 'Invalid lease transaction id'
pyvee.throw_error(msg, InvalidParameterException)
elif CHECK_FEE_SCALE and fee_scale != DEFAULT_FEE_SCALE:
msg = 'Wrong fee scale (currently, fee scale must be %d).' % DEFAULT_FEE_SCALE
pyvee.throw_error(msg, InvalidParameterException)
elif self.balance() < tx_fee:
msg = 'Insufficient VEE balance'
pyvee.throw_error(msg, InsufficientBalanceException)
else:
if timestamp == 0:
timestamp = int(time.time() * 1000000000)
sData = struct.pack(">B", LEASE_CANCEL_TX_TYPE) + \
struct.pack(">Q", tx_fee) + \
struct.pack(">H", fee_scale) + \
struct.pack(">Q", timestamp) + \
decode_lease_id
signature = bytes2str(sign(self.privateKey, sData))
data = json.dumps({
"senderPublicKey": self.publicKey,
"txId": lease_id,
"fee": tx_fee,
"feeScale": fee_scale,
"timestamp": timestamp,
"signature": signature
})
req = self.wrapper.request('/leasing/broadcast/cancel', data)
return req
def release(self,
slot_id,
tx_fee=DEFAULT_RELEASE_SLOT_FEE,
fee_scale=DEFAULT_FEE_SCALE,
timestamp=0):
if not self.privateKey:
msg = 'Private key required'
pyvee.throw_error(msg, MissingPrivateKeyException)
elif tx_fee < DEFAULT_RELEASE_SLOT_FEE:
msg = 'Transaction fee must be >= %d' % DEFAULT_RELEASE_SLOT_FEE
pyvee.throw_error(msg, InvalidParameterException)
elif slot_id >= 60 or slot_id < 0:
msg = 'Slot id must be in 0 to 59'
pyvee.throw_error(msg, InvalidParameterException)
elif CHECK_FEE_SCALE and fee_scale != DEFAULT_FEE_SCALE:
msg = 'Wrong fee scale (currently, fee scale must be %d).' % DEFAULT_FEE_SCALE
pyvee.throw_error(msg, InvalidParameterException)
elif self.balance() < tx_fee:
msg = 'Insufficient VEE balance'
pyvee.throw_error(msg, InsufficientBalanceException)
else:
if timestamp == 0:
timestamp = int(time.time() * 1000000000)
sData = struct.pack(">B", RELEASE_SLOT_TX_TYPE) + \
struct.pack(">I", slot_id) + \
struct.pack(">Q", tx_fee) + \
struct.pack(">H", fee_scale) + \
struct.pack(">Q", timestamp)
signature = bytes2str(sign(self.privateKey, sData))
data = json.dumps({
"senderPublicKey": self.publicKey,
"fee": tx_fee,
"feeScale": fee_scale,
"slotId": slot_id,
"timestamp": timestamp,
"signature": signature
})
return self.wrapper.request('/spos/broadcast/release', data)
def get_info(self):
if not (self.address and self.publicKey):
msg = 'Address required'
pyvee.throw_error(msg, MissingAddressException)
return None
if not self.publicKey:
msg = 'Public key and address required'
pyvee.throw_error(msg, MissingPublicKeyException)
return None
info = self.balance_detail()
if not info:
msg = 'Failed to get balance detail'
pyvee.throw_error(msg, NetworkException)
else:
info["publicKey"] = self.publicKey
return info
def dbput(self,
db_key,
db_data,
db_data_type="ByteArray",
tx_fee=DEFAULT_DBPUT_FEE,
fee_scale=DEFAULT_FEE_SCALE,
timestamp=0):
if not self.privateKey:
msg = 'Private key required'
pyvee.throw_error(msg, MissingPrivateKeyException)
elif tx_fee < DEFAULT_DBPUT_FEE:
msg = 'Transaction fee must be >= %d' % DEFAULT_DBPUT_FEE
pyvee.throw_error(msg, InvalidParameterException)
elif len(db_key) > MAX_DB_KEY_SIZE or len(db_key) < MIN_DB_KEY_SIZE:
msg = 'DB key length must be greater than %d and smaller than %d' % (
MIN_DB_KEY_SIZE, MAX_ATTACHMENT_SIZE)
pyvee.throw_error(msg, InvalidParameterException)
elif CHECK_FEE_SCALE and fee_scale != DEFAULT_FEE_SCALE:
msg = 'Wrong fee scale (currently, fee scale must be %d).' % DEFAULT_FEE_SCALE
pyvee.throw_error(msg, InvalidParameterException)
elif self.balance() < tx_fee:
msg = 'Insufficient VEE balance'
pyvee.throw_error(msg, InsufficientBalanceException)
else:
if timestamp == 0:
timestamp = int(time.time() * 1000000000)
# "ByteArray" is the only supported type in first version
if db_data_type == "ByteArray":
data_type_id = b'\x01'
# TODO: add more DB data type here
else:
msg = 'Unsupported data type: {}'.format(db_data_type)
pyvee.throw_error(msg, InvalidParameterException)
return
sData = struct.pack(">B", DBPUT_TX_TYPE) + \
struct.pack(">H", len(db_key)) + \
str2bytes(db_key) + \
struct.pack(">H", len(db_data)+1) + \
data_type_id + \
str2bytes(db_data) + \
struct.pack(">Q", tx_fee) + \
struct.pack(">H", fee_scale) + \
struct.pack(">Q", timestamp)
signature = bytes2str(sign(self.privateKey, sData))
data = json.dumps({
"senderPublicKey": self.publicKey,
"dbKey": db_key,
"dataType": db_data_type,
"data": db_data,
"fee": tx_fee,
"feeScale": fee_scale,
"timestamp": timestamp,
"signature": signature
})
return self.wrapper.request('/database/broadcast/put', data)
def lease(self,
recipient,
amount,
tx_fee=DEFAULT_LEASE_FEE,
fee_scale=DEFAULT_FEE_SCALE,
timestamp=0):
if not self.privateKey:
msg = 'Private key required'
pyvee.throw_error(msg, MissingPrivateKeyException)
if not self.chain.validate_address(recipient.address):
msg = 'Invalid recipient address'
pyvee.throw_error(msg, InvalidAddressException)
elif amount <= 0:
msg = 'Amount must be > 0'
pyvee.throw_error(msg, InvalidParameterException)
elif tx_fee < DEFAULT_LEASE_FEE:
msg = 'Transaction fee must be >= %d' % DEFAULT_LEASE_FEE
pyvee.throw_error(msg, InvalidParameterException)
elif CHECK_FEE_SCALE and fee_scale != DEFAULT_FEE_SCALE:
msg = 'Wrong fee scale (currently, fee scale must be %d).' % DEFAULT_FEE_SCALE
pyvee.throw_error(msg, InvalidParameterException)
elif self.balance() < amount + tx_fee:
msg = 'Insufficient VEE balance'
pyvee.throw_error(msg, InsufficientBalanceException)
else:
if timestamp == 0:
timestamp = int(time.time() * 1000000000)
sData = struct.pack(">B", LEASE_TX_TYPE) + \
base58.b58decode(recipient.address) + \
struct.pack(">Q", amount) + \
struct.pack(">Q", tx_fee) + \
struct.pack(">H", fee_scale) + \
struct.pack(">Q", timestamp)
signature = bytes2str(sign(self.privateKey, sData))
data = json.dumps({
"senderPublicKey": self.publicKey,
"recipient": recipient.address,
"amount": amount,
"fee": tx_fee,
"feeScale": fee_scale,
"timestamp": timestamp,
"signature": signature
})
req = self.wrapper.request('/leasing/broadcast/lease', data)
return req