ZestyMarket_ERC20_V2

Introduction

The logic of ZestyMarket V2 is similar to the V1 contract. The key difference is in Phase 2: Contract. V2 contracts use Shamir's Secret Sharing as a way of validating advertising delivery. The validator system will a Proof of Authority network initially, and we'll relax constraints on the trustworthiness of validators. In addition to the validation system, ZestyMarket V2 would incorporate a tax for validators and the Zesty DAO. It introduces token incentive mechanisms to reward usage of the contract. A future version of the contract will look into decentralizing the validation system. The process is as such.
Phase 2: Contract
    1.
    Once the contract starts, a validator node would act as dealer and set the hashlock (hash of the secret) for the particular contract and declare the total number of shares of the secret to be distributed. The shares would then be distributed to random validators within the validator network. The minimum threshold to uncover the original secret is 75% of secret shares.
    2.
    Validator nodes would randomly check whether the advertisement is delivered on the location which the seller has defined. The location would be described in the URI section of the NFT, this could be a URI or machine readable instructions to access a location within a game world. If the validator notes that the advertisement slot has be delivered, the validator would then publish the secret share on the smart contract. Otherwise, the secret share would be deleted.
    3.
    If at least 75% of the secret shares are known, the seller can reconstruct the original secret to unlock the hashlock which would unlock funds in the contract. Otherwise, after the contract expires (+ an additional 2 days grace period for seller to withdraw funds), the buyer would be refunded, as the advertisement has not been delivered in a satisfactory manner.

Specifications

Constructor

The constructor like V1 requires the a transaction token address (any ERC20 compatible token) and a zestyNFT address to be deployed.
It adds on rewardsTokenAddress which is the reward token given out to successful transactions on the contract.
Adds on a validator address and the a reward distributor address. The code for the reward distributor can be found under Governance > RewardDistributor.
The remaining rate function are the reward tokens given out in a transaction per transaction token to buyers, sellers, validators, and to be locked in the NFTs. Note that rewards are subject to availability, rewards might not be given out if there are no reward tokens held by the contract.
1
constructor(
2
address txTokenAddress_,
3
address zestyNFTAddress_,
4
address rewardsTokenAddress_,
5
address zestyDAO_,
6
address validator_,
7
address rewardsDistributor_,
8
uint256 rewardsRateBuyer_,
9
uint256 rewardsRateSeller_,
10
uint256 rewardsRateValidator_,
11
uint256 rewardsRateNFT_
12
)
Copied!

Getter Functions

getTxTokenAddress

Returns the transaction token address
1
function getTxTokenAddress() external view returns (address)
Copied!

getRewardsTokenAddress

Returns the reward token address
1
function getRewardsTokenAddress() external view returns (address)
Copied!

getValidator

Returns the validator address
1
function getValidator() external view returns (address)
Copied!

getRewardsBalance

Returns the reward token balance on the contract
1
function getRewardsBalance() external view returns (uint256)
Copied!

getRewardsRate

Returns the reward rate for the buyer, seller, nft, and validator.
1
function getRewardsRate()
2
external
3
view
4
returns (
5
uint256 rewardsRateBuyer,
6
uint256 rewardsRateSeller,
7
uint256 rewardsRateNFT,
8
uint256 rewardsRateValidator
9
)
Copied!

getSellerNFTSetting

Returns the deposited NFT settings which was deposited by the seller. Returns tokenId the id of the token, seller the address of the seller, autoApprove a uint8 value where 1 is False and 2 is True, inProgressCount an variable which increments and decrements depending on the number of auctions or contracts in progress or are completed. This prevents a seller from withdrawing a NFT when it is already on the market otherwise, the metadata of the NFT could be changed.
1
function getSellerNFTSetting(uint256 _tokenId)
2
external
3
view
4
returns (
5
uint256 tokenId,
6
address seller,
7
uint8 autoApprove,
8
uint256 inProgressCount
9
)
Copied!

getSellerAuctionPrice

Returns the current auction price of the auction. The price is a linearly decreasing function which follows the following equation:
V(Ti)=V(T0)(TiT0)×V(T0)TnT0V(T_{i}) = V(T_{0}) - (T_{i} - T_{0}) \times \frac{V(T_{0})}{T_{n} - T_{0}}
Definitions
V(Ti)V(T_i)
refers to the current NFT price in some ERC20 tokens
V(T0)V(T_{0})
refers to the starting price of the NFT in some ERC20 tokens
TiT_i
refers to the current time in Unix time
T0T_0
refers to the starting time of the Dutch auction in Unix time
TnT_n
refers to the expiration time of the NFT timeslot in Unix time
1
function getSellerAuctionPrice(uint256 _sellerAuctionId) public view returns (uint256)
Copied!

getSellerAuction

Returns the current auction state. seller refers to the seller's address, tokenId refers to the ZestyNFT token id that would be auctioned out. auctionTimeStart and auctionTimeEnd refers to the start and end time of the auction. contractTimeStart and contractTimeEnd refers to the start and ending time of the contract and advertising delivery. priceStart refers to the starting price of the Dutch auction. pricePending refers to the pending price of the Dutch auction upon a bid by a buyer. priceEnd refers to the ending price after the buyer has approved the buyerCampaign. buyerCampaign refers to the id of the buyer's campaign. buyerCampaignApproved is a uint8 representing a boolean (where 1 is False, and 2 is True), if approved, the auction proceeds to the contract section.
1
function getSellerAuction(uint256 _sellerAuctionId)
2
external
3
view
4
returns (
5
address seller,
6
uint256 tokenId,
7
uint256 auctionTimeStart,
8
uint256 auctionTimeEnd,
9
uint256 contractTimeStart,
10
uint256 contractTimeEnd,
11
uint256 priceStart,
12
uint256 pricePending,
13
uint256 priceEnd,
14
uint256 buyerCampaign,
15
uint8 buyerCampaignApproved
16
)
Copied!

getBuyerCampaign

Returns a buyer campaign. buyer refers to the buyer's address. uri refers to the campaign uri set by the buyer. This uri field would follow the ERC1155 json specifications.
1
function getBuyerCampaign(uint256 _buyerCampaignId)
2
external
3
view
4
returns (
5
address buyer,
6
string memory uri
7
)
Copied!

getContract

Returns the state of the contract. sellerAuctionId refers to the related sellerAuction, buyerCampaignId refers to the related buyerCampaign, contractTimeStart and contractTimeEnd refers to the ending and starting time of the contract in unix seconds. contractValue refers to the value of the contract. withdrawn and refunded is a uint8 representing a boolean, where (1 is False and 2 is True). shares refers to the Shamir's secret shares that are published on the contract and totalShares refers to the total shares that are announced by the dealer validator node.
1
function getContract(uint256 _contractId)
2
external
3
view
4
returns (
5
uint256 sellerAuctionId,
6
uint256 buyerCampaignId,
7
uint256 contractTimeStart,
8
uint256 contractTimeEnd,
9
uint256 contractValue,
10
uint8 withdrawn,
11
uint8 refunded,
12
string[] memory shares,
13
uint32 totalShares
14
)
Copied!

State Changing Functions

setValidator

Sets the validator address. This can only be done by the owner of the contract which would be the Zesty DAO address.
1
function setValidator(address validator_) external onlyOwner
Copied!

setCuts

Sets the tax that would be given to the validator and the Zesty DAO
1
function setCuts(uint32 validatorCut_, uint32 zestyCut_) external onlyOwner
Copied!

setRewardsRate

Set the reward rate for buyer, seller, nft, and validator. The rate is given by the amount of reward token per transaction token.
1
function setRewardsRate(
2
uint256 rewardsRateBuyer_,
3
uint256 rewardsRateSeller_,
4
uint256 rewardsRateNFT_,
5
uint256 rewardsRateValidator_
6
)
7
external
8
onlyOwner
Copied!

buyerCampaignCreate

Allows a buyer to create a campaign. Note that buyer campaign is append only, it can only be created and not deleted or edited. The uri field of the buyer campaign should point to a IPFS hash to ensure content integrity. This ensures that a seller of an advertising space would approve content that cannot be changed.
1
function buyerCampaignCreate(string memory _uri) external
Copied!

sellerNFTDeposit

Allows a seller to deposit a NFT and set auto approval settings. Note that auto approval is a uint8 that acts as a boolean where 1 is False and 2 is True. The function uses the nonReentrant modifier.
1
function sellerNFTDeposit(
2
uint256 _tokenId,
3
uint8 _autoApprove
4
)
5
external
6
nonReentrant
Copied!

sellerNFTWithdraw

Allows a seller to withdraw an NFT when there are no auctions and contracts in progress. Only the address that deposited the NFT would be able to withdraw the NFT. The function uses the nonReentrant modifier.
1
function sellerNFTWithdraw(uint256 _tokenId) external onlyDepositor(_tokenId) nonReentrant
Copied!

sellerNFTUpdate

Allows a seller to update the autoApprove setting on the NFT. This function can be executed by the address that deposited the NFT or an appointed operator.
1
function sellerNFTUpdate(
2
uint256 _tokenId,
3
uint8 _autoApprove
4
)
5
external
6
onlyDepositorOrOperator(_tokenId)
Copied!

sellerAuctionCreateBatch

Allows a seller to create auctions for a given NFT that is deposited by the seller. This function can be called by the seller or an operator for the seller. The seller would need to specify the start and end time for the auctions, start and end time for the contract, and the starting prices of each auctions.
1
function sellerAuctionCreateBatch(
2
uint256 _tokenId,
3
uint256[] memory _auctionTimeStart,
4
uint256[] memory _auctionTimeEnd,
5
uint256[] memory _contractTimeStart,
6
uint256[] memory _contractTimeEnd,
7
uint256[] memory _priceStart
8
)
9
external
10
onlyDepositorOrOperator(_tokenId)
Copied!

sellerAuctionCancelBatch

Allows to cancel an auction if it has no bids.
1
function sellerAuctionCancelBatch(uint256[] memory _sellerAuctionId) external
Copied!

sellerAuctionBidBatch

Allows a buyer or operator for buyer to bid on an auction if the buyer is not banned. The buyer would need to specify the buyer campaign that would be used. If the auction is expired or the price has decayed to 0, bids would not be allowed. A seller should not be able to bid on their own auctions. Upon bidding, an initial deposit of transaction token would be transferred to the contract to be held in escrow. This is denoted by pricePending in the auction state.
1
function sellerAuctionBidBatch(uint256[] memory _sellerAuctionId, uint256 _buyerCampaignId) external nonReentrant
Copied!

sellerAuctionBidCancelBatch

Allows a buyer or operator for buyer to cancel a bid if the seller has not approved. This is to allow a buyer to retrieve the deposit if the seller does not approve. Returns to the buyer pricePending amount in the auction state.
1
function sellerAuctionBidCancelBatch(uint256[] memory _sellerAuctionId) external nonReentrant
Copied!

sellerAuctionApproveBatch

Allows the seller or operator to approve auctions if they are not already approved. Returns funds to the buyer if the ad slot is not immediately approved. The returned funds is the difference between the pending price and the current price of the auction. Prevents approval when price reaches 0. The buyer would need to call sellerAuctionBidCancelBatch to retrieve funds in this scenario. Alternatively, the seller would need to call sellerAuctionRejectBatch.
1
function sellerAuctionApproveBatch(uint256[] memory _sellerAuctionId) external nonReentrant
Copied!

sellerAuctionRejectBatch

Allows the seller to reject a buyer's bid. Returns the buyer's initial deposit denoted pricePending
Some of the deposit would be taxed and given to the validators and DAO address. This is meant to prevent malicious bidding. Eg. repeatedly putting NSFW campaigns on a non-NSFW seller auction.
1
function sellerAuctionRejectBatch(uint256[] memory _sellerAuctionId) external nonReentrant
Copied!

contractSetHashlockBatch

Allows the validator to set a hashlock and declare the total shares on new contracts.
1
function contractSetHashlockBatch(
2
uint256[] memory _contractId,
3
bytes32[] memory _hashlock,
4
uint32[] memory _totalShares
5
) external
Copied!

contractSetShare

Allows the validator to declare a share of the secret when it has checked that an advertising slot has been delivered at some random time between the contract start time and end time.
1
function contractSetShare(uint256 _contractId, string memory _share) external
Copied!

contractWithdrawBatch

Allows the seller to withdraw funds when the contract is over and if the secret to the hashlock is known. The withdrawal is only possible when the contract has a valid auction and valid buy campaign. If available, reward tokens will be given out to the buyer, seller, validator, to the NFT. A cut of the value would be transferred to validators and the zesty DAO.
1
function contractWithdrawBatch(uint256[] memory _contractId, bytes32[] memory _preimage) external nonReentrant
Copied!

contractRefundBatch

Allows a buyer to be refunded after the end of the contract + some gracePeriod (default 2 days). The grace period exists to give time to the seller to claim funds if the advertising slot was delivered successfully. If the seller has not claimed the funds, it means that the seller did not obtain the secret or does not want to claim the funds for some reason. In that case, the buyer would be able to retrieved locked funds.
1
function contractRefundBatch(uint256[] memory _contractId) external nonReentrant
Copied!

notifyRewardAmount

Updates the reward balance of the contract when the RewardDistributor contract distributes rewards.
1
function notifyRewardAmount(uint256 reward) external override onlyRewardsDistributor
Copied!
Last modified 3mo ago