Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 463a78d

Browse files
committedSep 14, 2022
improve readme, add logo
1 parent 975c9b7 commit 463a78d

File tree

2 files changed

+50
-7
lines changed

2 files changed

+50
-7
lines changed
 

‎README.md

+35-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
1-
# RealTicket Smart Contracts
1+
# <img src="logo.svg" alt="RealTicket Smart Contracts" height="40px">
22

3-
[RealTicket](link_to_landing_page) is the NFT ticketing platform to replace all others
3+
[![ERC-721](https://img.shields.io/badge/-ERC--721-blue)](https://ethereum.org/en/developers/docs/standards/tokens/erc-721/)
4+
[![EIP-721](https://img.shields.io/badge/-EIP--721-blue)](https://eips.ethereum.org/EIPS/eip-721)
5+
[![OpenZeppelin](https://img.shields.io/badge/-OpenZeppelin-blue)](https://docs.openzeppelin.com/contracts/3.x/erc721)
6+
7+
[RealTicket](https://realticket.lokadevops.com/) is the NFT ticketing platform to replace all others
48

59
The tickets live on the [Polygon](https://polygon.technology/) network, a decentralised [Ethereum](https://ethereum.org/en/) scaling platform
610

7-
These smart contracts extend the ones provided by the [openzeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts/) library
11+
This smart contract extend the ones provided by the [openzeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts/) library
812

913
They were developed using the [npm](https://www.npmjs.com/) package [Truffle](https://trufflesuite.com/) for [nodejs](https://nodejs.org/en/)
1014

15+
# Overview
16+
17+
Each event launches its own [RealTicket.sol](contracts/RealTicket.sol) smart contract with the following variables:
18+
- `price`: ticket pricing
19+
- `fee`: transaction fee
20+
- `capacity`: event capacity
21+
- `manager role`: which is able to modify the event settings (price, fee, capacity, pause sales) and mint new tickets
22+
- `bouncer role`: which is able to change the status of a given ticket
23+
24+
It extends the base ERC721 standard with:
25+
- `ERC721Enumerable`: enumerate tokens owned by a given account
26+
- `ERC721Burnable`: a ticket may be burnt by its rightful owner
27+
- `ERC721Pausable`: a manager role may pause ticket sales
28+
- `ERC721Status`: a ticket has one of the following status: READY, BOUNDED, USED, BLOCKED
29+
30+
# Contribute
31+
There is still a lot of work ahead and we invite the community to contribute and take this vision a step further. A few things that we would like to pursue as next steps are:
32+
33+
- We must accept any token as payment method, specially stable coins which can be used to provide a steady pricing
34+
- An event should include several ticket types with different prices and permissions
35+
- A bouncer may only change the ticket status with a signature given by the tickets rightful owner
36+
37+
# License
38+
RealTicket Contracts are released under the [MIT License](LICENSE).
39+
40+
# Learn More
41+
1142
## Setup
1243

1344
### Install npm on MacOS
@@ -29,7 +60,7 @@ They were developed using the [npm](https://www.npmjs.com/) package [Truffle](ht
2960
### Add secrets
3061

3162
echo MNEMONIC > .secret
32-
echo INFURA_HEY > .infureId
63+
echo INFURA_HEY > .infuraId
3364
echo ALCHEMY_HEY > .alchemyId
3465

3566
## Truffle Steps
@@ -62,9 +93,6 @@ They were developed using the [npm](https://www.npmjs.com/) package [Truffle](ht
6293

6394
## Useful Links
6495

65-
- [ERC-721](https://ethereum.org/en/developers/docs/standards/tokens/erc-721/)
66-
- [EIP-721](https://eips.ethereum.org/EIPS/eip-721)
67-
- [Open Zeppelin Docs](https://docs.openzeppelin.com/contracts/3.x/erc721)
6896
- [Open Zeppelin Contracts](https://github.com/OpenZeppelin/openzeppelin-contracts)
6997
- [Verify on Polygonscan](https://mumbai.polygonscan.com/verifyContract)
7098
- [Realticket on Mumbai](https://mumbai.polygonscan.com/address/0x04bdaa899293788b8ecd91ef665f30d5ec5d719d)

‎logo.svg

+15
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.