difftreelog
Merge pull request #954 from UniqueNetwork/feature/update_market_v2_contract
in: master
4 files changed
tests/package.jsondiffbeforeafterboth47 "testEthNesting": "yarn _test './**/eth/nesting/**/*.*test.ts'",47 "testEthNesting": "yarn _test './**/eth/nesting/**/*.*test.ts'",48 "testEthFractionalizer": "yarn _test './**/eth/fractionalizer/**/*.*test.ts'",48 "testEthFractionalizer": "yarn _test './**/eth/fractionalizer/**/*.*test.ts'",49 "testEthMarketplace": "yarn _test './**/eth/marketplace/**/*.*test.ts'",49 "testEthMarketplace": "yarn _test './**/eth/marketplace/**/*.*test.ts'",50 "testEthMarket": "yarn _test './**/eth/marketplace-v2/**/*.*test.ts'",50 "testSub": "yarn _test './**/sub/**/*.*test.ts'",51 "testSub": "yarn _test './**/sub/**/*.*test.ts'",51 "testSubNesting": "yarn _test './**/sub/nesting/**/*.*test.ts'",52 "testSubNesting": "yarn _test './**/sub/nesting/**/*.*test.ts'",52 "testEvent": "yarn _test ./src/check-event/*.*test.ts",53 "testEvent": "yarn _test ./src/check-event/*.*test.ts",tests/src/eth/marketplace-v2/Market.soldiffbeforeafterboth--- a/tests/src/eth/marketplace-v2/Market.sol
+++ b/tests/src/eth/marketplace-v2/Market.sol
@@ -1,13 +1,16 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.17;
+import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "@openzeppelin/contracts/access/Ownable.sol";
import { UniqueNFT, CrossAddress } from "@unique-nft/solidity-interfaces/contracts/UniqueNFT.sol";
+import { UniqueFungible, CrossAddress as CrossAddressF } from "@unique-nft/solidity-interfaces/contracts/UniqueFungible.sol";
import "@unique-nft/solidity-interfaces/contracts/CollectionHelpers.sol";
import "./royalty/UniqueRoyaltyHelper.sol";
-contract Market {
+contract Market is Ownable, ReentrancyGuard {
using ERC165Checker for address;
struct Order {
@@ -20,6 +23,7 @@
}
uint32 public constant version = 0;
+ uint32 public constant buildVersion = 3;
bytes4 private constant InterfaceId_ERC721 = 0x80ac58cd;
bytes4 private constant InterfaceId_ERC165 = 0x5755c3f2;
CollectionHelpers private constant collectionHelpers =
@@ -29,7 +33,6 @@
uint32 private idCount = 1;
uint32 public marketFee;
uint64 public ctime;
- address selfAddress;
address public ownerAddress;
mapping(address => bool) public admins;
@@ -55,15 +58,11 @@
error OrderNotFound();
error TooManyAmountRequested();
error NotEnoughMoneyError();
+ error InvalidRoyaltiesError(uint256 totalRoyalty);
error FailTransferToken(string reason);
-
- modifier onlyOwner() {
- require(msg.sender == ownerAddress, "Only owner can");
- _;
- }
modifier onlyAdmin() {
- require(msg.sender == ownerAddress || admins[msg.sender], "Only admin can");
+ require(msg.sender == this.owner() || admins[msg.sender], "Only admin can");
_;
}
@@ -83,13 +82,22 @@
marketFee = fee;
ctime = timestamp;
- if (marketFee == 0 || marketFee >= 100) {
+ if (marketFee >= 100) {
revert InvalidMarketFee();
}
+ }
+
+ /**
+ * Fallback that allows this contract to receive native token.
+ * We need this for self-sponsoring
+ */
+ fallback() external payable {}
- ownerAddress = msg.sender;
- selfAddress = address(this);
- }
+ /**
+ * Receive also allows this contract to receive native token.
+ * We need this for self-sponsoring
+ */
+ receive() external payable {}
function getErc721(uint32 collectionId) private view returns (IERC721) {
address collectionAddress = collectionHelpers.collectionAddress(
@@ -110,36 +118,35 @@
}
return IERC721(collectionAddress);
- }
-
- // ################################################################
- // Set new contract owner #
- // ################################################################
-
- function setOwner() public onlyOwner {
- ownerAddress = msg.sender;
}
-
- // ################################################################
- // Add new admin #
- // ################################################################
+ /**
+ * Add new admin. Only owner or an existing admin can add admins.
+ *
+ * @param admin: Address of a new admin to add
+ */
function addAdmin(address admin) public onlyAdmin {
admins[admin] = true;
}
- // ################################################################
- // Remove admin #
- // ################################################################
-
+ /**
+ * Remove an admin. Only owner or an existing admin can remove admins.
+ *
+ * @param admin: Address of a new admin to add
+ */
function removeAdmin(address admin) public onlyAdmin {
delete admins[admin];
}
- // ################################################################
- // Place a token for sale #
- // ################################################################
-
+ /**
+ * Place an NFT or RFT token for sale. It must be pre-approved for transfers by this contract address.
+ *
+ * @param collectionId: ID of the token collection
+ * @param tokenId: ID of the token
+ * @param price: Price (with proper network currency decimals)
+ * @param amount: Number of token fractions to list (must always be 1 for NFT)
+ * @param seller: The seller cross-address (the beneficiary account to receive payment, may be different from transaction sender)
+ */
function put(
uint32 collectionId,
uint32 tokenId,
@@ -164,7 +171,7 @@
revert SellerIsNotOwner();
}
- if (erc721.getApproved(tokenId) != selfAddress) {
+ if (erc721.getApproved(tokenId) != address(this)) {
revert TokenIsNotApproved();
}
@@ -182,11 +189,14 @@
emit TokenIsUpForSale(version, order);
}
-
- // ################################################################
- // Get order #
- // ################################################################
+ /**
+ * Get information about the listed token order
+ *
+ * @param collectionId: ID of the token collection
+ * @param tokenId: ID of the token
+ * @return The order information
+ */
function getOrder(
uint32 collectionId,
uint32 tokenId
@@ -194,10 +204,13 @@
return orders[collectionId][tokenId];
}
- // ################################################################
- // Revoke the token from the sale #
- // ################################################################
-
+ /**
+ * Revoke the token from the sale. Only the original lister can use this method.
+ *
+ * @param collectionId: ID of the token collection
+ * @param tokenId: ID of the token
+ * @param amount: Number of token fractions to de-list (must always be 1 for NFT)
+ */
function revoke(
uint32 collectionId,
uint32 tokenId,
@@ -239,10 +252,12 @@
emit TokenRevoke(version, order, amount);
}
- // ################################################################
- // Check approved #
- // ################################################################
-
+ /**
+ * Test if the token is still approved to be transferred by this contract and delete the order if not.
+ *
+ * @param collectionId: ID of the token collection
+ * @param tokenId: ID of the token
+ */
function checkApproved(uint32 collectionId, uint32 tokenId) public onlyAdmin {
Order memory order = orders[collectionId][tokenId];
if (order.price == 0) {
@@ -251,7 +266,7 @@
IERC721 erc721 = getErc721(collectionId);
- if (erc721.getApproved(tokenId) != selfAddress) {
+ if (erc721.getApproved(tokenId) != address(this) || erc721.ownerOf(tokenId) != getAddressFromCrossAccount(order.seller)) {
uint32 amount = order.amount;
order.amount = 0;
emit TokenRevoke(version, order, amount);
@@ -262,16 +277,47 @@
}
}
- // ################################################################
- // Buy a token #
- // ################################################################
+ function getAddressFromCrossAccount(CrossAddress memory account) private pure returns (address) {
+ if (account.eth != address(0)) {
+ return account.eth;
+ } else {
+ return address(uint160(account.sub >> 96));
+ }
+ }
+
+ /**
+ * Revoke the token from the sale. Only the contract admin can use this method.
+ *
+ * @param collectionId: ID of the token collection
+ * @param tokenId: ID of the token
+ */
+ function revokeAdmin(uint32 collectionId, uint32 tokenId) public onlyAdmin {
+ Order memory order = orders[collectionId][tokenId];
+ if (order.price == 0) {
+ revert OrderNotFound();
+ }
+ uint32 amount = order.amount;
+ order.amount = 0;
+ emit TokenRevoke(version, order, amount);
+
+ delete orders[collectionId][tokenId];
+ }
+
+ /**
+ * Buy a token (partially for an RFT).
+ *
+ * @param collectionId: ID of the token collection
+ * @param tokenId: ID of the token
+ * @param amount: Number of token fractions to buy (must always be 1 for NFT)
+ * @param buyer: Cross-address of the buyer, eth part must be equal to the transaction signer address
+ */
function buy(
uint32 collectionId,
uint32 tokenId,
uint32 amount,
CrossAddress memory buyer
- ) public payable validCrossAddress(buyer.eth, buyer.sub) {
+ ) public payable validCrossAddress(buyer.eth, buyer.sub) nonReentrant {
if (msg.value == 0) {
revert InvalidArgument("msg.value must not be zero");
}
@@ -296,7 +342,7 @@
}
IERC721 erc721 = getErc721(order.collectionId);
- if (erc721.getApproved(tokenId) != selfAddress) {
+ if (erc721.getApproved(tokenId) != address(this)) {
revert TokenIsNotApproved();
}
@@ -316,26 +362,30 @@
order.tokenId
);
- (uint256 totalRoyalty, RoyaltyAmount[] memory royalties) = sendRoyalties(collectionAddress, tokenId, totalValue);
+ (uint256 totalRoyalty, RoyaltyAmount[] memory royalties) = sendRoyalties(collectionAddress, tokenId, totalValue - feeValue);
+ if (totalRoyalty >= totalValue - feeValue) {
+ revert InvalidRoyaltiesError(totalRoyalty);
+ }
+
sendMoney(order.seller, totalValue - feeValue - totalRoyalty);
if (msg.value > totalValue) {
- // todo, send money to signer or buyer ?
- payable(msg.sender).transfer(msg.value - totalValue);
+ sendMoney(buyer, msg.value - totalValue);
}
emit TokenIsPurchased(version, order, amount, buyer, royalties);
}
function sendMoney(CrossAddress memory to, uint256 money) private {
- address payable eth;
- if (to.eth != address(0)) {
- eth = payable(to.eth);
- } else {
- eth = payable(address(uint160(to.sub >> 96)));
- }
- eth.transfer(money);
+ address collectionAddress = collectionHelpers.collectionAddress(0);
+
+ UniqueFungible fungible = UniqueFungible(collectionAddress);
+
+ CrossAddressF memory fromF = CrossAddressF(address(this), 0);
+ CrossAddressF memory toF = CrossAddressF(to.eth, to.sub);
+
+ fungible.transferFromCross(fromF, toF, money);
}
function sendRoyalties(address collection, uint tokenId, uint sellPrice) private returns (uint256, RoyaltyAmount[] memory) {
@@ -355,7 +405,7 @@
}
function withdraw(address transferTo) public onlyOwner {
- uint256 balance = selfAddress.balance;
+ uint256 balance = address(this).balance;
if (balance > 0) {
payable(transferTo).transfer(balance);
tests/src/eth/marketplace-v2/marketplace.test.tsdiffbeforeafterboth--- a/tests/src/eth/marketplace-v2/marketplace.test.ts
+++ b/tests/src/eth/marketplace-v2/marketplace.test.ts
@@ -16,13 +16,15 @@
import {IKeyringPair} from '@polkadot/types/types';
import {readFile} from 'fs/promises';
-import {EthUniqueHelper, itEth, usingEthPlaygrounds} from '../util';
+import {EthUniqueHelper, SponsoringMode, itEth, usingEthPlaygrounds} from '../util';
import {makeNames} from '../../util';
import {expect} from 'chai';
import Web3 from 'web3';
const {dirname} = makeNames(import.meta.url);
+const MARKET_FEE = 1;
+
describe('Market V2 Contract', () => {
let donor: IKeyringPair;
@@ -43,10 +45,26 @@
fsPath: `${dirname}/../api/UniqueNFT.sol`,
},
{
+ solPath: '@unique-nft/solidity-interfaces/contracts/UniqueFungible.sol',
+ fsPath: `${dirname}/../api/UniqueFungible.sol`,
+ },
+ {
solPath: '@openzeppelin/contracts/utils/introspection/IERC165.sol',
fsPath: `${dirname}/../../../node_modules/@openzeppelin/contracts/utils/introspection/IERC165.sol`,
},
{
+ solPath: '@openzeppelin/contracts/access/Ownable.sol',
+ fsPath: `${dirname}/../../../node_modules/@openzeppelin/contracts/access/Ownable.sol`,
+ },
+ {
+ solPath: '@openzeppelin/contracts/utils/Context.sol',
+ fsPath: `${dirname}/../../../node_modules/@openzeppelin/contracts/utils/Context.sol`,
+ },
+ {
+ solPath: '@openzeppelin/contracts/security/ReentrancyGuard.sol',
+ fsPath: `${dirname}/../../../node_modules/@openzeppelin/contracts/security/ReentrancyGuard.sol`,
+ },
+ {
solPath: '@openzeppelin/contracts/utils/introspection/ERC165Checker.sol',
fsPath: `${dirname}/../../../node_modules/@openzeppelin/contracts/utils/introspection/ERC165Checker.sol`,
},
@@ -72,7 +90,7 @@
},
],
15000000,
- [1, 0],
+ [MARKET_FEE, 0],
);
}
@@ -90,63 +108,135 @@
});
itEth('Put + Buy [eth]', async ({helper}) => {
- const marketOwner = await helper.eth.createAccountWithBalance(donor, 600n);
+ const ONE_TOKEN = helper.balance.getOneTokenNominal();
+ const PRICE = 2n * ONE_TOKEN; // 2 UNQ
+ const marketOwner = await helper.eth.createAccountWithBalance(donor, 60000n);
const market = await deployMarket(helper, marketOwner);
+ const contractHelpers = helper.ethNativeContract.contractHelpers(marketOwner);
+
+ // Set external sponsoring
+ await contractHelpers.methods.setSponsor(market.options.address, marketOwner).send({from: marketOwner});
+ await contractHelpers.methods.confirmSponsorship(market.options.address).send({from: marketOwner});
+ // Configure sponsoring
+ await contractHelpers.methods.setSponsoringMode(market.options.address, SponsoringMode.Generous).send({from: marketOwner});
+ await contractHelpers.methods.setSponsoringRateLimit(market.options.address, 0).send({from: marketOwner});
+
const {collectionId, collectionAddress} = await helper.eth.createNFTCollection(marketOwner, 'Sponsor', 'absolutely anything', 'ROC');
- const collection = await helper.ethNativeContract.collection(collectionAddress, 'nft', marketOwner);
+ const collection = helper.ethNativeContract.collection(collectionAddress, 'nft', marketOwner, true);
+
+ // Set collection sponsoring
+ await collection.methods.setCollectionSponsor(marketOwner).send({from: marketOwner});
+ await collection.methods.confirmCollectionSponsorship().send({from: marketOwner});
- const sellerCross = await helper.ethCrossAccount.createAccountWithBalance(donor, 600n);
+ const sellerCross = helper.ethCrossAccount.createAccount();
const result = await collection.methods.mintCross(sellerCross, []).send();
const tokenId = result.events.Transfer.returnValues.tokenId;
await collection.methods.approve(market.options.address, tokenId).send({from: sellerCross.eth});
- const putResult = await market.methods.put(collectionId, tokenId, 1, 1, sellerCross).send({from: sellerCross.eth});
+ // Seller has no funds at all, his transactions are sponsored
+ const sellerBalance = await helper.balance.getEthereum(sellerCross.eth);
+ expect(sellerBalance).to.be.eq(0n);
+
+ const putResult = await market.methods.put(collectionId, tokenId, PRICE.toString(), 1, sellerCross).send({
+ from: sellerCross.eth, gasLimit: 1_000_000,
+ });
expect(putResult.events.TokenIsUpForSale).is.not.undefined;
+
+ // Seller balance are still 0
+ const sellerBalanceAfter = await helper.balance.getEthereum(sellerCross.eth);
+ expect(sellerBalanceAfter).to.be.eq(0n);
+
let ownerCross = await collection.methods.ownerOfCross(tokenId).call();
expect(ownerCross.eth).to.be.eq(sellerCross.eth);
expect(ownerCross.sub).to.be.eq(sellerCross.sub);
- const buyerCross = await helper.ethCrossAccount.createAccountWithBalance(donor, 600n);
- const buyResult = await market.methods.buy(collectionId, tokenId, 1, buyerCross).send({from: buyerCross.eth, value: 1});
+ const buyerCross = await helper.ethCrossAccount.createAccountWithBalance(donor, 10n);
+
+ // Buyer has only 10 UNQ
+ const buyerBalance = await helper.balance.getEthereum(buyerCross.eth);
+ expect(buyerBalance).to.be.eq(10n * ONE_TOKEN);
+
+ const buyResult = await market.methods.buy(collectionId, tokenId, 1, buyerCross).send({from: buyerCross.eth, value: PRICE.toString(), gasLimit: 1_000_000});
expect(buyResult.events.TokenIsPurchased).is.not.undefined;
+
+ // Buyer pays only value, transaction use sponsoring
+ const buyerBalanceAfter = await helper.balance.getEthereum(buyerCross.eth);
+ expect(buyerBalanceAfter).to.be.eq(10n * ONE_TOKEN - PRICE);
+
ownerCross = await collection.methods.ownerOfCross(tokenId).call();
expect(ownerCross.eth).to.be.eq(buyerCross.eth);
expect(ownerCross.sub).to.be.eq(buyerCross.sub);
});
itEth('Put + Buy [sub]', async ({helper}) => {
- const PRICE = 1n;
+ const ONE_TOKEN = helper.balance.getOneTokenNominal();
+ const PRICE = 2n * ONE_TOKEN; // 2 UNQ
const web3 = helper.getWeb3();
const marketOwner = await helper.eth.createAccountWithBalance(donor, 600n);
const market = await deployMarket(helper, marketOwner);
+ const contractHelpers = helper.ethNativeContract.contractHelpers(marketOwner);
+
+ // Set self sponsoring from contract balance
+ await contractHelpers.methods.selfSponsoredEnable(market.options.address).send({from: marketOwner});
+ await helper.eth.transferBalanceFromSubstrate(donor, market.options.address, 10n);
+
+ // Configure sponsoring
+ await contractHelpers.methods.setSponsoringMode(market.options.address, SponsoringMode.Generous).send({from: marketOwner});
+ await contractHelpers.methods.setSponsoringRateLimit(market.options.address, 0).send({from: marketOwner});
const {collectionId, collectionAddress} = await helper.eth.createNFTCollection(marketOwner, 'Sponsor', 'absolutely anything', 'ROC');
- const collection = await helper.ethNativeContract.collection(collectionAddress, 'nft', marketOwner);
+ const collection = helper.ethNativeContract.collection(collectionAddress, 'nft', marketOwner, true);
+
+ // Set collection sponsoring
+ await collection.methods.setCollectionSponsor(marketOwner).send({from: marketOwner});
+ await collection.methods.confirmCollectionSponsorship().send({from: marketOwner});
- const [seller] = await helper.arrange.createAccounts([600n], donor);
- const sellerMirror = helper.address.substrateToEth(seller.address);
+ const seller = helper.util.fromSeed(`//Market-seller-${(new Date()).getTime()}`);
const sellerCross = helper.ethCrossAccount.fromKeyringPair(seller);
+
+ // Seller has no funds at all, his transactions are sponsored
+ {
+ const sellerBalance = await helper.balance.getSubstrate(seller.address);
+ expect(sellerBalance).to.be.eq(0n);
+ }
+
const result = await collection.methods.mintCross(sellerCross, []).send();
const tokenId = result.events.Transfer.returnValues.tokenId;
- await helper.nft.approveToken(seller, collectionId, tokenId, {Ethereum: market.options.address}, 1n);
+ await helper.nft.approveToken(seller, collectionId, tokenId, {Ethereum: market.options.address});
await helper.eth.sendEVM(seller, market.options.address, market.methods.put(collectionId, tokenId, PRICE, 1, sellerCross).encodeABI(), '0');
+ // Seller balance is still zero
+ {
+ const sellerBalance = await helper.balance.getSubstrate(seller.address);
+ expect(sellerBalance).to.be.eq(0n);
+ }
let ownerCross = await collection.methods.ownerOfCross(tokenId).call();
expect(ownerCross.eth).to.be.eq(sellerCross.eth);
expect(substrateAddressToHex(ownerCross.sub, web3)).to.be.eq(substrateAddressToHex(sellerCross.sub, web3));
const [buyer] = await helper.arrange.createAccounts([600n], donor);
+ // Buyer has only expected balance
+ {
+ const buyerBalance = await helper.balance.getSubstrate(buyer.address);
+ expect(buyerBalance).to.be.eq(600n * ONE_TOKEN);
+ }
const buyerMirror = helper.address.substrateToEth(buyer.address);
const buyerCross = helper.ethCrossAccount.fromKeyringPair(buyer);
- await helper.eth.transferBalanceFromSubstrate(donor, buyerMirror, 1n);
- //TODO: change balance check to helper.balance.getSubstrate when implementation of sendMoney will be fixed in contract
- const sellerBalance = BigInt(await web3.eth.getBalance(sellerMirror));
+ await helper.eth.transferBalanceFromSubstrate(donor, buyerMirror, PRICE, false);
+
+ const buyerBalanceBefore = await helper.balance.getSubstrate(buyer.address);
await helper.eth.sendEVM(buyer, market.options.address, market.methods.buy(collectionId, tokenId, 1, buyerCross).encodeABI(), PRICE.toString());
- const sellerBalanceAfterBuy = BigInt(await web3.eth.getBalance(sellerMirror));
+ const buyerBalanceAfter = await helper.balance.getSubstrate(buyer.address);
+ // Buyer balance not changed: transaction is sponsored
+ expect(buyerBalanceBefore).to.be.eq(buyerBalanceAfter);
+
+ const sellerBalanceAfterBuy = BigInt(await helper.balance.getSubstrate(seller.address));
ownerCross = await collection.methods.ownerOfCross(tokenId).call();
expect(ownerCross.eth).to.be.eq(buyerCross.eth);
expect(substrateAddressToHex(ownerCross.sub, web3)).to.be.eq(substrateAddressToHex(buyerCross.sub, web3));
- expect(sellerBalance + PRICE).to.be.equal(sellerBalanceAfterBuy);
+
+ // Seller got only PRICE - MARKET_FEE
+ expect(sellerBalanceAfterBuy).to.be.eq(PRICE * BigInt(100 - MARKET_FEE) / 100n);
});
});
tests/src/eth/tokenProperties.test.tsdiffbeforeafterboth--- a/tests/src/eth/tokenProperties.test.ts
+++ b/tests/src/eth/tokenProperties.test.ts
@@ -561,10 +561,10 @@
itEth.ifWithPallets(`[${testCase.mode}] Can't be multiple set/read for non-existent token`, testCase.requiredPallets, async({helper}) => {
const caller = await helper.eth.createAccountWithBalance(donor);
- const properties = Array(5).fill(0).map((_, i) => { return {key: `key_${i}`, value: Buffer.from(`value_${i}`)}; });
- const permissions: ITokenPropertyPermission[] = properties.map(p => { return {key: p.key, permission: {tokenOwner: true,
+ const properties = Array(5).fill(0).map((_, i) => ({key: `key_${i}`, value: Buffer.from(`value_${i}`)}));
+ const permissions: ITokenPropertyPermission[] = properties.map(p => ({key: p.key, permission: {tokenOwner: true,
collectionAdmin: true,
- mutable: true}}; });
+ mutable: true}}));
const collection = await helper[testCase.mode].mintCollection(alice, {
tokenPrefix: 'ethp',