The custom errors currently live in the main contract.

This proposes to migrate them to a separate interface contract and then import them by the main contract.

Proposal:

• add expiry to the emitted events on swap creation
• change the emitted event named creator into owner

Add a dev branch to work on new features

Prosposal:

• get the blockful erc20 from this repo
• use the blockful erc20 instead of the openzeppelin in the swaplace repo
• test for bugs and conflicts and propose the fixes as well (if needed)

The father already has access to the error interface and it should be removed from the main contract, it should be placed in the factory where all immutable features will take place.

• Delete the IErrors import from Swaplace.sol
• Remove the implementation of the contract header

The following lib is not being used and should be deleted:

import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";

There are no event emissions in the Swaplace Contract, but that is about to change, the task is to implement the events while being cohesive on the log parameters. Don't forget to organize in the interface of Swaplace.

Proposal:

• Add event emission for each function in Swaplace.sol
• Add event interface in ISwaplace.sol
• Comment the events using NatSpec

Currently, there are two signers in the tests:

The owner and the accepted.

We should change in a way where:

• A deployer signer is introduced
• The owner remains the owner
• The acceptee remains the acceptee

The explanation of the Swaplace.sol function should be in the interface, and the main contract should host a reference to the interface.

Proposal:

• Do the same thing as in #61

The error interface was introduced in the main contract of Swaplace and needs to be adapted to the SwapFactory as well.

Must be done:

• Delete non-used errors
• Import Error interface
• Adapt any inconsistencies in the flow and tests

Enhance the current .gitignore by adding comments and separating categories to each blocked file or folder.

The current explanation is using wrong grammar and should point to the IERC-TransferFrom function.

Proposal:

• Add a title to the interface contract ITransfer
• Fix the grammar
• Refer to IERC20 and IERC721

Requirements:

• #15 completed

Add the timestamp function into the utils.ts file to reduce code test size and repetition.

const timestamp = (await ethers.provider.getBlock("latest")).timestamp;

The following NatSpec needs a refactor:

• Author name (me) changed to "0xneves" on all social media
• "Blockful" name is too big and should be changed to a smaller version. Generator here

Run this:
npx hardhat node

A list of private keys will be provided in order from 1 to 10, those are the default hardhat keys.

Take the first 3 keys and place them in the '.env.sample' file, we'll be using:
1st as Deployer
2nd as Trade Creator
3rd as Trade Acceptee

They should be implemented in the hardhat config file

To avoid OS capabilities among other unnecessities the locks must be removed from the root folder and also added to the git ignore to avoid future mistakes

The tests are built in a linear way using chai, they will fail depending on the order of the tests in the script.

This is not the behavior we are expecting and should be changed to an approach where each test is independent of its context.

The #15 provides a layer of usefulness to the current issue and more tools should be implemented to easily reutilize code and reduce the code base.

One thing noted is that we don't want to make it look too complicated but rather keep providing a familiar environment for newcomers who are learning about coding.

There is an IERC20 not being used but being imported in the main Swaplace file that needs to be removed.

Proposal:

• add title for errors interface just like in #70

Proposal:

• Make acceptSwap return a boolean type as true after the function ends

The descriptions of the SwaplaceFactory.sol do not follow the OpenZeppelin standard.

They should:

• Refer to the interface in the main contract
• Describe its features in the interface contract

This is because when using those features, the explanation is always supposed to be found in the interface to reduce the code size of the main contract and standardize the process of acknowledging what the contract do.

Add Echidna to the repository. Link

Proposal:

• Add Echidna config files
• Add tests for each functionality
• Create a readme-like file to explain and monitor the tests

This card aims to find who is interested in pushing forward the development of Swaplace v2.

The architecture will be very different and security regarding allowances should be checked above all matters.

The core idea of Swaplace v2 is to sell tokenized executions on the blockchain.

You could sell ownership, stake, airdrop, claim functions and delegate to the buyer of said functions.

Please show interest by commenting on this card.

The swap.owner variable should not be passed in the InvalidAddress event as it is the msg.sender which is wrong in this scenario.

    if (swap.owner != msg.sender) {
        revert InvalidAddress(swap.owner);
    }

Must be done:

• The parameter must be swapped with msg.sender instead

Proposal:

• remove unnecessary packages from the package.json file
• check for stable versions of the remaining packages
• move all packages but hardhat to devDependencies
• remove unwanted imports from hardhat.config.ts
• generate a yarn.lock file to commit
• prepare more scripts for running hardhat scripts:
• • npx hardhat clean
• • npx hardhat compile
• • npx hardhat run scripts/deploy
• • npx hardhat test
• • npx hardhat node

Run all tests to make sure its properly working

Proposal:

Enter in the pull request page in the swaplace-contracts repository and:

• Rename the labels
• Pick colors for labels

The IERC165 already implements this feature.

Proposal:

• Remove the supportsInterface function from the interface ISwaplace.sol

I think the bigger question here is:

• What does a good README look like?
• Should it have a short description of the project and long setups?

I've tried to explain a lot in the README but it is still not good enough, maybe needs some fluxes? Or more test commands? I'm getting negative feedback from someone, but is still hard to realize what is it lacking, every readme is different in its way, so I guess it is fine for me as it is. If we look at Uniswap README file, it is very simple and short.

Thus, we are accepting feedback and suggestions on what should be changed!

This issue will remain open until:

• It is decided by the vast majority that it is viable.

Title describes it well, refactor the name across the repository.

You must follow the OpenZepelin standard on this one.

E.g.:

• interfaces must hold the descriptions and requirements rather than in the main contract itself
• internal and view functions don't need an interface if other contracts do not use their functions.

We are expanding into the Cairo ecosystem of Starknet.

This card proposes to kickstart this development by introducing the repository at first.

Definition of done:

• Running a contract on the localhost
• Running a contract on the devnet

Proposal:

• Create a NatSpec title just like in ISwaplaceFactory.sol
• Specify in ISwaplaceFactory.sol that the contract is Factory (place after the keywordSwaplace) and not regular Swaplace ie.:

/**
 * @dev Interface of the Swaplace implementation.
 */

When calling createSwap, we check if the 'swap.owner' equals address(0) otherwise it reverts.

This check is unnecessary as it is impossible for the address 0 to call the contract.

The following branches can be removed because they already served their purpose and are implemented in the remaining branches:

Remove:

• develop/swaplace-architecture
• ens/swaplaceV2
• hidromel
• review
• selling-function-calls
• swaplace-v1

Keep:

• main
• ens/prod/swaplace
• prod/eth-version

Proposal:

• Add etherscan api key to env.sample
• Add etherscan api key to hardhat.config

Milestones can be added to the pull request page of the repository where the milestone will be tracked:

blockful-io => swaplace-contracts => pull-requests => milestones

This issue will be the first in the Milestone here proposed as the one to be completed by 11/15/2023 when Swaplace v1.0.0 is fully operating

Change the entire perspective when using calldata and structs into regular types. By that, I mean to delete the 'Swap' struct and use the input directly.

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;

interface ISwap {
    struct Asset {
        address addr;
        uint256 amountOrCallOrId;
    }

    struct Swap {
        address owner;
        address allowed;
        uint256 expiry;
        Asset[] biding;
        Asset[] asking;
    }
}

The variable amountOrCallOrId is used to determine what type of unit of value is being used by the swap.

If it is ERC20 will be amount/value and if it is ERC721 will be tokenId. But the call method will not be used in this milestone.

Rebase all the amountOrCallOrId and change for amountOrId

As the title describes, we changed them to look alike.

The colors picked for labels should be introduced by looking for vivid and friendly colors regarding matter.

Chatgpt is a good way to decide that

It's currently being used by the tests of swaplace, thus the need to create a utils.ts script to compose the swaps using typescript and then call it on the test files.

• Delete all about composing swaps in the SwapFactory.
• Forge utils file to aid swap making in tests
• Update all tests previously using composeSwap
• @edit add virtual keyword to the function in the SwaplaceFactory

The main variables of the contract have no comments on them.

Proposal:

• Comment what the variables do in a single line

Definition of Done:

• Find all the Trade keywords and change them into Swap as it is more logical following the sex appeal of the project and avoid mismatching with a word that is (for most people) attached to negativity.

We are setting an expiry time when we create a swap. We add the block timestamp on-chain. This will be more gas-consuming and the off-chain is more than willing to calculate the expiry for us.

Proposal:

• Change the expiry to be checked summing to the current block.timestamp.
• Remove the line where the swap.expiry is edited after the swap was stored.
• Fix all the loose knots from the test file after applying this change as it will require the current timestamp to be added to the expiry.

This task consists of finding default providers specified by the mainnet itself for the following EVM networks:

-BNB
-MATIC
-ETH
-AVAX
-FTM
-ASTR

They should be set in '.env.sample' file that the task assignee should create as well.
They should be implemented in the hardhat config file.

Proposal:

• Manually import the IERC165 into the interface folder of the Swaplace contracts
• Point the import on Swaplace.sol to the recent added file

The current NatSpec of the SwapFactory isn't looking that create in terms of explaining the file itself and it is also not matching the changes from the issue #5

Must be done:

• Make the same layout as the Swaplace contract
• Remove the Blockful character image since it is an implementation that is not the main contract
• Add a more readable and informative way to understand its underlying functions in the scope
• Provide examples of usage in the title as well

Follow the same standard used in the rest of the contract (OpenZeppelin's) to describe the interface of ISwap.sol.

Proposal:

• Implement the NatSpec interface for the ISwap.sol

We already checked if the owner is the same as the msg.sender in the createSwap function, we can revoke this check from the SwapFactory Contract.

Revoke bellow code from SwapFactory:

      if (owner == address(0)) {
          revert InvalidAddress(address(0));
      }