@flaunch/sdk 0.3.1 → 0.4.0

package/README.md

@@ -7,10 +7,13 @@ A TypeScript SDK for seamless interaction with the Flaunch protocol and Uniswap
 
 ![Flaunch Header](https://raw.githubusercontent.com/flayerlabs/flaunch-sdk/refs/heads/master/.github/flaunch-header.png)
 
+_Note: Add this `llms-full.txt` file into Cursor IDE / LLMs to provide context about using the Flaunch SDK: [llms-full.txt](https://raw.githubusercontent.com/flayerlabs/flaunch-sdk/refs/heads/master/llms-full.txt)_
+
 ## Features
 
 - 🚀 Flaunch new memecoins
 - 💱 Buy and sell memecoins via Uniswap V4 hooks
+- 🏗️ Build your own token launchpads on top of the flaunch protocol
 - 📊 Read functions for token and pool data
 - 🔒 Built-in Permit2 support for gasless approvals
 - 🔵 Works on Base and Base Sepolia networks
@@ -25,6 +28,7 @@ A TypeScript SDK for seamless interaction with the Flaunch protocol and Uniswap
   - [Selling with Permit2](#selling-with-permit2)
   - [Flaunching a Memecoin](#flaunching-a-memecoin)
     - [How to generate Base64Image from file upload](#how-to-generate-base64image-from-user-uploaded-file)
+  - [Advanced Integration: Revenue Sharing with RevenueManager](#advanced-integration-revenue-sharing-with-revenuemanager)
   - [All SDK functions](#all-sdk-functions)
   - [React Hooks](#react-hooks)
 - [Flaunch Docs](#flaunch-reference)
@@ -263,6 +267,80 @@ const handleImageChange = useCallback(
 />;
 ```
 
+### Advanced Integration: Revenue Sharing with RevenueManager
+
+For platforms building on top of Flaunch, the `RevenueManager` contract enables sophisticated revenue-sharing models. It allows platforms to automatically take a protocol fee from the trading fees generated by memecoins launched through their integration.
+
+**Key Concepts:**
+
+1.  **Deployment & Initialization**: Before flaunching tokens via your platform, deploy an instance of your `RevenueManager` with your protocol fee and recipient address.
+
+```ts
+const revenueManagerInstanceAddress = await flaunchWrite.deployRevenueManager({
+  protocolRecipient: "0xabc...",
+  protocolFeePercent: 20, // 20% revenue share between protocol and 80% to coin creators (of the 1% swap fees)
+});
+```
+
+2.  **Flaunching Directly to Manager**: Instead of the creator receiving the Flaunch NFT, you'd flaunch the token directly into the `RevenueManager`. This automatically sets up the fee split.
+
+```ts
+await flaunchWrite.flaunchIPFSWithRevenueManager({
+  name: "...",
+  symbol: "...",
+  metadata: {
+    base64Image: "...",
+  },
+  pinataConfig: {
+    jwt: "...",
+  },
+  fairLaunchPercent: 40,
+  fairLaunchDuration: 30 * 60, // 30 mins
+  initialMarketCapUSD: 1_000,
+  creator: "0x...",
+  creatorFeeAllocationPercent: 100,
+  // **Note:** Specify your instance of the RevenueManager here
+  revenueManagerInstanceAddress: "...",
+});
+```
+
+3.  **Claiming Fees**: Creators can claim their share of earned fees, and the protocol can claim its share via the `RevenueManager` contract.
+
+```ts
+// check address' balance
+const balance = await flaunchRead.revenueManagerBalance({
+  revenueManagerAddress: revenueManagerInstanceAddress,
+  recipient: "0xabc...",
+});
+
+// protocol claim: the connected wallet must be the protocol recipient for the revenue manager
+await flaunchWrite.revenueManagerProtocolClaim({
+  revenueManagerAddress: revenueManagerInstanceAddress,
+});
+
+// creator claim: the connected wallet must be the coin's creator for them to claim their share
+await flaunchWrite.revenueManagerCreatorClaim({
+  revenueManagerAddress: revenueManagerInstanceAddress,
+});
+
+// creator claim: for specific flaunch token ids:
+await flaunchWrite.revenueManagerCreatorClaimForTokens({
+  revenueManagerAddress: revenueManagerInstanceAddress,
+  flaunchTokens: [
+    {
+      flaunch: FlaunchAddress[base.id],
+      tokenId: 5,
+    },
+    {
+      flaunch: FlaunchV1_1Address[base.id],
+      tokenId: 10,
+    },
+  ],
+});
+```
+
+Refer to the [RevenueManager Docs](https://docs.flaunch.gg/manager-types/revenuemanager) for detailed implementation guides and function references.
+
 ### All SDK functions
 
 For a list of all the functions in the SDK, refer to: [FlaunchSDK.ts](./src/sdk/FlaunchSDK.ts)