├── .gitignore ├── requirements.txt ├── pricebot ├── commands │ ├── models │ │ └── prices.py │ ├── owner.py │ ├── admin.py │ └── price.py └── pricebot.py ├── config.yaml.example ├── main.py ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | *.db 3 | config.yaml 4 | contracts 5 | pricebot/plugin/ 6 | __pycache__/ 7 | .idea/ 8 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | web3==5.15.0 2 | discord.py==1.6.0 3 | discord==1.0.1 4 | PyYAML==5.4.1 5 | SQLAlchemy~=1.4.0b1 6 | SQLAlchemy-Utils==0.36.8 7 | -------------------------------------------------------------------------------- /pricebot/commands/models/prices.py: -------------------------------------------------------------------------------- 1 | from sqlalchemy import * # func, Table, Column, Boolean, BigInteger, Binary, DateTime, Integer, Float, String 2 | from sqlalchemy.sql import func 3 | from sqlalchemy.ext.declarative import declarative_base 4 | 5 | Base = declarative_base() 6 | 7 | class PriceATH(Base): 8 | __tablename__ = 'price_ath' 9 | 10 | id = Column(Integer, primary_key=True, autoincrement=True) 11 | token = Column(String, nullable=False, unique=True) 12 | price = Column(Float, nullable=False) 13 | timestamp = Column(DateTime, nullable=False, default=func.now(), server_onupdate=func.now()) 14 | 15 | def __repr__(self): 16 | return f"" 17 | -------------------------------------------------------------------------------- /config.yaml.example: -------------------------------------------------------------------------------- 1 | --- 2 | _config: 3 | amm: # Identification for multiple AMMs 4 | pancakeswap: 5 | address: '0x1B96B92314C44b159149f7E0303511fB2Fc4774f' 6 | name: PancakeSwap 7 | streetswap: 8 | address: '0xf2e4E3F9B58b3eDaC88Ad11D689a23f3119a782D' 9 | name: StreetSwap 10 | bnb_emoji: <:bnb:794297484473532447> # External emoji for BNB if used on multiple servers 11 | refresh_rate: 15 # How often prices refresh 12 | bsc_node: https://bsc-dataseed2.binance.org # HTTP RPC or local RPC path 13 | CAKE: 14 | token: 15 | apikey: ABCDEF # Discord API Key 16 | contract: '0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82' # Token Contract 17 | icon: 🥞 # Flavor icon for the user list 18 | emoji: <:cake_token:794304404286341140> # [Optional] External custom emoji 19 | lp: '0xA527a61703D82139F8a06Bc30097cC9CAA2df5A6' # BNB/[Token] LP Pair Contract 20 | from: pancakeswap # Follows keys from _config.amm 21 | config: 22 | refresh_rate: 30 # Overriding refresh rate 23 | restrict_to: # Initial values for 'restrict' commands 24 | 780148959502270525: # Guild ID 25 | - 793467848365834261 # Channel ID 26 | - 'offtopic' # Also accepts a channel name 27 | THUGS: 28 | token: 29 | apikey: GHIJKL 30 | contract: '0xE10e9822A5de22F8761919310DDA35CD997d63c0' 31 | icon: 👊 32 | emoji: <:thugs_token:794300116562477056> 33 | lp: '0x9354caB0F1083135439B23aA6c364329e578F39a' 34 | from: streetswap 35 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import importlib 3 | from pricebot import pricebot 4 | import yaml 5 | 6 | bots = {} 7 | 8 | with open('config.yaml') as cfg_file: 9 | cfg_data = yaml.safe_load(cfg_file) 10 | 11 | cfg_defaults = cfg_data.pop('_config') 12 | 13 | if len(sys.argv) < 2: 14 | print(f"Usage: {sys.argv[0]} ") 15 | sys.exit() 16 | 17 | if sys.argv[1] and cfg_data.get(sys.argv[1]): 18 | cfg_data = {sys.argv[1]: cfg_data.get(sys.argv[1])} 19 | else: 20 | raise Exception(f"Token {sys.argv[1]} does not exist in configuration!") 21 | 22 | for cfg_name, cfg_info in cfg_data.items(): 23 | token = cfg_info.get('token') 24 | if not token: 25 | raise Exception(f"Each instance must have a token configuration") 26 | 27 | token['name'] = cfg_name 28 | token['abi'] = pricebot.fetch_abi(token['contract']) 29 | 30 | config = ({**cfg_defaults, **cfg_info.get('config', {})}) 31 | 32 | if config.get('plugin'): 33 | try: 34 | module = importlib.import_module(config['plugin']) 35 | bots[cfg_name] = module.PriceBot(config, token) 36 | except ModuleNotFoundError as e: 37 | print(f"Token {cfg_name} has an invalid plugin configuration!", e) 38 | sys.exit() 39 | except AttributeError: 40 | print(f"The plugin for {cfg_name} must be named PriceBot!") 41 | sys.exit() 42 | else: 43 | bots[cfg_name] = pricebot.PriceBot(config, token) 44 | 45 | bots[cfg_name].exec() 46 | -------------------------------------------------------------------------------- /pricebot/commands/owner.py: -------------------------------------------------------------------------------- 1 | from discord.ext import commands 2 | 3 | class Owner(commands.Cog): 4 | def __init__(self, bot): 5 | self.bot = bot 6 | 7 | # Hidden means it won't show up on the default help. 8 | @commands.command(name='load', hidden=True) 9 | @commands.is_owner() 10 | async def owner_cog_load(self, ctx: commands.Context, *, cog: str): 11 | """Command which Loads a Module. 12 | Remember to use dot path. e.g: cogs.owner""" 13 | 14 | try: 15 | self.bot.load_extension(cog) 16 | except Exception as e: 17 | await ctx.send(f'**`ERROR:`** {type(e).__name__} - {e}') 18 | else: 19 | await ctx.message.add_reaction('👍') 20 | 21 | @commands.command(name='unload', hidden=True) 22 | @commands.is_owner() 23 | async def owner_cog_unload(self, ctx, *, cog: str): 24 | """Command which Unloads a Module. 25 | Remember to use dot path. e.g: cogs.owner""" 26 | 27 | try: 28 | self.bot.unload_extension(cog) 29 | except Exception as e: 30 | await ctx.send(f'**`ERROR:`** {type(e).__name__} - {e}') 31 | else: 32 | await ctx.message.add_reaction('👍') 33 | 34 | @commands.command(name='reload', hidden=True) 35 | @commands.is_owner() 36 | async def owner_cog_reload(self, ctx, *, cog: str): 37 | """Command which Reloads a Module. 38 | Remember to use dot path. e.g: cogs.owner""" 39 | 40 | try: 41 | self.bot.unload_extension(cog) 42 | self.bot.load_extension(cog) 43 | except Exception as e: 44 | await ctx.send(f'**`ERROR:`** {type(e).__name__} - {e}') 45 | else: 46 | await ctx.message.add_reaction('👍') 47 | 48 | def setup(bot): 49 | bot.add_cog(Owner(bot)) 50 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # discordpricebot 2 | A Discord Bot for displaying Token Prices on Binance Smart Chain 3 | 4 | ### About 5 | This bot will interface with both Discord and the BSC Network to continually keep a log of token prices. 6 | 7 | Note that this will only report the mid-price; buying and selling the tokens will be lower/higher than the listed price. 8 | 9 | ### Configuration 10 | See `config.yaml.example`. The token ticker is the parent key of the configuration. 11 | 12 | The web3 module requires all addresses to be [checksummed](https://coincodex.com/article/2078/ethereum-address-checksum-explained/); you can get the proper address from [BSCScan](https://bscscan.com/). 13 | 14 | ### Authorizing Discord User 15 | 16 | - Visit https://discord.com/developers/applications and create 'New Application'. 17 | - Set a worthy name 18 | - On the page that follows, set the account name and save. Then click Bot 19 | - Create a Bot account and Save. Click 'Copy' on the Token; this is the API Key you use in the bot script 20 | - Visit the OAuth2 tab. Under Scopes, select 'bot' 21 | - The resulting URL is what you (or anyone) use to add your bot instance to a server. 22 | 23 | A single bot instance can be added to multiple servers; the bot's nickname (the price) will be updated on all registered servers. 24 | 25 | ### Installation and Execution 26 | This assumes you already have python3 and pip3 installed on your system. 27 | 28 | Install the pre-requisites: 29 | `pip3 install -r requirements.txt` 30 | 31 | Due to limitations in the discord.py module, you cannot run all bots in one instance. 32 | Therefore, you will need to create a new instance for each token by passing the argument, such as `nohup python3 main.py CAKE &`. 33 | 34 | ### Contributing 35 | I need all the help I can get. PRs welcome. 36 | 37 | ### TODO 38 | - Error handling (web3 and discord) 39 | - Better configuration (single entrypoint file referencing external configuration) 40 | - Recording historical movements in status message 41 | - Configurable status messages (e.g. comparing CRED price to THUGS value) -------------------------------------------------------------------------------- /pricebot/commands/admin.py: -------------------------------------------------------------------------------- 1 | import discord 2 | from discord.ext import commands 3 | 4 | class Admin(commands.Cog): 5 | def __init__(self, bot): 6 | self.bot = bot 7 | 8 | @commands.Cog.listener() 9 | async def on_ready(self): 10 | if not self.bot.config.get('restrict_to'): 11 | self.bot.config['restrict_to'] = {} 12 | 13 | @commands.Cog.listener() 14 | async def on_command_error(self, ctx, error): 15 | if isinstance(error, commands.CommandNotFound) or isinstance(error, commands.CheckFailure): 16 | pass 17 | else: 18 | raise error 19 | 20 | @commands.group(name='restriction') 21 | @commands.guild_only() 22 | @commands.has_permissions(manage_channels=True) 23 | async def restriction(self, ctx: commands.Context): 24 | if ctx.invoked_subcommand is None: 25 | pass 26 | 27 | @restriction.command(name='list') 28 | async def list_restrictions(self, ctx: commands.Context): 29 | restrictions = self.bot.config['restrict_to'].get(ctx.guild.id) 30 | if restrictions: 31 | response = "Restricted to the following channels: " 32 | response += ' '.join([channel.mention for channel in restrictions]) 33 | return await ctx.channel.send(response) 34 | 35 | await ctx.channel.send('No restrictions on this server') 36 | 37 | @restriction.command(name='add') 38 | async def add_restriction(self, ctx: commands.Context, channel: discord.TextChannel): 39 | restrictions = self.bot.config['restrict_to'].get(ctx.guild.id) 40 | if not restrictions: 41 | restrictions = self.bot.config['restrict_to'][ctx.guild.id] = [] 42 | 43 | restrictions.append(channel) 44 | 45 | await ctx.channel.send(f'Restricted to {channel.name}') 46 | 47 | @restriction.command(name='remove') 48 | async def remove_restriction(self, ctx: commands.Context, channel: discord.TextChannel): 49 | restrictions = self.bot.config['restrict_to'].get(ctx.guild.id) 50 | if restrictions: 51 | await ctx.channel.send(f"Removed restriction for {channel.name}") 52 | 53 | await ctx.channel.send("I don't have a restriction to that channel!") 54 | 55 | @restriction.command(name='clear') 56 | async def clear_restrictions(self, ctx:commands.Context): 57 | self.bot.config['restrict_to'][ctx.guild.id] = [] 58 | await ctx.channel.send(f'Clearing all restrictions.') 59 | 60 | def setup(bot: commands.Bot): 61 | bot.add_cog(Admin(bot)) 62 | -------------------------------------------------------------------------------- /pricebot/commands/price.py: -------------------------------------------------------------------------------- 1 | import math 2 | from datetime import datetime 3 | 4 | import discord 5 | from discord.ext import tasks, commands 6 | from decimal import Decimal, DecimalException 7 | from pricebot.commands.models import prices 8 | 9 | class Prices(commands.Cog, command_attrs=dict(hidden=True)): 10 | current_ath = None 11 | 12 | def __init__(self, bot): 13 | self.bot = bot 14 | self.db = bot.db 15 | 16 | prices.Base.metadata.create_all(self.bot.dbengine) 17 | query = self.db.query(prices.PriceATH).filter(prices.PriceATH.token == self.bot.token['contract']) 18 | if result := query.first(): 19 | self.current_ath = result 20 | 21 | @commands.Cog.listener() 22 | async def on_ready(self): 23 | await self.update_price() 24 | 25 | self.bot.priceloop = tasks.loop(seconds=self.bot.config['refresh_rate'])(self.update_price) 26 | self.bot.priceloop.add_exception_type(discord.errors.HTTPException) 27 | self.bot.priceloop.start() 28 | 29 | async def update_price(self): 30 | try: 31 | self.bot.current_price = self.bot.get_token_price() 32 | except Exception: 33 | # Ignore issues with blockchain timeouts, but don't update anything 34 | return 35 | 36 | for guild in self.bot.guilds: 37 | await guild.me.edit(nick=self.bot.generate_nickname()) 38 | 39 | if self.current_ath: 40 | if self.bot.current_price > self.current_ath.price: 41 | try: 42 | self.current_ath.price = self.bot.current_price 43 | self.current_ath.timestamp = datetime.utcnow() 44 | 45 | self.db.update(self.current_ath) 46 | self.db.commit() 47 | return await self.bot.change_presence(activity=discord.Game(name='ATH Hit!')) 48 | except Exception: 49 | pass 50 | else: 51 | ath = prices.PriceATH(token=self.bot.token['contract'], price=self.bot.current_price) 52 | self.db.add(ath) 53 | self.db.commit() 54 | 55 | self.current_ath = ath 56 | 57 | presence = self.bot.generate_presence() 58 | if presence: 59 | await self.bot.change_presence(activity=discord.Game(name=presence)) 60 | 61 | @commands.Cog.listener() 62 | async def on_command_error(self, ctx, error): 63 | if isinstance(error, commands.CommandNotFound) or isinstance(error, commands.CheckFailure): 64 | pass 65 | else: 66 | raise error 67 | 68 | async def cog_check(self, ctx: commands.Context): 69 | if isinstance(ctx.channel, discord.channel.DMChannel): 70 | return True 71 | return await self.bot.check_restrictions(ctx) 72 | 73 | @commands.command(help='Display contents and value of LP tokens') 74 | async def lp(self, ctx: commands.Context, num_tokens=None): 75 | num_tokens = abs(self.bot.parse_decimal(num_tokens) or 1) 76 | 77 | with ctx.typing(): 78 | total_supply = self.bot.total_supply 79 | values = [Decimal(self.bot.token_amount / total_supply), Decimal(self.bot.bnb_amount / total_supply)] 80 | 81 | bnb_emoji = self.bot.config['bnb_emoji'] 82 | 83 | token_value = str(round(values[0] * num_tokens, 5)) 84 | bnb_value = str(round(values[1] * num_tokens, 5)) 85 | 86 | output_header = f"{format(num_tokens, '.12g')} {self.bot.token['name']}/BNB LP" 87 | output_body = f"{self.bot.icon_value(token_value)} + {bnb_emoji} {bnb_value}" 88 | 89 | embed = discord.Embed(color=0x98FB98, title=output_header, description=output_body) 90 | 91 | footer_text = f"≈ ${round(self.bot.lp_price * num_tokens, 4):.4f}" 92 | amm_info = self.bot.get_amm() 93 | if amm_info.get('name'): 94 | footer_text += f" | via {amm_info.get('name')}" 95 | 96 | embed.set_footer(text=footer_text) 97 | 98 | await ctx.channel.send(embed=embed) 99 | 100 | @commands.command(help='Display BNB value of tokens') 101 | async def convert(self, ctx: commands.Context, num_tokens=None): 102 | num_tokens = self.bot.parse_decimal(num_tokens) or Decimal(1) 103 | 104 | total_price = num_tokens * self.bot.current_price 105 | price_in_bnb = total_price / self.bot.bnb_price 106 | 107 | token_emoji = self.bot.icon_value() 108 | bnb_emoji = self.bot.config['bnb_emoji'] 109 | 110 | output_header = f"{format(float(num_tokens.quantize(self.bot.display_precision)), '.12g')} {self.bot.token['name']}" 111 | output_body = f"{bnb_emoji} **{Decimal(price_in_bnb).quantize(self.bot.display_precision)}**" 112 | 113 | usd = Decimal(price_in_bnb * self.bot.bnb_price).quantize(self.bot.display_precision) 114 | embed = discord.Embed(color=0x3D85C6, title=token_emoji + ' ' + output_header, 115 | description=f"{output_body} _(${usd})_") 116 | 117 | amm_info = self.bot.get_amm() 118 | if amm_info.get('name'): 119 | embed.set_footer(text=f"via {amm_info.get('name')}") 120 | 121 | await ctx.channel.send(embed=embed) 122 | 123 | @commands.command() 124 | async def ath(self, ctx: commands.Context): 125 | token_emoji = self.bot.icon_value() 126 | if not self.current_ath: 127 | return 128 | 129 | time = self.current_ath.timestamp.strftime('%Y-%m-%d %H:%M:%S UTC') 130 | 131 | output_body = f"The highest price for {self.bot.token['name']} was **${self.current_ath.price}**" 132 | 133 | embed = discord.Embed(color=discord.Color.green(), title=token_emoji + ' All Time High', description=output_body) 134 | 135 | amm_info = self.bot.get_amm() 136 | if amm_info.get('name'): 137 | embed.set_footer(text=f"Recorded {time} via {amm_info.get('name')}") 138 | 139 | await ctx.channel.send(embed=embed) 140 | 141 | def setup(bot: commands.Bot): 142 | bot.add_cog(Prices(bot)) 143 | -------------------------------------------------------------------------------- /pricebot/pricebot.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | from decimal import Decimal, DecimalException 4 | from urllib.parse import urlparse 5 | 6 | import discord 7 | from discord.ext import tasks, commands 8 | from urllib.request import urlopen, Request 9 | from web3 import Web3 10 | from sqlalchemy import create_engine 11 | from sqlalchemy.orm import sessionmaker 12 | 13 | def fetch_abi(contract): 14 | if not os.path.exists('contracts'): 15 | os.mkdir('./contracts') 16 | 17 | filename = f'contracts/{contract}.json' 18 | if os.path.exists(filename): 19 | with open(filename, 'r') as abi_file: 20 | abi = abi_file.read() 21 | else: 22 | # TODO: Error handling 23 | url = 'https://api.bscscan.com/api?module=contract&action=getabi&address=' + contract 24 | abi_response = urlopen(Request(url, headers={'User-Agent': 'Mozilla'})).read().decode('utf8') 25 | abi = json.loads(abi_response)['result'] 26 | 27 | with open(filename, 'w') as abi_file: 28 | abi_file.write(abi) 29 | 30 | return json.loads(abi) 31 | 32 | def list_cogs(directory): 33 | basedir = (os.path.basename(os.path.dirname(__file__))) 34 | return (f"{basedir}.{directory}.{f.rstrip('.py')}" for f in os.listdir(basedir + '/' + directory) if f.endswith('.py')) 35 | 36 | class PriceBot(commands.Bot): 37 | contracts = {} 38 | config = {} 39 | current_price = 0 40 | nickname = '' 41 | bnb_amount = 0 42 | bnb_price = 0 43 | token_amount = 0 44 | lp_price = 0 45 | total_supply = 0 46 | display_precision = Decimal('0.0001') # Round to 4 token_decimals 47 | 48 | # Static BSC contract addresses 49 | address = { 50 | 'bnb' : '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c', 51 | 'busd': '0xe9e7CEA3DedcA5984780Bafc599bD69ADd087D56' 52 | } 53 | 54 | intents = discord.Intents.default() 55 | intents.members = True 56 | 57 | def __init__(self, config, token): 58 | super().__init__(command_prefix=self.handle_prefix, case_insensitive=True) 59 | self.config = config 60 | self.token = token 61 | self.amm = config['amm'][token['from']] 62 | 63 | if not config['amm'].get(token['from']): 64 | raise Exception(f"{token['name']}'s AMM {token['from']} does not exist!") 65 | 66 | if node := config.get('bsc_node'): 67 | bsc_node = urlparse(node) 68 | if 'http' in bsc_node.scheme: 69 | provider = Web3.HTTPProvider(node) 70 | else: 71 | provider = Web3.IPCProvider(bsc_node.path) 72 | 73 | self.web3 = Web3(provider) # type: Web3.eth.account 74 | else: 75 | raise Exception("Required setting 'bsc_node' not configured!") 76 | 77 | self.contracts['bnb'] = self.web3.eth.contract(address=self.address['bnb'], abi=self.token['abi']) 78 | self.contracts['busd'] = self.web3.eth.contract(address=self.address['busd'], abi=self.token['abi']) 79 | self.contracts['token'] = self.web3.eth.contract(address=self.token['contract'], abi=self.token['abi']) 80 | self.contracts['lp'] = self.web3.eth.contract(address=self.token['lp'], abi=fetch_abi(self.token['lp'])) 81 | 82 | if 'getFinalTokens' in self.contracts['lp'].functions.__dict__: 83 | pair_info = self.contracts['lp'].functions.getFinalTokens().call() 84 | else: 85 | pair_info = [self.contracts['lp'].functions.token0().call(), self.contracts['lp'].functions.token1().call()] 86 | 87 | if not self.token.get('decimals'): 88 | self.token['decimals'] = self.contracts['token'].functions.decimals().call() 89 | 90 | self.help_command = commands.DefaultHelpCommand(command_attrs={"hidden": True}) 91 | 92 | self.dbengine = create_engine('sqlite:///pricebot.db', echo=self.config.get('debug', False)) 93 | session = sessionmaker(bind=self.dbengine) 94 | self.db = session() 95 | 96 | def handle_prefix(self, bot, message): 97 | if isinstance(message.channel, discord.channel.DMChannel): 98 | return '' 99 | 100 | return commands.when_mentioned(bot, message) 101 | 102 | def bscscan_link(self, link_hash, link_type='address', text=None): 103 | return f'[{text or link_hash}](https://bscscan.com/{link_type}/{link_hash})' 104 | 105 | def get_amm(self, amm=None): 106 | if not amm: 107 | return self.amm 108 | 109 | return self.config['amm'].get(amm) 110 | 111 | def icon_value(self, value=None): 112 | if self.token['emoji'] or self.token['icon']: 113 | value = f" {value}" if value else '' 114 | return f"{self.token['emoji'] or self.token['icon']}{value}" 115 | 116 | value = f"{value} " if value else '' 117 | return f"{value}{self.token['name']}" 118 | 119 | def get_icon(self): 120 | return self.token['emoji'] or self.token['icon'] or self.token['name'] 121 | 122 | def get_bnb_price(self, lp): 123 | bnb_amount = Decimal(self.contracts['bnb'].functions.balanceOf(lp).call()) 124 | busd_amount = Decimal(self.contracts['busd'].functions.balanceOf(lp).call()) 125 | 126 | self.bnb_price = Decimal(busd_amount) / Decimal(bnb_amount) 127 | 128 | return self.bnb_price 129 | 130 | def get_price(self, token_contract, native_lp, bnb_lp): 131 | self.bnb_amount = Decimal(self.contracts['bnb'].functions.balanceOf(native_lp).call()) 132 | self.token_amount = Decimal(token_contract.functions.balanceOf(native_lp).call()) * Decimal(10 ** (18 - self.token["decimals"])) # Normalize token_decimals 133 | 134 | bnb_price = self.get_bnb_price(bnb_lp) 135 | 136 | try: 137 | if ratio := self.token.get('ratio'): 138 | final_price = (self.bnb_amount * 2 * Decimal(str(ratio / 100))) / (self.token_amount * 2 * Decimal(str((100 - ratio) / 100))) * bnb_price 139 | else: 140 | final_price = self.bnb_amount / self.token_amount * bnb_price 141 | 142 | except ZeroDivisionError: 143 | final_price = 0 144 | 145 | return final_price 146 | 147 | def get_token_price(self): 148 | return self.get_price(self.contracts['token'], self.token['lp'], self.amm['address']).quantize(self.display_precision) 149 | 150 | def generate_presence(self): 151 | if not self.token_amount: 152 | return '' 153 | 154 | try: 155 | self.total_supply = self.contracts['lp'].functions.totalSupply().call() 156 | values = [Decimal(self.token_amount / self.total_supply), Decimal(self.bnb_amount / self.total_supply)] 157 | 158 | total_token_price = Decimal(self.contracts['token'].functions.balanceOf(self.contracts['lp'].address).call()) * self.current_price 159 | total_bnb_price = Decimal(self.contracts['bnb'].functions.balanceOf(self.contracts['lp'].address).call()) * self.bnb_price 160 | 161 | self.lp_price = (total_token_price + total_bnb_price) / self.total_supply 162 | 163 | return f"LP ≈${round(self.lp_price, 2)} | {round(values[0], 4)} + {round(values[1], 4)} BNB" 164 | except ValueError: 165 | pass 166 | 167 | def generate_nickname(self): 168 | return f"{self.token.get('icon', self.token['name'])} ${self.current_price:.4f} ({round(self.current_price / self.bnb_price, 4):.4f})" 169 | 170 | async def get_lp_value(self): 171 | self.total_supply = self.contracts['lp'].functions.totalSupply().call() 172 | return [self.token_amount / self.total_supply, self.bnb_amount / self.total_supply] 173 | 174 | async def on_guild_join(self, guild): 175 | await guild.me.edit(nick=self.nickname) 176 | 177 | async def check_restrictions(self, ctx): 178 | server_restriction = self.config.get('restrict_to', {}).get(ctx.guild.id) 179 | if server_restriction and not await self.is_owner(ctx.author): 180 | if ctx.channel.id not in server_restriction: 181 | if ctx.channel.permissions_for(ctx.guild.me).manage_messages: 182 | await ctx.message.delete() 183 | return False 184 | return True 185 | 186 | async def on_ready(self): 187 | restrictions = self.config.get('restrict_to', {}) 188 | all_channels = self.get_all_channels() 189 | for guild_id, channels in restrictions.items(): 190 | for i, channel in enumerate(channels): 191 | if not self.parse_int(channel): 192 | channels[i] = discord.utils.get(all_channels, guild__id=guild_id, name=channel) 193 | if not channels[i]: 194 | raise Exception('No channel named channel!') 195 | 196 | @staticmethod 197 | def parse_int(val): 198 | try: 199 | val = int(val) 200 | except ValueError: 201 | val = None 202 | 203 | return val 204 | 205 | @staticmethod 206 | def parse_decimal(val): 207 | try: 208 | val = Decimal(val) 209 | except (TypeError, DecimalException): 210 | val = None 211 | 212 | return val 213 | 214 | def exec(self): 215 | for cog in list_cogs('commands'): 216 | try: 217 | if self.token.get('command_override'): 218 | override = self.token.get('command_override') 219 | cog = override.get(cog, cog) 220 | 221 | self.load_extension(cog) 222 | except Exception as e: 223 | print(f'Failed to load extension {cog}.', e) 224 | 225 | self.run(self.token['apikey']) 226 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------