├── .prettierrc ├── .husky ├── pre-commit └── commit-msg ├── cache └── solidity-files-cache.json ├── .eslintrc ├── .github ├── dependabot.yml ├── CODEOWNERS └── workflows │ ├── lint.yml │ └── format.yml ├── .commitlintrc.json ├── utils ├── logger.ts └── index.ts ├── hardhat.config.ts ├── config.ts ├── package.json ├── .gitignore ├── scripts ├── draw-lottery.ts ├── close-lottery.ts └── start-lottery.ts ├── README.md ├── abi ├── RandomNumberGenerator.json └── PancakeSwapLottery.json ├── tsconfig.json └── LICENSE /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "printWidth": 120 3 | } -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | yarn format:check -------------------------------------------------------------------------------- /.husky/commit-msg: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | yarn commitlint --edit $1 -------------------------------------------------------------------------------- /cache/solidity-files-cache.json: -------------------------------------------------------------------------------- 1 | { 2 | "_format": "hh-sol-cache-2", 3 | "files": {} 4 | } 5 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "parser": "@typescript-eslint/parser", 3 | "plugins": [ 4 | "@typescript-eslint" 5 | ], 6 | "extends": [ 7 | "plugin:@typescript-eslint/recommended", 8 | "prettier" 9 | ] 10 | } -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | 3 | updates: 4 | # Maintain dependencies for GitHub Actions 5 | - package-ecosystem: "github-actions" 6 | directory: "/" 7 | schedule: 8 | interval: "monthly" 9 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # These owners will be the default owners for everything in 2 | # the repo. Unless a later match takes precedence, 3 | # @global-owner1 and @global-owner2 will be requested for 4 | # review when someone opens a pull request. 5 | * @ChefNyan @ChefKai 6 | -------------------------------------------------------------------------------- /.commitlintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["@commitlint/config-conventional"], 3 | "rules": { 4 | "subject-case": [2, "always", "sentence-case"], 5 | "type-enum": [ 6 | 2, 7 | "always", 8 | ["build", "ci", "chore", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test"] 9 | ] 10 | } 11 | } -------------------------------------------------------------------------------- /utils/logger.ts: -------------------------------------------------------------------------------- 1 | import winston from "winston"; 2 | import "winston-daily-rotate-file"; 3 | 4 | const transport = new winston.transports.DailyRotateFile({ 5 | dirname: "logs", 6 | filename: "lottery-%DATE%.log", 7 | datePattern: "YYYY-MM-DD", 8 | zippedArchive: true, 9 | }); 10 | 11 | const logger = winston.createLogger({ 12 | transports: [transport], 13 | }); 14 | 15 | export default logger; 16 | -------------------------------------------------------------------------------- /hardhat.config.ts: -------------------------------------------------------------------------------- 1 | import type { HardhatUserConfig } from "hardhat/types"; 2 | import { task } from "hardhat/config"; 3 | import "@nomiclabs/hardhat-ethers"; 4 | 5 | task("accounts", "Prints the list of accounts", async (args, { ethers }) => { 6 | const [operator] = await ethers.getSigners(); 7 | 8 | console.log(`Operator address: ${operator.address}`); 9 | }); 10 | 11 | const config: HardhatUserConfig = { 12 | solidity: "0.8.4", 13 | defaultNetwork: "testnet", 14 | networks: { 15 | testnet: { 16 | url: "https://data-seed-prebsc-1-s1.binance.org:8545/", 17 | chainId: 97, 18 | accounts: [process.env.OPERATOR_PRIVATE_KEY!], 19 | }, 20 | mainnet: { 21 | url: "https://bsc-dataseed.binance.org/", 22 | chainId: 56, 23 | accounts: [process.env.OPERATOR_PRIVATE_KEY!], 24 | }, 25 | }, 26 | }; 27 | 28 | export default config; 29 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: Lint 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - master 9 | 10 | jobs: 11 | lint: 12 | name: ESLint 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout code 17 | uses: actions/checkout@v2 18 | 19 | - name: Setup Node 20 | uses: actions/setup-node@v2 21 | with: 22 | node-version: 14.x 23 | 24 | - name: Get yarn cache directory path 25 | id: yarn-cache-dir-path 26 | run: echo "::set-output name=dir::$(yarn cache dir)" 27 | 28 | - uses: actions/cache@v2 29 | id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) 30 | with: 31 | path: ${{ steps.yarn-cache-dir-path.outputs.dir }} 32 | key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} 33 | restore-keys: | 34 | ${{ runner.os }}-yarn- 35 | 36 | - name: Install dependencies 37 | run: yarn install --frozen-lockfile 38 | 39 | - name: Run ESLint 40 | run: yarn lint 41 | -------------------------------------------------------------------------------- /.github/workflows/format.yml: -------------------------------------------------------------------------------- 1 | name: Format 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - master 9 | 10 | jobs: 11 | format: 12 | name: Prettier 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout code 17 | uses: actions/checkout@v2 18 | 19 | - name: Setup Node 20 | uses: actions/setup-node@v2 21 | with: 22 | node-version: 14.x 23 | 24 | - name: Get yarn cache directory path 25 | id: yarn-cache-dir-path 26 | run: echo "::set-output name=dir::$(yarn cache dir)" 27 | 28 | - uses: actions/cache@v2 29 | id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) 30 | with: 31 | path: ${{ steps.yarn-cache-dir-path.outputs.dir }} 32 | key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} 33 | restore-keys: | 34 | ${{ runner.os }}-yarn- 35 | 36 | - name: Install dependencies 37 | run: yarn install --frozen-lockfile 38 | 39 | - name: Run Prettier 40 | run: yarn format:check 41 | -------------------------------------------------------------------------------- /config.ts: -------------------------------------------------------------------------------- 1 | export default { 2 | Lottery: { 3 | mainnet: "0x5aF6D33DE2ccEC94efb1bDF8f92Bd58085432d2c", 4 | testnet: "0x5790c3534F30437641541a0FA04C992799602998", 5 | }, 6 | Chainlink: { 7 | Oracle: { 8 | // Documentation: https://docs.chain.link/docs/binance-smart-chain-addresses/ 9 | mainnet: "0xB6064eD41d4f67e353768aA239cA86f4F73665a1", 10 | testnet: "0x81faeDDfeBc2F8Ac524327d70Cf913001732224C", 11 | }, 12 | VRF: { 13 | // Documentation: https://docs.chain.link/docs/vrf-contracts/ 14 | KeyHash: { 15 | mainnet: "0xc251acd21ec4fb7f31bb8868288bfdbaeb4fbfec2df3735ddbd4f7dc8d60103c", 16 | testnet: "0xcaf3c3727e033261d383b315559476f48034c13b18f8cafed4d871abe5049186", 17 | }, 18 | }, 19 | }, 20 | Ticket: { 21 | Price: { 22 | mainnet: 5, 23 | testnet: 1, 24 | }, 25 | Precision: { 26 | mainnet: 2, 27 | testnet: 2, 28 | }, 29 | }, 30 | Discount: { 31 | mainnet: 2000, 32 | testnet: 2000, 33 | }, 34 | Rewards: { 35 | mainnet: [250, 375, 625, 1250, 2500, 5000], 36 | testnet: [250, 375, 625, 1250, 2500, 5000], 37 | }, 38 | Treasury: { 39 | mainnet: 2000, 40 | testnet: 2000, 41 | }, 42 | }; 43 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pancake-lottery-scheduler", 3 | "version": "1.0.0", 4 | "private": true, 5 | "scripts": { 6 | "execute:start:testnet": "npx hardhat run --network testnet scripts/start-lottery.ts", 7 | "execute:start:mainnet": "npx hardhat run --network mainnet scripts/start-lottery.ts", 8 | "execute:close:testnet": "npx hardhat run --network testnet scripts/close-lottery.ts", 9 | "execute:close:mainnet": "npx hardhat run --network mainnet scripts/close-lottery.ts", 10 | "execute:draw:testnet": "npx hardhat run --network testnet scripts/draw-lottery.ts", 11 | "execute:draw:mainnet": "npx hardhat run --network mainnet scripts/draw-lottery.ts", 12 | "format:check": "prettier --check '*/**/*.{js,ts}'", 13 | "format:write": "prettier --write '*/**/*.{js,ts}'", 14 | "lint": "eslint '*/**/*.{js,ts}'", 15 | "prepare": "husky install" 16 | }, 17 | "dependencies": { 18 | "@chainlink/contracts": "^0.2.0", 19 | "bignumber.js": "^9.0.0", 20 | "moment": "^2.29.0", 21 | "winston": "^3.3.0", 22 | "winston-daily-rotate-file": "^4.5.0" 23 | }, 24 | "devDependencies": { 25 | "@commitlint/cli": "^13.1.0", 26 | "@commitlint/config-conventional": "^13.1.0", 27 | "@nomiclabs/hardhat-ethers": "^2.0.2", 28 | "@types/node": "^15.12.5", 29 | "@typescript-eslint/eslint-plugin": "^4.28.0", 30 | "@typescript-eslint/parser": "^4.28.0", 31 | "eslint": "^7.29.0", 32 | "eslint-config-prettier": "^8.3.0", 33 | "ethers": "^5.4.0", 34 | "hardhat": "^2.5.0", 35 | "husky": "^7.0.0", 36 | "prettier": "^2.3.2", 37 | "ts-node": "^10.0.0", 38 | "typescript": "^4.3.5" 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Vercel build output 79 | .vercel 80 | 81 | # Next.js build output 82 | .next 83 | 84 | # Nuxt.js build / generate output 85 | .nuxt 86 | dist 87 | 88 | # Gatsby files 89 | .cache/ 90 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 91 | # https://nextjs.org/blog/next-9-1#public-directory-support 92 | # public 93 | 94 | # vuepress build output 95 | .vuepress/dist 96 | 97 | # Serverless directories 98 | .serverless/ 99 | 100 | # FuseBox cache 101 | .fusebox/ 102 | 103 | # DynamoDB Local files 104 | .dynamodb/ 105 | 106 | # TernJS port file 107 | .tern-port 108 | 109 | # MacOS 110 | .DS_Store 111 | 112 | # IDE's 113 | .vscode/ 114 | .idea/ 115 | -------------------------------------------------------------------------------- /scripts/draw-lottery.ts: -------------------------------------------------------------------------------- 1 | import { ethers, network } from "hardhat"; 2 | import lotteryABI from "../abi/PancakeSwapLottery.json"; 3 | import config from "../config"; 4 | import logger from "../utils/logger"; 5 | import { isTimeToRun } from "../utils"; 6 | 7 | /** 8 | * Draw lottery. 9 | */ 10 | const main = async () => { 11 | // Get network data from Hardhat config (see hardhat.config.ts). 12 | const networkName = network.name; 13 | 14 | // Get signer to sign the transaction(s). 15 | const [operator] = await ethers.getSigners(); 16 | 17 | // Check if the network is supported. 18 | if (networkName === "testnet" || networkName === "mainnet") { 19 | const timeToRun = await isTimeToRun(networkName); 20 | if (timeToRun) { 21 | // Check if the PancakeSwap Lottery smart contract address is set. 22 | if (config.Lottery[networkName] === ethers.constants.AddressZero) { 23 | throw new Error("Missing smart contract (Lottery) address."); 24 | } 25 | 26 | try { 27 | // Bind the smart contract address to the ABI, for a given network. 28 | const contract = await ethers.getContractAt(lotteryABI, config.Lottery[networkName]); 29 | 30 | // Get network data for running script. 31 | const [_blockNumber, _gasPrice, _lotteryId] = await Promise.all([ 32 | ethers.provider.getBlockNumber(), 33 | ethers.provider.getGasPrice(), 34 | contract.currentLotteryId(), 35 | ]); 36 | 37 | // Create, sign and broadcast transaction. 38 | const tx = await contract.drawFinalNumberAndMakeLotteryClaimable(_lotteryId, true, { 39 | from: operator.address, 40 | gasLimit: 500000, 41 | gasPrice: _gasPrice.mul(2), 42 | }); 43 | 44 | const message = `[${new Date().toISOString()}] network=${networkName} block=${_blockNumber} message='Drawed lottery #${_lotteryId}' hash=${ 45 | tx?.hash 46 | } signer=${operator.address}`; 47 | console.log(message); 48 | logger.info({ message }); 49 | } catch (error) { 50 | const message = `[${new Date().toISOString()}] network=${networkName} message='${error.message}' signer=${ 51 | operator.address 52 | }`; 53 | console.error(message); 54 | logger.error({ message }); 55 | } 56 | } 57 | } else { 58 | const message = `[${new Date().toISOString()}] network=${networkName} message='Unsupported network' signer=${ 59 | operator.address 60 | }`; 61 | console.error(message); 62 | logger.error({ message }); 63 | } 64 | }; 65 | 66 | main().catch((error) => { 67 | console.error(error); 68 | process.exit(1); 69 | }); 70 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Pancake Lottery Scheduler 2 | 3 | ### Description 4 | 5 | The scheduler is composed of multiple scripts used to call `startLottery`, `closeLottery`, and `drawFinalNumberAndMakeLotteryClaimable` functions, trigger events; and monitor lottery results. 6 | 7 | ### Configuration 8 | 9 | - `Lottery` Address of [PancakeSwapLottery](https://github.com/pancakeswap/pancake-contracts/tree/master/projects/lottery) contract. 10 | - `Ticket` Ticket Price (denominated in USD) and Precision. 11 | - `Discount` Divisor to compute discount magnitude for bulk ticket purchase. 12 | - `Rewards` Reward breakdown per bracket (total must be equal to 10,000). 13 | - `Treasury` Fee (denominated as percentage) to 2 decimals (e.g. 100 => 1%). 14 | 15 | > Configuration can be overwritten by editing [config.ts](config.ts) file. 16 | 17 | ### Deployment 18 | 19 | ```shell script 20 | # Export operator private key to be used on Hardhat Network Config. 21 | $ export OPERATOR_PRIVATE_KEY=OPERATOR_PRIVATE_KEY 22 | 23 | $ yarn execute:[command]:[network] 24 | ``` 25 | 26 | #### Command(s) 27 | 28 | - `start` Start a new lottery; for a given network. 29 | - `close` Close a lottery, based on `currentLotteryId`; for a given network. 30 | - `draw` Draw winning numbers, based on `currentLotteryId`; for a given network. 31 | 32 | #### Network(s) 33 | 34 | - `mainnet` ChainId `56` ([documentation](https://docs.binance.org/smart-chain/developer/rpc.html#mainnetchainid-0x38-56-in-decimal)) 35 | 36 | - `testnet` ChainId `97` ([documentation](https://docs.binance.org/smart-chain/developer/rpc.html#testnetchainid-0x61-97-in-decimal)) 37 | 38 | #### Execution 39 | 40 | ```shell script 41 | # Close lottery. 42 | 0 0,12 * * * cd ~/pancake-lottery-scheduler && yarn execute:close:mainnet 43 | 44 | # Draw lottery. 45 | 3 0,12 * * * cd ~/pancake-lottery-scheduler && yarn execute:draw:mainnet 46 | 47 | # Start lottery. 48 | 5 0,12 * * * cd ~/pancake-lottery-scheduler && yarn execute:start:mainnet 49 | ``` 50 | 51 | ### Logging 52 | 53 | Logs will be generated at `logs/lottery-YYYY-MM-DD.log` and will be archived (.gz) with a daily rotation. 54 | 55 | Examples of success logs: 56 | 57 | ```log 58 | {"message":"[1970-01-01T06:05:00.000Z] network=testnet block=10000000 message='Started lottery' hash=0x... signer=0x...","level":"info"} 59 | {"message":"[1970-01-01T18:00:00.000Z] network=testnet block=10010010 message='Closed lottery #123' hash=0x... signer=0x...","level":"info"} 60 | {"message":"[1970-01-01T18:03:00.000Z] network=testnet block=10100100 message='Drawed lottery #123' hash=0x... signer=0x...","level":"info"} 61 | {"message":"[1970-01-01T18:05:00.000Z] network=testnet block=11001000 message='Started lottery' hash=0x... signer=0x...","level":"info"} 62 | ``` 63 | 64 | Examples of error logs: 65 | 66 | ```log 67 | {"message":"[1970-01-01T00:00:00.000Z] network=testnet message='Unsupported network' signer=0x...","level":"error"} 68 | {"message":"[1970-01-01T12:00:00.000Z] network=testnet message='Invalid JSON RPC response' signer=0x...","level":"error"} 69 | {"message":"[1970-01-02T00:00:00.000Z] network=testnet message='Invalid keyHash on RandomGenerator contract' signer=0x...","level":"error"} 70 | ``` 71 | -------------------------------------------------------------------------------- /scripts/close-lottery.ts: -------------------------------------------------------------------------------- 1 | import { ethers, network } from "hardhat"; 2 | import lotteryABI from "../abi/PancakeSwapLottery.json"; 3 | import randomGeneratorABI from "../abi/RandomNumberGenerator.json"; 4 | import config from "../config"; 5 | import logger from "../utils/logger"; 6 | import { isTimeToRun } from "../utils"; 7 | 8 | /** 9 | * Close lottery. 10 | */ 11 | const main = async () => { 12 | // Get network data from Hardhat config (see hardhat.config.ts). 13 | const networkName = network.name; 14 | 15 | // Get signer to sign the transaction(s). 16 | const [operator] = await ethers.getSigners(); 17 | 18 | // Check if the network is supported. 19 | if (networkName === "testnet" || networkName === "mainnet") { 20 | const timeToRun = await isTimeToRun(networkName); 21 | if (timeToRun) { 22 | // Check if the PancakeSwap Lottery smart contract address is set. 23 | if (config.Lottery[networkName] === ethers.constants.AddressZero) { 24 | throw new Error("Missing smart contract (Lottery) address."); 25 | } 26 | 27 | try { 28 | // Bind the smart contract address to the ABI, for a given network. 29 | const contract = await ethers.getContractAt(lotteryABI, config.Lottery[networkName]); 30 | 31 | // Get network data for running script. 32 | const [_blockNumber, _gasPrice, _lotteryId, _randomGenerator] = await Promise.all([ 33 | ethers.provider.getBlockNumber(), 34 | ethers.provider.getGasPrice(), 35 | contract.currentLotteryId(), 36 | contract.randomGenerator(), 37 | ]); 38 | 39 | // Verify Chainlink VRF Key Hash is set and correct, according to Chainlink documentation, for a given network. 40 | const randomGeneratorContract = await ethers.getContractAt(randomGeneratorABI, _randomGenerator); 41 | const keyHash = await randomGeneratorContract.keyHash(); 42 | if (keyHash !== config.Chainlink.VRF.KeyHash[networkName]) { 43 | throw new Error("Invalid keyHash on RandomGenerator contract."); 44 | } 45 | 46 | // Create, sign and broadcast transaction. 47 | const tx = await contract.closeLottery(_lotteryId, { 48 | from: operator.address, 49 | gasLimit: 500000, 50 | gasPrice: _gasPrice.mul(2), 51 | }); 52 | 53 | const message = `[${new Date().toISOString()}] network=${networkName} block=${_blockNumber} message='Closed lottery #${_lotteryId}' hash=${ 54 | tx?.hash 55 | } signer=${operator.address}`; 56 | console.log(message); 57 | logger.info({ message }); 58 | } catch (error) { 59 | const message = `[${new Date().toISOString()}] network=${networkName} message='${error.message}' signer=${ 60 | operator.address 61 | }`; 62 | console.error(message); 63 | logger.error({ message }); 64 | } 65 | } 66 | } else { 67 | const message = `[${new Date().toISOString()}] network=${networkName} message='Unsupported network' signer=${ 68 | operator.address 69 | }`; 70 | console.error(message); 71 | logger.error({ message }); 72 | } 73 | }; 74 | 75 | main().catch((error) => { 76 | console.error(error); 77 | process.exit(1); 78 | }); 79 | -------------------------------------------------------------------------------- /scripts/start-lottery.ts: -------------------------------------------------------------------------------- 1 | import { parseUnits } from "@ethersproject/units"; 2 | import { ethers, network } from "hardhat"; 3 | import lotteryABI from "../abi/PancakeSwapLottery.json"; 4 | import config from "../config"; 5 | import { isTimeToRun, getEndTime, getTicketPrice } from "../utils"; 6 | import logger from "../utils/logger"; 7 | 8 | /** 9 | * Start lottery. 10 | */ 11 | const main = async () => { 12 | // Get network data from Hardhat config (see hardhat.config.ts). 13 | const networkName = network.name; 14 | 15 | // Get signer to sign the transaction(s). 16 | const [operator] = await ethers.getSigners(); 17 | 18 | // Check if the network is supported. 19 | if (networkName === "testnet" || networkName === "mainnet") { 20 | const timeToRun = await isTimeToRun(networkName); 21 | if (timeToRun) { 22 | // Check if the PancakeSwap Lottery / Chainlink Oracle smart contract addresses are set. 23 | if ( 24 | config.Lottery[networkName] === ethers.constants.AddressZero || 25 | config.Chainlink.Oracle[networkName] === ethers.constants.AddressZero 26 | ) { 27 | throw new Error("Missing smart contract (Lottery / Chainlink Oracle) addresses."); 28 | } 29 | 30 | try { 31 | // Bind the smart contract address to the ABI, for a given network. 32 | const contract = await ethers.getContractAt(lotteryABI, config.Lottery[networkName]); 33 | 34 | // Get network data for running script. 35 | const [_blockNumber, _gasPrice] = await Promise.all([ 36 | ethers.provider.getBlockNumber(), 37 | ethers.provider.getGasPrice(), 38 | ]); 39 | 40 | // Get ticket price (denominated in $Cake), for a given network. 41 | const ticketPrice: string = await getTicketPrice( 42 | networkName, 43 | config.Ticket.Price[networkName], 44 | config.Ticket.Precision[networkName] 45 | ); 46 | 47 | // Create, sign and broadcast transaction. 48 | const tx = await contract.startLottery( 49 | getEndTime(), 50 | parseUnits(ticketPrice, "ether"), 51 | config.Discount[networkName], 52 | config.Rewards[networkName], 53 | config.Treasury[networkName], 54 | { from: operator.address, gasLimit: 500000, gasPrice: _gasPrice.mul(2) } 55 | ); 56 | 57 | const message = `[${new Date().toISOString()}] network=${networkName} block=${_blockNumber} message='Started lottery' hash=${ 58 | tx?.hash 59 | } signer=${operator.address}`; 60 | console.log(message); 61 | logger.info({ message }); 62 | } catch (error) { 63 | const message = `[${new Date().toISOString()}] network=${networkName} message='${error.message}' signer=${ 64 | operator.address 65 | }`; 66 | console.error(message); 67 | logger.error({ message }); 68 | } 69 | } 70 | } else { 71 | const message = `[${new Date().toISOString()}] network=${networkName} message='Unsupported network' signer=${ 72 | operator.address 73 | }`; 74 | console.error(message); 75 | logger.error({ message }); 76 | } 77 | }; 78 | 79 | main().catch((error) => { 80 | console.error(error); 81 | process.exit(1); 82 | }); 83 | -------------------------------------------------------------------------------- /utils/index.ts: -------------------------------------------------------------------------------- 1 | import AggregatorV3InterfaceABI from "@chainlink/contracts/abi/v0.8/AggregatorV3Interface.json"; 2 | import BigNumber from "bignumber.js"; 3 | import { ethers } from "hardhat"; 4 | import moment from "moment"; 5 | import config from "../config"; 6 | import lotteryABI from "../abi/PancakeSwapLottery.json"; 7 | 8 | /** 9 | * Get the ticket price, based on current network, as $Cake. 10 | * Used by 'start-lottery' Hardhat script, only. 11 | */ 12 | export const getTicketPrice = async ( 13 | networkName: "testnet" | "mainnet", 14 | usd: number, 15 | precision: number 16 | ): Promise => { 17 | // Bind the smart contract address to the Chainlink AggregatorV3Interface ABI, for the given network. 18 | const contract = await ethers.getContractAt(AggregatorV3InterfaceABI, config.Chainlink.Oracle[networkName]); 19 | 20 | // Get the answer from the latest round data. 21 | const [, answer] = await contract.latestRoundData(); 22 | 23 | // Format the answer to a fixed point number, as per Oracle's decimals. 24 | // Note: We output answer BN.js to string to avoid playing with multiple types/implementations. 25 | const price: BigNumber = new BigNumber(answer.toString()).div(1e8); 26 | 27 | // Compute the ticket price (denominated in $Cake), to the required USD eq. value. 28 | const ticketPrice: BigNumber = new BigNumber(usd).div(price); 29 | 30 | // Return the ticket price, up to `n` decimals. 31 | return ticketPrice.toFixed(precision); 32 | }; 33 | 34 | /** 35 | * Get the next lottery 'endTime', based on current date, as UTC. 36 | * Used by 'start-lottery' Hardhat script, only. 37 | */ 38 | export const getEndTime = (): number => { 39 | // Get current date, as UTC. 40 | const now = moment().utc(); 41 | 42 | // Get meridiem (AM/PM), based on current UTC Date. 43 | const meridiem = now.format("A"); 44 | if (meridiem === "AM") { 45 | // We are in the morning (ante-meridiem), next lottery is at 12:00 PM (noon). 46 | return moment(`${now.format("MM DD YYYY")} 00:00:00 +0000`, "MM DD YYYY HH:mm:ss Z", true) 47 | .add(36, "hours") 48 | .startOf("hour") 49 | .utc() 50 | .unix(); 51 | } else if (meridiem === "PM") { 52 | // We are in the afternoon (post-meridiem), next lottery is at 12:00 AM (midnight). 53 | return moment(`${now.format("MM DD YYYY")} 12:00:00 +0000`, "MM DD YYYY HH:mm:ss Z", true) 54 | .add(12, "hours") 55 | .startOf("hour") 56 | .utc() 57 | .unix(); 58 | } 59 | 60 | throw new Error("Could not determine next Lottery end time."); 61 | }; 62 | 63 | export const isTimeToRun = async (networkName: "testnet" | "mainnet"): Promise => { 64 | let attempt = 1; 65 | let error; 66 | let isTime = true; 67 | while (attempt < 6) { 68 | try { 69 | // Bind the smart contract address to the ABI, for a given network. 70 | const contract = await ethers.getContractAt(lotteryABI, config.Lottery[networkName]); 71 | 72 | // Get network data for running script. 73 | const lotteryId = await contract.currentLotteryId(); 74 | 75 | const tx = await contract.viewLottery(lotteryId); 76 | isTime = moment.unix(tx.endTime).diff(moment.unix(moment().utc().unix()), "hours") <= 0; 77 | console.log(attempt); 78 | break; 79 | } catch (e) { 80 | error = e; 81 | } 82 | attempt++; 83 | } 84 | if (error && attempt >= 5) { 85 | console.log(error); 86 | } 87 | 88 | return isTime; 89 | }; 90 | -------------------------------------------------------------------------------- /abi/RandomNumberGenerator.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "inputs": [ 4 | { 5 | "internalType": "address", 6 | "name": "_vrfCoordinator", 7 | "type": "address" 8 | }, 9 | { 10 | "internalType": "address", 11 | "name": "_linkToken", 12 | "type": "address" 13 | } 14 | ], 15 | "stateMutability": "nonpayable", 16 | "type": "constructor" 17 | }, 18 | { 19 | "anonymous": false, 20 | "inputs": [ 21 | { 22 | "indexed": true, 23 | "internalType": "address", 24 | "name": "previousOwner", 25 | "type": "address" 26 | }, 27 | { 28 | "indexed": true, 29 | "internalType": "address", 30 | "name": "newOwner", 31 | "type": "address" 32 | } 33 | ], 34 | "name": "OwnershipTransferred", 35 | "type": "event" 36 | }, 37 | { 38 | "inputs": [], 39 | "name": "fee", 40 | "outputs": [ 41 | { 42 | "internalType": "uint256", 43 | "name": "", 44 | "type": "uint256" 45 | } 46 | ], 47 | "stateMutability": "view", 48 | "type": "function" 49 | }, 50 | { 51 | "inputs": [ 52 | { 53 | "internalType": "uint256", 54 | "name": "_seed", 55 | "type": "uint256" 56 | } 57 | ], 58 | "name": "getRandomNumber", 59 | "outputs": [], 60 | "stateMutability": "nonpayable", 61 | "type": "function" 62 | }, 63 | { 64 | "inputs": [], 65 | "name": "keyHash", 66 | "outputs": [ 67 | { 68 | "internalType": "bytes32", 69 | "name": "", 70 | "type": "bytes32" 71 | } 72 | ], 73 | "stateMutability": "view", 74 | "type": "function" 75 | }, 76 | { 77 | "inputs": [], 78 | "name": "latestLotteryId", 79 | "outputs": [ 80 | { 81 | "internalType": "uint256", 82 | "name": "", 83 | "type": "uint256" 84 | } 85 | ], 86 | "stateMutability": "view", 87 | "type": "function" 88 | }, 89 | { 90 | "inputs": [], 91 | "name": "latestRequestId", 92 | "outputs": [ 93 | { 94 | "internalType": "bytes32", 95 | "name": "", 96 | "type": "bytes32" 97 | } 98 | ], 99 | "stateMutability": "view", 100 | "type": "function" 101 | }, 102 | { 103 | "inputs": [], 104 | "name": "owner", 105 | "outputs": [ 106 | { 107 | "internalType": "address", 108 | "name": "", 109 | "type": "address" 110 | } 111 | ], 112 | "stateMutability": "view", 113 | "type": "function" 114 | }, 115 | { 116 | "inputs": [], 117 | "name": "pancakeSwapLottery", 118 | "outputs": [ 119 | { 120 | "internalType": "address", 121 | "name": "", 122 | "type": "address" 123 | } 124 | ], 125 | "stateMutability": "view", 126 | "type": "function" 127 | }, 128 | { 129 | "inputs": [], 130 | "name": "randomResult", 131 | "outputs": [ 132 | { 133 | "internalType": "uint32", 134 | "name": "", 135 | "type": "uint32" 136 | } 137 | ], 138 | "stateMutability": "view", 139 | "type": "function" 140 | }, 141 | { 142 | "inputs": [ 143 | { 144 | "internalType": "bytes32", 145 | "name": "requestId", 146 | "type": "bytes32" 147 | }, 148 | { 149 | "internalType": "uint256", 150 | "name": "randomness", 151 | "type": "uint256" 152 | } 153 | ], 154 | "name": "rawFulfillRandomness", 155 | "outputs": [], 156 | "stateMutability": "nonpayable", 157 | "type": "function" 158 | }, 159 | { 160 | "inputs": [], 161 | "name": "renounceOwnership", 162 | "outputs": [], 163 | "stateMutability": "nonpayable", 164 | "type": "function" 165 | }, 166 | { 167 | "inputs": [ 168 | { 169 | "internalType": "uint256", 170 | "name": "_fee", 171 | "type": "uint256" 172 | } 173 | ], 174 | "name": "setFee", 175 | "outputs": [], 176 | "stateMutability": "nonpayable", 177 | "type": "function" 178 | }, 179 | { 180 | "inputs": [ 181 | { 182 | "internalType": "bytes32", 183 | "name": "_keyHash", 184 | "type": "bytes32" 185 | } 186 | ], 187 | "name": "setKeyHash", 188 | "outputs": [], 189 | "stateMutability": "nonpayable", 190 | "type": "function" 191 | }, 192 | { 193 | "inputs": [ 194 | { 195 | "internalType": "address", 196 | "name": "_pancakeSwapLottery", 197 | "type": "address" 198 | } 199 | ], 200 | "name": "setLotteryAddress", 201 | "outputs": [], 202 | "stateMutability": "nonpayable", 203 | "type": "function" 204 | }, 205 | { 206 | "inputs": [ 207 | { 208 | "internalType": "address", 209 | "name": "newOwner", 210 | "type": "address" 211 | } 212 | ], 213 | "name": "transferOwnership", 214 | "outputs": [], 215 | "stateMutability": "nonpayable", 216 | "type": "function" 217 | }, 218 | { 219 | "inputs": [], 220 | "name": "viewLatestLotteryId", 221 | "outputs": [ 222 | { 223 | "internalType": "uint256", 224 | "name": "", 225 | "type": "uint256" 226 | } 227 | ], 228 | "stateMutability": "view", 229 | "type": "function" 230 | }, 231 | { 232 | "inputs": [], 233 | "name": "viewRandomResult", 234 | "outputs": [ 235 | { 236 | "internalType": "uint32", 237 | "name": "", 238 | "type": "uint32" 239 | } 240 | ], 241 | "stateMutability": "view", 242 | "type": "function" 243 | }, 244 | { 245 | "inputs": [ 246 | { 247 | "internalType": "address", 248 | "name": "_tokenAddress", 249 | "type": "address" 250 | }, 251 | { 252 | "internalType": "uint256", 253 | "name": "_tokenAmount", 254 | "type": "uint256" 255 | } 256 | ], 257 | "name": "withdrawTokens", 258 | "outputs": [], 259 | "stateMutability": "nonpayable", 260 | "type": "function" 261 | } 262 | ] 263 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Visit https://aka.ms/tsconfig.json to read more about this file */ 4 | 5 | /* Basic Options */ 6 | // "incremental": true, /* Enable incremental compilation */ 7 | "target": "ES6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ 8 | "module": "CommonJS", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ 9 | // "lib": [], /* Specify library files to be included in the compilation. */ 10 | // "allowJs": true, /* Allow javascript files to be compiled. */ 11 | // "checkJs": true, /* Report errors in .js files. */ 12 | // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ 13 | // "declaration": true, /* Generates corresponding '.d.ts' file. */ 14 | // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ 15 | // "sourceMap": true, /* Generates corresponding '.map' file. */ 16 | // "outFile": "./", /* Concatenate and emit output to single file. */ 17 | // "outDir": "./", /* Redirect output structure to the directory. */ 18 | // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ 19 | // "composite": true, /* Enable project compilation */ 20 | // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ 21 | // "removeComments": true, /* Do not emit comments to output. */ 22 | // "noEmit": true, /* Do not emit outputs. */ 23 | // "importHelpers": true, /* Import emit helpers from 'tslib'. */ 24 | // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ 25 | // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ 26 | 27 | /* Strict Type-Checking Options */ 28 | "strict": true, /* Enable all strict type-checking options. */ 29 | "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ 30 | "strictNullChecks": true, /* Enable strict null checks. */ 31 | "strictFunctionTypes": true, /* Enable strict checking of function types. */ 32 | "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ 33 | "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ 34 | "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ 35 | "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ 36 | 37 | /* Additional Checks */ 38 | // "noUnusedLocals": true, /* Report errors on unused locals. */ 39 | // "noUnusedParameters": true, /* Report errors on unused parameters. */ 40 | // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ 41 | // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ 42 | // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ 43 | 44 | /* Module Resolution Options */ 45 | // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ 46 | // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ 47 | // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ 48 | // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ 49 | // "typeRoots": [], /* List of folders to include type definitions from. */ 50 | // "types": [], /* Type declaration files to be included in compilation. */ 51 | // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ 52 | "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ 53 | // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ 54 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 55 | 56 | /* Source Map Options */ 57 | // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ 58 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 59 | // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ 60 | // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ 61 | 62 | /* Experimental Options */ 63 | // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ 64 | // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ 65 | 66 | /* Advanced Options */ 67 | "skipLibCheck": true, /* Skip type checking of declaration files. */ 68 | "forceConsistentCasingInFileNames": true, /* Disallow inconsistently-cased references to the same file. */ 69 | "resolveJsonModule": true /* Allows importing modules with a ‘.json’ extension. */ 70 | }, 71 | "include": ["scripts", "utils"], 72 | "files": ["hardhat.config.ts"] 73 | } 74 | -------------------------------------------------------------------------------- /abi/PancakeSwapLottery.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "inputs": [ 4 | { 5 | "internalType": "address", 6 | "name": "_cakeTokenAddress", 7 | "type": "address" 8 | }, 9 | { 10 | "internalType": "address", 11 | "name": "_randomGeneratorAddress", 12 | "type": "address" 13 | } 14 | ], 15 | "stateMutability": "nonpayable", 16 | "type": "constructor" 17 | }, 18 | { 19 | "anonymous": false, 20 | "inputs": [ 21 | { 22 | "indexed": false, 23 | "internalType": "address", 24 | "name": "token", 25 | "type": "address" 26 | }, 27 | { 28 | "indexed": false, 29 | "internalType": "uint256", 30 | "name": "amount", 31 | "type": "uint256" 32 | } 33 | ], 34 | "name": "AdminTokenRecovery", 35 | "type": "event" 36 | }, 37 | { 38 | "anonymous": false, 39 | "inputs": [ 40 | { 41 | "indexed": true, 42 | "internalType": "uint256", 43 | "name": "lotteryId", 44 | "type": "uint256" 45 | }, 46 | { 47 | "indexed": false, 48 | "internalType": "uint256", 49 | "name": "firstTicketIdNextLottery", 50 | "type": "uint256" 51 | } 52 | ], 53 | "name": "LotteryClose", 54 | "type": "event" 55 | }, 56 | { 57 | "anonymous": false, 58 | "inputs": [ 59 | { 60 | "indexed": true, 61 | "internalType": "uint256", 62 | "name": "lotteryId", 63 | "type": "uint256" 64 | }, 65 | { 66 | "indexed": false, 67 | "internalType": "uint256", 68 | "name": "injectedAmount", 69 | "type": "uint256" 70 | } 71 | ], 72 | "name": "LotteryInjection", 73 | "type": "event" 74 | }, 75 | { 76 | "anonymous": false, 77 | "inputs": [ 78 | { 79 | "indexed": true, 80 | "internalType": "uint256", 81 | "name": "lotteryId", 82 | "type": "uint256" 83 | }, 84 | { 85 | "indexed": false, 86 | "internalType": "uint256", 87 | "name": "finalNumber", 88 | "type": "uint256" 89 | }, 90 | { 91 | "indexed": false, 92 | "internalType": "uint256", 93 | "name": "countWinningTickets", 94 | "type": "uint256" 95 | } 96 | ], 97 | "name": "LotteryNumberDrawn", 98 | "type": "event" 99 | }, 100 | { 101 | "anonymous": false, 102 | "inputs": [ 103 | { 104 | "indexed": true, 105 | "internalType": "uint256", 106 | "name": "lotteryId", 107 | "type": "uint256" 108 | }, 109 | { 110 | "indexed": false, 111 | "internalType": "uint256", 112 | "name": "startTime", 113 | "type": "uint256" 114 | }, 115 | { 116 | "indexed": false, 117 | "internalType": "uint256", 118 | "name": "endTime", 119 | "type": "uint256" 120 | }, 121 | { 122 | "indexed": false, 123 | "internalType": "uint256", 124 | "name": "priceTicketInCake", 125 | "type": "uint256" 126 | }, 127 | { 128 | "indexed": false, 129 | "internalType": "uint256", 130 | "name": "firstTicketId", 131 | "type": "uint256" 132 | }, 133 | { 134 | "indexed": false, 135 | "internalType": "uint256", 136 | "name": "injectedAmount", 137 | "type": "uint256" 138 | } 139 | ], 140 | "name": "LotteryOpen", 141 | "type": "event" 142 | }, 143 | { 144 | "anonymous": false, 145 | "inputs": [ 146 | { 147 | "indexed": false, 148 | "internalType": "address", 149 | "name": "operator", 150 | "type": "address" 151 | }, 152 | { 153 | "indexed": false, 154 | "internalType": "address", 155 | "name": "treasury", 156 | "type": "address" 157 | } 158 | ], 159 | "name": "NewOperatorAndTreasuryAddresses", 160 | "type": "event" 161 | }, 162 | { 163 | "anonymous": false, 164 | "inputs": [ 165 | { 166 | "indexed": true, 167 | "internalType": "address", 168 | "name": "randomGenerator", 169 | "type": "address" 170 | } 171 | ], 172 | "name": "NewRandomGenerator", 173 | "type": "event" 174 | }, 175 | { 176 | "anonymous": false, 177 | "inputs": [ 178 | { 179 | "indexed": true, 180 | "internalType": "address", 181 | "name": "previousOwner", 182 | "type": "address" 183 | }, 184 | { 185 | "indexed": true, 186 | "internalType": "address", 187 | "name": "newOwner", 188 | "type": "address" 189 | } 190 | ], 191 | "name": "OwnershipTransferred", 192 | "type": "event" 193 | }, 194 | { 195 | "anonymous": false, 196 | "inputs": [ 197 | { 198 | "indexed": true, 199 | "internalType": "address", 200 | "name": "claimer", 201 | "type": "address" 202 | }, 203 | { 204 | "indexed": false, 205 | "internalType": "uint256", 206 | "name": "amount", 207 | "type": "uint256" 208 | }, 209 | { 210 | "indexed": true, 211 | "internalType": "uint256", 212 | "name": "lotteryId", 213 | "type": "uint256" 214 | }, 215 | { 216 | "indexed": false, 217 | "internalType": "uint256", 218 | "name": "numberTickets", 219 | "type": "uint256" 220 | } 221 | ], 222 | "name": "TicketsClaim", 223 | "type": "event" 224 | }, 225 | { 226 | "anonymous": false, 227 | "inputs": [ 228 | { 229 | "indexed": true, 230 | "internalType": "address", 231 | "name": "buyer", 232 | "type": "address" 233 | }, 234 | { 235 | "indexed": true, 236 | "internalType": "uint256", 237 | "name": "lotteryId", 238 | "type": "uint256" 239 | }, 240 | { 241 | "indexed": false, 242 | "internalType": "uint256", 243 | "name": "numberTickets", 244 | "type": "uint256" 245 | } 246 | ], 247 | "name": "TicketsPurchase", 248 | "type": "event" 249 | }, 250 | { 251 | "inputs": [], 252 | "name": "MAX_LENGTH_LOTTERY", 253 | "outputs": [ 254 | { 255 | "internalType": "uint256", 256 | "name": "", 257 | "type": "uint256" 258 | } 259 | ], 260 | "stateMutability": "view", 261 | "type": "function" 262 | }, 263 | { 264 | "inputs": [], 265 | "name": "MAX_TREASURY_FEE", 266 | "outputs": [ 267 | { 268 | "internalType": "uint256", 269 | "name": "", 270 | "type": "uint256" 271 | } 272 | ], 273 | "stateMutability": "view", 274 | "type": "function" 275 | }, 276 | { 277 | "inputs": [], 278 | "name": "MIN_DISCOUNT_DIVISOR", 279 | "outputs": [ 280 | { 281 | "internalType": "uint256", 282 | "name": "", 283 | "type": "uint256" 284 | } 285 | ], 286 | "stateMutability": "view", 287 | "type": "function" 288 | }, 289 | { 290 | "inputs": [], 291 | "name": "MIN_LENGTH_LOTTERY", 292 | "outputs": [ 293 | { 294 | "internalType": "uint256", 295 | "name": "", 296 | "type": "uint256" 297 | } 298 | ], 299 | "stateMutability": "view", 300 | "type": "function" 301 | }, 302 | { 303 | "inputs": [ 304 | { 305 | "internalType": "uint256", 306 | "name": "_lotteryId", 307 | "type": "uint256" 308 | }, 309 | { 310 | "internalType": "uint32[]", 311 | "name": "_ticketNumbers", 312 | "type": "uint32[]" 313 | } 314 | ], 315 | "name": "buyTickets", 316 | "outputs": [], 317 | "stateMutability": "nonpayable", 318 | "type": "function" 319 | }, 320 | { 321 | "inputs": [], 322 | "name": "cakeToken", 323 | "outputs": [ 324 | { 325 | "internalType": "contract IERC20", 326 | "name": "", 327 | "type": "address" 328 | } 329 | ], 330 | "stateMutability": "view", 331 | "type": "function" 332 | }, 333 | { 334 | "inputs": [ 335 | { 336 | "internalType": "uint256", 337 | "name": "_discountDivisor", 338 | "type": "uint256" 339 | }, 340 | { 341 | "internalType": "uint256", 342 | "name": "_priceTicket", 343 | "type": "uint256" 344 | }, 345 | { 346 | "internalType": "uint256", 347 | "name": "_numberTickets", 348 | "type": "uint256" 349 | } 350 | ], 351 | "name": "calculateTotalPriceForBulkTickets", 352 | "outputs": [ 353 | { 354 | "internalType": "uint256", 355 | "name": "", 356 | "type": "uint256" 357 | } 358 | ], 359 | "stateMutability": "pure", 360 | "type": "function" 361 | }, 362 | { 363 | "inputs": [ 364 | { 365 | "internalType": "address", 366 | "name": "_randomGeneratorAddress", 367 | "type": "address" 368 | } 369 | ], 370 | "name": "changeRandomGenerator", 371 | "outputs": [], 372 | "stateMutability": "nonpayable", 373 | "type": "function" 374 | }, 375 | { 376 | "inputs": [ 377 | { 378 | "internalType": "uint256", 379 | "name": "_lotteryId", 380 | "type": "uint256" 381 | }, 382 | { 383 | "internalType": "uint256[]", 384 | "name": "_ticketIds", 385 | "type": "uint256[]" 386 | }, 387 | { 388 | "internalType": "uint32[]", 389 | "name": "_brackets", 390 | "type": "uint32[]" 391 | } 392 | ], 393 | "name": "claimTickets", 394 | "outputs": [], 395 | "stateMutability": "nonpayable", 396 | "type": "function" 397 | }, 398 | { 399 | "inputs": [ 400 | { 401 | "internalType": "uint256", 402 | "name": "_lotteryId", 403 | "type": "uint256" 404 | } 405 | ], 406 | "name": "closeLottery", 407 | "outputs": [], 408 | "stateMutability": "nonpayable", 409 | "type": "function" 410 | }, 411 | { 412 | "inputs": [], 413 | "name": "currentLotteryId", 414 | "outputs": [ 415 | { 416 | "internalType": "uint256", 417 | "name": "", 418 | "type": "uint256" 419 | } 420 | ], 421 | "stateMutability": "view", 422 | "type": "function" 423 | }, 424 | { 425 | "inputs": [], 426 | "name": "currentTicketId", 427 | "outputs": [ 428 | { 429 | "internalType": "uint256", 430 | "name": "", 431 | "type": "uint256" 432 | } 433 | ], 434 | "stateMutability": "view", 435 | "type": "function" 436 | }, 437 | { 438 | "inputs": [ 439 | { 440 | "internalType": "uint256", 441 | "name": "_lotteryId", 442 | "type": "uint256" 443 | }, 444 | { 445 | "internalType": "bool", 446 | "name": "_autoInjection", 447 | "type": "bool" 448 | } 449 | ], 450 | "name": "drawFinalNumberAndMakeLotteryClaimable", 451 | "outputs": [], 452 | "stateMutability": "nonpayable", 453 | "type": "function" 454 | }, 455 | { 456 | "inputs": [ 457 | { 458 | "internalType": "uint256", 459 | "name": "_lotteryId", 460 | "type": "uint256" 461 | }, 462 | { 463 | "internalType": "uint256", 464 | "name": "_amount", 465 | "type": "uint256" 466 | } 467 | ], 468 | "name": "injectFunds", 469 | "outputs": [], 470 | "stateMutability": "nonpayable", 471 | "type": "function" 472 | }, 473 | { 474 | "inputs": [], 475 | "name": "maxNumberTicketsPerBuyOrClaim", 476 | "outputs": [ 477 | { 478 | "internalType": "uint256", 479 | "name": "", 480 | "type": "uint256" 481 | } 482 | ], 483 | "stateMutability": "view", 484 | "type": "function" 485 | }, 486 | { 487 | "inputs": [], 488 | "name": "operatorAddress", 489 | "outputs": [ 490 | { 491 | "internalType": "address", 492 | "name": "", 493 | "type": "address" 494 | } 495 | ], 496 | "stateMutability": "view", 497 | "type": "function" 498 | }, 499 | { 500 | "inputs": [], 501 | "name": "owner", 502 | "outputs": [ 503 | { 504 | "internalType": "address", 505 | "name": "", 506 | "type": "address" 507 | } 508 | ], 509 | "stateMutability": "view", 510 | "type": "function" 511 | }, 512 | { 513 | "inputs": [], 514 | "name": "pendingInjectionNextLottery", 515 | "outputs": [ 516 | { 517 | "internalType": "uint256", 518 | "name": "", 519 | "type": "uint256" 520 | } 521 | ], 522 | "stateMutability": "view", 523 | "type": "function" 524 | }, 525 | { 526 | "inputs": [], 527 | "name": "randomGenerator", 528 | "outputs": [ 529 | { 530 | "internalType": "contract IRandomNumberGenerator", 531 | "name": "", 532 | "type": "address" 533 | } 534 | ], 535 | "stateMutability": "view", 536 | "type": "function" 537 | }, 538 | { 539 | "inputs": [ 540 | { 541 | "internalType": "address", 542 | "name": "_tokenAddress", 543 | "type": "address" 544 | }, 545 | { 546 | "internalType": "uint256", 547 | "name": "_tokenAmount", 548 | "type": "uint256" 549 | } 550 | ], 551 | "name": "recoverWrongTokens", 552 | "outputs": [], 553 | "stateMutability": "nonpayable", 554 | "type": "function" 555 | }, 556 | { 557 | "inputs": [], 558 | "name": "renounceOwnership", 559 | "outputs": [], 560 | "stateMutability": "nonpayable", 561 | "type": "function" 562 | }, 563 | { 564 | "inputs": [ 565 | { 566 | "internalType": "uint256", 567 | "name": "_maxNumberTicketsPerBuy", 568 | "type": "uint256" 569 | } 570 | ], 571 | "name": "setMaxNumberTicketsPerBuy", 572 | "outputs": [], 573 | "stateMutability": "nonpayable", 574 | "type": "function" 575 | }, 576 | { 577 | "inputs": [ 578 | { 579 | "internalType": "address", 580 | "name": "_operatorAddress", 581 | "type": "address" 582 | }, 583 | { 584 | "internalType": "address", 585 | "name": "_treasuryAddress", 586 | "type": "address" 587 | } 588 | ], 589 | "name": "setOperatorAndTreasuryAddresses", 590 | "outputs": [], 591 | "stateMutability": "nonpayable", 592 | "type": "function" 593 | }, 594 | { 595 | "inputs": [ 596 | { 597 | "internalType": "uint256", 598 | "name": "_endTime", 599 | "type": "uint256" 600 | }, 601 | { 602 | "internalType": "uint256", 603 | "name": "_priceTicketInCake", 604 | "type": "uint256" 605 | }, 606 | { 607 | "internalType": "uint256", 608 | "name": "_discountDivisor", 609 | "type": "uint256" 610 | }, 611 | { 612 | "internalType": "uint256[6]", 613 | "name": "_rewardsBreakdown", 614 | "type": "uint256[6]" 615 | }, 616 | { 617 | "internalType": "uint256", 618 | "name": "_treasuryFee", 619 | "type": "uint256" 620 | } 621 | ], 622 | "name": "startLottery", 623 | "outputs": [], 624 | "stateMutability": "nonpayable", 625 | "type": "function" 626 | }, 627 | { 628 | "inputs": [ 629 | { 630 | "internalType": "address", 631 | "name": "newOwner", 632 | "type": "address" 633 | } 634 | ], 635 | "name": "transferOwnership", 636 | "outputs": [], 637 | "stateMutability": "nonpayable", 638 | "type": "function" 639 | }, 640 | { 641 | "inputs": [], 642 | "name": "treasuryAddress", 643 | "outputs": [ 644 | { 645 | "internalType": "address", 646 | "name": "", 647 | "type": "address" 648 | } 649 | ], 650 | "stateMutability": "view", 651 | "type": "function" 652 | }, 653 | { 654 | "inputs": [], 655 | "name": "viewCurrentLotteryId", 656 | "outputs": [ 657 | { 658 | "internalType": "uint256", 659 | "name": "", 660 | "type": "uint256" 661 | } 662 | ], 663 | "stateMutability": "view", 664 | "type": "function" 665 | }, 666 | { 667 | "inputs": [ 668 | { 669 | "internalType": "uint256", 670 | "name": "_lotteryId", 671 | "type": "uint256" 672 | } 673 | ], 674 | "name": "viewLottery", 675 | "outputs": [ 676 | { 677 | "components": [ 678 | { 679 | "internalType": "enum PancakeSwapLottery.Status", 680 | "name": "status", 681 | "type": "uint8" 682 | }, 683 | { 684 | "internalType": "uint256", 685 | "name": "startTime", 686 | "type": "uint256" 687 | }, 688 | { 689 | "internalType": "uint256", 690 | "name": "endTime", 691 | "type": "uint256" 692 | }, 693 | { 694 | "internalType": "uint256", 695 | "name": "priceTicketInCake", 696 | "type": "uint256" 697 | }, 698 | { 699 | "internalType": "uint256", 700 | "name": "discountDivisor", 701 | "type": "uint256" 702 | }, 703 | { 704 | "internalType": "uint256[6]", 705 | "name": "rewardsBreakdown", 706 | "type": "uint256[6]" 707 | }, 708 | { 709 | "internalType": "uint256", 710 | "name": "treasuryFee", 711 | "type": "uint256" 712 | }, 713 | { 714 | "internalType": "uint256[6]", 715 | "name": "cakePerBracket", 716 | "type": "uint256[6]" 717 | }, 718 | { 719 | "internalType": "uint256[6]", 720 | "name": "countWinnersPerBracket", 721 | "type": "uint256[6]" 722 | }, 723 | { 724 | "internalType": "uint256", 725 | "name": "firstTicketId", 726 | "type": "uint256" 727 | }, 728 | { 729 | "internalType": "uint256", 730 | "name": "firstTicketIdNextLottery", 731 | "type": "uint256" 732 | }, 733 | { 734 | "internalType": "uint256", 735 | "name": "amountCollectedInCake", 736 | "type": "uint256" 737 | }, 738 | { 739 | "internalType": "uint32", 740 | "name": "finalNumber", 741 | "type": "uint32" 742 | } 743 | ], 744 | "internalType": "struct PancakeSwapLottery.Lottery", 745 | "name": "", 746 | "type": "tuple" 747 | } 748 | ], 749 | "stateMutability": "view", 750 | "type": "function" 751 | }, 752 | { 753 | "inputs": [ 754 | { 755 | "internalType": "uint256[]", 756 | "name": "_ticketIds", 757 | "type": "uint256[]" 758 | } 759 | ], 760 | "name": "viewNumbersAndStatusesForTicketIds", 761 | "outputs": [ 762 | { 763 | "internalType": "uint32[]", 764 | "name": "", 765 | "type": "uint32[]" 766 | }, 767 | { 768 | "internalType": "bool[]", 769 | "name": "", 770 | "type": "bool[]" 771 | } 772 | ], 773 | "stateMutability": "view", 774 | "type": "function" 775 | }, 776 | { 777 | "inputs": [ 778 | { 779 | "internalType": "uint256", 780 | "name": "_lotteryId", 781 | "type": "uint256" 782 | }, 783 | { 784 | "internalType": "uint256", 785 | "name": "_ticketId", 786 | "type": "uint256" 787 | }, 788 | { 789 | "internalType": "uint32", 790 | "name": "_bracket", 791 | "type": "uint32" 792 | } 793 | ], 794 | "name": "viewRewardsForTicketId", 795 | "outputs": [ 796 | { 797 | "internalType": "uint256", 798 | "name": "", 799 | "type": "uint256" 800 | } 801 | ], 802 | "stateMutability": "view", 803 | "type": "function" 804 | }, 805 | { 806 | "inputs": [ 807 | { 808 | "internalType": "address", 809 | "name": "_user", 810 | "type": "address" 811 | }, 812 | { 813 | "internalType": "uint256", 814 | "name": "_lotteryId", 815 | "type": "uint256" 816 | }, 817 | { 818 | "internalType": "uint256", 819 | "name": "_cursor", 820 | "type": "uint256" 821 | }, 822 | { 823 | "internalType": "uint256", 824 | "name": "_size", 825 | "type": "uint256" 826 | } 827 | ], 828 | "name": "viewUserTicketNumbersAndStatusesForLottery", 829 | "outputs": [ 830 | { 831 | "internalType": "uint256[]", 832 | "name": "", 833 | "type": "uint256[]" 834 | }, 835 | { 836 | "internalType": "uint32[]", 837 | "name": "", 838 | "type": "uint32[]" 839 | }, 840 | { 841 | "internalType": "bool[]", 842 | "name": "", 843 | "type": "bool[]" 844 | }, 845 | { 846 | "internalType": "uint256", 847 | "name": "", 848 | "type": "uint256" 849 | } 850 | ], 851 | "stateMutability": "view", 852 | "type": "function" 853 | } 854 | ] 855 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------