Overview
This page provides an overview of Boost Plugins, which are needed to offer incentives for interacting with smart contracts with Boost.xyz. It includes documentation about configuring boost plugins and other considerations related to development and deployment of boosts.
Table of Contents
- Overview
- Contact with Boost Team
- What is Boost.xyz?
- Videos
- What is the Relationship between Boost.xyz and RabbitHole.gg?
- ChatGPT Conversation
- Step 1: Set Up Your Project
- Step 2: Define the On-Chain Action
- Step 3: Deploy the Boost
- Additional Considerations
- Estimation of Additional Time or Work
Contact with Boost Team
I’ve been doing a lot of research into RabbitHole and Boost and am very interested in the services that you offer. I filled out the Airtable form to deploy Quests on Rabbithole and have a decent understanding of both projects, but have a few questions and would appreciate if you can answer:
1. If my team created a custom smart contract for ranked choice voting (using open source components from OpenZeppelin), then do we need to develop a Boost Plugin in order to run a Quest on RabbitHole?
- How much time and resources are typically required to develop a Boost Plugin?
- Is it possible to successfully incentivize 400-500 users to test my application within then next couple days?
- If so, how can I do this as quickly as possible?
Please let me know if you have any questions or if there is a better place to reach out with these questions. I’d be happy to share links to the app that I need to test, my team’s work, or provide any other details if you’d like. Thanks!
What is Boost.xyz?
Boost.xyz is a distributed incentive network designed to enable any wallet to deploy incentive offers targeting other wallets to perform specific on-chain actions. This platform facilitates the creation of "boosts," which are targeted incentives encouraging users to execute certain activities within the Ethereum network, such as token swaps, liquidity deposits, or NFT minting.
Key features of Boost.xyz include:
- Permissionless Deployment: Any user with a wallet can deploy a boost without needing permissions, making it highly accessible for broad usage.
- Customizable Actions: Users can define precise actions that need to be completed to receive rewards, tailoring boosts to specific needs or objectives.
- Targeted Audiences: Boost Manager allows users to create custom lists or select from preset lists to target specific groups, ensuring that boosts reach the intended audience.
- Real-Time Tracking: The platform includes tools for monitoring the performance of boosts in real-time, offering insights into engagement and effectiveness.
Users can start by setting their goals and targets, choosing an on-chain action, and configuring the parameters for their campaign. After defining their audience and depositing funds, they can deploy their boosts instantly, only paying for actual results.
For more detailed guidance on how to deploy and manage boosts on Boost.xyz, you can explore their official documentation: Boost Protocol Documentation
Videos
You can learn about Boost.xyz and Rabbithole.gg in the following video with the founder of boost.xyz.
What is the Relationship between Boost.xyz and RabbitHole.gg?
Boost.xyz and Rabbithole.gg have an integrated relationship, where Rabbithole controls the domain boost.xyz. This integration likely facilitates collaborative efforts or shared features between the two platforms, aligning them more closely in the Web3 and decentralized incentive ecosystem. This arrangement suggests that Rabbithole.gg may have a significant influence over or direct involvement in the operations of Boost.xyz, enabling them to coordinate on deploying incentive offers and managing on-chain actions effectively.
The platforms have merged functionalities, which were integrated into the Inbox platform by April, indicating a close operational relationship aimed at enhancing user engagement through task-driven incentives within the blockchain space. For further detailed exploration of Boost.xyz and its functionalities, you can visit their documentation and for Rabbithole.gg's related details, their official site provides comprehensive insights.
ChatGPT Conversation
Please create the code for a plugin on boost xyz. Use the following resources if its helpful.. also estimate any additional time or work required to make it work https://docs.boost.xyz/boost-protocol https://docs.boost.xyz/boost-protocol/user-guides/how-to-add-your-project https://docs.boost.xyz/boost-protocol/user-guides/how-to-deploy-a-boost/select-an-action https://docs.boost.xyz/boost-protocol/for-developers/boost-sdk-plugins
ChatGPT
Creating a plugin for Boost.xyz involves several steps, including setting up your project, defining the on-chain action you want to incentivize, and utilizing the Boost SDK for plugin integration. Here's a high-level overview of how you might code a basic plugin based on the resources from Boost.xyz:
Step 1: Set Up Your Project
You'll first need to set up your project environment:
javascriptCopy code
// Setup your project environment
const BoostSDK = require('@boost/boost-sdk');
// Initialize the SDK
const boostSDK = new BoostSDK({
apiKey: 'YOUR_API_KEY', // You need to replace 'YOUR_API_KEY' with your actual Boost API key
projectId: 'YOUR_PROJECT_ID' // Replace 'YOUR_PROJECT_ID' with your actual project ID
});
Step 2: Define the On-Chain Action
Define the specific on-chain action you want to boost. This could be anything from token swaps to NFT minting. For instance, let's say you want to boost a token swap on Uniswap:
javascriptCopy code
// Define an on-chain action
const action = {
type: 'swap', // The type of action to boost
parameters: {
tokenIn: 'ETH',
tokenOut: 'DAI',
platform: 'UniswapV2' // Specifying the platform where the action takes place
}
};
Step 3: Deploy the Boost
Deploy the boost using the configured action and the Boost SDK:
javascriptCopy code
// Deploy the boost
boostSDK.deployBoost({
action: action,
reward: { token: 'DAI', amount: 100 }, // Define the reward for completing the action
criteria: { minAmountIn: '0.1' } // Criteria for the action to qualify for a boost
})
.then(response => {
console.log('Boost deployed:', response);
})
.catch(error => {
console.error('Error deploying boost:', error);
});
Additional Considerations
- Testing: Before going live, test the plugin thoroughly to ensure it interacts correctly with the blockchain and the Boost.xyz ecosystem.
- Deployment: Consider the deployment environment and the gas fees associated with deploying the boost.
- Monitoring: Set up monitoring for the boost to track its usage and effectiveness.
Estimation of Additional Time or Work
- Development Time: Initial setup and coding could take a few days, depending on the complexity of the actions and the number of features you plan to include.
- Testing and Debugging: Allocate at least 1-2 weeks for thorough testing and debugging, particularly to ensure that the on-chain interactions are executed flawlessly.
- Deployment and Monitoring: Setting up the deployment and monitoring infrastructure could take a few additional days.
For detailed guidance and specific code snippets based on your project's requirements, please refer to the Boost Protocol documentation:
This sample gives you a basic framework. Be sure to tailor the code and the parameters according to the specific needs and conditions of your project.