This repo contains the solidity code used in the Bazaar smart contracts hosted on the compatible EVM mainnets.
| Command | Description | |
|---|---|---|
| 1 | npm install | Installs dependencies |
| 2 | truffle run coverage | Runs tests and coverage report |
| 3 | truffle compile | Compiles contracts |
| 4 | truffle test | Runs tests for the contract (start truffle dev command-line first) |
| 5 | deployMumbai | Deploys contract on mumbai (need to create .privKey with private key) |
| 6 | verifyMumbai | Verifies contract and publishes code on polygonscan |
The Web3 Bazaar is a dApp supported by non-custodial escrow contracts that enable peer-to-peer swaps of ERC-20, ERC-721 or ERC-1155 tokens. The contracts' only purpose is to swap asset ownership from one wallet address to another under according to the terms pre-established by both parties.
- fully permisionless: every token from a supported standard can be traded by every wallet withouth censorship.
- non-custodial: Your assets never leave your wallet until the trade is complete.
- free to use: no fees are charged to access or swap assets within the Bazaar (apart from gas fees)
- bundle transaction enabled: asset owners can do 1:1 trades or mix assets in a bundle to trade for another set of assets owned by the counter-party.
| Network | Contract address |
|---|---|
| Polygon | 0xa80e4eA13aC0d8Fb1bfD1f57697cB49B445eF8Db |
- Establishing trade terms between two different wallet addresses (a creator wallet and an executor wallet)
- trade terms can involve single or bundles of ERC-20, ERC-721 and ERC-1155 tokens from the networks it is hosted in.
- there's a limit of 1,000 assets allowed per party per trade
- the contract never stores or recieves assets in order to execute a trade
- the contract only stores the data about trade terms in it
- The smart contract verifies the ownership of assets from both parties before executing a swap
- a swap is executed only after both parties confirm the trade and the verification is succesfull
- a swap occurs with assets moving from one wallet to another in the same transaction
- a trade can be cancelled both by the creator and executor, making it unexecutable by anyone
- only wallet addresses provided in trade terms can execute a trade
The contract handles a state machine within in order to determine and limit the methods that are interactable according to the actions already performed by the parties.
| State | Description |
|---|---|
| Created | Terms are established in the contract and counter-party can now execute the trade. Both parties can change the state to "Cancelled" |
| Completed | Counter-party executed the trade and assets swapped wallets. The trade can't be executed anymore |
| Cancelled | One of the parties cancelled the trade and it can't be executed anymore |
A trade is started by the Creator who provides the terms (assets' smart contract addresses and counter-party wallet address). The smart contract procceeds with its validation an checks if all the assets belong to the wallet addresses provided and if the creator gave the necessary permissions for the smart contract to perform the swap. if an issue is detected the, the trade isn't submitted and the code returns an error as describbed in the ERROR LIST at the end of this Readme.
| Parameter | Input |
|---|---|
| creatorTokenAddress[] | smart contract address of the asset you're going to deposit |
| creatorTokenId[] | for ERC-721 and ERC-1155 assets only. Input the specific ID of the NFT you're depositing |
| creatorAmount[] | amount of assets to deposit. Non-applicable to ERC-721 assets |
| creatorTokenType[] | "1" for native token, "2" for ERC-20, "3" for ERC-721 or "4" for ERC-1155 |
| executerAddress | wallet address of the trade counterparty |
| executorAssetContract | smart contract address of the asset expected form counterparty |
| executorTokenAddress[] | "1" for native token, "2" for ERC-20, "3" for ERC-721 or "4" for ERC-1155 |
| executorTokenId[] | for ERC-721 and ERC-1155 assets only. nNput the specific ID of the NFT you're expecting from the counterparty |
| executorAmount[] | amount of assets to deposit. Non-applicable to ERC-721 assets |
| executorTokenType[] | "1" for native token, "2" for ERC-20, "3" for ERC-721 or "4" for ERC-1155 |
Note: Once this method is called, the smart contract will return a unique
tradeIdvalue that will be used by the methods below in order to limit the operations to the designtaed parties and assets.
The contract then internally stores all the trade terms and assets' data depicted below:
When a trade is submitted and enters created status and the counter-party becomes able to execute it. to do so, counter-party must first approve the contract methods to move its assets.
A verification of the ownership of the assets provided in the trade terms is performed again before executing it.
Upon succesful verification the contract executes the swap and changes the status of the trade to Completed
| Parameter | Input |
|---|---|
| tradeId | Input value returned by startTrade method |
Get Trade methods gives information about the trade based on the `tradeId and user wallet. It returns asset's swapped in that trade.
| Paramater name | Description |
|---|---|
| tradeId | tradeId |
| userWallet | user address |
| Code | Description |
|---|---|
| CREATOR_PARMS_LEN_ERROR | Error sending parameters for creator |
| EXECUTER_PARMS_LEN_ERROR | Error sending parameters for executer |
| ERR_NOT_OWN_ID_ERC721 | User doesn't own the other ERC721 ID asset |
| ERR_NOT_ALLOWED_TO_TRANSER_ITEMS_ERC721 | User did not give permission to spend ERC721 |
| ERR_NOT_ENOUGH_FUNDS_ERC20 | The user does not have enough ERC20 |
| ERR_NOT_ALLOWED_TO_SPEND_FUNDS | User did not give permission to spend ERC20 |
| ERR_NOT_ENOUGH_FUNDS_ERC1155 | The user has not own the amount specified for ERC1155 |
| ERR_NOT_ALLOWED_TO_TRANSER_ITEMS_ERC1155 | user did not give permission to spend ERC1155 |