Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pancakeswap/pancake-lottery-scheduler
🎰 Pancake Lottery scheduler
https://github.com/pancakeswap/pancake-lottery-scheduler
lottery pancakeswap scheduler
Last synced: about 2 months ago
JSON representation
🎰 Pancake Lottery scheduler
- Host: GitHub
- URL: https://github.com/pancakeswap/pancake-lottery-scheduler
- Owner: pancakeswap
- License: gpl-3.0
- Created: 2021-06-07T19:47:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T04:41:24.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T01:55:12.499Z (9 months ago)
- Topics: lottery, pancakeswap, scheduler
- Language: TypeScript
- Homepage: https://pancakeswap.finance/lottery
- Size: 739 KB
- Stars: 45
- Watchers: 3
- Forks: 76
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Pancake Lottery Scheduler
### Description
The scheduler is composed of multiple scripts used to call `startLottery`, `closeLottery`, and `drawFinalNumberAndMakeLotteryClaimable` functions, trigger events; and monitor lottery results.
### Configuration
- `Lottery` Address of [PancakeSwapLottery](https://github.com/pancakeswap/pancake-contracts/tree/master/projects/lottery) contract.
- `Ticket` Ticket Price (denominated in USD) and Precision.
- `Discount` Divisor to compute discount magnitude for bulk ticket purchase.
- `Rewards` Reward breakdown per bracket (total must be equal to 10,000).
- `Treasury` Fee (denominated as percentage) to 2 decimals (e.g. 100 => 1%).
> Configuration can be overwritten by editing [config.ts](config.ts) file.
### Deployment
```shell script
# Export operator private key to be used on Hardhat Network Config.
$ export OPERATOR_PRIVATE_KEY=OPERATOR_PRIVATE_KEY
$ yarn execute:[command]:[network]
```
#### Command(s)
- `start` Start a new lottery; for a given network.
- `close` Close a lottery, based on `currentLotteryId`; for a given network.
- `draw` Draw winning numbers, based on `currentLotteryId`; for a given network.
#### Network(s)
- `mainnet` ChainId `56` ([documentation](https://docs.binance.org/smart-chain/developer/rpc.html#mainnetchainid-0x38-56-in-decimal))
- `testnet` ChainId `97` ([documentation](https://docs.binance.org/smart-chain/developer/rpc.html#testnetchainid-0x61-97-in-decimal))
#### Execution
```shell script
# Close lottery.
0 0,12 * * * cd ~/pancake-lottery-scheduler && yarn execute:close:mainnet
# Draw lottery.
3 0,12 * * * cd ~/pancake-lottery-scheduler && yarn execute:draw:mainnet
# Start lottery.
5 0,12 * * * cd ~/pancake-lottery-scheduler && yarn execute:start:mainnet
```
### Logging
Logs will be generated at `logs/lottery-YYYY-MM-DD.log` and will be archived (.gz) with a daily rotation.
Examples of success logs:
```log
{"message":"[1970-01-01T06:05:00.000Z] network=testnet block=10000000 message='Started lottery' hash=0x... signer=0x...","level":"info"}
{"message":"[1970-01-01T18:00:00.000Z] network=testnet block=10010010 message='Closed lottery #123' hash=0x... signer=0x...","level":"info"}
{"message":"[1970-01-01T18:03:00.000Z] network=testnet block=10100100 message='Drawed lottery #123' hash=0x... signer=0x...","level":"info"}
{"message":"[1970-01-01T18:05:00.000Z] network=testnet block=11001000 message='Started lottery' hash=0x... signer=0x...","level":"info"}
```
Examples of error logs:
```log
{"message":"[1970-01-01T00:00:00.000Z] network=testnet message='Unsupported network' signer=0x...","level":"error"}
{"message":"[1970-01-01T12:00:00.000Z] network=testnet message='Invalid JSON RPC response' signer=0x...","level":"error"}
{"message":"[1970-01-02T00:00:00.000Z] network=testnet message='Invalid keyHash on RandomGenerator contract' signer=0x...","level":"error"}
```