A collection of smart contract tools and interfaces used by ApeSwap..

• Factories: Turn a contract into a factory using the contract address as an implementation with Clones or TransparentUpgradeableProxy

• Sweeper: Sweep any ERC-20 or NFT locked in a contract with this utility.

yarn add @apeswap.finance/contracts

Once installed, you can use the contracts in the library by importing them:

pragma solidity ^0.8.0;

import "@apeswapfinance/contracts/utils/Sweeper";

contract MyContract is Sweeper {
    constructor(address[] lockedTokens) Sweeper(lockedTokens) {
    }
}

If you're new to smart contract development, head to Developing Smart Contracts to learn about creating a new project and compiling your contracts.

To 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.

ApeSwap Contracts exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the contribution guide!

ApeSwap Contracts is released under the MIT License.