├── requirements.txt ├── .gitignore ├── images └── logo.png ├── README.md ├── DEXcalculator.py ├── ArbitrageAggregator.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | web3 2 | pandas -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # You shouldn't edit these files, as they're generated by DEXcalculator.py 2 | .csv 3 | -------------------------------------------------------------------------------- /images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/EvanGottschalk/ArbitrageAggregator/HEAD/images/logo.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Contributors][contributors-shield]][contributors-url] 2 | [![Forks][forks-shield]][forks-url] 3 | [![Stargazers][stars-shield]][stars-url] 4 | [![Issues][issues-shield]][issues-url] 5 | [![MIT License][license-shield]][license-url] 6 | [![LinkedIn][linkedin-shield]][linkedin-url] 7 | 8 | 9 | 10 | 11 |
12 |

13 | 14 | Logo 15 | 16 | 17 |

ArbitrageAggregator

18 | 19 |

20 | A customizable module for detecting arbitrage opportunities between DeFi exchanges 21 |
22 | Explore the docs » 23 |
24 |
25 | View Demo 26 | · 27 | Report Bug 28 | · 29 | Request Feature 30 |

31 |

32 | 33 | 34 | 35 | 36 |
37 |

Table of Contents

 38 |
    39 |
  1. 40 | About The Project 41 | 44 |
    2. 45 |
  2. 46 | Getting Started 47 | 51 |
    3. 52 |
  3. Usage
    4. 53 |
  4. Roadmap
    5. 54 |
  5. Contributing
    6. 55 |
  6. License
    7. 56 |
  7. Contact
    8. 57 |
  8. Acknowledgements
    9. 58 |
59 |
60 | 61 | 62 | 63 | 64 | ## About The Project 65 | 66 | I initially built `ArbitrageAggregator` and [`DEXcalculator`](https://github.com/EvanGottschalk/DEXcalculator) as part of a programming challenge to find arbitrage opportunities between decentralized cryptocurrency exchanges (DEX's). The main purpose of `ArbitrageAggregator` is to continuously detect those profitable trade opportunities and collect data on them. 67 | 68 | 69 | ### Built With 70 | 71 | * `Python 3.6` 72 | * `web3` 73 | * `pandas` 74 | * [`DEXcalculator`](https://github.com/EvanGottschalk/DEXcalculator) - This program uses API calls to fetch decentralized exchange balances, which are then used to calculate prices of tokens. 75 | 76 | 77 | 78 | ## Getting Started 79 | 80 | Getting `ArbitrageAggregator` up and running is easy (and free!). 81 | 82 | ### Prerequisites 83 | 84 | Running `ArbitrageAggregator` requires the `pandas` and `web3` libraries. One must also create a free account on [Alchemy.com](https://www.alchemy.com/) to obtain an API key. 85 | 86 | 87 | ### Installation 88 | 89 | 1. To use `ArbitrageAggregator`, one must obtain their own [Alchemy](https://www.alchemy.com/) API key. This is quick, simple, and free to do. 90 | 1a. First, create a free account on [Alchemy.com](https://www.alchemy.com/). 91 | 1b. Next, create a blank app using the "+CREATE APP" button (the app's particular parameters are not relevant to `ArbitrageAggregator`). 92 | 1c. That's it! The new API key will be displayed on the [Alchemy](https://www.alchemy.com/) dashboard. 93 | 94 | 2. Install the `pandas` and `web3` libraries, which are listed in `requirements.txt`. The easiest way to do this to download `requirements.txt` and use `pip`: 95 | ``` 96 | pip install -r requirements.txt 97 | ``` 98 | 99 | 3. Download the `.py` files from this repository (`ArbitrageAggregator.py` and `DEXcalculator.py`) 100 | 101 | 4. Run `ArbitrageAggregator.py` and enter your [Alchemy](https://www.alchemy.com/) API URL 102 | 103 | 5. Congratulations! You can now use `ArbitrageAggregator` to constantly detect arbitrage opportunities between DeFi exchanges! 104 | 105 | 106 | 107 | 108 | ## Usage 109 | 110 | `ArbitrageAggregator` can be used it a number of ways. It can be used as a bot for detecting arbitrage opportunities between decentralized cryptocurrency exchanges by by calling its `loopArbitrageDetection()` function. It will then continuously check prices of the selected currencies across decentralized exchanges, recording profitable arbitrage trades in a `pandas DataFrame` and exported to `CSV`. 111 | 112 | The individual functions that make up `loopArbitrageDetection()` can also be useful on their own and included in other programs. For example, `collectPriceDataOnAllExchanges()` provides an easy way to get a massive amount of price data on decentralized exchanges, which could then be used for analysis, or used in some other automated process. One can also use `checkForArbitrage()` to quickly check for live profit opportunities in a given moment, rather than checking continuously. 113 | 114 | 115 | 116 | 117 | ## Roadmap 118 | 119 | See the [open issues](https://github.com/EvanGottschalk/ArbitrageAggregator/issues) for a list of proposed features (and known issues). 120 | 121 | 122 | 123 | 124 | ## Contributing 125 | 126 | Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. 127 | 128 | 1. Fork the Project 129 | 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 130 | 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 131 | 4. Push to the Branch (`git push origin feature/AmazingFeature`) 132 | 5. Open a Pull Request 133 | 134 | 135 | 136 | 137 | ## License 138 | 139 | Distributed under the GNU GPL-3 License. See `LICENSE` for more information. 140 | 141 | 142 | 143 | 144 | ## Contact 145 | 146 | Evan Gottschalk - [@Fort1Evan](https://twitter.com/Fort1Evan) - evan@fort1e.com 147 | 148 | Project Link: [https://github.com/EvanGottschalk/ArbitrageAggregator](https://github.com/EvanGottschalk/ArbitrageAggregator) 149 | 150 | 151 | 152 | 153 | ## Acknowledgements 154 | 155 | Thinking about contributing to this project? Please do! Your Github username will then appear here. 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | [contributors-shield]: https://img.shields.io/github/contributors/EvanGottschalk/ArbitrageAggregator.svg?style=for-the-badge 164 | [contributors-url]: https://github.com/EvanGottschalk/ArbitrageAggregator/graphs/contributors 165 | [forks-shield]: https://img.shields.io/github/forks/EvanGottschalk/ArbitrageAggregator.svg?style=for-the-badge 166 | [forks-url]: https://github.com/EvanGottschalk/ArbitrageAggregator/network/members 167 | [stars-shield]: https://img.shields.io/github/stars/EvanGottschalk/ArbitrageAggregator.svg?style=for-the-badge 168 | [stars-url]: https://github.com/EvanGottschalk/ArbitrageAggregator/stargazers 169 | [issues-shield]: https://img.shields.io/github/issues/EvanGottschalk/ArbitrageAggregator.svg?style=for-the-badge 170 | [issues-url]: https://github.com/EvanGottschalk/ArbitrageAggregator/issues 171 | [license-shield]: https://img.shields.io/github/license/EvanGottschalk/ArbitrageAggregator.svg?style=for-the-badge 172 | [license-url]: https://github.com/EvanGottschalk/ArbitrageAggregator/blob/master/LICENSE.txt 173 | [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 174 | [linkedin-url]: https://linkedin.com/in/EvanGottschalk -------------------------------------------------------------------------------- /DEXcalculator.py: -------------------------------------------------------------------------------- 1 | from dotenv import load_dotenv 2 | load_dotenv() 3 | import os 4 | from web3 import Web3 5 | import json 6 | 7 | 8 | class DEXcalculator: 9 | def __init__(self): 10 | self.connected = False 11 | self.web3_object = None 12 | self.ABI = json.loads('[{"inputs":[{"name":"_owner","type":"address"}],"name":"balanceOf","outputs":[{"name":"","type":"uint256"}],"type":"function"}]') 13 | self.contractAddresses = {'WETH': '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2', \ 14 | 'DAI': '0x6b175474e89094c44da98b954eedeac495271d0f'} 15 | self.exchangeAddresses = {'UniswapV2': '0xa478c2975ab1ea89e8196811f51a7b7ade33eb11', \ 16 | 'Sushiswap': '0xc3d03e4f041fd4cd388c549ee2a29a9e5075882f', \ 17 | 'Shebaswap': '0x8faf958e36c6970497386118030e6297fff8d275', \ 18 | 'Sakeswap': '0x2ad95483ac838e2884563ad278e933fba96bc242', \ 19 | 'Croswap': '0x60a26d69263ef43e9a68964ba141263f19d71d51'} 20 | 21 | 22 | def connectToWeb3(self, api_url=None): 23 | self.connected = False 24 | if os.path.isfile('.env'): 25 | api_url = os.getenv('ALCHEMY_API_URL') 26 | while not(self.connected): 27 | self.web3_object = Web3(Web3.HTTPProvider(api_url)) 28 | if self.web3_object.isConnected(): 29 | self.connected = True 30 | # security! 31 | del api_url 32 | else: 33 | if api_url: 34 | print('\nConnection Error in EPC.connectToWeb3 : Invalid API URL. Double-check the API URL and try again.') 35 | api_url = input('\nPlease input your Alchemy.io API URL.\n\nAPI URL: ') 36 | return(self.web3_object) 37 | 38 | 39 | def fetchLatestBlockNumber(self): 40 | if not(self.connected): 41 | self.connectToWeb3() 42 | latest_block = self.web3_object.eth.get_block('latest') 43 | latest_block_number = latest_block['number'] 44 | print('\nThe latest block number is ' + str(latest_block_number)) 45 | return(latest_block_number) 46 | 47 | 48 | def fetchBalance(self, raw_wallet_address=None, raw_contract_address=None): 49 | valid_wallet_address = None 50 | valid_contract_address = None 51 | if not(self.connected): 52 | self.connectToWeb3() 53 | 54 | #1) The raw_wallet_address and raw_contract_address are converted using toChecksumAddress() and assigned to their "valid" counterparts 55 | while not(valid_wallet_address): 56 | try: 57 | valid_wallet_address = self.web3_object.toChecksumAddress(raw_wallet_address) 58 | except ValueError as error: 59 | if raw_wallet_address: 60 | print('ValueError in EPC.fetchBalance : Invalid wallet address. Please double-check the wallet address and enter it again.') 61 | raw_wallet_address = input('\nPlease input the wallet address.\n\nWallet Address: ') 62 | while not(valid_contract_address): 63 | try: 64 | valid_contract_address = self.web3_object.toChecksumAddress(raw_contract_address) 65 | except ValueError as error: 66 | if raw_contract_address: 67 | print('ValueError in EPC.fetchBalance : Invalid contract address. Please double-check the wallet address and enter it again.') 68 | raw_contract_address = input('\nPlease input the contract address.\n\nContract Address: ') 69 | 70 | #2) The wallet balance is fetched using the addresses provided 71 | contract_object = self.web3_object.eth.contract(valid_contract_address, abi=self.ABI) 72 | raw_balance = contract_object.functions.balanceOf(valid_wallet_address).call() 73 | 74 | #3) The amount in raw_balance is measured in Wei. It is converted to Ethereum for readability 75 | balance = float(self.web3_object.fromWei(raw_balance, 'ether')) 76 | return(balance) 77 | 78 | 79 | def fetchExchangeBalances(self, silent_mode=False): 80 | if not(self.connected): 81 | self.connectToWeb3() 82 | exchange_balances = {} 83 | if not(silent_mode): 84 | print('\nExchange Balances:') 85 | for exchange_name in self.exchangeAddresses: 86 | exchange_balances[exchange_name] = {} 87 | for token_name in self.contractAddresses: 88 | balance = self.fetchBalance(**{'raw_wallet_address': self.exchangeAddresses[exchange_name], \ 89 | 'raw_contract_address': self.contractAddresses[token_name]}) 90 | exchange_balances[exchange_name][token_name] = balance 91 | if not(silent_mode): 92 | print(' ' + exchange_name + ' ' + token_name + ' Balance: ' + str(balance)) 93 | return(exchange_balances) 94 | 95 | 96 | def getPriceParameters(self, exchange_name=None, spent_token=None, received_token=None, spent_amount=None): 97 | exchange_address = None 98 | spent_token_address = None 99 | received_token_address = None 100 | 101 | # The addresses for the chosen exchange and tokens are retrieved so their respective balances can be fetched 102 | while not(exchange_address): 103 | exchange_address = self.exchangeAddresses.get(exchange_name) 104 | if not(exchange_address): 105 | if exchange_name: 106 | print('ERROR! Invalid exchange name. Enter UniswapV2, Sushiswap, Shebaswap, Sakeswap, or Croswap.') 107 | exchange_name = input('\nPlease input the exchange that you would like to access.\n\nExchange Name: ') 108 | 109 | while not(spent_token_address): 110 | spent_token_address = self.contractAddresses.get(spent_token) 111 | if not(spent_token_address): 112 | if spent_token: 113 | print('ERROR! Invalid token name. Enter WETH or DAI.') 114 | spent_token = input('\nPlease input the token that you would like to spend.\n\nSpent Token: ') 115 | 116 | while not(received_token_address): 117 | received_token_address = self.contractAddresses.get(received_token) 118 | if not(received_token_address): 119 | if received_token: 120 | print('ERROR! Invalid token name. Enter WETH or DAI.') 121 | received_token = input('\nPlease input the token that you would to receive in exchange.\n\nReceived Token: ') 122 | 123 | while not(spent_amount) or spent_amount <= 0: 124 | if spent_amount: 125 | print('ERROR! Invalid amount. Please enter a real, positive number.') 126 | spent_amount = float(input('\nHow much ' + spent_token + ' would you like to spend on ' + received_token + '?\n\nAmount: ')) 127 | 128 | spent_token_balance = self.fetchBalance(exchange_address, spent_token_address) 129 | received_token_balance = self.fetchBalance(exchange_address, received_token_address) 130 | return(spent_token_balance, received_token_balance, spent_amount, exchange_name, spent_token, received_token) 131 | 132 | 133 | def calculatePrice(self, spent_token_balance, received_token_balance, spent_amount, exchange_name=None, spent_token=None, received_token=None): 134 | price = None 135 | k = spent_token_balance * received_token_balance 136 | received_amount = round(received_token_balance - (k / (spent_token_balance + spent_amount)), 18) 137 | if received_amount > 0: 138 | price = spent_amount / received_amount 139 | if exchange_name and spent_token and received_token: 140 | print('\nSpending ' + str(spent_amount) + ' ' + spent_token + ' on ' + exchange_name + ' gets you ' + str(received_amount) + ' ' + \ 141 | received_token + ' at a price of ' + str(price) + ' ' + spent_token + ' per ' + received_token) 142 | return(price) 143 | -------------------------------------------------------------------------------- /ArbitrageAggregator.py: -------------------------------------------------------------------------------- 1 | from DEXcalculator import DEXcalculator 2 | 3 | import pandas as pd 4 | import time 5 | import warnings 6 | 7 | 8 | class ArbitrageAggregator: 9 | def __init__(self): 10 | self.DEX = DEXcalculator() 11 | self.exchangeBalances = None 12 | 13 | 14 | # digit_granularity : this int value determines the minimum difference between the spent amounts used to calculate prices in collectPriceData() 15 | # Example: If digit_granularity is 3, and the max_spent_amount is 70000, the first few spent amounts used to calculate prices are 70000, 69900, 69800... 16 | # When the spent amount used 10000, the next few spent amounts used will be 9990, 9980, 9970... 17 | # When the spent amount used .01, the next few spent amounts used will be .00999, .00998, .00997 ... 18 | def collectPriceData(self, exchange_name, spent_token, received_token, max_spent_amount, min_spent_amount, digit_granularity, save_files=True): 19 | 20 | #1) If all the exchanges' balances have already been stored in self.exchangeBalances, those balances are used for price calculations 21 | # Otherwise, ConnectToETH.fetchBalance() is used to acquire the latest balances 22 | if self.exchangeBalances: 23 | spent_token_balance = self.exchangeBalances.get(exchange_name).get(spent_token) 24 | received_token_balance = self.exchangeBalances.get(exchange_name).get(received_token) 25 | else: 26 | spent_token_balance = self.DEX.fetchBalance(self.DEX.exchangeAddresses[exchange_name], self.DEX.contractAddresses[spent_token]) 27 | received_token_balance = self.DEX.fetchBalance(self.DEX.exchangeAddresses[exchange_name], self.DEX.contractAddresses[received_token]) 28 | #2) Using the exchanges' balances and the chosen spending constraints, potential trade prices are calculated and stored in price_data_list 29 | amount_multiplier = 10**len(str(int(max_spent_amount))) 30 | price_data_list = [] 31 | while amount_multiplier > min_spent_amount: 32 | for num in range(0, int(.9 * 10**digit_granularity)): 33 | spent_amount = max_spent_amount - (num / (10 ** (digit_granularity - 1))) * (amount_multiplier / 10) 34 | price = self.DEX.calculatePrice(spent_token_balance, received_token_balance, spent_amount) 35 | inverse_price = 1 / price 36 | received_amount = round(spent_amount / price, 18) 37 | new_data_entry = {'Exchange': exchange_name, \ 38 | 'Spent Token': spent_token, \ 39 | 'Price ('+spent_token+')': price, \ 40 | 'Price ('+received_token+')': inverse_price, \ 41 | 'Spent Amount': spent_amount, \ 42 | 'Received Amount': received_amount} 43 | price_data_list.append(new_data_entry) 44 | if spent_amount <= amount_multiplier / 10: 45 | break 46 | if not(price): 47 | amount_multiplier = 0 48 | break 49 | max_spent_amount = amount_multiplier / 10 50 | amount_multiplier = amount_multiplier / 10 51 | 52 | #3) price_data_list is converted to a DataFrame and exported to CSV to facilitate automated and manual analysis 53 | price_dataframe = pd.DataFrame(price_data_list, columns=list(new_data_entry)) 54 | if save_files: 55 | self.saveDataToCSV(price_dataframe, exchange_name + ' ' + spent_token + '-' + received_token) 56 | return(price_dataframe) 57 | 58 | 59 | def collectPriceDataOnAllExchanges(self, spent_token, received_token, max_spent_amount, min_spent_amount, digit_granularity, silent_mode=False): 60 | price_dataframe_dict = {} 61 | if not(self.exchangeBalances): 62 | self.exchangeBalances = self.DEX.fetchExchangeBalances(silent_mode) 63 | for exchange_name in self.exchangeBalances: 64 | price_dataframe = self.collectPriceData(exchange_name, spent_token, received_token, max_spent_amount, min_spent_amount, digit_granularity, save_files=not(silent_mode)) 65 | price_dataframe_dict[exchange_name] = price_dataframe 66 | return(price_dataframe_dict) 67 | 68 | 69 | def checkForArbitrage(self, token_A, token_B, max_spent_amount, min_spent_amount, digit_granularity, silent_mode=False): 70 | #1) Prices for spending token_A across exchanges are calculated and stored in token_A_data 71 | self.exchangeBalances = self.DEX.fetchExchangeBalances(silent_mode=True) 72 | token_A_data = self.collectPriceDataOnAllExchanges(token_A, token_B, max_spent_amount, min_spent_amount, digit_granularity, silent_mode) 73 | 74 | #2) token_A_data is checked for arbitrage opportunities by comparing prices across exchanges 75 | arbitrage_data_list = [] 76 | start_time = int(time.time()) 77 | for exchange_name_A in token_A_data: 78 | for exchange_name_B in token_A_data: 79 | if exchange_name_A != exchange_name_B: 80 | if not(silent_mode): 81 | print('\nCalculating arbitrage opportunities for buying ' + token_B + ' on ' + exchange_name_A + ' and selling it on ' + exchange_name_B + '...') 82 | number_of_arbitrage_opportunities_found = len(arbitrage_data_list) 83 | for index_A in token_A_data[exchange_name_A].index: 84 | # The row at index_A contains an amount of token_A that can be spent for an amount of token_B on exchange_A 85 | # Using that amount of token_B that could be bought on exchange_A, a new price is calculated for a second trade on exchange_B 86 | # Using that price, the amount of token_A that can be bought using token_B on exchange_B is calculated 87 | # The pair of trades is an arbitrage opportunity if the amount of token_A bought in the second trade is greater than the amount spent in the first 88 | token_B_amount_bought = token_A_data[exchange_name_A]['Received Amount'][index_A] 89 | token_B_sell_price = self.DEX.calculatePrice(self.exchangeBalances[exchange_name_B][token_B], \ 90 | self.exchangeBalances[exchange_name_B][token_A], token_B_amount_bought) 91 | token_A_amount_received = round(token_B_amount_bought / token_B_sell_price, 18) 92 | total_profit = token_A_amount_received - token_A_data[exchange_name_A]['Spent Amount'][index_A] 93 | if total_profit > 0: 94 | new_data_entry = {'Buy Exchange': exchange_name_A, \ 95 | 'Sell Exchange': exchange_name_B, \ 96 | 'Buy Price ('+token_A+')': token_A_data[exchange_name_A]['Price ('+token_A+')'][index_A], \ 97 | 'Sell Price ('+token_A+')': 1 / token_B_sell_price, \ 98 | 'Traded Amount ('+token_B+')': token_B_amount_bought, \ 99 | 'Spent Amount ('+token_A+')': token_A_data[exchange_name_A]['Spent Amount'][index_A], \ 100 | 'Received Amount ('+token_A+')': token_A_amount_received, \ 101 | 'Trade Profit ('+token_A+')': total_profit} 102 | arbitrage_data_list.append(new_data_entry) 103 | if not(silent_mode): 104 | print(' ' + str(len(arbitrage_data_list) - number_of_arbitrage_opportunities_found) + ' arbitrage opportunities found!') 105 | run_time = int(time.time()) - start_time 106 | print('\nRun Time: ' + str(int(run_time / 60)) + ' minutes ' + str(run_time % 60) + ' seconds') 107 | 108 | #3) arbitrage_data_list is converted to a DataFrame and exported to CSV to facilitate automated and manual analysis 109 | arbitrage_dataframe = pd.DataFrame(arbitrage_data_list, columns=list(new_data_entry)) 110 | if not(silent_mode): 111 | file_name = self.saveDataToCSV(arbitrage_dataframe, 'ArbitrageOpportunities') 112 | print('\nArbitrage data saved to ' + file_name) 113 | print('\nA total of ' + str(sum(arbitrage_dataframe['Trade Profit ('+token_A+')'])) + ' ' + token_A + \ 114 | ' in arbitrage profits was found across ' + str(len(arbitrage_dataframe)) + ' trades.') 115 | return(arbitrage_dataframe) 116 | 117 | 118 | def loopArbitrageDetection(self, token_A, token_B, max_spent_amount, min_spent_amount, digit_granularity): 119 | collect_data = True 120 | arbitrage_statistics_list = [] 121 | start_time = int(time.time()) 122 | # Irrelevant warnings sometimes occur while looping with older versions of pandas, so they are ignored 123 | warnings.filterwarnings("ignore") 124 | 125 | #1) This while loop will repetitively use checkForArbitrage() to collect data on potential arbitrage opportunities across exchanges 126 | # The loop will run indefinitely until keyboard interrupt or an error 127 | while collect_data: 128 | try: 129 | arbitrage_dataframe = self.checkForArbitrage(token_A, token_B, max_spent_amount, min_spent_amount, digit_granularity, silent_mode=True) 130 | new_statistics_entry = {} 131 | for buy_exchange in self.exchangeBalances: 132 | for sell_exchange in self.exchangeBalances: 133 | if buy_exchange != sell_exchange: 134 | 135 | #2) A truncated DataFrame containing only arbitrage opportunities between a particular pair of exchanges is created 136 | # This truncated DataFrame is used to generate statistical data for comparison with other pairs of exchanges 137 | exchange_pair = buy_exchange + '-' + sell_exchange 138 | exchange_pair_dataframe = arbitrage_dataframe[arbitrage_dataframe['Buy Exchange'] == buy_exchange]\ 139 | [arbitrage_dataframe['Sell Exchange'] == sell_exchange] 140 | new_statistics_entry.update({exchange_pair + ' # of Profitable Trades': len(exchange_pair_dataframe), \ 141 | exchange_pair + ' Total Profit': sum(exchange_pair_dataframe['Trade Profit ('+token_A+')']), \ 142 | exchange_pair + ' Biggest Trade Profit': exchange_pair_dataframe['Trade Profit ('+token_A+')'].max(), \ 143 | exchange_pair + ' Average Profit': exchange_pair_dataframe['Trade Profit ('+token_A+')'].mean(), \ 144 | exchange_pair + ' Median Profit': exchange_pair_dataframe['Trade Profit ('+token_A+')'].median()}) 145 | 146 | #3) Statistics about the different arbitrage opportunities, along with the current run time and block number, are stored in arbitrage_statistics_list 147 | latest_block_number = self.DEX.fetchLatestBlockNumber() 148 | run_time = int(time.time()) - start_time 149 | print('Run Time: ' + str(int(run_time / 60)) + ' minutes ' + str(run_time % 60) + ' seconds') 150 | new_statistics_entry['Run Time (seconds)'] = run_time 151 | new_statistics_entry['Block Number'] = latest_block_number 152 | arbitrage_statistics_list.append(new_statistics_entry) 153 | print('Loop Count: ' + str(len(arbitrage_statistics_list))) 154 | except KeyboardInterrupt as error: 155 | print('\nEnding Arbitrage Detection Loop...') 156 | collect_data = False 157 | except Exception as error: 158 | print('\nERROR! Arbitrage Detection Loop ended due to unexpected error: ' + str(error)) 159 | collect_data = False 160 | 161 | #4) In the case of keyboard interruption or an unintentional error, arbitrage_statistics_dataframe is converted to a DataFrame and exported to CSV 162 | arbitrage_statistics_dataframe = pd.DataFrame(arbitrage_statistics_list, columns=list(new_statistics_entry)) 163 | file_name = self.saveDataToCSV(arbitrage_statistics_dataframe, 'ArbitrageDetectionStats') 164 | print('\nArbitrage statistics saved to ' + file_name) 165 | warnings.filterwarnings("default") 166 | return(arbitrage_statistics_dataframe) 167 | 168 | 169 | # Saves DataFrame objects to CSV with the current date and time in the file name 170 | def saveDataToCSV(self, data, file_name): 171 | date_time = list(time.localtime()) 172 | full_file_name = file_name + '_' + str(date_time[1]) + '-' + str(date_time[2]) + '-' + str(date_time[0]) + '_' + \ 173 | '0'*(2 - len(str(date_time[3]))) + str(date_time[3]) + '-' + '0'*(2-len(str(date_time[4])))+ \ 174 | str(date_time[4]) + '-' + '0'*(2-len(str(date_time[5]))) + str(date_time[5]) + '.csv' 175 | data.to_csv(full_file_name) 176 | return(full_file_name) 177 | 178 | def startLoop(self, defaults=False): 179 | if defaults: 180 | token_A = 'WETH' 181 | token_B = 'DAI' 182 | max_spent_amount = 100000 183 | min_spent_amount = .000001 184 | digit_granularity = 3 185 | else: 186 | 187 | # >>> WETH 188 | token_A = input('\nPlease enter the first token you would like to arbitrage:\nToken Symbol: ') 189 | # >>> DAI 190 | token_B = input('\nPlease enter the second token you would like to arbitrage:\nToken Symbol: ') 191 | # >>> 100000 192 | max_spent_amount = input('\nPlease enter the maxiumum amount of $USD you are willing to spend on a trade:\nMaximum Spent Amount: ') 193 | # >>> .00001 194 | min_spent_amount = input('\nPlease enter the minumum amount of $USD you are willing to spend on a trade:\nMinimum Spent Amount: ') 195 | # >>> 3 196 | digit_granularity = input('\nPlease enter the depth of digit variance you want the detector to try:\nDigit Granularity: ') 197 | self.loopArbitrageDetection(token_A, token_B, max_spent_amount, min_spent_amount, digit_granularity) 198 | 199 | AA = ArbitrageAggregator() 200 | AA.startLoop(defaults=False) 201 | 202 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------