@campnetwork/origin 1.2.0-3 → 1.2.0

package/README.md

@@ -15,8 +15,6 @@
 The Origin SDK currently exposes the following modules:
 
 - `"@campnetwork/origin"` - The main entry point for the SDK, exposes the following classes:
-  - `TwitterAPI` - For fetching user Twitter data from Origin
-  - `SpotifyAPI` - For fetching user Spotify data from Origin
   - `Auth` - For authenticating users with the Origin SDK (browser and Node.js)
   - Signer adapters and utilities for Node.js support (ethers, viem, custom signers)
   - Camp Network chain configurations (`campMainnet`, `campTestnet`)
@@ -45,229 +43,13 @@ The core modules can be imported either as a CommonJS module or as an ES6 module
 ### CommonJS
 
 ```js
-const { TwitterAPI, SpotifyAPI, Auth } = require("@campnetwork/origin");
+const { Auth } = require("@campnetwork/origin");
 ```
 
 ### ES6
 
 ```js
-import { TwitterAPI, SpotifyAPI, Auth } from "@campnetwork/origin";
-```
-
-## Socials
-
-### TwitterAPI
-
-The TwitterAPI class is the entry point for fetching user Twitter data from Origin. It requires an API key to be instantiated.
-
-**Note: The methods for fetching data will only return data for users who have authenticated to your app via the Origin SDK.**
-
-#### Constructor
-
-`apiKey` - The API key of your app.
-
-```js
-const twitter = new TwitterAPI({
-  apiKey: string,
-});
-```
-
-#### Methods
-
-##### fetchUserByUsername
-
-`fetchUserByUsername(twitterUserName: string)`
-
-```js
-const user = await twitter.fetchUserByUsername("jack");
-```
-
-##### fetchTweetsByUsername
-
-`fetchTweetsByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const tweets = await twitter.fetchTweetsByUsername("jack", 1, 10);
-```
-
-##### fetchFollowersByUsername
-
-`fetchFollowersByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const followers = await twitter.fetchFollowersByUsername("jack", 1, 10);
-```
-
-##### fetchFollowingByUsername
-
-`fetchFollowingByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const following = await twitter.fetchFollowingByUsername("jack", 1, 10);
-```
-
-##### fetchTweetById
-
-`fetchTweetById(tweetId: string)`
-
-```js
-const tweet = await twitter.fetchTweetById("1234567890");
-```
-
-##### fetchUserByWalletAddress
-
-`fetchUserByWalletAddress(walletAddress: string, page: number, limit: number)`
-
-```js
-const user = await twitter.fetchUserByWalletAddress("0x1234567890", 1, 10);
-```
-
-##### fetchRepostedByUsername
-
-`fetchRepostedByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const reposts = await twitter.fetchRepostedByUsername("jack", 1, 10);
-```
-
-##### fetchRepliesByUsername
-
-`fetchRepliesByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const replies = await twitter.fetchRepliesByUsername("jack", 1, 10);
-```
-
-##### fetchLikesByUsername
-
-`fetchLikesByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const likes = await twitter.fetchLikesByUsername("jack", 1, 10);
-```
-
-##### fetchFollowsByUsername
-
-`fetchFollowsByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const follows = await twitter.fetchFollowsByUsername("jack", 1, 10);
-```
-
-##### fetchViewedTweetsByUsername
-
-`fetchViewedTweetsByUsername(twitterUserName: string, page: number, limit: number)`
-
-```js
-const viewedTweets = await twitter.fetchViewedTweetsByUsername("jack", 1, 10);
-```
-
-### SpotifyAPI
-
-The SpotifyAPI class is the entry point for fetching user Spotify data from Origin. It requires an API key to be instantiated.
-
-**Note: The methods for fetching data will only return data for users who have authenticated to your app via the Origin SDK.**
-
-#### Constructor
-
-`apiKey` - The API key of your app.
-
-```js
-const spotify = new SpotifyAPI({
-  apiKey: string,
-});
-```
-
-#### Methods
-
-##### fetchSavedTracksById
-
-`fetchSavedTracksById(spotifyId: string)`
-
-```js
-const savedTracks = await spotify.fetchSavedTracksById("1234567890");
-```
-
-##### fetchPlayedTracksById
-
-`fetchPlayedTracksById(spotifyId: string)`
-
-```js
-const playedTracks = await spotify.fetchPlayedTracksById("1234567890");
-```
-
-##### fetchSavedAlbumsById
-
-`fetchSavedAlbumsById(spotifyId: string)`
-
-```js
-const savedAlbums = await spotify.fetchSavedAlbumsById("1234567890");
-```
-
-##### fetchSavedPlaylistsById
-
-`fetchSavedPlaylistsById(spotifyId: string)`
-
-```js
-const savedPlaylists = await spotify.fetchSavedPlaylistsById("1234567890");
-```
-
-##### fetchTracksInAlbum
-
-`fetchTracksInAlbum(spotifyId: string, albumId: string)`
-
-```js
-const tracks = await spotify.fetchTracksInAlbum("1234567890", "1234567890");
-```
-
-##### fetchTracksInPlaylist
-
-`fetchTracksInPlaylist(spotifyId: string, playlistId: string)`
-
-```js
-const tracks = await spotify.fetchTracksInPlaylist("1234567890", "1234567890");
-```
-
-##### fetchUserByWalletAddress
-
-`fetchUserByWalletAddress(walletAddress: string)`
-
-```js
-const user = await spotify.fetchUserByWalletAddress("0x1234567890");
-```
-
-### TikTokAPI
-
-The TikTokAPI class is the entry point for fetching user TikTok data from Origin. It requires an API key to be instantiated.
-
-**Note: The methods for fetching data will only return data for users who have authenticated to your app via the Origin SDK.**
-
-#### Constructor
-
-`apiKey` - The API key of your app.
-
-```js
-const tiktok = new TikTokAPI({
-  apiKey: string,
-});
-```
-
-#### Methods
-
-##### fetchUserByUsername
-
-`fetchUserByUsername(tiktokUserName: string)`
-
-```js
-const user = await tiktok.fetchUserByUsername("jack");
-```
-
-##### fetchVideoById
-
-`fetchVideoById(userHandle: string, videoId: string)`
-
-```js
-const video = await tiktok.fetchVideo("jack", "1234567890");
+import { Auth } from "@campnetwork/origin";
 ```
 
 ## Auth
@@ -276,11 +58,13 @@ The Auth class is the entry point for authenticating users with the Origin SDK.
 
 ### Constructor
 
-- `clientId` - The client ID of your app. This is required to authenticate users with the Origin SDK.
+- `clientId` - `string` - The client ID of your app. This is required to authenticate users with the Origin SDK.
 - `redirectUri` - The URI to redirect to after the user completes oauth for any of the socials. Defaults to `window.location.href`.
   The `redirectUri` can also be an object with the following optional properties:
   - `twitter` - The URI to redirect to after the user completes oauth for Twitter.
   - `spotify` - The URI to redirect to after the user completes oauth for Spotify.
+- `environment` - `string` - The environment to use. Can be either `DEVELOPMENT` or `PRODUCTION`. Defaults to `DEVELOPMENT`.
+- `baseParentId` - `bigint` - A valid tokenID to be used as the parent of all IPNFTs minted on your platform, making them all derivatives of your base asset.
 
 You may use the `redirectUri` object to redirect the user to different pages based on the social they are linking.
 You may only define the URIs for the socials you are using, the rest will default to `window.location.href`.
@@ -291,7 +75,6 @@ import { Auth } from "@campnetwork/origin";
 const auth = new Auth({
   clientId: string,
   redirectUri: string | object,
-  allowAnalytics: boolean,
 });
 ```
 
@@ -305,6 +88,13 @@ const auth = new Auth({
 });
 ```
 
+```js
+const auth = new Auth({
+  clientId: "your-client-id",
+  baseParentId: 123n,
+});
+```
+
 ### Methods
 
 #### connect
@@ -722,6 +512,7 @@ It can also take the following optional props:
 - `redirectUri` - `string | object` - Either a string that will be used as the redirect URI for all socials, or an object with the following optional properties: `twitter`, `spotify`. This is used to redirect the user to different pages after they have completed the OAuth flow for a social.
 - `environment` - `string` - The environment to use. Can be either `DEVELOPMENT` or `PRODUCTION`. Defaults to `DEVELOPMENT`.
 - - the `DEVELOPMENT` environment uses the Camp Testnet while the `PRODUCTION` environment uses the Camp Mainnet.
+- `baseParentId` - `string | bigint` - A valid tokenID to be used as the parent of all IPNFTs minted on your platform, making them all derivatives of your base asset.
 
 ```jsx
 import { CampProvider } from "@campnetwork/origin/react";
@@ -1263,6 +1054,32 @@ Call these methods as `await auth.origin.methodName(...)` after authenticating.
 
 ---
 
+# Advanced flows
+
+## App Revenue Share in Origin using derivatives
+
+You can enable app-level revenue sharing in **Origin** using the following setup:
+
+1. **Mint a base (genesis) IPNFT** for your platform and set its royalty percentage to whatever share you want the platform to receive. This can be done using the Origin UI, or the SDK.
+2. **Make all user-created IPNFTs derivatives** of this base IPNFT. There are two ways to do this:
+   - **Automatic (recommended):**
+     Set the `baseParentId` parameter on the `CampProvider` or `Auth` class (depending on your integration) to the tokenId of the base IPNFT.
+     → This automatically applies to _all mints_, including those made through the **Camp SDK Modal**.
+   - **Manual:**
+     If you’re using a custom mint flow, add the base IPNFT’s tokenId to the `parents` array before calling `origin.mintFile` or `origin.mintSocial`.
+     → Note: this does **not** affect mints made through the Camp SDK Modal.
+3. **Royalties flow automatically:**
+
+   The royalty percentage defined on the base IPNFT will be collected from every subscription to its derivative IPNFTs.
+
+4. **Claim your platform royalties:**
+
+   You can view and claim the accumulated platform royalties directly from your **Creator Dashboard** in the **Origin UI**.
+
+**Note:** Each IPNFT can have a maximum of 8 parents. Using one parent slot for app-level revenue sharing reduces the available slots for user-defined parent–derivative relationships to 7.
+
+---
+
 # Contributing
 
 Install the dependencies.