Punk Gateway

If you need to use native CryptoPunks in the protocol, they must first be wrapped into WPunks. The Punk Gateway contract is a helper contract to easily wrap and unwrap Punks as necessary when interacting with the protocol, since only ERC721 is used within protocol interactions. This allows users to interact with the LendPool seamlessly without previously wrapping Punks themselves.

The source code of the Punk Gateway can be found on Github.

View methods

isCallerInWhitelist

function isCallerInWhitelist(address caller) external view returns (bool)

Checks if the caller is whitelisted.

Call params

Name	Type	Description
caller	address	The address to be checked

Return values

Type	Description
bool	Returns true if the caller is whitelisted, false otherwise

Write methods

borrowETH

function borrowETH( uint256 amount, uint256 punkIndex, address onBehalfOf, uint16 referralCode ) external override nonReentrant

Borrows amount of ETH, sending the amount of unwrapped WETH to msg.sender , and setting punkIndex punk as collateral.

Example: Alice borrows 10 ETH using her Punk with punkIndex 1 as collateral.

The referral program is coded but inactive. You can pass a 0 as referralCode.

The borrowing can only be done if your NFT is configured on the protocol.

To do this, the triggerUserCollateral needs to be called first. Also, there's a _timeFrame variable configured that will validate the time between configuring the NFT and the borrow. If the time is exceeded, it will revert.

The _timeFrame can be checked with the getTimeframe() function in the LendPool contract

Call params

Amount	Type	Description
amount	uint256	Amount to be borrowed, expressed in wei units
punkIndex	uint256	The punk index
onBehalfOf	address	address of user who will incur the debt. Use msg.sender when not calling on behalf of a different user.
referralCode	uint16	Referral code. The referral program is currently in development. Therefore, referralCode must be set to 0.

borrow

function borrow( address reserveAsset, uint256 amount, uint256 punkIndex, address onBehalfOf, uint16 referralCode ) external override nonReentrant

Borrows amount of reserveAsset, sending it to msg.sender , and setting punkIndex punk as collateral.

Example: Alice borrows 10 WETH using her Punk with punkIndex 1 as collateral.

The referral program is coded but inactive. You can pass a 0 as referralCode.

The borrowing can only be done if your NFT is configured on the protocol.

To do this, the triggerUserCollateral needs to be called first. Also, there's a _timeFrame variable configured that will validate the time between configuring the NFT and the borrow. If the time is exceeded, it will revert.

The _timeFrame can be checked with the getTimeframe() function in the LendPool contract

Call params

Name	Type	Description
reserveAsset	address	The reserve address to be borrowed
amount	uint256	Amount to be borrowed, expressed in wei units
punkIndex	uint256	The punk index
onBehalfOf	address	address of user who will incur the debt. Use msg.sender when not calling on behalf of a different user.
referralCode	uint16	Referral code. The referral program is currently in development. Therefore, referralCode must be set to 0.

repayETH

function repayETH(uint256 punkIndex, uint256 amount) external payable override nonReentrant returns (uint256, bool)

Repays a borrowed amount of ETH equal to or less than the amount owed from the specified collateral punk with punkIndex. It will burn the same amount of debt tokens.

Example: Alice decides to pay 2 ETH from her borrowed amount. Alice will use her uNFT to identify the loan, will give 2 ETH and will burn the same amount in debt tokens.

Ensure that the repayETH() transaction also includes the amount of ETH you are repaying in the msg.value.

Call params

Name	Type	Description
punkIndex	uint256	The punk index
amount	uint256	Amount to be repaid, expressed in wei units

Return values

Type	Description
uint256	The repaid amount
bool	true if the total amount is repaid or false if partially repaid.

repay

function repay(uint256 punkIndex, uint256 amount) external override nonReentrant returns (uint256, bool)

Repays a borrowed amount equal to or less than the amount owed from the specified collateral punk with punkIndex. It will burn the same amount of debt tokens.

Example: Alice decides to pay 2 WETH from her borrowed amount. Alice will use her uNFT to identify the loan, will give 2 WETH and will burn the same amount in debt tokens.

Call params

Name	Type	Description
punkIndex	uint256	The punk index
amount	uint256	Amount to be repaid, expressed in wei units

Return values

Type	Description
uint256	The repaid amount
bool	true if the total amount is repaid or false if partially repaid.

auctionETH

function auctionETH(uint256 punkIndex, address onBehalfOf) external payable override nonReentrant

Places a bid in ETH for a Punk whose current health factor is below one. The users can trigger an auction if they want to buy the collateral asset, placing a bid for the msg.valueamount. New bids should always be higher than the loan borrowed amount, and 1% higher than the previous bid (in case there is one). The first user to bid will always receive a 2.5% bid incentive for being the first bidder.

Example: Alice's Punk price went down, together with her loan's health factor (HF), which is now below 1. Bob decides to bid for that Punk. If there's a second bid, Bob's bid will be cancelled and the new bid will the the current winning bid. Bob will still receive a 2.5% reward fee for being the first bidder. The bidFine will also be paid if Alice decides to redeem part of the debt and make the HF go above one.

Ensure that the auctionETH() transaction also includes the amount of ETH you are bidding for in the msg.value.

Call params

Name	Type	Description
punkIndex	uint256	The punk index
onBehalfOf	address	address of user who will incur the auction. Use msg.sender when not calling on behalf of a different user.

auction

function auction( uint256 punkIndex, uint256 bidPrice, address onBehalfOf ) external override nonReentrant

Places a bid for a Punk whose current health factor is below one. The users can trigger an auction if they want to buy the collateral asset, placing a bid for the msg.valueamount. New bids should always be higher than the loan borrowed amount, and 1% higher than the previous bid (in case there is one). The first user to bid will always receive a 2.5% bid incentive for being the first bidder.

Example: Alice's Punk price went down, together with her loan's health factor (HF), which is now below 1. Bob decides to bid for that Punk. If there's a second bid, Bob's bid will be cancelled and the new bid will the the current winning bid. Bob will still receive a 2.5% reward fee for being the first bidder. The bidFine will also be paid if Alice decides to redeem part of the debt and make the HF go above one.

Call params

Name	Type	Description
punkIndex	uint256	The punk index
bidPrice	uint256	The bid price
onBehalfOf	address	address of user who will incur the auction. Use msg.sender when not calling on behalf of a different user.

redeemETH

function redeemETH( uint256 punkIndex, uint256 amount, uint256 bidFine ) external payable override nonReentrant returns (uint256)

Allows a borrower to increase his loan's Health Factor using ETH in case it is below 1. In order to redeem, a bidFine should be paid by the borrower to the current loan bidder (in case there is one).

Example: Alice's Punk price went down, together with her loan's health factor (HF), which is now below 1. Bob decides to bid for that Punk. After Bob's bid, Alice decides to redeem her Punk in order to increase her loan's HF and avoid getting liquidated. Bob will receive his bidding amount back, plus a bidFine reward fee for being the first bidder.

The redeem amount needs to be higher than the (borrowAmount * redeemThreshold)/100

Ensure that theredeemETH() transaction also includes the amount of ETH you are redeeming, as well as the bid fine you are transferring in the msg.value.

Call params

Name	Type	Description
punkIndex	uint256	The punk index
amount	uint256	Amount to be redeemed, expressed in wei units
bidFine	uint256	Amount to be paid as bid fine, expressed in wei units

Return values

Type	Description
uint256	The total payback (amount redeemed plus the bid fine)

redeem

function redeem( uint256 punkIndex, uint256 amount, uint256 bidFine ) external override nonReentrant returns (uint256)

Allows a borrower to increase his loan's Health Factor in case it is below 1. In order to redeem, a bidFine should be paid by the borrower to the current loan bidder (in case there is one).

Example: Alice's Punk price went down, together with her loan's health factor (HF), which is now below 1. Bob decides to bid for that Punk. After Bob's bid, Alice decides to redeem her Punk in order to increase her loan's HF and avoid getting liquidated. Bob will receive his bidding amount back, plus a bidFine reward fee for being the first bidder.

The redeem amount needs to be higher than the (borrowAmount * redeemThreshold)/100

Call params

Name	Type	Description
punkIndex	uint256	The punk index
amount	uint256	Amount to be redeemed, expressed in wei units
bidFine	uint256	Amount to be paid as bid fine, expressed in wei units

Return values

Type	Description
uint256	The total payback (amount redeemed plus the bid fine)

liquidateETH

function liquidateETH(uint256 punkIndex) external payable override nonReentrant returns (uint256)

Allows an auction winner to liquidate the position and get the Punk.

Example: Bob wins the auction. He can call this function to get his collateral (Punk) into his wallet.

The msg.value amount is the amount to be sent in case the bid price can't cover the borrow amount (for example, if a user takes a long time to redeem and the borrow amount needed to be paid has increased substantially due to interest rates)

Ensure that theredeemETH() transaction also includes the amount of ETH you want to add as amount to liquidate as msg.value.

Call params

Name	Type	Description
punkIndex	uint256	The punk index

Return values

Type	Description
uint256	The extra debt amount (in case there is one) paid due to last bid price can not cover the borrow amount

liquidate

function liquidate(uint256 punkIndex, uint256 amount) external override nonReentrant returns (uint256)

Allows an auction winner to liquidate the position and get the Punk.

Example: Bob wins the auction. He can call this function to get his collateral (Punk) into his wallet.

The amount is the amount to be sent in case the bid price can't cover the borrow amount (for example, if a user takes a long time to redeem and the borrow amount needed to be paid has increased substantially due to interest rates)

Call params

Name	Type	Description
punkIndex	uint256	The punk index
amount	uint256	The extra amount to be sent in case the bid price can't cover the borrow amount

Return values

Type	Description
uint256	The extra debt amount (in case there is one) paid due to last bid price can not cover the borrow amount

authorizeLendPoolERC20

function authorizeLendPoolERC20(address[] calldata tokens) external nonReentrant onlyOwner

Approves the lendpool for given tokens

Call params

Name	Type	Description
tokens	address[]	The array of tokens

authorizeCallerWhitelist

function authorizeCallerWhitelist(address[] calldata callers, bool flag) external nonReentrant onlyOwner

Authorizes/unauthorizes a list of callers for the whitelist

Call params

Name	Type	Description
callers	address[]	The array of callers to be authorized
flag	bool	The flag to authorize/unauthorize

buyoutETH

function buyoutETH(uint256 punkIndex, address onBehalfOf) external payable override nonReentrant

This will allow the buyers in case of an auction to do a buyout on a crypto punk NFT using ETH.

The address onBehalfOf can be the msg.sender or any address given by the user when executing the function.

The amount will be passed as msg.value, should be equal to the NFT Price.

Call Params

Name	Type	Description
punkIndex	uint256	The punk index (tokenId)
onBehalfOf	address	address of user who will incur the buyout. Use msg.sender when not calling on behalf of a different user

buyout

function buyout(uint256 punkIndex, uint256 amount, address onBehalfOf) external override nonReentrant

Allows the buyers in case of an auction to do a buyout on a crypto punk NFT using WETH.

Call Params

Name	Type	Description
punkIndex	uint256	The punk index (tokenId)
amount	uint256	the amount to execute the buyout in WETH
onBehalfOf	address	address of user who will incur the buyout. Use msg.sender when not calling on behalf of a different user

buyDebtPunk

function buyDebtPunkETH(uint256 punkIndex, address onBehalfOf, uint256 amount) external override nonReentrant

Allows the user to buy a debt market listing for a crypto punk using WETH

Name	Type	Description
punkIndex	uint256	The punk index (tokenId)
onBehalfOf	address	address of user who will incur the buy debt punk. Use msg.sender when not calling on behalf of a different user
amount	uint256	the amount to execute the buyout(buy) in WETH

buyDebtPunkETH

function buyDebtPunk(uint256 punkIndex, address onBehalfOf) external override nonReentrant

Allows the user to buy a debt market listing for a crypto punk using ETH directly

The address onBehalfOf can be the msg.sender or any address given by the user when executing the function.

The amount will be passed as msg.value, should be equal to the NFT Price.

Name	Type	Description
punkIndex	uint256	The punk index (tokenId)
onBehalfOf	address	address of user who will incur the buy debt punk. Use msg.sender when not calling on behalf of a different user