token-swap's Introduction

Token Swap

Swap Ether and ERC20 tokens on the Ethereum network. This is beta software so, please, use with caution.

If you found this helpful then you can buy me a beer at 0xA459552915C85d079b2EC8e28024314a538f3fd3.

Usage

The buyer calls create to begin the Swap.

TokenSwap.create(token, tokenAmount, price, seller, buyer, [recipient])

token is the address of an ERC20-compatible token contract
tokenAmount is the amount of tokens to be sold
price is the total price, in Wei, to be paid for the tokens
seller is the address of the token holder
buyer is the address of the Ether holder (this address must send the payment to conclude the Swap)
recipient is an optional argument specifying an address to receive the tokens; if no recipient is specified then buyer is used

The seller approves the TokenSwap contract to spend tokenAmount tokens, using the ERC20 approve function.
The buyer calls conclude with price Wei.

If the tokens have not been approved then the call will fail. If the tokens have been, and the value of the call is sufficient, the tokens will be sent to the recipient (or buyer, if none is specified) and the Ether to the seller.

An additional cancel function has also been provided. The buyer, seller and recipient are all able to cancel a Swap at any time before it is concluded. Any tokens that have been approved will be refunded.

Development

Install truffle and openzeppelin-solidity by running npm i.
Compile the contracts using truffle compile.
Run the test by installing and launching ganache, then running truffle test.

License

MIT © Luke Mitchell

token-swap's People

Contributors

Stargazers

Watchers

token-swap's Issues

Test refunding overpayment to buyer

If the buyer overpays in Ether when calling connect() the contract will return the difference. There is a stub test, however, this does not check that the difference has been refunded in a robust manner.

Test multiple Swaps for a single `buyer`

This has been prevented with #8a7fc554056928b7ce6b97cca529278763b110fc but there is not yet a test in place. The following code requires modification to check for the a failed require, which will eventually map to a REVERT opcode.

it("user cannot create a second Swap whilst one exists", function() {
    return ts.create(token.address, amount, price, seller, buyer, {from: buyer})
    .then(function() {
      return ts.create(token.address, amount, price, seller, buyer, {from: buyer})
    }).then(function() {
      // TODO: check for REVERT
    })
  });

lukem512 / token-swap Goto Github PK

token-swap's Introduction

Token Swap

Usage

Development

License

token-swap's People

Contributors

Stargazers

Watchers

Forkers

token-swap's Issues

Test refunding overpayment to buyer

Test multiple Swaps for a single `buyer`

Test `cancel`

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent