![\"Plush](\"https://avatars.githubusercontent.com/u/74625046?s=200&v=4\")
\n\n
Plush Protocol is the core of the Plush ecosystem.
\n\n![\"NPM](\"https://img.shields.io/npm/v/@plushfamily/plush-protocol-contracts.svg\")
\n![\"Package](\"https://img.shields.io/npm/l/@plushfamily/plush-protocol-contracts.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/@plushfamily/plush-protocol-contracts.svg\")
\n![\"twitter\"](\"https://img.shields.io/twitter/follow/plush_family_.svg?style=social&label=Follow\")
\n\n## Description\n\nThis repository contains the Plush Protocol contracts and the development environment of Plush Protocol.\n\nImport this library to connect your contracts to the Plush ecosystem.\n\n## Overview\n\n### Installation\n\n```console\nnpm install @plushfamily/plush-protocol-contracts\n```\n\n### Description of protocol contracts\n\n- **PlushApps** - the main contract of the ecosystem. It contains the addresses of the current applications of the ecosystem.\n- **PlushAccounts** - using to simplify transactions in the ecosystem and the storage of application tokens.\n- **PlushController** - the main contract of a third-party application. Used to connect app to the Plush ecosystem.\n- **Plush** - ERC-20 ecosystem token (***PLSH***).\n- **WrappedPlush** - wrapped ERC-20 ecosystem token (***wPLSH***).\n- **LifeSpan** - ERC-721 LifeSpan token (***LIFESPAN***).\n- **PlushGetLifeSpan** - self-minting of LifeSpan token (***LIFESPAN***).\n- **PlushFaucet** - ERC-20 ecosystem token faucet (***PLSH***).\n\n## Using\n\n### Protocol importing\n\nOnce installed, you can use the contracts in the library by importing them:\n\n```solidity\n// SPDX-License-Identifier: MIT\npragma solidity ^0.8.4;\n\nimport \"@plushfamily/plush-protocol-contracts/contracts/templates/apps/PlushController.sol\";\n\ncontract PlushForestController is PlushController {}\n```\n_Example of importing a controller._\n\n### Connecting third-party app to the Plush ecosystem\n\nTo add your application to the ecosystem, you need to write the address of the deployed controller contract in a special form (the form will be published later).\n\nExample of connecting a third-party application to the Plush ecosystem: [Plush Studio Contracts](https://github.com/PlushStudio/plush-studio-contracts)\n\n## Development of the Plush Protocol\n\nWe will be glad if you join the protocol development!\n\n### Project structure\n\n`arguments` directory with current contract addresses for each of the environments.\n\n`contracts` directory with source code of contracts\n\n`scripts` directory with scripts for deploying and upgrading contracts\n\n`hardhat.config.ts` hardhat configuration\n\n### Preparation for development\n\nFirst you need to make sure that the Node.js platform is installed.\n\n**Recommended using the 16 version NodeJS!**\n\nLink to download: [download Node.js](https://nodejs.org)\n\nNext, you need to install the yarn package manager: `npm install --global yarn`\n\nBefore starting the project, you need to install all project dependencies: `yarn install`\n\n\n### Configuration\n\nCreate `.env` file:\n```\nNETWORK = mumbai\nAPI_URL = \"https://eth-mumbai.alchemyapi.io/v2/x-L3PRORMY7KyYFFMH9Gny4YD4sDxe5T\" # EXAMPLE\nPRIVATE_KEY = \"ETH_PRIVATE_KEY\"\nETHERSCAN_API_KEY = \"ETHERSCAN_KEY\"\nPOLYGONSCAN_API_KEY = \"POLYGONSCAN_KEY\"\nDEFENDER_TEAM_API_KEY=\"KEY\"\nDEFENDER_TEAM_API_SECRET_KEY=\"KEY\"\n```\n_You can use any Blockchain provider : Alchemy, Infura, etc._\n\nSupport networks:\n1. Goerli – `goerli`\n2. Mumbai – `mumbai`\n3. Mainnet ETH – `mainnet`\n4. Polygon mainnet – `polygon`\n5. Local – `local` # for Ganache\n\n### Where to get the required keys\n\nGet api keys on [Etherscan](https://docs.etherscan.io/getting-started/viewing-api-usage-statistics) and [Polygonscan](https://polygonscan.com/myapikey) websites\nTo request an upgrade contracts, you need to use a [OpenZeppelin Defender](https://defender.openzeppelin.com/). \n\n### Deploying contracts\n\nTo deploy contract use: `npx hardhat run scripts/deploy/.../{FileName}`\n\n### Upgrading contracts\n\nTo deploy contract use: `npx hardhat run scripts/upgrade/.../{FileName}`\n","readmeFilename":"README.md"}