DEPRECATION NOTICE

The contents of this repository are superseded by agoraxyz/generic-fee-collector-contract.
For the version that was used in production, check releases.

POAP fee collector smart contract

A smart contract for registering POAP events, their fees and vaults that collect the paid funds.

A detailed documentation of the contract can be found in the docs folder.

Setup

To run the project you need Node.js development environment.

Pull the repository from GitHub, then install its dependencies by executing this command:

npm install

Certain actions, like deploying to a public network or verifying source code on block explorers, need environment variables in a file named .env. See .env.example for more info.

Some additional steps before deployment

Open scripts/deploy-feecollector.ts. Notice the top four constants:

const guildFeeCollector = "0x..."; // The address that will receive Guild's share from the funds.
const guildSharex100 = 0; // The percentage of Guild's share multiplied by 100 (e.g 500 for a 5% cut).
const poapFeeCollector = "0x..."; // The address that will receive POAP's share from the funds.
const poapSharex100 = 0; // The percentage of POAP's share multiplied by 100 (e.g 500 for a 5% cut).

Edit them according to your needs.

Contract deployment

To deploy the smart contracts to a network, replace [networkName] with the name of the network and [scriptName] with the name of the script you wish to run in this command:

npx hardhat run scripts/[scriptName] --network [networkName]

Networks can be configured in hardhat.config.ts. We've preconfigured the following:

• hardhat (for local testing, default)
• ethereum (Ethereum Mainnet)
• goerli (Görli Ethereum Testnet)
• rinkeby (Rinkeby Ethereum Testnet)
• ropsten (Ropsten Ethereum Testnet)
• bsc (BNB Smart Chain)
• bsctest (BNB Smart Chain Testnet)
• polygon (Polygon Mainnet (formerly Matic))
• mumbai (Matic Mumbai Testnet)
• gnosis (Gnosis Chain (formerly xDai Chain))

Verification

For source code verification on block explorers, you can use the Etherscan plugin:

npx hardhat verify [contractAddress] [constructorArguments] --network [networkName]

Note: the contract's address and the constructor arguments are printed by the deploy script, so they can easily be copied to this command.

For more detailed instructions, check out the plugin's documentation here.

Linting

The project uses Solhint for Solidity smart contracts and ESLint for TypeScript files. To lint all files, simply execute:

npm run lint

To lint only the Solidity files:

npm run lint-contracts

To lint only the TypeScript files:

npm run lint-ts

Tests

To run the unit tests written for this project, execute this command in a terminal:

npm test

To run the unit tests only in a specific file, just append the path to the command. For example, to run tests just for FeeCollector:

npm test test/FeeCollector.spec.ts

Documentation

The documentation for the contracts is generated via the solidity-docgen package. Run the tool via the following command:

npm run docgen

The output can be found in the docs folder.