bokkypoobah/umswapPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star15

umswap - "Like WETH, but for ERC-721s"

License

MIT license

15 stars 2 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 358 Commits
code-review		code-review
contracts		contracts
deployed		deployed
docs		docs
scripts		scripts
test		test
.gitignore		.gitignore
20_testIt.sh		20_testIt.sh
LICENSE		LICENSE
README.md		README.md
hardhat.config.js		hardhat.config.js
package-lock.json		package-lock.json
package.json		package.json
testIt.out		testIt.out

Repository files navigation

umswap - "Like WETH, but for ERC-721s"

Umswaps are subsets of ERC-721 NFT collections pooled into ERC-20 tokens.

Umswaps are created by UmswapFactory.

UI being built athttps://bokkypoobah.github.io/umswap/.

History

2022-07-16UmswapFactory 0.8.5 testing deployed to0x9d6856a4ccef088da9b6e8a7c476ae05bc7caa2e
2022-07-30UmswapFactory 0.8.6 testing deployed to0x39D61eDC9E951C93A0A714c008006c5093992db3
2022-07-31UmswapFactory 0.8.7 testing deployed to0xb9969521413D036eAb5Ff2095cDc31BF4600AF9e
2022-08-01UmswapFactory 0.8.8 testing deployed to0x06cD34744eb3bE01808790Df7D1AeB63355b27Ea
- Bug bounty offer on this contract
  - Cancelled 2022-08-15 - new version
2022-08-15UmswapFactory 0.8.9 testing deployed to0x0AE45D0a938f4F07F236e5f43ffB05E79ceE8268
- Bug bounty now on offer on this contract
  - Cancelled 2022-09-28 - new version
2022-09-28UmswapFactory 0.9.0 testing deployed to0x8f093895cD4C54eaB897C6377e1Bf85Fe5B4E948
- Bug bounty now on offer on this contract

Umswap Functions

Umswap Read Functions

allowance(tokenOwner, spender)

StandardERC-20 function.

functionallowance(addresstokenOwner,addressspender)overrideexternalviewreturns(uintremaining)

balanceOf(tokenOwner)

StandardERC-20 function.

functionbalanceOf(addresstokenOwner)overrideexternalviewreturns(uintbalance)

decimals()

StandardERC-20 function. Set to 18 decimals.

functiondecimals()overrideexternalviewreturns(uint8)

getInfo()

functiongetInfo()publicviewreturns(address_creator,stringmemory__symbol,stringmemory__name,uint[]memory_tokenIds,uint_swappedIn,uint_swappedOut,uint__totalSupply)

isValidTokenId(tokenId)

functionisValidTokenId(uint_tokenId)publicviewreturns(bool)

name()

StandardERC-20 function.

functionname()overrideexternalviewreturns(stringmemory)

symbol()

StandardERC-20 function.

functionsymbol()overrideexternalviewreturns(stringmemory)

totalSupply()

StandardERC-20 function.

functiontotalSupply()overrideexternalviewreturns(uint)

Umswap Write Functions

approve(spender, tokens)

StandardERC-20 function.

functionapprove(addressspender,uinttokens)overrideexternalreturns(boolsuccess)

receive()

Receive any tips in ETH.

receive() external payable

swap(inTokenIds, outTokenIds, integrator)

functionswap(uint[]calldata_inTokenIds,uint[]calldata_outTokenIds,addressintegrator)publicpayablereentrancyGuard

transfer(to, tokens)

StandardERC-20 function.

functiontransfer(addressto,uinttokens)overrideexternalreturns(boolsuccess)

transferFrom(from, to, tokens)

StandardERC-20 function.

functiontransferFrom(addressfrom,addressto,uinttokens)overrideexternalreturns(boolsuccess)

UmswapFactory Functions

UmswapFactory Read Functions

isValidName

Is name valid? Name cannot start or end with spaces, or contain repeating spaces. Name must be between 1 and 48 characters in length. Valid characters are 0-9, A-Z, a-z, space, +, -, : .

functionisValidName(stringmemorystr)publicpurereturns(bool)

getUmswapsLength

functiongetUmswapsLength()publicviewreturns(uint_length)

getUmswaps

functiongetUmswaps(uint[]memoryindices)publicviewreturns(Umswap[]memory_umswaps,address[]memory_creators,string[]memory_symbols,string[]memory_names,uint[][]memory_tokenIds,uint[]memory_swappedIns,uint[]memory_swappedOuts,uint[]memory_totalSupplies)

owner

Owner of UmswapFactory

addresspublicowner

umswaps

Array of child Umswap addresses

Umswap[]publicumswaps

UmswapFactory Write Functions

newUmswap

functionnewUmswap(IERC721Partial_collection,stringcalldata_name,uint[]calldata_tokenIds,addressintegrator)

receive

receive()externalpayable

transferOwnership

functiontransferOwnership(address_newOwner)publiconlyOwner

withdraw

functionwithdraw(addresstoken,uinttokens,uinttokenId)publiconlyOwner

Testing

Seetest/00_test_0.js for the testing scripts andtestIt.out for the results.

UmswapFactory

Owned
- Can only initialise onceAlreadyInitialised()
- Transfer ownership
  - Valid ownership transfer
  - Invalid ownership transferNotOwner()
TipHandler
- Zero tips
- Non-zero tips
  - integrator set toaddress(0)
  - integrator set toaddress(this)
  - integrator set to EOA/contract address/contract that rejects ETH payment
CloneFactory
- Check
UmswapFactory
- newUmswap(...)
  - Collection set to EOANotERC721()
  - Collection set to non ERC-721 contractNotERC721()
  - Invalid nameInvalidName()
  - TokenIds not sorted ascendingTokenIdsMustBeSortedWithNoDuplicates()
  - Duplicate setDuplicateSet()
- Receive ETH transfers
- Reject ERC-721safeTransferFrom(msg.sender, UmswapFactory, tokenId) transfers
- Withdraw
  - ETH
  - ERC-20
  - ERC-721
  - Not ownerNotOwner()

Umswap

[ ]
- [ ]

Notes

npm install --save-dev hardhatOpenZeppelin v4.7.0npm install --save-dev @openzeppelin/test-helpersnpm install --save-dev @nomicfoundation/hardhat-toolbox

About

umswap - "Like WETH, but for ERC-721s"

Releases

No releases published

Packages

No packages published

Movatterモバイル変換

License

bokkypoobah/umswap

Folders and files

Latest commit

History

Repository files navigation

umswap - "Like WETH, but for ERC-721s"

History

Umswap Functions

Umswap Read Functions

allowance(tokenOwner, spender)

balanceOf(tokenOwner)

decimals()

getInfo()

isValidTokenId(tokenId)

name()

symbol()

totalSupply()

Umswap Write Functions

approve(spender, tokens)

receive()

swap(inTokenIds, outTokenIds, integrator)

transfer(to, tokens)

transferFrom(from, to, tokens)

UmswapFactory Functions

UmswapFactory Read Functions

isValidName

getUmswapsLength

getUmswaps

owner

umswaps

UmswapFactory Write Functions

newUmswap

receive

transferOwnership

withdraw

Testing

UmswapFactory

Umswap

Notes

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages0

Uh oh!

Languages

Packages