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!

Permissionless vault creation — You can now create and deploy your own vaults and vault factories without any permission or registration. Vault factories no longer need to be registered in the VaultPortal before they can be used to launch tokens.

Work through the FlapVaultExample repository for a complete working example of a vault and vault factory implementation. It is the fastest way to understand the patterns you need to follow.

Once you have written your vault, use the FlapVaultSpecChecker AI toolkit to automatically verify that your implementation correctly follows the specification before deploying.

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

Next steps

• Review the Vault & VaultFactory specification to understand how to build your own vaults and vault factories

• Read the Flap Tax Vault documentation for an overview of the vault concept and VaultPortal integration

• Explore registered (i.e, verified by Flap) 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. Launch a token with a custom vault — You can launch a token and set the fund recipient wallet to your smart contract. If it follows the spec defined in the Vault & VaultFactory specification, its info will be automatically available on our website and partner websites. No registration is required.

2. Build a vault factory for others — If you have an idea to build a vault to be used by others, you can build a VaultFactoryBaseV2 and take a portion of the tax as a commission in each vault you create. Implement vaultDataSchema() so the UI can automatically render a launch form for your vault type. See the Vault & VaultFactory specification for full details.