Quests Protocol is a protocol to distribute token rewards for completing on-chain tasks.

• Quest Protocol
  • Documentation
  • Addresses
  • Contracts
  • Patterns
  • Install
  • Testing
  • Deployment
  • Upgrading
  • Audits
  • Bug Bounty
  • License

For more information on all docs related to the Quest Protocol, see the documentation directory here.

• Overview
• Quest Claim
• Quest Create

Mainnet, Optimism, Polygon, Arbitrum, Base and Sepolia:

The main contracts are:

• Quest Factory (code)
  • Creates new Quest instances of an NFT reward Quest or ERC-20 reward Quest.
• Quest (code)
  • A Quest in which the reward is an ERC-20 token
• QuestNFT (code)
  • A Quest in which the reward is a NFT
• Protocol Rewards (code)
  • An escrow like contract in which funds are deposited into account balances.

Contracts are layed out in the following order:

1. Use statements (i.e. using SafeTransferLib for address;)
2. Contract storage - we use upgradable architecture so pay special attention to preserving the order of contract storage, and only add to the end.
3. Contract constructors and initialization functions
4. Modifiers
5. External Update functions - anything that modifies contract state
6. External View Functions - self explanatory
7. Internal Update functions
8. Internal View functions

Interfaces should be used to hold the following:

1. Events
2. Errors
3. Structs

The contracts use two main patterns.

More reading here

More reading here

More reading here

yarn

yarn compile

yarn test

yarn test:coverage

yarn test:gas-stories

1. Deploy the ProxyAdmin forge script script/ProxyAdmin.s.sol:ProxyAdminDeploy --rpc-url sepolia --broadcast --verify -vvvv
2. Deploy QuestFactory (this also upgrades it to the latest version) forge script script/QuestFactory.s.sol:QuestFactoryDeploy --rpc-url sepolia --broadcast --verify -vvvv
3. Deploy RabbitHoleTickets (this also upgrades it to the latest version) forge script script/RabbitHoleTickets.s.sol:RabbitHoleTicketsDeploy --rpc-url sepolia --broadcast --verify -vvvv
4. Deploy Quest forge script script/Quest.s.sol:QuestDeploy --rpc-url sepolia --broadcast --verify -vvvv
5. Deploy Quest1155 forge script script/Quest.s.sol:Quest1155Deploy --rpc-url sepolia --broadcast --verify -vvvv
6. Set any storage variables manually if need be.

• checkout from sha ea60f723fadfb5f02edad862f56072c0c972cfc2

• checkout from sha fbc3c0fb7fdf13713314b996fa20a2551f9d591e

• checkout from sha 70a56a1567dcd9c4d6f7718388667c5e0564fb2f (must add in the deploy script manually)

then:

• yarn hardhat deploy --network network_name
• yarn hardhat --network network_name etherscan-verify --api-key etherscan_api_key

important: make sure storage layouts are compatible, by running the upgrades-core validate script on the contract you are upgrading, for example: forge clean && forge build && npx @openzeppelin/upgrades-core validate --contract RabbitHoleTickets

Then to upgrade a contract, run one of the following commands: forge script script/QuestFactory.s.sol:QuestFactoryUpgrade --rpc-url sepolia --broadcast --verify -vvvv forge script script/RabbitHoleTickets.s.sol:RabbitHoleTicketsUpgrade --rpc-url sepolia --broadcast --verify -vvvv forge script script/Quest.s.sol:QuestDeploy --rpc-url sepolia --broadcast --verify -vvvv forge script script/Quest.s.sol:Quest1155Deploy --rpc-url sepolia --broadcast --verify -vvvv

The following auditors reviewed the protocol.

• Code4rena (report here)

All contracts except tests, interfaces, dependencies are in scope and eligible for the Quest Protocol Bug Bounty program.

The rubric we use to determine bug bounties is as follows:

Any vulnerability or bug discovered must be reported only to the following email: security@rabbithole.gg.

The primary license for the Quest Protocol is the GNU General Public License 3.0 (GPL-3.0), see LICENSE.

Several interface/dependencies files from other sources maintain their original license (as indicated in their SPDX header). All files in test/ remain MIT (as indicated in their SPDX header).