def ink(self, cup_id: int) -> Wad:
"""Get the amount of SKR collateral locked in a cup.
Args:
cup_id: Id of the cup.
Returns:
Amount of SKR collateral locked in the cup, in SKR.
"""
assert isinstance(cup_id, int)
return Wad(self._contractTub.call().ink(int_to_bytes32(cup_id)))
def safe(self, cup_id: int) -> bool:
"""Determine if a cup is safe.
Args:
cup_id: Id of the cup
Returns:
`True` if the cup is safe. `False` otherwise.
"""
assert isinstance(cup_id, int)
return self._contractTub.call().safe(int_to_bytes32(cup_id))
def tab(self, cup_id: int) -> Wad:
"""Get the amount of debt in a cup.
Args:
cup_id: Id of the cup.
Returns:
Amount of debt in the cup, in SAI.
"""
assert isinstance(cup_id, int)
return Wad(self._contractTub.call().tab(int_to_bytes32(cup_id)))
def lad(self, cup_id: int) -> Address:
"""Get the owner of a cup.
Args:
cup_id: Id of the cup.
Returns:
Address of the owner of the cup.
"""
assert isinstance(cup_id, int)
return Address(self._contractTub.call().lad(int_to_bytes32(cup_id)))
def cups(self, cup_id: int) -> Cup:
"""Get the cup details.
Args:
cup_id: Id of the cup to get the details of.
Returns:
Class encapsulating cup details.
"""
assert isinstance(cup_id, int)
array = self._contractTub.call().cups(int_to_bytes32(cup_id))
return Cup(cup_id, Address(array[0]), Wad(array[1]), Wad(array[2]))
def bite(self, cup_id: int) -> Optional[Receipt]:
"""Initiate liquidation of an undercollateralized cup.
Args:
cup_id: Id of the cup to liquidate.
Returns:
A `Receipt` if the Ethereum transaction was successful.
`None` if the Ethereum transaction failed.
"""
assert isinstance(cup_id, int)
return self._transact(self.web3, f"Tub('{self.address}').bite('{cup_id}')",
lambda: self._contractTub.transact().bite(int_to_bytes32(cup_id)))
def test_int_to_bytes32():
assert int_to_bytes32(0) == bytes([
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
])
assert int_to_bytes32(1) == bytes([
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01
])
assert int_to_bytes32(512) == bytes([
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00
])
assert int_to_bytes32(2**256 - 1) == bytes([
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
])
def give(self, cup_id: int, new_lad: Address) -> Optional[Receipt]:
"""Transfer ownership of a cup.
Args:
cup_id: Id of the cup to transfer ownership of.
new_lad: New owner of the cup.
Returns:
A `Receipt` if the Ethereum transaction was successful.
`None` if the Ethereum transaction failed.
"""
assert isinstance(cup_id, int)
assert isinstance(new_lad, Address)
return self._transact(self.web3, f"Tub('{self.address}').give('{cup_id}', '{new_lad}')",
lambda: self._contractTub.transact().give(int_to_bytes32(cup_id), new_lad.address))
def draw(self, cup_id: int, amount_in_sai: Wad) -> Optional[Receipt]:
"""Issue the specified amount of SAI stablecoins.
Args:
cup_id: Id of the cup to issue the SAI from.
amount_in_sai: The amount SAI to be issued.
Returns:
A `Receipt` if the Ethereum transaction was successful.
`None` if the Ethereum transaction failed.
"""
assert isinstance(cup_id, int)
assert isinstance(amount_in_sai, Wad)
return self._transact(self.web3, f"Tub('{self.address}').draw('{cup_id}', '{amount_in_sai}')",
lambda: self._contractTub.transact().draw(int_to_bytes32(cup_id), amount_in_sai.value))
def wipe(self, cup_id: int, amount_in_sai: Wad) -> Optional[Receipt]:
"""Repay some portion of existing SAI debt.
Args:
cup_id: Id of the cup to repay the SAI to.
amount_in_sai: The amount SAI to be repaid.
Returns:
A `Receipt` if the Ethereum transaction was successful.
`None` if the Ethereum transaction failed.
"""
assert isinstance(cup_id, int)
assert isinstance(amount_in_sai, Wad)
return self._transact(self.web3, f"Tub('{self.address}').wipe('{cup_id}', '{amount_in_sai}')",
lambda: self._contractTub.transact().wipe(int_to_bytes32(cup_id), amount_in_sai.value))
def free(self, cup_id: int, amount_in_skr: Wad) -> Optional[Receipt]:
"""Remove excess SKR collateral from a cup.
Args:
cup_id: Id of the cup to remove the collateral from.
amount_in_skr: The amount of collateral to remove, in SKR.
Returns:
A `Receipt` if the Ethereum transaction was successful.
`None` if the Ethereum transaction failed.
"""
assert isinstance(cup_id, int)
assert isinstance(amount_in_skr, Wad)
return self._transact(self.web3, f"Tub('{self.address}').free('{cup_id}', '{amount_in_skr}')",
lambda: self._contractTub.transact().free(int_to_bytes32(cup_id), amount_in_skr.value))
def kill(self, offer_id: int) -> Optional[Receipt]:
"""Cancels an existing offer.
Offers can be cancelled only by their owners. In addition to that, in case of expiring markets,
after the market has expired all orders can be cancelled by anyone.
Args:
offer_id: Id of the offer you want to cancel.
Returns:
A `Receipt` if the Ethereum transaction was successful and the offer has been cancelled.
`None` if the Ethereum transaction failed.
"""
return self._transact(
self.web3, f"SimpleMarket('{self.address}').kill('{offer_id}')",
lambda: self._contract.transact().kill(int_to_bytes32(offer_id)))
def shut(self, cup_id: int) -> Optional[Receipt]:
"""Close a cup.
Involves calling `wipe()` and `free()` internally in order to clear all remaining SAI debt and free
all remaining SKR collateral.
Args:
cup_id: Id of the cup to close.
Returns:
A `Receipt` if the Ethereum transaction was successful.
`None` if the Ethereum transaction failed.
"""
assert isinstance(cup_id, int)
return self._transact(self.web3, f"Tub('{self.address}').shut('{cup_id}')",
lambda: self._contractTub.transact().shut(int_to_bytes32(cup_id)))
def take(self, offer_id: int, quantity: Wad) -> Optional[Receipt]:
"""Takes (buys) an offer.
If `quantity` is equal to `sell_how_much`, the whole offer will be taken (bought) which will make it
disappear from the order book. If you want to buy a fraction of the offer, set `quantity` to a number
lower than `sell_how_much`.
Args:
offer_id: Id of the offer you want to take (buy).
quantity: Quantity of `sell_which_token` that you want to buy.
Returns:
A `Receipt` if the Ethereum transaction was successful and the offer has been taken (bought).
`None` if the Ethereum transaction failed.
"""
return self._transact(
self.web3,
f"SimpleMarket('{self.address}').take('{offer_id}', '{quantity}')",
lambda: self._contract.transact().take(int_to_bytes32(offer_id),
quantity.value))
class DSGuard(Contract):
abi = Contract._load_abi(__name__, 'abi/DSGuard.abi')
bin = Contract._load_bin(__name__, 'abi/DSGuard.bin')
ANY = int_to_bytes32(2 ** 256 - 1)
def __init__(self, web3, address):
self.web3 = web3
self.address = address
self._contract = web3.eth.contract(abi=self.abi)(address=address.address)
@staticmethod
def deploy(web3: Web3):
return DSGuard(web3=web3, address=Contract._deploy(web3, DSGuard.abi, DSGuard.bin, []))
def permit(self, src, dst, sig: bytes) -> Optional[Receipt]:
assert(isinstance(src, Address) or isinstance(src, bytes))
assert(isinstance(dst, Address) or isinstance(dst, bytes))
assert(isinstance(sig, bytes) and len(sig) == 32)
if isinstance(src, Address):
src = src.address
if isinstance(dst, Address):
dst = dst.address
return self._transact(self.web3, f"DSGuard('{self.address}').permit('{src}', '{dst}', '{bytes_to_hexstring(sig)}')",
lambda: self._contract.transact().permit(src, dst, sig))
def forbid(self, src: Address, dst: Address, sig: bytes) -> Optional[Receipt]:
assert(isinstance(src, Address) or isinstance(src, bytes))
assert(isinstance(dst, Address) or isinstance(dst, bytes))
assert(isinstance(sig, bytes) and len(sig) == 32)
if isinstance(src, Address):
src = src.address
if isinstance(dst, Address):
dst = dst.address
return self._transact(self.web3, f"DSGuard('{self.address}').forbid('{src}', '{dst}', '{bytes_to_hexstring(sig)}')",
lambda: self._contract.transact().forbid(src, dst, sig))
async def kill_async(self, offer_id: int) -> Optional[Receipt]:
return await self._async_transact(
self.web3, f"SimpleMarket('{self.address}').kill('{offer_id}')",
lambda: self._contract.transact().kill(int_to_bytes32(offer_id)))
def take_calldata(self, offer_id: int, quantity: Wad) -> Calldata:
return Calldata(
self.web3.eth.contract(abi=self.abi).encodeABI(
'take', [int_to_bytes32(offer_id), quantity.value]))
