Reveel Protocol v2 Documentation
  • πŸš€Reveel Protocol - Introduction
  • 🏁Getting Started
    • Creating a Revenue Path
    • Adding Revenue Path Tiers
    • Viewing your Revenue Path
    • Withdrawing Funds
    • Revenue Path Dashboard
    • Updating your Revenue Path
    • Selecting a Network
  • βš—οΈProtocol Concepts
    • Tiers
    • Mutable Revenue Paths
    • Path Manager
    • Platform Fee
    • Meta Transactions
  • πŸ§‘β€πŸŒΎSDK
    • Overview
    • 1.0 React Hooks
    • 2.0 Async Javascript
    • 3.0 Data API
  • NFT Marketplace Integrations
    • Lens
    • Zora
    • Foundation
    • OpenSea
    • Manifold
    • Decent
    • Vol FM
  • ♾️Revenue Share Use Cases
    • Recoup Advance
    • Primary vs. Secondary Splits
    • Revenue Milestone
    • Cap Earnings
Powered by GitBook
On this page
  1. SDK

3.0 Data API

Previous2.0 Async JavascriptNextLens

Last updated 1 year ago

V2 Revenue Paths require an API Key provided by the R3VL team. This enables the SDK to authorize and communicate with the R3VL API which is responsible for storing Revenue Path configurations.

We store wallet and distribution share data in databases, reducing costs and gas consumption. Firebase is currently supported, with plans to add Polybase and other options. Actual data is stored externally, with a hash reference saved in the contract.

import { useR3vlClient } from "@r3vl/sdk/hooks";

useR3vlClient({
  chainId: chain?.id
  provider,
  signer,
  initV2Final: true, // In case you want to create a "complex" Revenue Path with tiers
  initSimple: true, // For revenue paths with no additional tiers configuration
  apiKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx',
  // Api key is required so SDK can store and access data related to Revenue Path configuration 
});

Request API Key .

πŸ§‘β€πŸŒΎ
here