From aba3c12b43302255a861397ff7d3504657054565 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emilio=20L=C3=B3pez?= Date: Sat, 26 Oct 2024 18:27:11 +0200 Subject: [PATCH] tests: vyper: fix compilation failure Testing vyper integration of /opt/hostedtoolcache/Python/3.12.7/x64/bin/crytic-compile ERROR:CryticCompile:missing type annotation (hint: did you mean something like `for i: uint256 in ...`?) line 111:4 110 refund: uint256 = 0 ---> 111 for i in range(MAX_BIDS): -------------^ 112 # Note that loop may break sooner than 128 iterations if i >= _numBids ERROR:CryticCompile:Vyper compilation errored vyper test failed --- scripts/ci_test_vyper.sh | 10 +- tests/vyper/{auction.vy => auction-0.3.vy} | 0 tests/vyper/auction-0.4.vy | 178 +++++++++++++++++++++ 3 files changed, 186 insertions(+), 2 deletions(-) rename tests/vyper/{auction.vy => auction-0.3.vy} (100%) create mode 100644 tests/vyper/auction-0.4.vy diff --git a/scripts/ci_test_vyper.sh b/scripts/ci_test_vyper.sh index 9be8fa31..309ae191 100755 --- a/scripts/ci_test_vyper.sh +++ b/scripts/ci_test_vyper.sh @@ -4,11 +4,17 @@ pip install vyper +if vyper --version | grep -q 0.3; then + TEST_FILE=auction-0.3.vy +else + TEST_FILE=auction-0.4.vy +fi + echo "Testing vyper integration of $(realpath "$(which crytic-compile)")" cd tests/vyper || exit 255 -if ! crytic-compile auction.vy --export-formats standard +if ! crytic-compile "$TEST_FILE" --export-formats standard then echo "vyper test failed" && exit 255 else echo "vyper test passed" && exit 0 -fi +fi \ No newline at end of file diff --git a/tests/vyper/auction.vy b/tests/vyper/auction-0.3.vy similarity index 100% rename from tests/vyper/auction.vy rename to tests/vyper/auction-0.3.vy diff --git a/tests/vyper/auction-0.4.vy b/tests/vyper/auction-0.4.vy new file mode 100644 index 00000000..a23d3063 --- /dev/null +++ b/tests/vyper/auction-0.4.vy @@ -0,0 +1,178 @@ +# Taken from https://github.com/vyperlang/vyper/blob/9136169468f317a53b4e7448389aa315f90b95ba/examples/auctions/blind_auction.vy +# Blind Auction. Adapted to Vyper from [Solidity by Example](https://github.com/ethereum/solidity/blob/develop/docs/solidity-by-example.rst#blind-auction-1) + +struct Bid: + blindedBid: bytes32 + deposit: uint256 + +# Note: because Vyper does not allow for dynamic arrays, we have limited the +# number of bids that can be placed by one address to 128 in this example +MAX_BIDS: constant(int128) = 128 + +# Event for logging that auction has ended +event AuctionEnded: + highestBidder: address + highestBid: uint256 + +# Auction parameters +beneficiary: public(address) +biddingEnd: public(uint256) +revealEnd: public(uint256) + +# Set to true at the end of auction, disallowing any new bids +ended: public(bool) + +# Final auction state +highestBid: public(uint256) +highestBidder: public(address) + +# State of the bids +bids: HashMap[address, Bid[128]] +bidCounts: HashMap[address, int128] + +# Allowed withdrawals of previous bids +pendingReturns: HashMap[address, uint256] + + +# Create a blinded auction with `_biddingTime` seconds bidding time and +# `_revealTime` seconds reveal time on behalf of the beneficiary address +# `_beneficiary`. +@external +def __init__(_beneficiary: address, _biddingTime: uint256, _revealTime: uint256): + self.beneficiary = _beneficiary + self.biddingEnd = block.timestamp + _biddingTime + self.revealEnd = self.biddingEnd + _revealTime + + +# Place a blinded bid with: +# +# _blindedBid = keccak256(concat( +# convert(value, bytes32), +# convert(fake, bytes32), +# secret) +# ) +# +# The sent ether is only refunded if the bid is correctly revealed in the +# revealing phase. The bid is valid if the ether sent together with the bid is +# at least "value" and "fake" is not true. Setting "fake" to true and sending +# not the exact amount are ways to hide the real bid but still make the +# required deposit. The same address can place multiple bids. +@external +@payable +def bid(_blindedBid: bytes32): + # Check if bidding period is still open + assert block.timestamp < self.biddingEnd + + # Check that payer hasn't already placed maximum number of bids + numBids: int128 = self.bidCounts[msg.sender] + assert numBids < MAX_BIDS + + # Add bid to mapping of all bids + self.bids[msg.sender][numBids] = Bid({ + blindedBid: _blindedBid, + deposit: msg.value + }) + self.bidCounts[msg.sender] += 1 + + +# Returns a boolean value, `True` if bid placed successfully, `False` otherwise. +@internal +def placeBid(bidder: address, _value: uint256) -> bool: + # If bid is less than highest bid, bid fails + if (_value <= self.highestBid): + return False + + # Refund the previously highest bidder + if (self.highestBidder != empty(address)): + self.pendingReturns[self.highestBidder] += self.highestBid + + # Place bid successfully and update auction state + self.highestBid = _value + self.highestBidder = bidder + + return True + + +# Reveal your blinded bids. You will get a refund for all correctly blinded +# invalid bids and for all bids except for the totally highest. +@external +def reveal(_numBids: int128, _values: uint256[128], _fakes: bool[128], _secrets: bytes32[128]): + # Check that bidding period is over + assert block.timestamp > self.biddingEnd + + # Check that reveal end has not passed + assert block.timestamp < self.revealEnd + + # Check that number of bids being revealed matches log for sender + assert _numBids == self.bidCounts[msg.sender] + + # Calculate refund for sender + refund: uint256 = 0 + for i: uint256 in range(MAX_BIDS): + # Note that loop may break sooner than 128 iterations if i >= _numBids + if (i >= _numBids): + break + + # Get bid to check + bidToCheck: Bid = (self.bids[msg.sender])[i] + + # Check against encoded packet + value: uint256 = _values[i] + fake: bool = _fakes[i] + secret: bytes32 = _secrets[i] + blindedBid: bytes32 = keccak256(concat( + convert(value, bytes32), + convert(fake, bytes32), + secret + )) + + # Bid was not actually revealed + # Do not refund deposit + assert blindedBid == bidToCheck.blindedBid + + # Add deposit to refund if bid was indeed revealed + refund += bidToCheck.deposit + if (not fake and bidToCheck.deposit >= value): + if (self.placeBid(msg.sender, value)): + refund -= value + + # Make it impossible for the sender to re-claim the same deposit + zeroBytes32: bytes32 = empty(bytes32) + bidToCheck.blindedBid = zeroBytes32 + + # Send refund if non-zero + if (refund != 0): + send(msg.sender, refund) + + +# Withdraw a bid that was overbid. +@external +def withdraw(): + # Check that there is an allowed pending return. + pendingAmount: uint256 = self.pendingReturns[msg.sender] + if (pendingAmount > 0): + # If so, set pending returns to zero to prevent recipient from calling + # this function again as part of the receiving call before `transfer` + # returns (see the remark above about conditions -> effects -> + # interaction). + self.pendingReturns[msg.sender] = 0 + + # Then send return + send(msg.sender, pendingAmount) + + +# End the auction and send the highest bid to the beneficiary. +@external +def auctionEnd(): + # Check that reveal end has passed + assert block.timestamp > self.revealEnd + + # Check that auction has not already been marked as ended + assert not self.ended + + # Log auction ending and set flag + log AuctionEnded(self.highestBidder, self.highestBid) + self.ended = True + + # Transfer funds to beneficiary + send(self.beneficiary, self.highestBid) \ No newline at end of file