Quick start for Vault Developers

Welcome to the Vault Developers guide! This section will help you get started with developing and integrating with Flap's vault system.

Overview

Flap's vault system allows you to build a smart contract for managing and distributing BNB revenue generated from tax tokens. Vaults can be customized to fit various use cases, such as splitting revenue among multiple recipients or routing funds based on social proof, or funding a game treasury. The only limitation is your creativity!

Available vault types

Flap currently supports the following official vault types:

  1. Split Vault - Distributes BNB revenue across multiple recipients based on configurable basis points (percentage shares)

  2. Gift Vault (FlapXVault) - Routes revenue based on X (Twitter) proof verification with fallback to snowball buyback

Getting started

To work with vaults, you'll need:

  • Vault Factory Contract Address - The factory that creates and manages vault instances

  • Tax Token Address - The token for which you're managing fee distribution

  • Vault-specific parameters - Each vault type has its own configuration requirements

Next steps

  • Review the Flap Tax Vault documentation for general vault concepts and learn how to build your own vaults

  • Explore registered vaults in the Registered Vaults page to see available vault factories and their configuration schemas

  • Learn about the Gift Vault (FlapXVault) and how to integrate X proof-based revenue routing

Common workflows

  1. If you are only launching a token, you can launch a token and set the fund recipient wallet to your smart contract. If it follows the spec defined in The Vault Specification, its info will be automatically available on our website and partner websites.

  2. If you are a developer who has an idea to build a vault to be used by others, you can build a VaultFactory and take a portion of the tax as a commission in each vault you create. Please refer to the VaultFactory section for more details.

Last updated