re-nft / cryptopunks Goto Github PK

View Code? Open in Web Editor NEW

12.0 4.0 6.0 6.13 MB

Cryptopunk gifting protocol. Available on https://cryptopunk.rent

Home Page: https://cryptopunk.rent

License: MIT License

JavaScript 71.44% TypeScript 22.39% SCSS 0.07% Solidity 6.10%

cryptopunk cryptopunks thegraphprotocol thegraph subgraph

cryptopunks's Introduction

Cryptopunks Lending & Renting Protocol

With utmost respect,

Contributions

Our issues are split into 2 categories

🎨 denotes predominantly works pertaining to front-end spec below
🧠 denotes predominantly works pertaining to protocol spec / subgraph

Issue format is the following

{emoji} - {if front: endpoint} - {description}

To contribute, create a branch with the id of the issue you are tackling. One PR per one issue only, please!

We are using tailwindcss for our front-end for 10x development. If you are working on a front-end task, have a look here to pick which components you need

https://tailwindui.com/components

Then, drop all the required components in the issue you are working in and I will share the HTML code snippet with you.

When submitting a PR, ensure all checks pass. Only PRs that are fully checked out can be merged.

Spec

Protocol Spec

We propose to construct the minSalePriceInWei argument in the offerPunkForSaleToAddress and offerPunkForSale in a particular way to be able to achieve the v0 Cryptopunk gifting feature. Find below the explanation

ff is to ensure noone can accept the bid. These two hex characters at the front ensure that the number we end up with is at least: 115339776388732929035197660848497720713218148788040405586178452820382218977280 that is how much someone would have to pay to accept the offer you can verify this here https://www.rapidtables.com/convert/number/hex-to-decimal.html by inputting 0xff00000000000000000000000000000000000000000000000000000000000000
8e is the checksum. This is to ensure that during the price transmission no data was lost in a message. Standard computer science trick https://en.wikipedia.org/wiki/Checksum#:~:text=A%20checksum%20is%20a%20small,upon%20to%20verify%20data%20authenticity.
00 is the protocol version. This will help people correctly parse the messages we send. It is conceivable that extension of the gifting protocol will require new data to be specified. Such as the rent price. This new data, will be packed into all or some of the remaining 54 hexbytes we have left. Therefore, developers will be able to say: "oh, this is version 00 so I know I have to parse it as per the spec here" this will be incremented +1 on each new version release, obviously
000e is the lease length. e in hexadecimal is 14, denoting days

Frontend Spec

Filtering in Cryptopunks
- requires filters
- view all cryptopunks gifted (superset of the below)
- view cryptopunks gifted to me (subset of the above)
- view cryptopunks I gifted (subset of all, by definition lol)
- under each punk view extra info (current owner, current tenant, tenancy dates)
Click on a punk, modal window opens
- requires subgraph
- details on a punk
- owner
- tenant
- tenancy dates
- provenance history
- if owner: lend the punk (created the offer to address or plain offer to as per protocol)
FAQ
- section about how it works
- section about responsibilities of the renter and the lender
Optional
- little notes section for yourself, to remind you where you have used the cryptopunks this is useful for when the renting period ends to remind you where you need to take it off
- email notification for when the due date is coming up
- ability to view lender's address
- filtering / sorting
- highly useful. API to change all / some of your social avatars with the cryptopunk you have just rented out. Likewise, enable unsetting. (we can do this super easily with Next.js)
- only owner can change details about the punk. When clicking on a punk, show the punk's provenance + owners' details. (plural)
Future
- view cryptopunks available for rent
- web3 call to og crypto punks. create bid. 4 1s. This will accept tenancy rights.

Services

subgraph
- pull all cryptopunks currently gifted to someone
pull all cryptopunks (there is an image). There should be an API, too

Communications

renft cryptopunk leasing support channel?

Tech

Next.js

This is a Next.js project bootstrapped with create-next-app.

Getting Started

# Fork the repo on Github & clone it
git clone [email protected]:re-nft/cryptopunks.git
cd cryptopunks

# Install NPM modules
yarn

# Start the development server
yarn dev

Open http://localhost:3000 in your browser to see the website.

Deployment

Deployed on Vercel.

cryptopunks's People

Contributors

Stargazers

Watchers

Forkers

eenagy monte9 kccdev starcorpceo rafzk enixdark

cryptopunks's Issues

🎨 - /cryptopunks - implement pagination

🎨 - /cryptopunks - view all cryptopunks gifted

This is default view when you go to /cryptopunks. This is pulled from punks context, which in turn pulls this from the subgraph that naz will implement

🎨 - /cryptopunks - the transaction hash overflows the modal

we can just do the ellipsis trick, that back of the data isn't very useful anyhow in protocol version 0 (i.e. it is not used)

🎨 - / - responsive design

Using Emmet Re:view extension: https://chrome.google.com/webstore/detail/emmet-review/epejoicbhllgiimigokgjdoijnpaphdp?hl=en

ensure that the website looks slick on all the android / apple / tablet and desktop computer devices.

🎨 - /cryptopunks - add all ever gifted punks tab

This tab will show all the punks that have ever been gifted. Same rules of sorting by newest at the top, apply.

🧠 - implement the punks subgraph

🎨 - /cryptopunks - punk modal disappears

at a certain breakpoint, think it is 760 px the modal will just fly to the bottom of the page, it will appear as if it is gone. keep shrinking that bastard, now it is back where it needs to be. naughty

🧠 - integrate the punks subgraph into the punks context

🎨 - /cryptopunks - unscrollable tenancy provenance in some cases

🎨 - / - replace the tailwindcss components with their React counterparts

Just when we have launched this project, Tailwindcss upgraded their front and have realeased all the components to be compatible with React... Let's make a move to the React counterparts for better compatibility.

🎨 - /cryptopunks - make the background grey but transparent (opacity) when modal opens

right now, when the modal opens, there is no background.

I recall there was, but I commented that code out because could not make the transition work. Doesn't matter. Let's just have that background without the transition

🎨 - / - add web3modal to sign in with metamask

🧠 - provenance subgraph overwrites latest address

Overwrites the provenance with the latest address. Subgraph issue.

🎨 - / - ensure navigation links won't make the app refresh

🧠 - checkusm can't be computed - Sprint #2

keccak256 refuses to work in the graph's runtime. Is it even implemented there?

🎨 - /cryptopunks - view all cryptopunks I gifted

Taken from the punks context. These are the punks that you own and gifted the tenancy rights to someone. Once again, on the front-end this is a filter option, and from context perspective this is a simple subgraph query that will be implemented by naz

🎨 - /cryptopunks - when modal is open, clicking on the menu hamburger closes the modal

it should not

🧠 - tenancyDates end can't be computed in the graph - Sprint #2

During the first sprint I have come across a prbolem whereby I could not compute the tenancy end date. This problem arises due to invalid parsing of Number.parseInt('0x000e', 16). For some, unknown reason, this returns null. Instead of the expected 14. I have tried this parsing in webassembly.studio and it works as expected there. The graph's runtime uses its own Number?

🎨 - / - accessability for punks is messed up

Can't tab punks. Also if you tab, crypto punks and faq get highlighted twice, should only highlight once

🎨 - /cryptopunks - view all cryptopunks gifted to me

This will be coming from the punk context, which in turn will query the punks in the subgraph by your address. This requires adding the front + the subgraph implementation.

🎨 - /cryptopunks - the modal is no longer vertically scrollable on smaller screens

🎨 - / - request a punk for rent

Implement being able to see all of the punks.
Request the punk for rent (any punk). This goes into the firebase db.
A filter/tab to be able to see all of the requested punks.
If you are an owner of the punk, being able to accept the request.
Once accepted follow the new protocol version. Thus, this issue depends on the issue of implementing a new version of the protocol

🎨 - /cryptopunks - add a filter to see all the cryptopunks you own

right now we are tracking:

all punks ever gifted through our protocl
punks gifted to me
punks I gifted

But how would a user that has punks gift one of his own? He can't. There is no filter for all the punks that the user owns. This requires adding another query to our subgraph. Follow the patterns in the code. Look into the contexts folder. You will find a utils folder in there. Within it there is a queries.js file that shows two queries. Yours will look similar. Integrate the new query and fetched results into the front.

The end result is that we have another tab / filter that says "My punk". Here the punk owners will be able to gift their punks. You will find the graph endpoint in the code too.