@campnetwork/origin 1.2.0-0 → 1.2.0-2

package/README.md

@@ -1,1073 +1,1300 @@
-<p align="center">
-<img src="https://imgur.com/7nLZezD.png" height="200px"/>
-</p>
-<br/>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/@campnetwork/origin"><img src="https://img.shields.io/npm/v/@campnetwork/origin?style=for-the-badge" alt="npm version"/></a>
-  <img alt="GitHub License" src="https://img.shields.io/github/license/campaign-layer/camp-sdk?style=for-the-badge">
-  <img src="https://img.shields.io/npm/last-update/%40campnetwork%2Forigin?style=for-the-badge" alt="npm last update"/>
-  <img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/%40campnetwork%2Forigin?style=for-the-badge">
-</p>
-
-# Origin SDK
-
-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
-- `"@campnetwork/origin/react"` - Exposes the CampProvider and CampContext, as well as React components and hooks for authentication and fetching user data via Origin
-
-# Installation
-
-```bash
-npm install @campnetwork/origin
-```
-
-# Core
-
-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");
-```
-
-### 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");
-```
-
-## Auth
-
-The Auth class is the entry point for authenticating users with the Origin SDK. It requires a clientId to be instantiated.
-
-**Note: The Auth class is only to be used on the client side.**
-
-### Constructor
-
-- `clientId` - 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.
-
-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`.
-
-```js
-import { Auth } from "@campnetwork/origin";
-
-const auth = new Auth({
-  clientId: string,
-  redirectUri: string | object,
-  allowAnalytics: boolean,
-});
-```
-
-```js
-const auth = new Auth({
-  clientId: "your-client-id",
-  redirectUri: {
-    twitter: "https://your-website.com/twitter",
-    spotify: "https://your-website.com/spotify",
-  },
-});
-```
-
-### Methods
-
-#### connect
-
-`connect() => void`
-
-The `connect` method prompts the user to sign a message with their wallet in order to authenticate with the Origin SDK.
-The wallet provider can be set by calling the `setProvider` method on the Auth instance beforehand. The default provider used is `window.ethereum`.
-
-```js
-auth.connect();
-```
-
-#### disconnect
-
-`disconnect() => void`
-
-The `disconnect` method logs the user out of the Origin SDK on the client side.
-
-```js
-auth.disconnect();
-```
-
-#### setProvider
-
-`setProvider(provider: { provider: EIP1193Provider, info: EIP6963ProviderInfo, address?: string }) => void`
-
-_Read more about the [EIP1193Provider](https://eips.ethereum.org/EIPS/eip-1193) and [EIP6963ProviderInfo](https://eips.ethereum.org/EIPS/eip-6963) interfaces._
-
-The `setProvider` method sets the wallet provider to be used for authentication.
-
-```js
-auth.setProvider({
-  provider: window.ethereum,
-  info: { name: "MetaMask", icon: "https://..." },
-});
-```
-
-#### setWalletAddress
-
-`setWalletAddress(walletAddress: string) => void`
-
-The `setWalletAddress` method sets the wallet address to be used for authentication (via the `connect` method).
-
-**This is only needed if the provider does not support the `eth_requestAccounts` method. Only use this method if you are sure you need to set the wallet address manually.**
-
-```js
-auth.setWalletAddress("0x1234567890");
-```
-
-#### on
-
-`on(event: string, callback: (data: any) => void) => void`
-
-The `on` method listens for events emitted by the Auth module of the Origin SDK.
-
-The following events are emitted:
-
-##### "state"
-
-Possible states:
-
-- `authenticated` - The user has successfully authenticated.
-- `unauthenticated` - The user has been logged out.
-- `loading` - The user is in the process of authenticating.
-
-```js
-auth.on("state", (data) => {
-  console.log(data); // "authenticated" | "unauthenticated" | "loading"
-});
-```
-
-##### "provider"
-
-Returns the provider that has been set via the `setProvider` method.
-If using the Origin SDK React components, this event is emitted when the user selects a provider in the Auth modal.
-
-```js
-auth.on("provider", (data) => {
-  console.log(data); // { provider: EIP1193Provider, info: EIP6963ProviderInfo }
-});
-```
-
-##### "providers"
-
-Returns the list of providers that have been injected via EIP6963 and that the user can select from.
-
-```js
-auth.on("providers", (data) => {
-  console.log(data); // [{ provider: EIP1193Provider, info: EIP6963ProviderInfo }]
-});
-```
-
-You may use this event to update the UI with the available providers. The user can then select a provider to authenticate with, and the `setProvider` method can be called with the selected provider. The `connect` method can then be called to authenticate the user.
-
-```js
-auth.on("providers", (data) => {
-  // Update UI with providers
-  // User selects a provider
-  const selectedProvider = data[0];
-
-  auth.setProvider(selectedProvider);
-
-  auth.connect();
-});
-```
-
-#### off
-
-`off(event: string, callback: (data: any) => void) => void`
-
-The `off` method unsubscribes from events emitted by the Auth module of the Origin SDK.
-
-```js
-auth.off("state", callback);
-```
-
-#### getLinkedSocials
-
-`getLinkedSocials() => Promise<{ twitter: boolean, tiktok: boolean, spotify: boolean }>`
-
-The `getLinkedSocials` method returns a promise that resolves to an object containing the possible socials that the user can link and whether they are linked or not.
-
-```js
-const linkedSocials = await auth.getLinkedSocials();
-
-console.log(linkedSocials); // { twitter: true, tiktok: false, spotify: true }
-```
-
----
-
-After the user has authenticated, the following methods can be used to link and unlink social accounts.
-When linking a social account, the user will be redirected to the OAuth flow for that social platform.
-Afterwards, the user will be redirected back to the `redirectUri` specified in the Auth constructor.
-
-#### linkTwitter
-
-`linkTwitter() => void`
-
-The `linkTwitter` method redirects the user to the Twitter OAuth flow to link their Twitter account to Origin.
-
-```js
-auth.linkTwitter();
-```
-
-#### linkSpotify
-
-`linkSpotify() => void`
-
-The `linkSpotify` method redirects the user to the Spotify OAuth flow to link their Spotify account to Origin.
-
-```js
-auth.linkSpotify();
-```
-
-#### linkTikTok
-
-`linkTikTok(handle: string) => Promise<void>`
-
-The `linkTikTok` method links the provided TikTok handle to Origin.
-
-```js
-auth.linkTikTok("tiktokhandle");
-```
-
----
-
-#### unlinkTwitter
-
-`unlinkTwitter() => Promise<void>`
-
-The `unlinkTwitter` method unlinks the user's Twitter account from Origin.
-
-```js
-await auth.unlinkTwitter();
-```
-
-#### unlinkSpotify
-
-`unlinkSpotify() => Promise<void>`
-
-The `unlinkSpotify` method unlinks the user's Spotify account from Origin.
-
-```js
-await auth.unlinkSpotify();
-```
-
-#### unlinkTikTok
-
-`unlinkTikTok() => Promise<void>`
-
-The `unlinkTikTok` method unlinks the user's TikTok account from Origin.
-
-```js
-await auth.unlinkTikTok();
-```
-
-# React
-
-The React components and hooks can be imported as ES6 modules. The example below shows how to set up the `CampProvider` component and subsequently use the provided hooks and components.
-
-```js
-// main.jsx
-import { StrictMode } from "react";
-import { createRoot } from "react-dom/client";
-import { CampProvider } from "@campnetwork/origin/react";
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-import App from "./App.jsx";
-
-const queryClient = new QueryClient();
-
-createRoot(document.getElementById("root")).render(
-  <StrictMode>
-    <QueryClientProvider client={queryClient}>
-      <CampProvider clientId="your-client-id">
-        <App />
-      </CampProvider>
-    </QueryClientProvider>
-  </StrictMode>
-);
-```
-
-## CampProvider
-
-The `CampProvider` component requires a `clientId` prop to be passed in order link the users to your app.
-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.
-
-```jsx
-import { CampProvider } from "@campnetwork/origin/react";
-// ...
-function App() {
-  return (
-    <CampProvider
-      clientId="your-client-id"
-      redirectUri="https://your-website.com"
-      environment="DEVELOPMENT"
-    >
-      <div>Your app</div>
-    </CampProvider>
-  );
-}
-```
-
-Or, with an object for the `redirectUri`:
-
-```jsx
-import { CampProvider } from "@campnetwork/origin/react";
-// ...
-function App() {
-  return (
-    <CampProvider
-      clientId="your-client-id"
-      redirectUri={{
-        twitter: "https://your-website.com/twitter",
-        spotify: "https://your-website.com/spotify",
-      }}
-      environment="DEVELOPMENT"
-    >
-      <div>Your app</div>
-    </CampProvider>
-  );
-}
-```
-
-The `CampProvider` component sets up the context for the Origin SDK and provides the Auth instance to the rest of the app.
-
-## CampModal
-
-![@campnetwork/origin](https://imgur.com/AFmorL4.png)
-
-The **CampModal** is a one-line\* solution for authenticating users with the Origin SDK. It can be used to connect users to Origin, link and unlink social accounts, mint IPNFTs, and view the user's Origin stats.
-
-It works as follows:
-
-The **CampModal** component displays a button with the text "**Connect**" that the user can click on in order to summon the modal. The modal shows a list of available providers that the user can select from. After a provider has been selected, the `connect` method is called on the Auth instance to authenticate the user.
-
-If the user is already authenticated, the button will instead say "**My Origin**" and the modal will display the user's Origin profile information and allow them to link and unlink social accounts.
-
-The **CampModal** can take the following props:
-
-- `wcProjectId` - `string` - The WalletConnect project ID to use for authentication. Allows the users to authenticate via WalletConnect.
-- `injectButton` - `boolean` - Whether to inject the button into the DOM or not. Defaults to `true`. If set to `false`, the button will not be rendered and the modal can be opened programmatically via the `openModal` function returned by the `useModal` hook.
-- `onlyWagmi` - `boolean` - Whether to only show the provider that the user is currently authenticated with. Defaults to `false`.
-- `defaultProvider` - `{ provider: EIP1193Provider, info: EIP6963ProviderInfo, exclusive: boolean }` - Custom provider to set as the highlighted provider in the modal. If not set, the wagmi provider will be highlighted if it is available. The `exclusive` property can be set to `true` to only show this provider in the modal.
-
-### Usage
-
-Basic usage of the **CampModal** component:
-
-```jsx
-import { CampModal } from "@campnetwork/origin/react";
-
-function App() {
-  return (
-    <div>
-      <CampModal />
-    </div>
-  );
-}
-```
-
-With custom props:
-
-```jsx
-import { CampModal } from "@campnetwork/origin/react";
-
-function App() {
-  return (
-    <div>
-      <CampModal
-        wcProjectId="your-wc-project-id"
-        defaultProvider={{
-          provider: window.ethereum,
-          info: { name: "MetaMask", icon: "https://..." },
-          exclusive: false,
-        }}
-      />
-    </div>
-  );
-}
-```
-
-You can find more [examples here](./examples/client-side/react/providers-configuration).
-
-Only show the provider that the user is currently authenticated with (if using wagmi):
-
-```jsx
-import { CampModal } from "@campnetwork/origin/react";
-
-function App() {
-  return (
-    <div>
-      <CampModal onlyWagmi />
-    </div>
-  );
-}
-```
-
-Users can be authenticated either via the Camp Modal as outlined above or programmatically by calling the `connect` method on the Auth instance.
-
-### Usage with third party providers (Privy, Appkit, Magic, etc.)
-
-The Camp Modal can be used in conjunction with providers such as Privy and Appkit to create a seamless authentication experience for users. When using wagmi, it will automatically detect if the user is authenticated via a third party provider and give them the option to connect to Origin using that provider. Otherwise, you can set up the default provider to be whatever provider you are using.
-
-[Example usage with Privy](./examples/client-side/react/privy-connector/)
-
-[Example usage with Appkit](./examples/client-side/react/appkit-connector/)
-
-[Example usage with magic.link](./examples/client-side/react/magic-link-connector/)
-
-After the user has authenticated, you can use the provided hooks to fetch user data and listen for events.
-
-## LinkButton
-
-The **LinkButton** component is a button that can be used to link and unlink social accounts. Under the hood it uses the `useLinkModal` hook to open the Link Socials modal.
-
-The **LinkButton** can take the following props:
-
-- `social` - `string` - The social account to link or unlink. Can be one of: `twitter`, `tiktok`, `spotify`.
-- `variant` - `string` - The variant of the button. Can be one of: `default`, `icon`. Defaults to `default`.
-- `theme` - `string` - The theme of the button. Can be one of: `default`, `camp`. Defaults to `default`.
-
-**Note: The `<CampModal/>` component must be rendered in the component tree for the buttons to work.**
-
-### Usage
-
-Basic usage of the **LinkButton** component:
-
-```jsx
-import { LinkButton, CampModal } from "@campnetwork/origin/react";
-
-function App() {
-  return (
-    <div>
-      <CampModal />
-      <LinkButton social="twitter" />
-      <LinkButton social="spotify" theme="camp" />
-      <LinkButton social="tiktok" variant="icon" theme="camp" />
-    </div>
-  );
-}
-```
-
-## CampButton
-
-The **CampButton** component allows you to render a button that opens the Auth or My Origin modal when clicked. It can be used as an alternative to the button that is injected by the **CampModal** component. It allows you to have multiple buttons in your app that open the modal, or to have the button in a different location than where the **CampModal** component is rendered.
-
-```jsx
-import { CampButton, CampModal } from "@campnetwork/origin/react";
-
-function App() {
-  return (
-    <div>
-      <CampModal injectButton={false} />
-      <CampButton />
-    </div>
-  );
-}
-```
-
-## Hooks
-
-### useAuth
-
-The `useAuth` hook returns the instance of the Auth class that is provided by the CampProvider.
-It can be used as outlined in the Core section in order to build custom authentication flows, listen for events, and fetch user data.
-
-```jsx
-import { useAuth } from "@campnetwork/origin/react";
-
-function App() {
-  const auth = useAuth();
-
-  return (
-    <div>
-      <button onClick={auth.connect}>Connect</button>
-    </div>
-  );
-}
-```
-
-### useAuthState
-
-The `useAuthState` hook returns the current authentication state of the user.
-
-```jsx
-import { useAuthState } from "@campnetwork/origin/react";
-
-function App() {
-  const { authenticated, loading } = useAuthState();
-
-  return (
-    <div>
-      {loading && <div>Loading...</div>}
-      {authenticated && <div>Authenticated</div>}
-    </div>
-  );
-}
-```
-
-### useProvider
-
-The `useProvider` hook returns the provider that has been set via the `setProvider` method, as well as a `setProvider` function that can be used to update the provider.
-
-```jsx
-import { useProvider } from "@campnetwork/origin/react";
-
-function App() {
-  const { provider, setProvider } = useProvider();
-
-  return (
-    <div>
-      <div>Current provider: {provider.info.name}</div>
-      <button
-        onClick={() =>
-          setProvider({ provider: window.ethereum, info: { name: "Metamask" } })
-        }
-      >
-        Set Provider
-      </button>
-    </div>
-  );
-}
-```
-
-### useProviders
-
-The `useProviders` hook returns the list of providers that have been injected via EIP6963 and that the user or app can select from.
-
-```jsx
-import { useProviders, useProvider } from "@campnetwork/origin/react";
-
-function App() {
-  const providers = useProviders();
-  const { setProvider } = useProvider();
-
-  return (
-    <div>
-      {providers.map((provider) => (
-        <button key={provider.info.name} onClick={() => setProvider(provider)}>
-          {provider.info.name}
-        </button>
-      ))}
-    </div>
-  );
-}
-```
-
-### useConnect
-
-The `useConnect` hook returns functions that can be used to connect and disconnect the user.
-
-```jsx
-import { useConnect, useAuthState } from "@campnetwork/origin/react";
-
-function App() {
-  const { connect, disconnect } = useConnect();
-  const { authenticated } = useAuthState();
-
-  return (
-    <div>
-      {authenticated ? (
-        <button onClick={disconnect}>Disconnect</button>
-      ) : (
-        <button onClick={connect}>Connect</button>
-      )}
-    </div>
-  );
-}
-```
-
-### useSocials
-
-The `useSocials` hook returns the state of the user's linked social accounts.
-
-```jsx
-import { useSocials } from "@campnetwork/origin/react";
-
-function App() {
-  const { data, error, isLoading } = useSocials();
-
-  if (loading) return <div>Loading...</div>;
-  if (error) return <div>Error: {error.message}</div>;
-
-  return (
-    <div>
-      <div>Twitter: {data.twitter ? "Linked" : "Not linked"}</div>
-      <div>Tiktok: {data.tiktok ? "Linked" : "Not linked"}</div>
-      <div>Spotify: {data.spotify ? "Linked" : "Not linked"}</div>
-    </div>
-  );
-}
-```
-
-### useLinkSocials
-
-The `useLinkSocials` hook returns functions that can be used to link and unlink social accounts.
-
-```jsx
-import { useLinkSocials } from "@campnetwork/origin/react";
-
-function App() {
-  const {
-    linkTwitter,
-    linkSpotify,
-    linkTiktok,
-    unlinkTwitter,
-    unlinkSpotify,
-    unlinkTiktok,
-  } = useLinkSocials();
-
-  return (
-    <div>
-      <button onClick={linkTwitter}>Link Twitter</button>
-      <button onClick={linkSpotify}>Link Spotify</button>
-      <button onClick={() => linkTiktok("tiktokhandle")}>Link TikTok</button>
-      </button>
-      <button onClick={unlinkTwitter}>Unlink Twitter</button>
-      <button onClick={unlinkTiktok}>Unlink TikTok</button>
-      <button onClick={unlinkSpotify}>Unlink Spotify</button>
-    </div>
-  );
-}
-```
-
-### useModal
-
-The `useModal` hook returns the state of the Auth and My Origin modals, as well as functions to show and hide them.
-
-**Note: The `<CampModal/>` component must be rendered in the component tree for the modals to be displayed.**
-
-```jsx
-import { useModal, CampModal } from "@campnetwork/origin/react";
-
-function App() {
-  const { isOpen, openModal, closeModal } = useModal();
-
-  return (
-    <div>
-      <button onClick={openModal}>Open Modal</button>
-      <button onClick={closeModal}>Close Modal</button>
-      <CampModal injectButton={false} />
-    </div>
-  );
-}
-```
-
-The state and functions returned by the `useModal` hook can be used to show and hide the Auth and My Origin modals, as well as to check if they are currently open. The modal being controlled is dictated by the user's authentication state.
-
-### useLinkModal
-
-The `useLinkModal` hook returns the state of the Link Socials modal, as well as functions to show and hide it.
-
-**Note: The `<CampModal/>` component must be rendered in the component tree for the modal to be displayed.**
-
-```jsx
-import { useLinkModal, CampModal } from "@campnetwork/origin/react";
-
-function App() {
-  const { isLinkingOpen, openTwitterModal } = useLinkModal();
-
-  return (
-    <div>
-      <CampModal />
-      <button onClick={openTwitterModal}>Link Twitter</button>
-    </div>
-  );
-}
-```
-
-It returns the following properties and functions:
-
-- `isLinkingOpen` - `boolean` - Whether the Link Socials modal is open or not.
-- `openTwitterModal` - `() => void`
-- `openSpotifyModal` - `() => void`
-- `openTiktokModal` - `() => void`
-- `linkTwitter` - `() => void`
-- `linkSpotify` - `() => void`
-- `linkTiktok` - `() => void`
-- `linkTelegram` - `() => void`
-- `unlinkTwitter` - `() => void`
-- `unlinkSpotify` - `() => void`
-- `unlinkTiktok` - `() => void`
-- `closeModal` - `() => void`
-
-The difference between the `openXModal` functions and the `linkX / unlinkX` functions is that the former opens the modal regardless of the user's linking state, allowing them to either link or unlink their account, while the latter only opens the specified modal if the user's linking state allows for it.
-
-For example, if the user is linked to Twitter, calling `openTwitterModal` will open the modal to _unlink_ their Twitter account, while calling `linkTwitter` will not do anything, and calling `unlinkTwitter` will open the modal to unlink their Twitter account.
-
-## Origin Methods (`auth.origin`)
-
-The `Origin` class provides blockchain and API methods for interacting with Origin IpNFTs, uploading files, managing user stats, and more. Access these via `auth.origin` after authentication.
-
-### Types
-
-#### `LicenseTerms`
-
-The license terms object used in minting and updating methods:
-
-```typescript
-type LicenseTerms = {
-  price: bigint; // Price in wei
-  duration: number; // Duration in seconds
-  royaltyBps: number; // Royalty in basis points (1-10000)
-  paymentToken: Address; // Payment token address (address(0) for native currency)
-};
-```
-
-### Minting Constraints
-
-When minting or updating an IpNFT, the following constraints apply to the `LicenseTerms`:
-
-- The price must be at least `1000000000000000` wei (0.001 $CAMP).
-- The royaltyBps must be between `1` and `10000` (0.01% to 100%).
-- The duration must be between `86400` seconds and `2628000` seconds (1 day to 30 days).
-
-### File Upload & Minting
-
-#### `mintFile(file, metadata, license, parents?, options?)`
-
-Uploads a file and mints an IpNFT for it.
-
-- `file`: File to upload and mint
-- `metadata`: Additional metadata for the IpNFT
-  - `name`: Name of the IpNFT
-  - `description`: Description of the IpNFT
-  - `image`: Optional image URL for the IpNFT
-  - `attributes`: Optional array of attributes
-- `license`: LicenseTerms object
-- `parents`: Optional array of parent token IDs for derivatives
-- `options.progressCallback`: Optional progress callback
-- **Returns:** Minted token ID as a string, or throws on failure
-
-#### `mintSocial(source, metadata, license)`
-
-Mints an IpNFT for a connected social account.
-
-- `source`: Social platform (`"spotify" | "twitter" | "tiktok"`)
-- `metadata`: Additional metadata for the IpNFT
-- `license`: LicenseTerms object
-- **Returns:** Minted token ID as a string, or throws on failure
-
-### IpNFT & Marketplace Methods
-
-Most methods mirror smart contract functions and require appropriate permissions.
-
-#### Core IpNFT Methods
-
-- `mintWithSignature(account, tokenId, parents, creatorContentHash, uri, license, deadline, signature)`
-- `registerIpNFT(source, deadline, license, metadata, fileKey?, parents?)`
-- `updateTerms(tokenId, license)`
-- `finalizeDelete(tokenId)`
-- `getOrCreateRoyaltyVault(tokenId)`
-- `getTerms(tokenId)`
-- `ownerOf(tokenId)`
-- `balanceOf(owner)`
-- `tokenURI(tokenId)`
-- `dataStatus(tokenId)`
-- `isApprovedForAll(owner, operator)`
-- `transferFrom(from, to, tokenId)`
-- `safeTransferFrom(from, to, tokenId)`
-- `approve(to, tokenId)`
-- `setApprovalForAll(operator, approved)`
-
-#### Marketplace Methods
-
-- `buyAccess(buyer, tokenId, expectedPrice, expectedDuration, expectedPaymentToken, value?)`
-- `hasAccess(tokenId, user)`
-- `subscriptionExpiry(tokenId, user)`
-
-#### Utility & Royalty Methods
-
-- `getRoyalties(token?, owner?)` — Get royalty vault and balance
-- `claimRoyalties(token?, owner?)` — Claim royalties
-
-#### Smart Access & Data
-
-- `buyAccessSmart(tokenId)` — Buys access, handles payment approval and license details - **Recommended in place of buyAccess**
-- `getData(tokenId)` — Fetches the underlying IP for a given IPNFT if the user has purchased access to it
-
-### User Data & Stats
-
-- `getOriginUploads()` — Fetch user's Origin file uploads (returns array or null)
-- `getOriginUsage()` — Fetch user's Origin stats (returns object with multiplier, points, active, teams, dataSources)
-- `setOriginConsent(consent: boolean)` — Set user's consent for Origin usage
-
-### Utility Methods
-
-- `getJwt()` — Get current JWT token
-- `setViemClient(client)` — Set viem wallet client for blockchain interactions
-
----
-
-Call these methods as `await auth.origin.methodName(...)` after authenticating. See inline code documentation for full details and parameter types.
-
----
-
-# Contributing
-
-Install the dependencies.
-
-```bash
-npm install
-```
-
-Build the SDK.
-
-```bash
-npm run build
-```
-
-This will generate the SDK in the `dist` folder.
-
-You can also run the following command to watch for changes and rebuild the SDK automatically:
-
-```bash
-npm run dev
-```
-
-In order to use the sdk in a local project, you can link the sdk to the project.
-
-```bash
-npm link .
-```
-
-Then, in the project you want to use the sdk in, run:
-
-```bash
-npm link @campnetwork/origin
-```
-
-This will link the local sdk to the project.
+<p align="center">
+<img src="https://imgur.com/7nLZezD.png" height="200px"/>
+</p>
+<br/>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@campnetwork/origin"><img src="https://img.shields.io/npm/v/@campnetwork/origin?style=for-the-badge" alt="npm version"/></a>
+  <img alt="GitHub License" src="https://img.shields.io/github/license/campaign-layer/camp-sdk?style=for-the-badge">
+  <img src="https://img.shields.io/npm/last-update/%40campnetwork%2Forigin?style=for-the-badge" alt="npm last update"/>
+  <img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/%40campnetwork%2Forigin?style=for-the-badge">
+</p>
+
+# Origin SDK
+
+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`)
+  - Origin utilities (`createLicenseTerms`, `LicenseTerms`, `DataStatus`)
+- `"@campnetwork/origin/react"` - Exposes the CampProvider and CampContext, as well as React components and hooks for authentication and fetching user data via Origin
+
+## Features
+
+- 🌐 **Browser & Node.js Support** - Use in client-side and server-side applications
+- 🔐 **Multiple Signer Types** - Works with ethers, viem, or custom signers
+- 🔗 **Social Account Linking** - Connect Twitter, Spotify, Discord, TikTok, and Telegram
+- ⚛️ **React Components** - Pre-built UI components and hooks
+- 📦 **TypeScript Support** - Full type definitions included
+- 🛠️ **Flexible Storage** - Custom storage adapters for session persistence
+
+# Installation
+
+```bash
+npm install @campnetwork/origin
+```
+
+# Core
+
+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");
+```
+
+### 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");
+```
+
+## Auth
+
+The Auth class is the entry point for authenticating users with the Origin SDK. It requires a clientId to be instantiated.
+
+**Note: The Auth class is only to be used on the client side.**
+
+### Constructor
+
+- `clientId` - 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.
+
+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`.
+
+```js
+import { Auth } from "@campnetwork/origin";
+
+const auth = new Auth({
+  clientId: string,
+  redirectUri: string | object,
+  allowAnalytics: boolean,
+});
+```
+
+```js
+const auth = new Auth({
+  clientId: "your-client-id",
+  redirectUri: {
+    twitter: "https://your-website.com/twitter",
+    spotify: "https://your-website.com/spotify",
+  },
+});
+```
+
+### Methods
+
+#### connect
+
+`connect() => void`
+
+The `connect` method prompts the user to sign a message with their wallet in order to authenticate with the Origin SDK.
+The wallet provider can be set by calling the `setProvider` method on the Auth instance beforehand. The default provider used is `window.ethereum`.
+
+```js
+auth.connect();
+```
+
+#### disconnect
+
+`disconnect() => void`
+
+The `disconnect` method logs the user out of the Origin SDK on the client side.
+
+```js
+auth.disconnect();
+```
+
+#### setProvider
+
+`setProvider(provider: { provider: EIP1193Provider, info: EIP6963ProviderInfo, address?: string }) => void`
+
+_Read more about the [EIP1193Provider](https://eips.ethereum.org/EIPS/eip-1193) and [EIP6963ProviderInfo](https://eips.ethereum.org/EIPS/eip-6963) interfaces._
+
+The `setProvider` method sets the wallet provider to be used for authentication.
+
+```js
+auth.setProvider({
+  provider: window.ethereum,
+  info: { name: "MetaMask", icon: "https://..." },
+});
+```
+
+#### setWalletAddress
+
+`setWalletAddress(walletAddress: string) => void`
+
+The `setWalletAddress` method sets the wallet address to be used for authentication (via the `connect` method).
+
+**This is only needed if the provider does not support the `eth_requestAccounts` method. Only use this method if you are sure you need to set the wallet address manually.**
+
+```js
+auth.setWalletAddress("0x1234567890");
+```
+
+#### on
+
+`on(event: string, callback: (data: any) => void) => void`
+
+The `on` method listens for events emitted by the Auth module of the Origin SDK.
+
+The following events are emitted:
+
+##### "state"
+
+Possible states:
+
+- `authenticated` - The user has successfully authenticated.
+- `unauthenticated` - The user has been logged out.
+- `loading` - The user is in the process of authenticating.
+
+```js
+auth.on("state", (data) => {
+  console.log(data); // "authenticated" | "unauthenticated" | "loading"
+});
+```
+
+##### "provider"
+
+Returns the provider that has been set via the `setProvider` method.
+If using the Origin SDK React components, this event is emitted when the user selects a provider in the Auth modal.
+
+```js
+auth.on("provider", (data) => {
+  console.log(data); // { provider: EIP1193Provider, info: EIP6963ProviderInfo }
+});
+```
+
+##### "providers"
+
+Returns the list of providers that have been injected via EIP6963 and that the user can select from.
+
+```js
+auth.on("providers", (data) => {
+  console.log(data); // [{ provider: EIP1193Provider, info: EIP6963ProviderInfo }]
+});
+```
+
+You may use this event to update the UI with the available providers. The user can then select a provider to authenticate with, and the `setProvider` method can be called with the selected provider. The `connect` method can then be called to authenticate the user.
+
+```js
+auth.on("providers", (data) => {
+  // Update UI with providers
+  // User selects a provider
+  const selectedProvider = data[0];
+
+  auth.setProvider(selectedProvider);
+
+  auth.connect();
+});
+```
+
+#### off
+
+`off(event: string, callback: (data: any) => void) => void`
+
+The `off` method unsubscribes from events emitted by the Auth module of the Origin SDK.
+
+```js
+auth.off("state", callback);
+```
+
+#### getLinkedSocials
+
+`getLinkedSocials() => Promise<{ twitter: boolean, tiktok: boolean, spotify: boolean }>`
+
+The `getLinkedSocials` method returns a promise that resolves to an object containing the possible socials that the user can link and whether they are linked or not.
+
+```js
+const linkedSocials = await auth.getLinkedSocials();
+
+console.log(linkedSocials); // { twitter: true, tiktok: false, spotify: true }
+```
+
+---
+
+After the user has authenticated, the following methods can be used to link and unlink social accounts.
+When linking a social account, the user will be redirected to the OAuth flow for that social platform.
+Afterwards, the user will be redirected back to the `redirectUri` specified in the Auth constructor.
+
+#### linkTwitter
+
+`linkTwitter() => void`
+
+The `linkTwitter` method redirects the user to the Twitter OAuth flow to link their Twitter account to Origin.
+
+```js
+auth.linkTwitter();
+```
+
+#### linkSpotify
+
+`linkSpotify() => void`
+
+The `linkSpotify` method redirects the user to the Spotify OAuth flow to link their Spotify account to Origin.
+
+```js
+auth.linkSpotify();
+```
+
+#### linkTikTok
+
+`linkTikTok(handle: string) => Promise<void>`
+
+The `linkTikTok` method links the provided TikTok handle to Origin.
+
+```js
+auth.linkTikTok("tiktokhandle");
+```
+
+---
+
+#### unlinkTwitter
+
+`unlinkTwitter() => Promise<void>`
+
+The `unlinkTwitter` method unlinks the user's Twitter account from Origin.
+
+```js
+await auth.unlinkTwitter();
+```
+
+#### unlinkSpotify
+
+`unlinkSpotify() => Promise<void>`
+
+The `unlinkSpotify` method unlinks the user's Spotify account from Origin.
+
+```js
+await auth.unlinkSpotify();
+```
+
+#### unlinkTikTok
+
+`unlinkTikTok() => Promise<void>`
+
+The `unlinkTikTok` method unlinks the user's TikTok account from Origin.
+
+```js
+await auth.unlinkTikTok();
+```
+
+## Node.js Support
+
+The Origin SDK supports Node.js environments, allowing you to authenticate and interact with Origin using server-side signers like ethers or viem.
+
+### Installation for Node.js
+
+```bash
+# With ethers
+npm install @campnetwork/origin ethers
+
+# With viem
+npm install @campnetwork/origin viem
+```
+
+### Key Differences from Browser Usage
+
+1. **No Browser Provider Detection**: In Node.js, you explicitly provide a signer instead of detecting browser wallets
+2. **Storage**: By default, Node.js uses in-memory storage (not persisted). You can provide a custom storage adapter
+3. **OAuth Social Linking**: Social account linking requires browser environment for OAuth flow
+4. **SIWE Domain/URI**: You must provide domain and URI for SIWE messages
+
+### Using with ethers
+
+```js
+import { Auth, campMainnet } from "@campnetwork/origin";
+import { ethers } from "ethers";
+
+// Setup ethers provider and signer
+const provider = new ethers.JsonRpcProvider(
+  process.env.RPC_URL || campMainnet.rpcUrls.default.http[0]
+);
+const signer = new ethers.Wallet(process.env.PRIVATE_KEY, provider);
+
+// Create Auth instance
+const auth = new Auth({
+  clientId: process.env.CLIENT_ID,
+  redirectUri: "https://myapp.com/callback",
+  environment: "PRODUCTION",
+});
+
+// Connect using ethers signer
+const result = await auth.connectWithSigner(signer, {
+  domain: "myapp.com",
+  uri: "https://myapp.com",
+});
+
+console.log("Connected!", result.walletAddress);
+
+// Use origin methods
+if (auth.origin) {
+  const terms = await auth.origin.getTerms(tokenId);
+  console.log("Terms:", terms);
+}
+```
+
+### Using with viem
+
+```js
+import { Auth, createNodeWalletClient, campMainnet } from "@campnetwork/origin";
+import { privateKeyToAccount } from "viem/accounts";
+
+// Create viem account from private key
+const account = privateKeyToAccount(process.env.PRIVATE_KEY);
+
+// Create wallet client for Node.js using Camp Network chain
+const client = createNodeWalletClient(
+  account,
+  campMainnet,
+  process.env.RPC_URL || campMainnet.rpcUrls.default.http[0]
+);
+
+// Create Auth instance
+const auth = new Auth({
+  clientId: process.env.CLIENT_ID,
+  redirectUri: "https://myapp.com/callback",
+  environment: "PRODUCTION",
+});
+
+// Connect using viem client
+await auth.connectWithSigner(client, {
+  domain: "myapp.com",
+  uri: "https://myapp.com",
+});
+
+console.log("Authenticated:", auth.isAuthenticated);
+```
+
+### Exported Chain Configurations
+
+The SDK exports Camp Network chain configurations for easy use:
+
+```js
+import { campMainnet, campTestnet } from "@campnetwork/origin";
+
+// campMainnet - Chain ID: 484 (Production)
+// campTestnet - Chain ID: 123420001114 (Basecamp testnet)
+
+console.log(campMainnet.rpcUrls.default.http[0]); // RPC URL
+console.log(campMainnet.blockExplorers.default.url); // Block explorer
+```
+
+### Custom Storage Adapter
+
+By default, Node.js uses in-memory storage. You can provide a custom storage adapter for persistence:
+
+```js
+import { Auth, MemoryStorage } from "@campnetwork/origin";
+
+// Custom file-based storage
+class FileStorage {
+  async getItem(key) {
+    /* read from file */
+  }
+  async setItem(key, value) {
+    /* write to file */
+  }
+  async removeItem(key) {
+    /* delete from file */
+  }
+}
+
+const auth = new Auth({
+  clientId: process.env.CLIENT_ID,
+  redirectUri: "https://myapp.com/callback",
+  environment: "PRODUCTION",
+  storage: new FileStorage(), // Custom storage
+});
+```
+
+### Methods
+
+#### connectWithSigner
+
+`connectWithSigner(signer: any, options?: { domain?: string, uri?: string }) => Promise<{ success: boolean, message: string, walletAddress: string }>`
+
+Connect with a custom signer (viem WalletClient, ethers Signer, or custom signer implementation).
+
+```js
+await auth.connectWithSigner(signer, {
+  domain: "myapp.com", // Required: Your application domain
+  uri: "https://myapp.com", // Required: Your application URI
+});
+```
+
+**Supported Signer Types:**
+
+- **viem WalletClient** - Automatically detected and used
+- **ethers Signer** (v5 or v6) - Works with both versions
+- **Custom Signer** - Must implement `getAddress()`, `signMessage()`, and `getChainId()` methods
+
+### Exported Types and Utilities
+
+```js
+import {
+  // Auth class
+  Auth,
+
+  // Signer adapters
+  ViemSignerAdapter,
+  EthersSignerAdapter,
+  CustomSignerAdapter,
+  createSignerAdapter,
+
+  // Storage adapters
+  BrowserStorage,
+  MemoryStorage,
+
+  // Viem helpers
+  createNodeWalletClient,
+
+  // Chain configs
+  campMainnet,
+  campTestnet,
+} from "@campnetwork/origin";
+```
+
+### Examples
+
+See the [examples/server-side](./examples/server-side) directory for complete Node.js examples including:
+
+- `connect-with-ethers.js` - Using ethers v6 Signer
+- `connect-with-viem.js` - Using viem WalletClient
+- `connect-with-custom-signer.js` - Custom signer implementation
+- `query-origin-data.js` - Querying blockchain data
+
+# React
+
+The React components and hooks can be imported as ES6 modules. The example below shows how to set up the `CampProvider` component and subsequently use the provided hooks and components.
+
+```js
+// main.jsx
+import { StrictMode } from "react";
+import { createRoot } from "react-dom/client";
+import { CampProvider } from "@campnetwork/origin/react";
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import App from "./App.jsx";
+
+const queryClient = new QueryClient();
+
+createRoot(document.getElementById("root")).render(
+  <StrictMode>
+    <QueryClientProvider client={queryClient}>
+      <CampProvider clientId="your-client-id">
+        <App />
+      </CampProvider>
+    </QueryClientProvider>
+  </StrictMode>
+);
+```
+
+## CampProvider
+
+The `CampProvider` component requires a `clientId` prop to be passed in order link the users to your app.
+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.
+
+```jsx
+import { CampProvider } from "@campnetwork/origin/react";
+// ...
+function App() {
+  return (
+    <CampProvider
+      clientId="your-client-id"
+      redirectUri="https://your-website.com"
+      environment="DEVELOPMENT"
+    >
+      <div>Your app</div>
+    </CampProvider>
+  );
+}
+```
+
+Or, with an object for the `redirectUri`:
+
+```jsx
+import { CampProvider } from "@campnetwork/origin/react";
+// ...
+function App() {
+  return (
+    <CampProvider
+      clientId="your-client-id"
+      redirectUri={{
+        twitter: "https://your-website.com/twitter",
+        spotify: "https://your-website.com/spotify",
+      }}
+      environment="DEVELOPMENT"
+    >
+      <div>Your app</div>
+    </CampProvider>
+  );
+}
+```
+
+The `CampProvider` component sets up the context for the Origin SDK and provides the Auth instance to the rest of the app.
+
+## CampModal
+
+![@campnetwork/origin](https://imgur.com/AFmorL4.png)
+
+The **CampModal** is a one-line\* solution for authenticating users with the Origin SDK. It can be used to connect users to Origin, link and unlink social accounts, mint IPNFTs, and view the user's Origin stats.
+
+It works as follows:
+
+The **CampModal** component displays a button with the text "**Connect**" that the user can click on in order to summon the modal. The modal shows a list of available providers that the user can select from. After a provider has been selected, the `connect` method is called on the Auth instance to authenticate the user.
+
+If the user is already authenticated, the button will instead say "**My Origin**" and the modal will display the user's Origin profile information and allow them to link and unlink social accounts.
+
+The **CampModal** can take the following props:
+
+- `wcProjectId` - `string` - The WalletConnect project ID to use for authentication. Allows the users to authenticate via WalletConnect.
+- `injectButton` - `boolean` - Whether to inject the button into the DOM or not. Defaults to `true`. If set to `false`, the button will not be rendered and the modal can be opened programmatically via the `openModal` function returned by the `useModal` hook.
+- `onlyWagmi` - `boolean` - Whether to only show the provider that the user is currently authenticated with. Defaults to `false`.
+- `defaultProvider` - `{ provider: EIP1193Provider, info: EIP6963ProviderInfo, exclusive: boolean }` - Custom provider to set as the highlighted provider in the modal. If not set, the wagmi provider will be highlighted if it is available. The `exclusive` property can be set to `true` to only show this provider in the modal.
+
+### Usage
+
+Basic usage of the **CampModal** component:
+
+```jsx
+import { CampModal } from "@campnetwork/origin/react";
+
+function App() {
+  return (
+    <div>
+      <CampModal />
+    </div>
+  );
+}
+```
+
+With custom props:
+
+```jsx
+import { CampModal } from "@campnetwork/origin/react";
+
+function App() {
+  return (
+    <div>
+      <CampModal
+        wcProjectId="your-wc-project-id"
+        defaultProvider={{
+          provider: window.ethereum,
+          info: { name: "MetaMask", icon: "https://..." },
+          exclusive: false,
+        }}
+      />
+    </div>
+  );
+}
+```
+
+You can find more [examples here](./examples/client-side/react/providers-configuration).
+
+Only show the provider that the user is currently authenticated with (if using wagmi):
+
+```jsx
+import { CampModal } from "@campnetwork/origin/react";
+
+function App() {
+  return (
+    <div>
+      <CampModal onlyWagmi />
+    </div>
+  );
+}
+```
+
+Users can be authenticated either via the Camp Modal as outlined above or programmatically by calling the `connect` method on the Auth instance.
+
+### Usage with third party providers (Privy, Appkit, Magic, etc.)
+
+The Camp Modal can be used in conjunction with providers such as Privy and Appkit to create a seamless authentication experience for users. When using wagmi, it will automatically detect if the user is authenticated via a third party provider and give them the option to connect to Origin using that provider. Otherwise, you can set up the default provider to be whatever provider you are using.
+
+[Example usage with Privy](./examples/client-side/react/privy-connector/)
+
+[Example usage with Appkit](./examples/client-side/react/appkit-connector/)
+
+[Example usage with magic.link](./examples/client-side/react/magic-link-connector/)
+
+After the user has authenticated, you can use the provided hooks to fetch user data and listen for events.
+
+## LinkButton
+
+The **LinkButton** component is a button that can be used to link and unlink social accounts. Under the hood it uses the `useLinkModal` hook to open the Link Socials modal.
+
+The **LinkButton** can take the following props:
+
+- `social` - `string` - The social account to link or unlink. Can be one of: `twitter`, `tiktok`, `spotify`.
+- `variant` - `string` - The variant of the button. Can be one of: `default`, `icon`. Defaults to `default`.
+- `theme` - `string` - The theme of the button. Can be one of: `default`, `camp`. Defaults to `default`.
+
+**Note: The `<CampModal/>` component must be rendered in the component tree for the buttons to work.**
+
+### Usage
+
+Basic usage of the **LinkButton** component:
+
+```jsx
+import { LinkButton, CampModal } from "@campnetwork/origin/react";
+
+function App() {
+  return (
+    <div>
+      <CampModal />
+      <LinkButton social="twitter" />
+      <LinkButton social="spotify" theme="camp" />
+      <LinkButton social="tiktok" variant="icon" theme="camp" />
+    </div>
+  );
+}
+```
+
+## CampButton
+
+The **CampButton** component allows you to render a button that opens the Auth or My Origin modal when clicked. It can be used as an alternative to the button that is injected by the **CampModal** component. It allows you to have multiple buttons in your app that open the modal, or to have the button in a different location than where the **CampModal** component is rendered.
+
+```jsx
+import { CampButton, CampModal } from "@campnetwork/origin/react";
+
+function App() {
+  return (
+    <div>
+      <CampModal injectButton={false} />
+      <CampButton />
+    </div>
+  );
+}
+```
+
+## Hooks
+
+### useAuth
+
+The `useAuth` hook returns the instance of the Auth class that is provided by the CampProvider.
+It can be used as outlined in the Core section in order to build custom authentication flows, listen for events, and fetch user data.
+
+```jsx
+import { useAuth } from "@campnetwork/origin/react";
+
+function App() {
+  const auth = useAuth();
+
+  return (
+    <div>
+      <button onClick={auth.connect}>Connect</button>
+    </div>
+  );
+}
+```
+
+### useAuthState
+
+The `useAuthState` hook returns the current authentication state of the user.
+
+```jsx
+import { useAuthState } from "@campnetwork/origin/react";
+
+function App() {
+  const { authenticated, loading } = useAuthState();
+
+  return (
+    <div>
+      {loading && <div>Loading...</div>}
+      {authenticated && <div>Authenticated</div>}
+    </div>
+  );
+}
+```
+
+### useProvider
+
+The `useProvider` hook returns the provider that has been set via the `setProvider` method, as well as a `setProvider` function that can be used to update the provider.
+
+```jsx
+import { useProvider } from "@campnetwork/origin/react";
+
+function App() {
+  const { provider, setProvider } = useProvider();
+
+  return (
+    <div>
+      <div>Current provider: {provider.info.name}</div>
+      <button
+        onClick={() =>
+          setProvider({ provider: window.ethereum, info: { name: "Metamask" } })
+        }
+      >
+        Set Provider
+      </button>
+    </div>
+  );
+}
+```
+
+### useProviders
+
+The `useProviders` hook returns the list of providers that have been injected via EIP6963 and that the user or app can select from.
+
+```jsx
+import { useProviders, useProvider } from "@campnetwork/origin/react";
+
+function App() {
+  const providers = useProviders();
+  const { setProvider } = useProvider();
+
+  return (
+    <div>
+      {providers.map((provider) => (
+        <button key={provider.info.name} onClick={() => setProvider(provider)}>
+          {provider.info.name}
+        </button>
+      ))}
+    </div>
+  );
+}
+```
+
+### useConnect
+
+The `useConnect` hook returns functions that can be used to connect and disconnect the user.
+
+```jsx
+import { useConnect, useAuthState } from "@campnetwork/origin/react";
+
+function App() {
+  const { connect, disconnect } = useConnect();
+  const { authenticated } = useAuthState();
+
+  return (
+    <div>
+      {authenticated ? (
+        <button onClick={disconnect}>Disconnect</button>
+      ) : (
+        <button onClick={connect}>Connect</button>
+      )}
+    </div>
+  );
+}
+```
+
+### useSocials
+
+The `useSocials` hook returns the state of the user's linked social accounts.
+
+```jsx
+import { useSocials } from "@campnetwork/origin/react";
+
+function App() {
+  const { data, error, isLoading } = useSocials();
+
+  if (loading) return <div>Loading...</div>;
+  if (error) return <div>Error: {error.message}</div>;
+
+  return (
+    <div>
+      <div>Twitter: {data.twitter ? "Linked" : "Not linked"}</div>
+      <div>Tiktok: {data.tiktok ? "Linked" : "Not linked"}</div>
+      <div>Spotify: {data.spotify ? "Linked" : "Not linked"}</div>
+    </div>
+  );
+}
+```
+
+### useLinkSocials
+
+The `useLinkSocials` hook returns functions that can be used to link and unlink social accounts.
+
+```jsx
+import { useLinkSocials } from "@campnetwork/origin/react";
+
+function App() {
+  const {
+    linkTwitter,
+    linkSpotify,
+    linkTiktok,
+    unlinkTwitter,
+    unlinkSpotify,
+    unlinkTiktok,
+  } = useLinkSocials();
+
+  return (
+    <div>
+      <button onClick={linkTwitter}>Link Twitter</button>
+      <button onClick={linkSpotify}>Link Spotify</button>
+      <button onClick={() => linkTiktok("tiktokhandle")}>Link TikTok</button>
+      </button>
+      <button onClick={unlinkTwitter}>Unlink Twitter</button>
+      <button onClick={unlinkTiktok}>Unlink TikTok</button>
+      <button onClick={unlinkSpotify}>Unlink Spotify</button>
+    </div>
+  );
+}
+```
+
+### useModal
+
+The `useModal` hook returns the state of the Auth and My Origin modals, as well as functions to show and hide them.
+
+**Note: The `<CampModal/>` component must be rendered in the component tree for the modals to be displayed.**
+
+```jsx
+import { useModal, CampModal } from "@campnetwork/origin/react";
+
+function App() {
+  const { isOpen, openModal, closeModal } = useModal();
+
+  return (
+    <div>
+      <button onClick={openModal}>Open Modal</button>
+      <button onClick={closeModal}>Close Modal</button>
+      <CampModal injectButton={false} />
+    </div>
+  );
+}
+```
+
+The state and functions returned by the `useModal` hook can be used to show and hide the Auth and My Origin modals, as well as to check if they are currently open. The modal being controlled is dictated by the user's authentication state.
+
+### useLinkModal
+
+The `useLinkModal` hook returns the state of the Link Socials modal, as well as functions to show and hide it.
+
+**Note: The `<CampModal/>` component must be rendered in the component tree for the modal to be displayed.**
+
+```jsx
+import { useLinkModal, CampModal } from "@campnetwork/origin/react";
+
+function App() {
+  const { isLinkingOpen, openTwitterModal } = useLinkModal();
+
+  return (
+    <div>
+      <CampModal />
+      <button onClick={openTwitterModal}>Link Twitter</button>
+    </div>
+  );
+}
+```
+
+It returns the following properties and functions:
+
+- `isLinkingOpen` - `boolean` - Whether the Link Socials modal is open or not.
+- `openTwitterModal` - `() => void`
+- `openSpotifyModal` - `() => void`
+- `openTiktokModal` - `() => void`
+- `linkTwitter` - `() => void`
+- `linkSpotify` - `() => void`
+- `linkTiktok` - `() => void`
+- `linkTelegram` - `() => void`
+- `unlinkTwitter` - `() => void`
+- `unlinkSpotify` - `() => void`
+- `unlinkTiktok` - `() => void`
+- `closeModal` - `() => void`
+
+The difference between the `openXModal` functions and the `linkX / unlinkX` functions is that the former opens the modal regardless of the user's linking state, allowing them to either link or unlink their account, while the latter only opens the specified modal if the user's linking state allows for it.
+
+For example, if the user is linked to Twitter, calling `openTwitterModal` will open the modal to _unlink_ their Twitter account, while calling `linkTwitter` will not do anything, and calling `unlinkTwitter` will open the modal to unlink their Twitter account.
+
+## Origin Methods (`auth.origin`)
+
+The `Origin` class provides blockchain and API methods for interacting with Origin IpNFTs, uploading files, managing user stats, and more. Access these via `auth.origin` after authentication.
+
+### Types
+
+#### `LicenseTerms`
+
+The license terms object used in minting and updating methods:
+
+```typescript
+type LicenseTerms = {
+  price: bigint; // Price in wei
+  duration: number; // Duration in seconds
+  royaltyBps: number; // Royalty in basis points (1-10000)
+  paymentToken: Address; // Payment token address (address(0) for native currency)
+};
+```
+
+### Minting Constraints
+
+When minting or updating an IpNFT, the following constraints apply to the `LicenseTerms`:
+
+- The price must be at least `1000000000000000` wei (0.001 $CAMP).
+- The royaltyBps must be between `1` and `10000` (0.01% to 100%).
+- The duration must be between `86400` seconds and `2628000` seconds (1 day to 30 days).
+
+### `createLicenseTerms(price, duration, royaltyBps, paymentToken)`
+
+A utility function to create properly validated license terms for minting and updating IpNFTs.
+
+- `price`: Price in wei (bigint) - must be at least `1000000000000000` wei
+- `duration`: Duration in seconds (number) - must be between `86400` and `2628000` seconds
+- `royaltyBps`: Royalty in basis points (number) - must be between `1` and `10000`
+- `paymentToken`: Payment token address (Address) - use `zeroAddress` from viem for native currency
+- **Returns:** A validated `LicenseTerms` object
+- **Throws:** Error if any parameter violates the constraints
+
+**Example:**
+
+```typescript
+import { createLicenseTerms } from "@campnetwork/origin";
+import { zeroAddress } from "viem";
+
+// Create license terms with validation
+const license = createLicenseTerms(
+  BigInt("1000000000000000"), // 0.001 CAMP in wei
+  86400, // 1 day in seconds
+  1000, // 10% royalty (1000 basis points)
+  zeroAddress // Native currency (CAMP)
+);
+
+// Use with minting functions
+await auth.origin.mintFile(file, metadata, license);
+await auth.origin.mintSocial("twitter", metadata, license);
+```
+
+### File Upload & Minting
+
+#### `mintFile(file, metadata, license, parents?, options?)`
+
+Uploads a file and mints an IpNFT for it.
+
+- `file`: File to upload and mint
+- `metadata`: Additional metadata for the IpNFT
+  - `name`: Name of the IpNFT
+  - `description`: Description of the IpNFT
+  - `image`: Optional image URL for the IpNFT
+  - `attributes`: Optional array of attributes
+- `license`: LicenseTerms object
+- `parents`: Optional array of parent token IDs for derivatives
+- `options.progressCallback`: Optional progress callback
+- **Returns:** Minted token ID as a string, or throws on failure
+
+#### `mintSocial(source, metadata, license)`
+
+Mints an IpNFT for a connected social account.
+
+- `source`: Social platform (`"spotify" | "twitter" | "tiktok"`)
+- `metadata`: Additional metadata for the IpNFT
+- `license`: LicenseTerms object
+- **Returns:** Minted token ID as a string, or throws on failure
+
+### IpNFT & Marketplace Methods
+
+Most methods mirror smart contract functions and require appropriate permissions.
+
+#### Core IpNFT Methods
+
+- `mintWithSignature(account, tokenId, parents, creatorContentHash, uri, license, deadline, signature)`
+- `registerIpNFT(source, deadline, license, metadata, fileKey?, parents?)`
+- `updateTerms(tokenId, license)`
+- `finalizeDelete(tokenId)`
+- `getOrCreateRoyaltyVault(tokenId)`
+- `getTerms(tokenId)`
+- `ownerOf(tokenId)`
+- `balanceOf(owner)`
+- `tokenURI(tokenId)`
+- `dataStatus(tokenId)`
+- `isApprovedForAll(owner, operator)`
+- `transferFrom(from, to, tokenId)`
+- `safeTransferFrom(from, to, tokenId)`
+- `approve(to, tokenId)`
+- `setApprovalForAll(operator, approved)`
+
+#### Marketplace Methods
+
+- `buyAccess(buyer, tokenId, expectedPrice, expectedDuration, expectedPaymentToken, value?)`
+- `hasAccess(tokenId, user)`
+- `subscriptionExpiry(tokenId, user)`
+
+#### Utility & Royalty Methods
+
+- `getRoyalties(token?, owner?)` — Get royalty vault and balance
+- `claimRoyalties(token?, owner?)` — Claim royalties
+
+#### Smart Access & Data
+
+- `buyAccessSmart(tokenId)` — Buys access, handles payment approval and license details - **Recommended in place of buyAccess**
+- `getData(tokenId)` — Fetches the underlying IP for a given IPNFT if the user has purchased access to it
+
+### User Data & Stats
+
+- `getOriginUploads()` — Fetch user's Origin file uploads (returns array or null)
+- `getOriginUsage()` — Fetch user's Origin stats (returns object with multiplier, points, active, teams, dataSources)
+- `setOriginConsent(consent: boolean)` — Set user's consent for Origin usage
+
+### Utility Methods
+
+- `getJwt()` — Get current JWT token
+- `setViemClient(client)` — Set viem wallet client for blockchain interactions
+
+---
+
+Call these methods as `await auth.origin.methodName(...)` after authenticating. See inline code documentation for full details and parameter types.
+
+---
+
+# Contributing
+
+Install the dependencies.
+
+```bash
+npm install
+```
+
+Build the SDK.
+
+```bash
+npm run build
+```
+
+This will generate the SDK in the `dist` folder.
+
+You can also run the following command to watch for changes and rebuild the SDK automatically:
+
+```bash
+npm run dev
+```
+
+In order to use the sdk in a local project, you can link the sdk to the project.
+
+```bash
+npm link .
+```
+
+Then, in the project you want to use the sdk in, run:
+
+```bash
+npm link @campnetwork/origin
+```
+
+This will link the local sdk to the project.