Ethereum-based decentralized application that allows airlines to sell flight tickets to customers via smart contracts and manages payments between the parties in cryptocurrency.
A quick video tour over the functionality:
- Demo in Rinkeby
- Architecture
- Prerequisites
- How to run it
- Testing
- Security
- Design pattern decisions
- Author
Contracts are deployed in Rinkeby testnet. Contract addresses in Rinkeby are listed in deployed_addresses.txt.
The UI is available here (use any):
-
IPFS + ENS: flight-tickets.eth
You can use a browser extension to resolve
.ethdomain names, e.g. ENS Content Resolver -
IPFS directly: Qmc6Ejj7XaxPoeQNvQJ6zeLFPEh1h1h98njVognhnU7qmY
-
Traditionally hosted: https://sapph1re.github.io/flight-tickets/
Check the Play around block in the How to run it section to get an idea of what you can do.
Sample data is deployed with cities: Dubai, Bangkok, Hong Kong, Tokyo, Singapore, Jakarta, Denpasar.
Flight dates provided by the sample data: 4 Dec 2018 - 7 Dec 2018.
Check it out, try booking. If you need test ether in Rinkeby, use the faucet to get some and come back.
Contact me if you want to own an airline :)
Admin can add/edit/remove airlines. Each airline has:
- Unique autoincremented ID
- Unique name
- Logo: an image uploaded to IPFS and its hash stored in the contract
- Owner: an Ethereum address
Airline owner can add/edit/remove tickets. Each ticket has:
- Unique autoincremented ID
- Airline ID: a reference to the airline that provides this ticket
- From City
- To City
- Price in wei: converted to ether in the UI
- Quantity: how many seats are available, quantity is reduced after each purchase
- Departure: UTC timestamp
- Arrival: UTC timestamp
All departures and arrivals are in UTC, to make the logic more straightforward. Unlike real flights where local time is used for every city.
Any user can search for flights from city A to another city B, on a given day. The system will find all matching tickets departing on that day:
- direct flights from A to B
- one-stop flights A to C, C to B
Day of arrival may differ, if the flights or the layover is long enough. Total flight durations and the layover time are calculated and displayed to the user.
Found flights can be sorted either by price or by total duration.
User can buy a flight that he found, which involves entering his passenger details (first name & last name) and sending a payment. The UI sends a precise payment amount to cover the ticket(s) being purchased, but if a user interacts with the contract directly and sends any excessive ether, the change will be returned to him. Sending insufficient ether will revert the transaction and nothing will happen. The payments are instantly forwarded to the owner of the airline per each ticket being purchased.
Purchase history is stored in the event logs.
Users can find the history of tickets they purchased in My Purchases.
Airline owners can find the history of tickets they sold in My Airline > Sold Tickets.
The main contract is FlightTickets, implemented in Solidity. It uses SafeMath library and Pausable and Destructible base contracts provided by Zeppelin. Zeppelin package code is updated manually from their github and the used files are saved to the repository, because their EthPM package is very outdated and seems to be unmaintained.
Another contract is FlightTicketsRegistry, implemented in Vyper and compiled to LLL also. Its bytecode and ABI are saved manually to /build/contracts/FlightTicketsRegistry.json.
- NodeJS 10+
- npm 6+
- truffle 4.1.13+
- ganache-cli 6.1.6+
- browser with MetaMask connected to ganache
- Clone the repository and navigate to it
git clone https://github.com/sapph1re/flight-tickets.git
cd flight-tickets
- Install dependencies:
npm install
- Run Ganache:
ganache-cli
Make sure it's listening at 127.0.0.1:8545.
- Compile the contracts:
truffle compile
- Deploy the contracts
truffle migrate
- This step is optional. Populate the contract with sample data. Do it if you want to have some data to play with. Otherwise you can add all airlines and tickets by yourself.
npm run populate
If you want to change the sample data, it's configured in sample-data.json.
- Run the frontend
npm run start
- Play around. Try searching & buying tickets.
Sample data provides flights between the following cities: Dubai, Bangkok, Hong Kong, Tokyo, Singapore, Jakarta, Denpasar. All of them are connected with each other more or less, so you can try to find a flight from any of these cities to any other of them. Try turning "only direct flights" switch on and off.
Make sure to set your flight date anywhere between 04/12/2018 and 07/12/2018, as tickets are provided for these four days.
Results may be sorted either by total price or by total duration.
Try buying tickets that you find. Press "Book", enter passenger's name and surname, press "Buy Now" and confirm the transaction with MetaMask. Then you can go to "My Purchases" and see the tickets you've just bought.
With an airline owner's account, you can go to "My Airline" and see the tickets that have been sold to customers. You can see those ones you just bought, but make sure you log in with the proper airline. Also check your ETH balance, you'll have the revenue from selling the tickets.
The first ganache address is the owner of the contract and the admin of the dapp. If you login in to MetaMask with it, you will see the admin panel in the menu. The first address also owns one airline. Two more airlines are owned by the second ganache's address and one airline by the third address. When you're logged in to MetaMask with an address that owns an airline, you will see your airline panel in the menu.
Feel free to play around with airlines and their owners in the admin panel, as well as with the tickets of your airlines in the airline panel. You may add more tickets to new destinations and then try finding and buying them in the "Search Tickets" tab.
Every airline has a logo, which is stored in IPFS. Sample data has logos uploaded from the sample-images directory. One of them is missing, Hainan Airlines, so that you can try setting it yourself, you'll find the logo itself in the directory.
You can also pause/unpause the contract when logged in as admin. In the Admin Panel you have a button "Pause Contract", which stops the contract and it will refuse to perform any state-changing operations described above until you unpause it.
The tests cover:
- ownership of the contract and authorization of access
- add/edit/remove operations for airlines and for tickets
- verification of the data stored
- input data validation
- searching for tickets
- buying tickets
- emergency stop
- upgradability
To run the tests:
truffle test
- Roman Vinogradov - sapph1re