├── .gitignore ├── .gitattributes ├── .npmrc ├── .yarnrc ├── .mocharc.json ├── tsconfig.json ├── README.md ├── .prettierrc ├── .waffle.json ├── contracts ├── libraries │ └── UQ112x112.sol ├── interfaces │ ├── IBakerySwapFactory.sol │ ├── IBakerySwapBEP20.sol │ └── IBakerySwapPair.sol ├── BakerySwapFactory.sol ├── BakerySwapBEP20.sol └── BakerySwapPair.sol ├── package.json ├── test ├── BakerySwapFactory.spec.ts ├── shared │ └── utilities.ts └── BakerySwapBEP20.spec.ts └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | .idea 3 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | *.sol linguist-language=Solidity -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | @BakeryProject:registry=https://npm.pkg.github.com 2 | -------------------------------------------------------------------------------- /.yarnrc: -------------------------------------------------------------------------------- 1 | ignore-scripts true 2 | "@BakeryProject:registry" "https://npm.pkg.github.com" 3 | -------------------------------------------------------------------------------- /.mocharc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extension": ["ts"], 3 | "spec": "./test/**/*.spec.ts", 4 | "require": "ts-node/register", 5 | "timeout": 12000 6 | } 7 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "module": "commonjs", 5 | "strict": true, 6 | "esModuleInterop": true, 7 | "resolveJsonModule": true 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Bakery Swap Core 2 | 3 | 4 | # Local Development 5 | 6 | The following assumes the use of `node@>=10`. 7 | 8 | ## Install Dependenciess 9 | 10 | `yarn` 11 | 12 | ## Compile Contracts 13 | 14 | `yarn compile` 15 | 16 | ## Run Tests 17 | 18 | `yarn test` 19 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": false, 3 | "singleQuote": true, 4 | "printWidth": 120, 5 | "overrides": [ 6 | { 7 | "files": "*.sol", 8 | "options": { 9 | "tabWidth": 4, 10 | "useTabs": false, 11 | "singleQuote": true, 12 | "bracketSpacing": false, 13 | "explicitTypes": "always" 14 | } 15 | } 16 | ] 17 | } 18 | -------------------------------------------------------------------------------- /.waffle.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerVersion": "./node_modules/solc", 3 | "outputType": "all", 4 | "compilerOptions": { 5 | "outputSelection": { 6 | "*": { 7 | "*": [ 8 | "evm.bytecode.object", 9 | "evm.deployedBytecode.object", 10 | "abi", 11 | "evm.bytecode.sourceMap", 12 | "evm.deployedBytecode.sourceMap", 13 | "metadata" 14 | ], 15 | "": ["ast"] 16 | } 17 | }, 18 | "evmVersion": "istanbul", 19 | "optimizer": { 20 | "enabled": true, 21 | "runs": 999999 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /contracts/libraries/UQ112x112.sol: -------------------------------------------------------------------------------- 1 | pragma solidity =0.5.16; 2 | 3 | // a library for handling binary fixed point numbers (https://en.wikipedia.org/wiki/Q_(number_format)) 4 | 5 | // range: [0, 2**112 - 1] 6 | // resolution: 1 / 2**112 7 | 8 | library UQ112x112 { 9 | uint224 constant Q112 = 2**112; 10 | 11 | // encode a uint112 as a UQ112x112 12 | function encode(uint112 y) internal pure returns (uint224 z) { 13 | z = uint224(y) * Q112; // never overflows 14 | } 15 | 16 | // divide a UQ112x112 by a uint112, returning a UQ112x112 17 | function uqdiv(uint224 x, uint112 y) internal pure returns (uint224 z) { 18 | z = x / uint224(y); 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /contracts/interfaces/IBakerySwapFactory.sol: -------------------------------------------------------------------------------- 1 | pragma solidity >=0.5.0; 2 | 3 | interface IBakerySwapFactory { 4 | event PairCreated(address indexed token0, address indexed token1, address pair, uint256); 5 | 6 | function feeTo() external view returns (address); 7 | 8 | function feeToSetter() external view returns (address); 9 | 10 | function getPair(address tokenA, address tokenB) external view returns (address pair); 11 | 12 | function allPairs(uint256) external view returns (address pair); 13 | 14 | function allPairsLength() external view returns (uint256); 15 | 16 | function createPair(address tokenA, address tokenB) external returns (address pair); 17 | 18 | function setFeeTo(address) external; 19 | 20 | function setFeeToSetter(address) external; 21 | } 22 | -------------------------------------------------------------------------------- /contracts/interfaces/IBakerySwapBEP20.sol: -------------------------------------------------------------------------------- 1 | pragma solidity >=0.5.0; 2 | 3 | interface IBakerySwapBEP20 { 4 | event Approval(address indexed owner, address indexed spender, uint256 value); 5 | event Transfer(address indexed from, address indexed to, uint256 value); 6 | 7 | function name() external pure returns (string memory); 8 | 9 | function symbol() external pure returns (string memory); 10 | 11 | function decimals() external pure returns (uint8); 12 | 13 | function totalSupply() external view returns (uint256); 14 | 15 | function balanceOf(address owner) external view returns (uint256); 16 | 17 | function allowance(address owner, address spender) external view returns (uint256); 18 | 19 | function approve(address spender, uint256 value) external returns (bool); 20 | 21 | function transfer(address to, uint256 value) external returns (bool); 22 | 23 | function transferFrom( 24 | address from, 25 | address to, 26 | uint256 value 27 | ) external returns (bool); 28 | 29 | function DOMAIN_SEPARATOR() external view returns (bytes32); 30 | 31 | function PERMIT_TYPEHASH() external pure returns (bytes32); 32 | 33 | function nonces(address owner) external view returns (uint256); 34 | 35 | function permit( 36 | address owner, 37 | address spender, 38 | uint256 value, 39 | uint256 deadline, 40 | uint8 v, 41 | bytes32 r, 42 | bytes32 s 43 | ) external; 44 | } 45 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@BakeryProject/bakery-swap-core", 3 | "description": "Bakery Swap Core", 4 | "version": "0.0.1", 5 | "keywords": [ 6 | "swap", 7 | "ethereum", 8 | "core" 9 | ], 10 | "files": [ 11 | "contracts", 12 | "build" 13 | ], 14 | "engines": { 15 | "node": ">=10" 16 | }, 17 | "dependencies": { 18 | "@BakeryProject/bakery-swap-lib": "0.0.1" 19 | }, 20 | "devDependencies": { 21 | "@types/chai": "^4.2.6", 22 | "@types/mocha": "^5.2.7", 23 | "chai": "^4.2.0", 24 | "ethereum-waffle": "^2.4.1", 25 | "ethereumjs-util": "^6.2.0", 26 | "ethers": "^4.0.48", 27 | "mocha": "^6.2.2", 28 | "prettier": "^1.19.1", 29 | "prettier-plugin-solidity": "^1.0.0-alpha.57", 30 | "rimraf": "^3.0.0", 31 | "solc": "0.5.16", 32 | "ts-node": "^8.5.4", 33 | "typescript": "^3.7.3" 34 | }, 35 | "scripts": { 36 | "lint": "yarn prettier --check ./test/{**/*,*}.ts ./contracts/{**/*,*}.sol ", 37 | "lint:fix": "yarn prettier --write ./test/{**/*,*}.ts ./contracts/{**/*,*}.sol", 38 | "clean": "rimraf ./build/", 39 | "precompile": "yarn clean", 40 | "compile": "waffle .waffle.json", 41 | "pretest": "yarn compile", 42 | "test": "mocha", 43 | "prepublishOnly": "yarn lint" 44 | }, 45 | "license": "GPL-3.0-or-later", 46 | "repository": { 47 | "type": "git", 48 | "url": "ssh://git@github.com/BakeryProject/bakery-swap-core.git" 49 | }, 50 | "publishConfig": { 51 | "registry": "https://npm.pkg.github.com/" 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /contracts/BakerySwapFactory.sol: -------------------------------------------------------------------------------- 1 | pragma solidity =0.5.16; 2 | 3 | import './interfaces/IBakerySwapFactory.sol'; 4 | import './BakerySwapPair.sol'; 5 | 6 | contract BakerySwapFactory is IBakerySwapFactory { 7 | address public feeTo; 8 | address public feeToSetter; 9 | 10 | mapping(address => mapping(address => address)) public getPair; 11 | address[] public allPairs; 12 | 13 | event PairCreated(address indexed token0, address indexed token1, address pair, uint256); 14 | 15 | constructor(address _feeToSetter) public { 16 | feeToSetter = _feeToSetter; 17 | // default feeTo is feeToSetter 18 | feeTo = feeToSetter; 19 | } 20 | 21 | function allPairsLength() external view returns (uint256) { 22 | return allPairs.length; 23 | } 24 | 25 | function createPair(address tokenA, address tokenB) external returns (address pair) { 26 | require(tokenA != tokenB, 'BakerySwapFactory: IDENTICAL_ADDRESSES'); 27 | (address token0, address token1) = tokenA < tokenB ? (tokenA, tokenB) : (tokenB, tokenA); 28 | require(token0 != address(0), 'BakerySwapFactory: ZERO_ADDRESS'); 29 | require(getPair[token0][token1] == address(0), 'BakerySwapFactory: PAIR_EXISTS'); // single check is sufficient 30 | bytes memory bytecode = type(BakerySwapPair).creationCode; 31 | bytes32 salt = keccak256(abi.encodePacked(token0, token1)); 32 | assembly { 33 | pair := create2(0, add(bytecode, 32), mload(bytecode), salt) 34 | } 35 | IBakerySwapPair(pair).initialize(token0, token1); 36 | getPair[token0][token1] = pair; 37 | getPair[token1][token0] = pair; // populate mapping in the reverse direction 38 | allPairs.push(pair); 39 | emit PairCreated(token0, token1, pair, allPairs.length); 40 | } 41 | 42 | function setFeeTo(address _feeTo) external { 43 | require(msg.sender == feeToSetter, 'BakerySwapFactory: FORBIDDEN'); 44 | feeTo = _feeTo; 45 | } 46 | 47 | function setFeeToSetter(address _feeToSetter) external { 48 | require(msg.sender == feeToSetter, 'BakerySwapFactory: FORBIDDEN'); 49 | feeToSetter = _feeToSetter; 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /test/BakerySwapFactory.spec.ts: -------------------------------------------------------------------------------- 1 | import chai from 'chai' 2 | import * as ethers from 'ethers' 3 | import {AddressZero} from 'ethers/constants' 4 | import {deployContract, solidity} from 'ethereum-waffle' 5 | 6 | import BakerySwapFactory from '../build/BakerySwapFactory.json' 7 | 8 | chai.use(solidity) 9 | 10 | describe('BakerySwapFactory', () => { 11 | const provider = new ethers.providers.JsonRpcProvider('https://data-seed-prebsc-1-s1.binance.org:8545') 12 | // const provider = ethers.getDefaultProvider('rinkeby') 13 | const privateKey = '' 14 | const wallet = new ethers.Wallet(privateKey, provider) 15 | const overrides = { 16 | gasLimit: 9999999, 17 | gasPrice: 390000000000 18 | } 19 | 20 | it('deploy', async () => { 21 | console.log(`start deployContract swapFactory`) 22 | const swapFactory = await deployContract( 23 | wallet, 24 | BakerySwapFactory, 25 | ['0xf9e89b5aCA2e6061d22EA98CBCc2d826E3f9E4b1'], 26 | overrides 27 | ) 28 | console.log(`contract swapFactory address ${swapFactory.address}`) 29 | console.log(`contract swapFactory deploy transaction hash ${swapFactory.deployTransaction.hash}`) 30 | await swapFactory.deployed() 31 | console.log(`finish deployContract swapFatory`) 32 | /** 33 | * contract swapFactory address 0x9303c500e327D08257514FEB7cec90e1aBc757B1 34 | * contract swapFactory deploy transaction hash 0x211f40d4dda0eb8a121cfdda08494bec303a90945479adb23caf6939c47d9dcc 35 | */ 36 | /** 37 | * 20200901 38 | * contract swapFactory address 0x63b231323F0d207a9a649A328d10514619FDDCC9 39 | * contract swapFactory deploy transaction hash 0xd6f2c15183944decf8a041d1399f538dcea2e715d3d034be5f1e0472f8f18330 40 | * 41 | * 0x80fc24CE272C5f1f063dA9715CfEC5B5dD7dcBF2 42 | * 0x0459cae24f5f6911b79134a849db1ae9ac78953cce46bb16585db99bb51efa7b 43 | */ 44 | /** 45 | * 20200902 46 | * contract swapFactory address 0xfb2bfD8db30865A1619A0E6eCa807a100917c563 47 | * contract swapFactory deploy transaction hash 0x229dcdfe923e1c0f767b163612002ea8d05d17ad500e8530f38fa6ff4bdf8f40 48 | */ 49 | /** 50 | * 51 | * 20200904 bsc test net 52 | * contract swapFactory address 0x54f36A35889717214eee4931d0367d78308c8b13 53 | * contract swapFactory deploy transaction hash 0x9ca0cc61a85540d4c6d2563161a421f1883a8f2d850730a3bd2e859722d2e523 54 | */ 55 | /** 56 | * 57 | * 202009010 bsc test net 58 | * contract swapFactory address 0x9A0615b24C8064F26A3030507c2B5f0DB7F975b4 59 | * contract swapFactory deploy transaction hash 0x55adfd1c40513a8317ad748362962e1a52b7ec5cd0173c7bd5bf39cd962ce43b 60 | */ 61 | }) 62 | }) 63 | -------------------------------------------------------------------------------- /test/shared/utilities.ts: -------------------------------------------------------------------------------- 1 | import {Contract} from 'ethers' 2 | import {Web3Provider} from 'ethers/providers' 3 | import {BigNumber, bigNumberify, getAddress, keccak256, defaultAbiCoder, toUtf8Bytes, solidityPack} from 'ethers/utils' 4 | 5 | const PERMIT_TYPEHASH = keccak256( 6 | toUtf8Bytes('Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)') 7 | ) 8 | 9 | export function expandTo18Decimals(n: number): BigNumber { 10 | return bigNumberify(n).mul(bigNumberify(10).pow(18)) 11 | } 12 | 13 | function getDomainSeparator(name: string, tokenAddress: string) { 14 | return keccak256( 15 | defaultAbiCoder.encode( 16 | ['bytes32', 'bytes32', 'bytes32', 'uint256', 'address'], 17 | [ 18 | keccak256(toUtf8Bytes('EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)')), 19 | keccak256(toUtf8Bytes(name)), 20 | keccak256(toUtf8Bytes('1')), 21 | 1, 22 | tokenAddress 23 | ] 24 | ) 25 | ) 26 | } 27 | 28 | export function getCreate2Address( 29 | factoryAddress: string, 30 | [tokenA, tokenB]: [string, string], 31 | bytecode: string 32 | ): string { 33 | const [token0, token1] = tokenA < tokenB ? [tokenA, tokenB] : [tokenB, tokenA] 34 | const create2Inputs = [ 35 | '0xff', 36 | factoryAddress, 37 | keccak256(solidityPack(['address', 'address'], [token0, token1])), 38 | keccak256(bytecode) 39 | ] 40 | const sanitizedInputs = `0x${create2Inputs.map(i => i.slice(2)).join('')}` 41 | return getAddress(`0x${keccak256(sanitizedInputs).slice(-40)}`) 42 | } 43 | 44 | export async function getApprovalDigest( 45 | token: Contract, 46 | approve: { 47 | owner: string 48 | spender: string 49 | value: BigNumber 50 | }, 51 | nonce: BigNumber, 52 | deadline: BigNumber 53 | ): Promise { 54 | const name = await token.name() 55 | const DOMAIN_SEPARATOR = getDomainSeparator(name, token.address) 56 | return keccak256( 57 | solidityPack( 58 | ['bytes1', 'bytes1', 'bytes32', 'bytes32'], 59 | [ 60 | '0x19', 61 | '0x01', 62 | DOMAIN_SEPARATOR, 63 | keccak256( 64 | defaultAbiCoder.encode( 65 | ['bytes32', 'address', 'address', 'uint256', 'uint256', 'uint256'], 66 | [PERMIT_TYPEHASH, approve.owner, approve.spender, approve.value, nonce, deadline] 67 | ) 68 | ) 69 | ] 70 | ) 71 | ) 72 | } 73 | 74 | export async function mineBlock(provider: Web3Provider, timestamp: number): Promise { 75 | await new Promise(async (resolve, reject) => { 76 | ;(provider._web3Provider.sendAsync as any)( 77 | {jsonrpc: '2.0', method: 'evm_mine', params: [timestamp]}, 78 | (error: any, result: any): void => { 79 | if (error) { 80 | reject(error) 81 | } else { 82 | resolve(result) 83 | } 84 | } 85 | ) 86 | }) 87 | } 88 | 89 | export function encodePrice(reserve0: BigNumber, reserve1: BigNumber) { 90 | return [reserve1.mul(bigNumberify(2).pow(112)).div(reserve0), reserve0.mul(bigNumberify(2).pow(112)).div(reserve1)] 91 | } 92 | -------------------------------------------------------------------------------- /contracts/interfaces/IBakerySwapPair.sol: -------------------------------------------------------------------------------- 1 | pragma solidity >=0.5.0; 2 | 3 | interface IBakerySwapPair { 4 | event Approval(address indexed owner, address indexed spender, uint256 value); 5 | event Transfer(address indexed from, address indexed to, uint256 value); 6 | 7 | function name() external pure returns (string memory); 8 | 9 | function symbol() external pure returns (string memory); 10 | 11 | function decimals() external pure returns (uint8); 12 | 13 | function totalSupply() external view returns (uint256); 14 | 15 | function balanceOf(address owner) external view returns (uint256); 16 | 17 | function allowance(address owner, address spender) external view returns (uint256); 18 | 19 | function approve(address spender, uint256 value) external returns (bool); 20 | 21 | function transfer(address to, uint256 value) external returns (bool); 22 | 23 | function transferFrom( 24 | address from, 25 | address to, 26 | uint256 value 27 | ) external returns (bool); 28 | 29 | function DOMAIN_SEPARATOR() external view returns (bytes32); 30 | 31 | function PERMIT_TYPEHASH() external pure returns (bytes32); 32 | 33 | function nonces(address owner) external view returns (uint256); 34 | 35 | function permit( 36 | address owner, 37 | address spender, 38 | uint256 value, 39 | uint256 deadline, 40 | uint8 v, 41 | bytes32 r, 42 | bytes32 s 43 | ) external; 44 | 45 | event Mint(address indexed sender, uint256 amount0, uint256 amount1); 46 | event Burn(address indexed sender, uint256 amount0, uint256 amount1, address indexed to); 47 | event Swap( 48 | address indexed sender, 49 | uint256 amount0In, 50 | uint256 amount1In, 51 | uint256 amount0Out, 52 | uint256 amount1Out, 53 | address indexed to 54 | ); 55 | event Sync(uint112 reserve0, uint112 reserve1); 56 | 57 | function MINIMUM_LIQUIDITY() external pure returns (uint256); 58 | 59 | function factory() external view returns (address); 60 | 61 | function token0() external view returns (address); 62 | 63 | function token1() external view returns (address); 64 | 65 | function getReserves() 66 | external 67 | view 68 | returns ( 69 | uint112 reserve0, 70 | uint112 reserve1, 71 | uint32 blockTimestampLast 72 | ); 73 | 74 | function price0CumulativeLast() external view returns (uint256); 75 | 76 | function price1CumulativeLast() external view returns (uint256); 77 | 78 | function kLast() external view returns (uint256); 79 | 80 | function mint(address to) external returns (uint256 liquidity); 81 | 82 | function burn(address to) external returns (uint256 amount0, uint256 amount1); 83 | 84 | function swap( 85 | uint256 amount0Out, 86 | uint256 amount1Out, 87 | address to 88 | ) external; 89 | 90 | function skim(address to) external; 91 | 92 | function sync() external; 93 | 94 | function initialize(address, address) external; 95 | } 96 | -------------------------------------------------------------------------------- /test/BakerySwapBEP20.spec.ts: -------------------------------------------------------------------------------- 1 | import chai, {expect} from 'chai' 2 | import {Contract} from 'ethers' 3 | import {MaxUint256} from 'ethers/constants' 4 | import {bigNumberify, hexlify, keccak256, defaultAbiCoder, toUtf8Bytes} from 'ethers/utils' 5 | import {solidity, MockProvider, deployContract} from 'ethereum-waffle' 6 | import {ecsign} from 'ethereumjs-util' 7 | import {hexToAscii} from 'web3-utils' 8 | 9 | import {expandTo18Decimals, getApprovalDigest} from './shared/utilities' 10 | 11 | import BakerySwapBEP20 from '../build/BakerySwapBEP20.json' 12 | 13 | chai.use(solidity) 14 | 15 | const TEST_AMOUNT = expandTo18Decimals(10) 16 | 17 | describe('BakerySwapBEP20', () => { 18 | const provider = new MockProvider({ 19 | hardfork: 'istanbul', 20 | mnemonic: 'horn horn horn horn horn horn horn horn horn horn horn horn', 21 | gasLimit: 9999999 22 | }) 23 | const [wallet, other] = provider.getWallets() 24 | 25 | let token: Contract 26 | beforeEach(async () => { 27 | token = await deployContract(wallet, BakerySwapBEP20) 28 | }) 29 | 30 | it('name, symbol, decimals, totalSupply, balanceOf, DOMAIN_SEPARATOR, PERMIT_TYPEHASH', async () => { 31 | const name = await token.name() 32 | expect(name).to.eq('Swap') 33 | expect(await token.symbol()).to.eq('SWAP') 34 | expect(await token.decimals()).to.eq(18) 35 | expect(await token.DOMAIN_SEPARATOR()).to.eq( 36 | keccak256( 37 | defaultAbiCoder.encode( 38 | ['bytes32', 'bytes32', 'bytes32', 'uint256', 'address'], 39 | [ 40 | keccak256( 41 | toUtf8Bytes('EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)') 42 | ), 43 | keccak256(toUtf8Bytes(name)), 44 | keccak256(toUtf8Bytes('1')), 45 | 1, 46 | token.address 47 | ] 48 | ) 49 | ) 50 | ) 51 | expect(await token.PERMIT_TYPEHASH()).to.eq( 52 | keccak256(toUtf8Bytes('Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)')) 53 | ) 54 | }) 55 | 56 | it('permit', async () => { 57 | const nonce = await token.nonces(wallet.address) 58 | const deadline = MaxUint256 59 | const digest = await getApprovalDigest( 60 | token, 61 | {owner: wallet.address, spender: other.address, value: TEST_AMOUNT}, 62 | nonce, 63 | deadline 64 | ) 65 | 66 | const {v, r, s} = ecsign(Buffer.from(digest.slice(2), 'hex'), Buffer.from(wallet.privateKey.slice(2), 'hex')) 67 | 68 | await expect(token.permit(wallet.address, other.address, TEST_AMOUNT, deadline, v, hexlify(r), hexlify(s))) 69 | .to.emit(token, 'Approval') 70 | .withArgs(wallet.address, other.address, TEST_AMOUNT) 71 | expect(await token.allowance(wallet.address, other.address)).to.eq(TEST_AMOUNT) 72 | expect(await token.nonces(wallet.address)).to.eq(bigNumberify(1)) 73 | }) 74 | 75 | it('toAscii', async () => { 76 | console.log( 77 | hexToAscii( 78 | '0xeaaed4420000000000000000000000002a9a937fc5540a060fc960ac7ba53916fbad1c0b00000000000000000000000000000000000000000000003635c9adc5dea0000000000000000000000000000000000000000000000000003635c9adc5dea000000000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000337e3cee9c3e892f84c76b0ec2c06fd4ab06a734000000000000000000000000000000000000000000000000000000005f56ec11' 79 | ) 80 | ) 81 | }) 82 | }) 83 | -------------------------------------------------------------------------------- /contracts/BakerySwapBEP20.sol: -------------------------------------------------------------------------------- 1 | pragma solidity =0.5.16; 2 | 3 | import './interfaces/IBakerySwapBEP20.sol'; 4 | import '@BakeryProject/bakery-swap-lib/contracts/math/SafeMath.sol'; 5 | 6 | contract BakerySwapBEP20 is IBakerySwapBEP20 { 7 | using SafeMath for uint256; 8 | 9 | string public constant name = 'Bakery LPs'; 10 | string public constant symbol = 'BLP'; 11 | uint8 public constant decimals = 18; 12 | uint256 public totalSupply; 13 | mapping(address => uint256) public balanceOf; 14 | mapping(address => mapping(address => uint256)) public allowance; 15 | 16 | bytes32 public DOMAIN_SEPARATOR; 17 | // keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); 18 | bytes32 public constant PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9; 19 | mapping(address => uint256) public nonces; 20 | 21 | event Approval(address indexed owner, address indexed spender, uint256 value); 22 | event Transfer(address indexed from, address indexed to, uint256 value); 23 | 24 | constructor() public { 25 | uint256 chainId; 26 | assembly { 27 | chainId := chainid 28 | } 29 | DOMAIN_SEPARATOR = keccak256( 30 | abi.encode( 31 | keccak256('EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)'), 32 | keccak256(bytes(name)), 33 | keccak256(bytes('1')), 34 | chainId, 35 | address(this) 36 | ) 37 | ); 38 | } 39 | 40 | function _mint(address to, uint256 value) internal { 41 | totalSupply = totalSupply.add(value); 42 | balanceOf[to] = balanceOf[to].add(value); 43 | emit Transfer(address(0), to, value); 44 | } 45 | 46 | function _burn(address from, uint256 value) internal { 47 | balanceOf[from] = balanceOf[from].sub(value); 48 | totalSupply = totalSupply.sub(value); 49 | emit Transfer(from, address(0), value); 50 | } 51 | 52 | function _approve( 53 | address owner, 54 | address spender, 55 | uint256 value 56 | ) private { 57 | allowance[owner][spender] = value; 58 | emit Approval(owner, spender, value); 59 | } 60 | 61 | function _transfer( 62 | address from, 63 | address to, 64 | uint256 value 65 | ) private { 66 | balanceOf[from] = balanceOf[from].sub(value); 67 | balanceOf[to] = balanceOf[to].add(value); 68 | emit Transfer(from, to, value); 69 | } 70 | 71 | function approve(address spender, uint256 value) external returns (bool) { 72 | _approve(msg.sender, spender, value); 73 | return true; 74 | } 75 | 76 | function transfer(address to, uint256 value) external returns (bool) { 77 | _transfer(msg.sender, to, value); 78 | return true; 79 | } 80 | 81 | function transferFrom( 82 | address from, 83 | address to, 84 | uint256 value 85 | ) external returns (bool) { 86 | if (allowance[from][msg.sender] != uint256(-1)) { 87 | allowance[from][msg.sender] = allowance[from][msg.sender].sub(value); 88 | } 89 | _transfer(from, to, value); 90 | return true; 91 | } 92 | 93 | function permit( 94 | address owner, 95 | address spender, 96 | uint256 value, 97 | uint256 deadline, 98 | uint8 v, 99 | bytes32 r, 100 | bytes32 s 101 | ) external { 102 | require(deadline >= block.timestamp, 'BakerySwapBEP20: EXPIRED'); 103 | bytes32 digest = keccak256( 104 | abi.encodePacked( 105 | '\x19\x01', 106 | DOMAIN_SEPARATOR, 107 | keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, nonces[owner]++, deadline)) 108 | ) 109 | ); 110 | address recoveredAddress = ecrecover(digest, v, r, s); 111 | require(recoveredAddress != address(0) && recoveredAddress == owner, 'BakerySwapBEP20: INVALID_SIGNATURE'); 112 | _approve(owner, spender, value); 113 | } 114 | } 115 | -------------------------------------------------------------------------------- /contracts/BakerySwapPair.sol: -------------------------------------------------------------------------------- 1 | pragma solidity =0.5.16; 2 | 3 | import './interfaces/IBakerySwapPair.sol'; 4 | import './BakerySwapBEP20.sol'; 5 | import './libraries/UQ112x112.sol'; 6 | import '@BakeryProject/bakery-swap-lib/contracts/token/BEP20/IBEP20.sol'; 7 | import './interfaces/IBakerySwapFactory.sol'; 8 | 9 | contract BakerySwapPair is IBakerySwapPair, BakerySwapBEP20 { 10 | using SafeMath for uint256; 11 | using UQ112x112 for uint224; 12 | 13 | uint256 public constant MINIMUM_LIQUIDITY = 10**3; 14 | bytes4 private constant SELECTOR = bytes4(keccak256(bytes('transfer(address,uint256)'))); 15 | 16 | address public factory; 17 | address public token0; 18 | address public token1; 19 | 20 | uint112 private reserve0; // uses single storage slot, accessible via getReserves 21 | uint112 private reserve1; // uses single storage slot, accessible via getReserves 22 | uint32 private blockTimestampLast; // uses single storage slot, accessible via getReserves 23 | 24 | uint256 public price0CumulativeLast; 25 | uint256 public price1CumulativeLast; 26 | uint256 public kLast; // reserve0 * reserve1, as of immediately after the most recent liquidity event 27 | 28 | uint256 private unlocked = 1; 29 | modifier lock() { 30 | require(unlocked == 1, 'BakerySwapPair: LOCKED'); 31 | unlocked = 0; 32 | _; 33 | unlocked = 1; 34 | } 35 | 36 | function getReserves() 37 | public 38 | view 39 | returns ( 40 | uint112 _reserve0, 41 | uint112 _reserve1, 42 | uint32 _blockTimestampLast 43 | ) 44 | { 45 | _reserve0 = reserve0; 46 | _reserve1 = reserve1; 47 | _blockTimestampLast = blockTimestampLast; 48 | } 49 | 50 | function _safeTransfer( 51 | address token, 52 | address to, 53 | uint256 value 54 | ) private { 55 | (bool success, bytes memory data) = token.call(abi.encodeWithSelector(SELECTOR, to, value)); 56 | require(success && (data.length == 0 || abi.decode(data, (bool))), 'BakerySwapPair: TRANSFER_FAILED'); 57 | } 58 | 59 | event Mint(address indexed sender, uint256 amount0, uint256 amount1); 60 | event Burn(address indexed sender, uint256 amount0, uint256 amount1, address indexed to); 61 | event Swap( 62 | address indexed sender, 63 | uint256 amount0In, 64 | uint256 amount1In, 65 | uint256 amount0Out, 66 | uint256 amount1Out, 67 | address indexed to 68 | ); 69 | event Sync(uint112 reserve0, uint112 reserve1); 70 | 71 | constructor() public { 72 | factory = msg.sender; 73 | } 74 | 75 | // called once by the factory at time of deployment 76 | function initialize(address _token0, address _token1) external { 77 | require(msg.sender == factory, 'BakerySwapPair: FORBIDDEN'); // sufficient check 78 | token0 = _token0; 79 | token1 = _token1; 80 | } 81 | 82 | // update reserves and, on the first call per block, price accumulators 83 | function _update( 84 | uint256 balance0, 85 | uint256 balance1, 86 | uint112 _reserve0, 87 | uint112 _reserve1 88 | ) private { 89 | require(balance0 <= uint112(-1) && balance1 <= uint112(-1), 'BakerySwapPair: OVERFLOW'); 90 | uint32 blockTimestamp = uint32(block.timestamp % 2**32); 91 | uint32 timeElapsed = blockTimestamp - blockTimestampLast; // overflow is desired 92 | if (timeElapsed > 0 && _reserve0 != 0 && _reserve1 != 0) { 93 | // * never overflows, and + overflow is desired 94 | price0CumulativeLast += uint256(UQ112x112.encode(_reserve1).uqdiv(_reserve0)) * timeElapsed; 95 | price1CumulativeLast += uint256(UQ112x112.encode(_reserve0).uqdiv(_reserve1)) * timeElapsed; 96 | } 97 | reserve0 = uint112(balance0); 98 | reserve1 = uint112(balance1); 99 | blockTimestampLast = blockTimestamp; 100 | emit Sync(reserve0, reserve1); 101 | } 102 | 103 | // if fee is on, mint liquidity equivalent to 1/6th of the growth in sqrt(k) 104 | function _mintFee(uint112 _reserve0, uint112 _reserve1) private returns (bool feeOn) { 105 | address feeTo = IBakerySwapFactory(factory).feeTo(); 106 | feeOn = feeTo != address(0); 107 | uint256 _kLast = kLast; // gas savings 108 | if (feeOn) { 109 | if (_kLast != 0) { 110 | uint256 rootK = SafeMath.sqrt(uint256(_reserve0).mul(_reserve1)); 111 | uint256 rootKLast = SafeMath.sqrt(_kLast); 112 | if (rootK > rootKLast) { 113 | uint256 numerator = totalSupply.mul(rootK.sub(rootKLast)); 114 | uint256 denominator = rootK.mul(5).add(rootKLast); 115 | uint256 liquidity = numerator / denominator; 116 | if (liquidity > 0) _mint(feeTo, liquidity); 117 | } 118 | } 119 | } else if (_kLast != 0) { 120 | kLast = 0; 121 | } 122 | } 123 | 124 | // this low-level function should be called from a contract which performs important safety checks 125 | function mint(address to) external lock returns (uint256 liquidity) { 126 | (uint112 _reserve0, uint112 _reserve1, ) = getReserves(); // gas savings 127 | uint256 balance0 = IBEP20(token0).balanceOf(address(this)); 128 | uint256 balance1 = IBEP20(token1).balanceOf(address(this)); 129 | uint256 amount0 = balance0.sub(_reserve0); 130 | uint256 amount1 = balance1.sub(_reserve1); 131 | 132 | bool feeOn = _mintFee(_reserve0, _reserve1); 133 | uint256 _totalSupply = totalSupply; // gas savings, must be defined here since totalSupply can update in _mintFee 134 | if (_totalSupply == 0) { 135 | liquidity = SafeMath.sqrt(amount0.mul(amount1)).sub(MINIMUM_LIQUIDITY); 136 | _mint(address(0), MINIMUM_LIQUIDITY); // permanently lock the first MINIMUM_LIQUIDITY tokens 137 | } else { 138 | liquidity = SafeMath.min(amount0.mul(_totalSupply) / _reserve0, amount1.mul(_totalSupply) / _reserve1); 139 | } 140 | require(liquidity > 0, 'BakerySwapPair: INSUFFICIENT_LIQUIDITY_MINTED'); 141 | _mint(to, liquidity); 142 | 143 | _update(balance0, balance1, _reserve0, _reserve1); 144 | if (feeOn) kLast = uint256(reserve0).mul(reserve1); // reserve0 and reserve1 are up-to-date 145 | emit Mint(msg.sender, amount0, amount1); 146 | } 147 | 148 | // this low-level function should be called from a contract which performs important safety checks 149 | function burn(address to) external lock returns (uint256 amount0, uint256 amount1) { 150 | (uint112 _reserve0, uint112 _reserve1, ) = getReserves(); // gas savings 151 | address _token0 = token0; // gas savings 152 | address _token1 = token1; // gas savings 153 | uint256 balance0 = IBEP20(_token0).balanceOf(address(this)); 154 | uint256 balance1 = IBEP20(_token1).balanceOf(address(this)); 155 | uint256 liquidity = balanceOf[address(this)]; 156 | 157 | bool feeOn = _mintFee(_reserve0, _reserve1); 158 | uint256 _totalSupply = totalSupply; // gas savings, must be defined here since totalSupply can update in _mintFee 159 | amount0 = liquidity.mul(balance0) / _totalSupply; // using balances ensures pro-rata distribution 160 | amount1 = liquidity.mul(balance1) / _totalSupply; // using balances ensures pro-rata distribution 161 | require(amount0 > 0 && amount1 > 0, 'BakerySwapPair: INSUFFICIENT_LIQUIDITY_BURNED'); 162 | _burn(address(this), liquidity); 163 | _safeTransfer(_token0, to, amount0); 164 | _safeTransfer(_token1, to, amount1); 165 | balance0 = IBEP20(_token0).balanceOf(address(this)); 166 | balance1 = IBEP20(_token1).balanceOf(address(this)); 167 | 168 | _update(balance0, balance1, _reserve0, _reserve1); 169 | if (feeOn) kLast = uint256(reserve0).mul(reserve1); // reserve0 and reserve1 are up-to-date 170 | emit Burn(msg.sender, amount0, amount1, to); 171 | } 172 | 173 | // this low-level function should be called from a contract which performs important safety checks 174 | function swap( 175 | uint256 amount0Out, 176 | uint256 amount1Out, 177 | address to 178 | ) external lock { 179 | require(amount0Out > 0 || amount1Out > 0, 'BakerySwapPair: INSUFFICIENT_OUTPUT_AMOUNT'); 180 | (uint112 _reserve0, uint112 _reserve1, ) = getReserves(); // gas savings 181 | require(amount0Out < _reserve0 && amount1Out < _reserve1, 'BakerySwapPair: INSUFFICIENT_LIQUIDITY'); 182 | 183 | uint256 balance0; 184 | uint256 balance1; 185 | { 186 | // scope for _token{0,1}, avoids stack too deep errors 187 | address _token0 = token0; 188 | address _token1 = token1; 189 | require(to != _token0 && to != _token1, 'BakerySwapPair: INVALID_TO'); 190 | if (amount0Out > 0) _safeTransfer(_token0, to, amount0Out); // optimistically transfer tokens 191 | if (amount1Out > 0) _safeTransfer(_token1, to, amount1Out); // optimistically transfer tokens 192 | balance0 = IBEP20(_token0).balanceOf(address(this)); 193 | balance1 = IBEP20(_token1).balanceOf(address(this)); 194 | } 195 | uint256 amount0In = balance0 > _reserve0 - amount0Out ? balance0 - (_reserve0 - amount0Out) : 0; 196 | uint256 amount1In = balance1 > _reserve1 - amount1Out ? balance1 - (_reserve1 - amount1Out) : 0; 197 | require(amount0In > 0 || amount1In > 0, 'BakerySwapPair: INSUFFICIENT_INPUT_AMOUNT'); 198 | { 199 | // scope for reserve{0,1}Adjusted, avoids stack too deep errors 200 | uint256 balance0Adjusted = balance0.mul(1000).sub(amount0In.mul(3)); 201 | uint256 balance1Adjusted = balance1.mul(1000).sub(amount1In.mul(3)); 202 | require( 203 | balance0Adjusted.mul(balance1Adjusted) >= uint256(_reserve0).mul(_reserve1).mul(1000**2), 204 | 'BakerySwapPair: K' 205 | ); 206 | } 207 | 208 | _update(balance0, balance1, _reserve0, _reserve1); 209 | emit Swap(msg.sender, amount0In, amount1In, amount0Out, amount1Out, to); 210 | } 211 | 212 | // force balances to match reserves 213 | function skim(address to) external lock { 214 | address _token0 = token0; // gas savings 215 | address _token1 = token1; // gas savings 216 | _safeTransfer(_token0, to, IBEP20(_token0).balanceOf(address(this)).sub(reserve0)); 217 | _safeTransfer(_token1, to, IBEP20(_token1).balanceOf(address(this)).sub(reserve1)); 218 | } 219 | 220 | // force reserves to match balances 221 | function sync() external lock { 222 | _update(IBEP20(token0).balanceOf(address(this)), IBEP20(token1).balanceOf(address(this)), reserve0, reserve1); 223 | } 224 | } 225 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------