P2P Token Exchange

A simple Peer 2 Peer Token exchange where;

sellers create a trade listing, depositing their ERC20 tokens to trade into the contract.
buyers pay ETH for the tokens and both actors are paid their coins.

This project focuses on the best patterns and practices implementation from the Consensys academy bootcamp. A lot of focus of the solution is the incorporation of important ethereum design patterns, protection mechanisms and the stretch goals that would be used in a real world decentralized solution. The project evaluation checklist provided below lists the completed tasks.

User Journey

Navigate to the REACT Dapp on IPFS https://ipfs.io/ipfs/QmdXFKKok8i3E26V7mW7ZPPxqDzvMAjXywTwf8Rk8JT9fu
See a list of available trades or
Create a trade listing and deposit your ERC20 Tokens escrowed in the contract
Buyers can select a trade to fulfil and send ETH to the contract and will be send your tokens, you will be sent the ETH
Withdraw your trade listing and have your tokens returned to you

Setup

Requirements:

Truffle
Node Package Manager (npm)
Ganache CLI
MetaMask

Steps:

Run Tests

Clone the repo and cd into the folder
Install all the dependencies for the Truffle environment (Zeppelin library, ethers.js for the tests...etc).
```
$ npm install
```
Start a local blockchain with Ganache. Make sure it is set on port 8545 and set the block gas limit to 8,000,000 becuase the exchange contract is too big to deploy
```
$ ganache-cli -p 8545 -l 8000000
```
Run truffle test

You should see

Run the DAPP

Steps:

From ganache, grab the private key of the first account and add it to metamask
Connect Metamask to localhost
in MetaMask add the private key of the first account in ganache
Run
```
$ truffle migrate
```
Grab the ShartCoin address from ganache
and add the custom token to metamask.
You should see you have 100B SHT
Go the client directory and install all the app dependencies.
```
$ cd client
$ npm install
```

As this app is using ether.js the Contract constructor will need the contract address. You will need to update the address in App.js. Update SMART_CONTRACT_ADDR to point to your local deployed address

const SMART_CONTRACT_ADDR_ROPSTEN = "0xf371b912b26d3c9220e4e7cbc312591e6074721a";
const SMART_CONTRACT_ADDR_LOCAL = "";
const SMART_CONTRACT_ENS = "p2ptokenexchange.eth";

// Set this const to your chosen ENV
const SMART_CONTRACT_ADDR = SMART_CONTRACT_ADDR_ROPSTEN;

Start the React app.
```
$ npm run start
```
Alternatively you can test the app with the ropsten deployed addresses

Ropsten:

TokenExchange: https://ropsten.etherscan.io/address/0xF371b912B26d3c9220e4e7cbC312591E6074721A
TokenExchange ABI https://gist.github.com/hav-noms/4da6852c9656e10217cfda83f998bdd3
Proxy: https://ropsten.etherscan.io/address/0x5f05f53A0E3E19A0de45b0Ac85100e3e61aE7EE4
ShartCoin: https://ropsten.etherscan.io/token/0x651d56e6cCe013cf08C32b7E53cD2A1cbf103976
TokenExchangeState: https://ropsten.etherscan.io/address/0xF371b912B26d3c9220e4e7cbC312591E6074721A

Rinkeby:

I did not deploy to rinkeby as ENS is not available on Rikeby only Ropsten

Deployed versions of the dApp

Ropsten: https://p2ptokenexchange-ropsten.netlify.com

To test the ROPSTEN connected DAPP you can buy the existing SHT coin tokens for ROPSTEN ETH and then sell them back to the exchange to create a listing. Or send any ERC20 on ROPSTEN to create a listing. Or ping me with your MM wallet address and I'll send you some SHT.

IPFS: https://ipfs.io/ipfs/QmdXFKKok8i3E26V7mW7ZPPxqDzvMAjXywTwf8Rk8JT9fu

Developer Bootcamp Final Project Evaluation Checklist

Project Requirements

User Interface

Run the dapp on a development server locally for testing and grading.
- Testing on Ropsten; (I chose ropsten instead of rinkeby becuase there is no ENS on rinkeby)
You should be able to visit a URL (can be localhost) and interact with the application
- localhost via npm run start in client dir
- https://p2ptokenexchange-ropsten.netlify.com
Display the current account;
Sign transactions using MetaMask;
Reflect updates to the contract state

Testing

Write 5 tests for each contract you wrote in Javascript;
Tests are properly structured (ie sets up context, executes a call on the function to be tested, and verifies the result is correct)
Explain why you wrote those tests in code comments;
Tests provide adequate coverage for the contracts
All Tests pass with truffle test.

Design Patterns

Implement a circuit breaker (emergency stop) pattern.
What other design patterns have you used / not used?
- Why did you choose the patterns that you did?

Security Tools / Common Attacks

Explain what measures you have taken to ensure that your contracts are not susceptible to common attacks.

Use a Library or Extend a Contract

At least one of the project contracts includes an import from a library/contract or an ethPM package.

Deployment

Additional

Smart Contract code should be commented according to the specs in the documentation https://solidity.readthedocs.io/en/v0.4.21/layout-of-source-files.html#comments"

hav-noms / final-project-hav-noms Goto Github PK

final-project-hav-noms's Introduction

P2P Token Exchange

User Journey

Setup

Steps:

Run Tests

Run the DAPP

Deployed versions of the dApp

Developer Bootcamp Final Project Evaluation Checklist

Project Requirements

User Interface

Testing

Design Patterns

Security Tools / Common Attacks

Use a Library or Extend a Contract

Deployment

Additional

Stretch

final-project-hav-noms's People

Contributors

Watchers

Recommend Projects

Recommend Topics

Recommend Org