{"_id":"@chanceprotocol/yield-source-interface","name":"@chanceprotocol/yield-source-interface","dist-tags":{"latest":"1.4.0"},"versions":{"1.4.0":{"name":"@chanceprotocol/yield-source-interface","version":"1.4.0","main":"index.js","license":"GPL-3.0","devDependencies":{"@nomiclabs/hardhat-ethers":"^2.0.5","@nomiclabs/hardhat-waffle":"^2.0.3","chai":"^4.3.6","ethereum-waffle":"3.4.4","ethers":"^5.6.4","hardhat":"2.6.5","hardhat-abi-exporter":"2.3.0","husky":"8.0.1","prettier":"2.4.1","prettier-plugin-solidity":"1.0.0-beta.18","solhint":"3.3.6","solidity-coverage":"0.7.21"},"dependencies":{"@openzeppelin/contracts":"4.6.0","hardhat-deploy":"^0.11.4","hardhat-deploy-ethers":"^0.3.0-beta.13"},"scripts":{"compile":"hardhat compile","clean":"rm -rf artifacts cache abis","coverage":"hardhat coverage","coverage:file":"hardhat coverage --testfiles","format":"prettier --config .prettierrc --write \"**/*.{ts,js}\" \"contracts/**/*.sol\"","format:file":"prettier --config .prettierrc --write","hint":"solhint \"contracts/**/*.sol\"","test":"hardhat test"},"description":"PoolTogether would like to integrate any protocol that serves as a yield source.  The PoolTogether 3.3.0 contracts introduce a Yield Source Prize Pool, that is bound to a contract that implements the Yield Source Interface.  This is a generic interface th","_id":"@chanceprotocol/yield-source-interface@1.4.0","_integrity":"sha512-A6DF2FP1Uuj4QGv8sTigDpDVxSfQAZGFED2A+yDKfsGwVS57xwn6TKy/wu5ddnLeseFgaObp6fHuj/UdTE1Flg==","_resolved":"/tmp/f4e714e5ed7f14d17d49c93249c35a2e/chanceprotocol-yield-source-interface-1.4.0.tgz","_from":"file:chanceprotocol-yield-source-interface-1.4.0.tgz","_nodeVersion":"16.15.1","_npmVersion":"9.6.5","dist":{"integrity":"sha512-A6DF2FP1Uuj4QGv8sTigDpDVxSfQAZGFED2A+yDKfsGwVS57xwn6TKy/wu5ddnLeseFgaObp6fHuj/UdTE1Flg==","shasum":"4c421215d6a6c0fcc581473eb6b5875cd8904194","tarball":"https://registry.npmjs.org/@chanceprotocol/yield-source-interface/-/yield-source-interface-1.4.0.tgz","fileCount":20,"unpackedSize":2095966,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCpLAg28Ww+MgqJ8zN52E552UzUCqGoJSe6fRStVFeecAIgSTLOvQ477n7o6ygFIhOrEEfmEhXFSeB+MlYBikOQ7SA="}]},"_npmUser":{"name":"chanceprotocol","email":"chance@netixsol.com"},"directories":{},"maintainers":[{"name":"chanceprotocol","email":"chance@netixsol.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/yield-source-interface_1.4.0_1692257315401_0.3172564746749238"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-17T07:28:35.301Z","1.4.0":"2023-08-17T07:28:35.697Z","modified":"2023-08-17T07:28:35.997Z"},"maintainers":[{"name":"chanceprotocol","email":"chance@netixsol.com"}],"description":"PoolTogether would like to integrate any protocol that serves as a yield source.  The PoolTogether 3.3.0 contracts introduce a Yield Source Prize Pool, that is bound to a contract that implements the Yield Source Interface.  This is a generic interface th","license":"GPL-3.0","readme":"# PoolTogether Yield Source Specification\n\nPoolTogether would like to integrate any protocol that serves as a yield source.  The PoolTogether 3.3.0 contracts introduce a Yield Source Prize Pool, that is bound to a contract that implements the Yield Source Interface.  This is a generic interface that allows a Yield Source Prize Pool to use an external contract for yield.  As long as a contract supports the Yield Source Interface, it can be plugged into the Yield Source Prize Pool.  This makes it easy to add new yield sources.\n\n# Yield Source Interface\n\nThe Yield Source Interface is defined in the [IYieldSource.sol](./contracts/IYieldSource.sol) file.\n\nKeep in mind:\n\n- All deposits are denominated in the `depositToken()` ERC20.\n- The `balanceOfToken(address)` function is similar to the Aave aToken, in that the balance must always increase.\n\n# Implementations\n\n**Note: these implementations may or may not have been audited.**  They should be considered experimental until proven otherwise.\n\n- [Compound cToken Yield Source](https://github.com/pooltogether/pooltogether-pool-contracts/blob/f3c40ecacc654caa323f956f91e9851703a73111/contracts/yield-source/CTokenYieldSource.sol)\n- [Aave aToken Yield Source](https://github.com/pooltogether/aave-yield-source)\n- [xSushi Yield Source](https://github.com/steffenix/sushi-pooltogether)\n- [Yearn V2 Vault Yield Source](https://github.com/pooltogether/pooltogether-yearnv2-yield-source)\n","readmeFilename":"README.md"}