{"_id":"@apeswap.finance/contracts","_rev":"1-3d2be1083230917b92e738b1786660d0","name":"@apeswap.finance/contracts","dist-tags":{"latest":"0.2.0"},"versions":{"0.2.0":{"name":"@apeswap.finance/contracts","description":"A collection of smart contract tools and interfaces used by ApeSwap.","version":"0.2.0","engines":{"yarn":"^1.22.0"},"bin":{"apeswapfinance-contracts-migrate-imports":"scripts/migrate-imports.js"},"scripts":{"compile":"hardhat compile","compile:force":"hardhat compile --force","coverage":"export COVERAGE=true; hardhat coverage","docs":"oz-docs","docs:watch":"yarn docs watch contracts 'docs/*.hbs' docs/helpers.js","prepare-docs":"scripts/prepare-docs.sh","lint:js":"eslint --ignore-path .gitignore .","lint:js:fix":"eslint --ignore-path .gitignore . --fix","lint:sol":"solhint 'contracts/**/*.sol' && prettier -c 'contracts/**/*.sol'","lint:sol:fix":"prettier --write \"contracts/**/*.sol\"","prepublish":"rimraf build contracts/build artifacts cache","prepare":"export COMPILE_MODE=production; yarn compile","prepack":"scripts/prepack.sh","release":"scripts/release/release.sh","version":"scripts/release/version.sh","pretest":"yarn compile","test":"mocha --exit --recursive --timeout 30000","test:ci":"yarn test","test:inheritance":"node scripts/inheritanceOrdering artifacts/build-info/*","gas-report":"export ENABLE_GAS_REPORT=true; yarn test","lint":"solhint './contracts/**/*.sol'","lint:fix":"solhint './contracts/**/*.sol' --fix","gen:docs":"yarn docs && sol2uml ./contracts -o docs/uml.svg","prettier:fix":"prettier --write 'contracts/**/*.sol'"},"repository":{"type":"git","url":"git+https://github.com/ApeSwapFinance/apeswap-contracts.git"},"keywords":["solidity","ethereum","smart","contracts","security","zeppelin"],"author":{"name":"ApeSwap Community","email":"hello@apeswap.finance"},"license":"MIT","bugs":{"url":"https://github.com/ApeSwapFinance/apeswap-contracts/issues"},"homepage":"https://github.com/ApeSwapFinance/apeswap-contracts/","resolutions":{"ansi-regex":"^5.0.1","glob-parent":"^5.1.2","highlight.js":"^10.4.1","underscore":"^1.12.1","yargs-parser":"^5.0.1"},"devDependencies":{"@commitlint/cli":"^13.2.1","@commitlint/config-conventional":"^13.2.0","@nomiclabs/hardhat-truffle5":"^2.0.0","@nomiclabs/hardhat-web3":"^2.0.0","@openzeppelin/contracts":"^4.3.2","@openzeppelin/docs-utils":"^0.1.0","@openzeppelin/test-helpers":"^0.5.13","@truffle/abi-utils":"^0.2.3","chai":"^4.2.0","dotenv":"^10.0.0","eslint":"^6.5.1","eslint-config-standard":"^14.1.1","eslint-plugin-import":"^2.20.0","eslint-plugin-mocha-no-only":"^1.1.0","eslint-plugin-node":"^10.0.0","eslint-plugin-promise":"^4.2.1","eslint-plugin-standard":"^4.0.1","eth-sig-util":"^3.0.0","ethereumjs-util":"^7.0.7","ethereumjs-wallet":"^1.0.1","graphlib":"^2.1.8","hardhat":"^2.0.6","hardhat-gas-reporter":"^1.0.4","husky":"6.0.0","keccak256":"^1.0.2","lodash.startcase":"^4.4.0","lodash.zip":"^4.2.0","merkletreejs":"^0.2.13","micromatch":"^4.0.2","prettier":"^2.3.0","prettier-plugin-solidity":"^1.0.0-beta.16","rimraf":"^3.0.2","sol2uml":"^1.1.29","solc":"^0.8.3","solhint":"^3.3.6","solidity-ast":"^0.4.25","solidity-coverage":"^0.7.11","solidity-docgen":"^0.5.16","web3":"^1.3.0","yargs":"^16.2.0"},"dependencies":{},"gitHead":"1acfe2d75e7d30c3c3c86187522257522f043be4","_id":"@apeswap.finance/contracts@0.2.0","_nodeVersion":"16.0.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-lnit7cQ9ciytKESbGZm3YXwo7pzkFJyGd/1kAsLdYnQzRBAQntRr25GsXdSp+IBCOIpX5Rrje+oziysI0ic2kQ==","shasum":"f3ada35aed55babcbb907ba3e1805c6237be968d","tarball":"https://registry.npmjs.org/@apeswap.finance/contracts/-/contracts-0.2.0.tgz","fileCount":22,"unpackedSize":129427,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiDqIyACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo2iQ//Ug18a+bI0vRVy1skHr2sLY/mbOsacBbu7vW3cLW8aPDOXtLL\r\nwygERTWL22Z6HtTsWGOSqrx5SgVUMw4X6dU/pK4ZsSvomdtbnzss9LmoZKSR\r\nkSfr3ORzR0qEAGWmWMHpBITq2gmB4hTsDwhOmSdxgf8X0JX5knquVVoinHtY\r\nVgiqdFyz6Bd6tyeqDNCaFaPMZJ7+pZI7t3QUeLovPCl2qtkyoonQeMXkOqqp\r\nn+6mlg8DHO4KfR6wLoK2x3/CCRK6GXJHVZhS183ZVgBf6DknBppyh2sJosZt\r\nA13z/a1FBKhonFwg+rX4ksdhmi6kEfGiiISvOp7+lUFMJlCWhYtEkyyQycHM\r\nmeGW0h7Vp8XMMSXUuodM73IKp0hwxCFhlEkpwQK5ceRqc+xjSnoWSAd6JsXg\r\nnrRePL84zB7XRNrGi8RY0GSAEfA7HYIyOg75rYlkg4nmbEXd0hi3KKe5UTbK\r\nG4PHF2uoazKWstbMAM2nGtEZD7cig3UU41sCGx1IynsnUIIm+x4eohDR9fAJ\r\nDykH+g5canydcHSuVLiJyPLl4Nfg/DcxekUeumSPd2CAt5EbqsUwwEc5hyaA\r\nZf2cCMbc8tXaNH09RsUExkdbJW1/8rB8M3hYoOFy+qzA8ib7qmUuOQJZTecs\r\nLGUjxqVz67G1WvcxcWhYUykgHoSUstlMBL8=\r\n=knNO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC58OTz2T6eZ9ruovMXxzyKpaJXYgrNfITh9yjZY2NFjQIhAJOsWVIs2KayeHXh8Y+ZScS5JeVlwh16jj5NJgf/EYiv"}]},"_npmUser":{"name":"defifofum","email":"DeFiFoFum0@gmail.com"},"directories":{},"maintainers":[{"name":"defifofum","email":"DeFiFoFum0@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/contracts_0.2.0_1645126194037_0.40066776900528467"},"_hasShrinkwrap":false}},"time":{"created":"2022-02-17T19:29:53.965Z","0.2.0":"2022-02-17T19:29:54.192Z","modified":"2022-04-04T14:33:03.307Z"},"maintainers":[{"name":"defifofum","email":"DeFiFoFum0@gmail.com"}],"description":"A collection of smart contract tools and interfaces used by ApeSwap.","homepage":"https://github.com/ApeSwapFinance/apeswap-contracts/","keywords":["solidity","ethereum","smart","contracts","security","zeppelin"],"repository":{"type":"git","url":"git+https://github.com/ApeSwapFinance/apeswap-contracts.git"},"author":{"name":"ApeSwap Community","email":"hello@apeswap.finance"},"bugs":{"url":"https://github.com/ApeSwapFinance/apeswap-contracts/issues"},"license":"MIT","readme":" \n\n<img src=\"logo.svg\" alt=\"ApeSwap\" height=\"100px\">\n\n# ApeSwap Contracts \n\n**A collection of smart contract tools and interfaces used by ApeSwap..** \n\n## Features\n\n- **Factories**: Turn a contract into a factory using the contract address as an implementation with `Clones` or `TransparentUpgradeableProxy`\n\n- **Sweeper**: Sweep any ERC-20 or NFT locked in a contract with this utility.\n\n\n## Installation\n\n1. Create a GitHub [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)\n\n\n2. Create a `.npmrc` file at the root of this repo or at your $HOME dir and add the following lines, replacing `<NPM_TOKEN>` with yours\n\n```\n//npm.pkg.github.com/:_authToken=<NPM_TOKEN>\n@apeswapfinance:registry=https://npm.pkg.github.com\n```\n\n3. `yarn add @apeswapfinance/contracts` \n\n## Usage\n\nOnce installed, you can use the contracts in the library by importing them:\n\n```solidity\npragma solidity ^0.8.0;\n\nimport \"@apeswapfinance/contracts/utils/Sweeper\";\n\ncontract MyContract is Sweeper {\n    constructor(address[] lockedTokens) Sweeper(lockedTokens) {\n    }\n}\n```\n\n_If you're new to smart contract development, head to [Developing Smart Contracts](https://docs.openzeppelin.com/learn/developing-smart-contracts) to learn about creating a new project and compiling your contracts._\n\nTo keep your system secure, you should **always** use the installed code as-is, and neither copy-paste it from online sources, nor modify it yourself. The library is designed so that only the contracts and functions you use are deployed, so you don't need to worry about it needlessly increasing gas costs.\n\n\n## Contribute\n\nApeSwap Contracts exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the [contribution guide](CONTRIBUTING.md)!\n\n## License\n\nApeSwap Contracts is released under the [MIT License](LICENSE).\n","readmeFilename":"README.md"}