@campnetwork/origin 1.0.0-alpha.14 → 1.0.0-alpha.15

package/README.md

@@ -15,10 +15,10 @@
 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 the Auth Hub
-  - `SpotifyAPI` - For fetching user Spotify data from the Auth Hub
+  - `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 the Camp Auth Hub
+- `"@campnetwork/origin/react"` - Exposes the CampProvider and CampContext, as well as React components and hooks for authentication and fetching user data via Origin
 
 # Installation
 
@@ -46,7 +46,7 @@ import { TwitterAPI, SpotifyAPI, Auth } from "@campnetwork/origin";
 
 ### TwitterAPI
 
-The TwitterAPI class is the entry point for fetching user Twitter data from the Auth Hub. It requires an API key to be instantiated.
+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.**
 
@@ -152,7 +152,7 @@ const viewedTweets = await twitter.fetchViewedTweetsByUsername("jack", 1, 10);
 
 ### SpotifyAPI
 
-The SpotifyAPI class is the entry point for fetching user Spotify data from the Auth Hub. It requires an API key to be instantiated.
+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.**
 
@@ -226,7 +226,7 @@ const user = await spotify.fetchUserByWalletAddress("0x1234567890");
 
 ### TikTokAPI
 
-The TikTokAPI class is the entry point for fetching user TikTok data from the Auth Hub. It requires an API key to be instantiated.
+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.**
 
@@ -270,9 +270,7 @@ The Auth class is the entry point for authenticating 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.
-  - `discord` - The URI to redirect to after the user completes oauth for Discord.
   - `spotify` - The URI to redirect to after the user completes oauth for Spotify.
-- `allowAnalytics` - Whether to allow analytics to be collected. Defaults to `true`.
 
 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`.
@@ -292,7 +290,6 @@ const auth = new Auth({
   clientId: "your-client-id",
   redirectUri: {
     twitter: "https://your-website.com/twitter",
-    discord: "https://your-website.com/discord",
     spotify: "https://your-website.com/spotify",
   },
 });
@@ -323,7 +320,7 @@ auth.disconnect();
 
 #### setProvider
 
-`setProvider(provider: { provider: EIP1193Provider, info: EIP6963ProviderInfo }) => void`
+`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._
 
@@ -405,16 +402,26 @@ auth.on("providers", (data) => {
 });
 ```
 
+#### 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, discord: boolean, spotify: boolean }>`
+`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, discord: false, spotify: true }
+console.log(linkedSocials); // { twitter: true, tiktok: false, spotify: true }
 ```
 
 ---
@@ -427,27 +434,17 @@ Afterwards, the user will be redirected back to the `redirectUri` specified in t
 
 `linkTwitter() => void`
 
-The `linkTwitter` method redirects the user to the Twitter OAuth flow to link their Twitter account to the Auth Hub.
+The `linkTwitter` method redirects the user to the Twitter OAuth flow to link their Twitter account to Origin.
 
 ```js
 auth.linkTwitter();
 ```
 
-#### linkDiscord
-
-`linkDiscord() => void`
-
-The `linkDiscord` method redirects the user to the Discord OAuth flow to link their Discord account to the Auth Hub.
-
-```js
-auth.linkDiscord();
-```
-
 #### linkSpotify
 
 `linkSpotify() => void`
 
-The `linkSpotify` method redirects the user to the Spotify OAuth flow to link their Spotify account to the Auth Hub.
+The `linkSpotify` method redirects the user to the Spotify OAuth flow to link their Spotify account to Origin.
 
 ```js
 auth.linkSpotify();
@@ -457,58 +454,29 @@ auth.linkSpotify();
 
 `linkTikTok(handle: string) => Promise<void>`
 
-The `linkTikTok` method links the provided TikTok handle to the Auth Hub.
+The `linkTikTok` method links the provided TikTok handle to Origin.
 
 ```js
 auth.linkTikTok("tiktokhandle");
 ```
 
-#### sendTelegramOTP
-
-`sendTelegramOTP(phoneNumber: string) => Promise<void>`
-The `sendTelegramOTP` method sends an OTP to the provided phone number via Telegram. The OTP can be used via the `linkTelegram` method to link the user's Telegram account to the Auth Hub.
-
-```js
-const { phone_code_hash } = await auth.sendTelegramOTP("+1234567890");
-```
-
-#### linkTelegram
-
-`linkTelegram(phoneNumber: string, otp: string, phoneCodeHash: string) => Promise<void>`
-
-The `linkTelegram` method links the provided phone number to the Auth Hub using the OTP and phone code hash received from the `sendTelegramOTP` method.
-
-```js
-await auth.linkTelegram("+1234567890", "123456", "abc123");
-```
-
 ---
 
 #### unlinkTwitter
 
 `unlinkTwitter() => Promise<void>`
 
-The `unlinkTwitter` method unlinks the user's Twitter account from the Auth Hub.
+The `unlinkTwitter` method unlinks the user's Twitter account from Origin.
 
 ```js
 await auth.unlinkTwitter();
 ```
 
-#### unlinkDiscord
-
-`unlinkDiscord() => Promise<void>`
-
-The `unlinkDiscord` method unlinks the user's Discord account from the Auth Hub.
-
-```js
-await auth.unlinkDiscord();
-```
-
 #### unlinkSpotify
 
 `unlinkSpotify() => Promise<void>`
 
-The `unlinkSpotify` method unlinks the user's Spotify account from the Auth Hub.
+The `unlinkSpotify` method unlinks the user's Spotify account from Origin.
 
 ```js
 await auth.unlinkSpotify();
@@ -518,21 +486,12 @@ await auth.unlinkSpotify();
 
 `unlinkTikTok() => Promise<void>`
 
-The `unlinkTikTok` method unlinks the user's TikTok account from the Auth Hub.
+The `unlinkTikTok` method unlinks the user's TikTok account from Origin.
 
 ```js
 await auth.unlinkTikTok();
 ```
 
-#### unlinkTelegram
-
-`unlinkTelegram() => Promise<void>`
-The `unlinkTelegram` method unlinks the user's Telegram account from the Auth Hub.
-
-```js
-await auth.unlinkTelegram();
-```
-
 # 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.
@@ -563,7 +522,9 @@ createRoot(document.getElementById("root")).render(
 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`, `discord`, `spotify`. This is used to redirect the user to different pages after they have completed the OAuth flow for a social.
+- `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";
@@ -573,6 +534,7 @@ function App() {
     <CampProvider
       clientId="your-client-id"
       redirectUri="https://your-website.com"
+      environment="DEVELOPMENT"
     >
       <div>Your app</div>
     </CampProvider>
@@ -591,9 +553,9 @@ function App() {
       clientId="your-client-id"
       redirectUri={{
         twitter: "https://your-website.com/twitter",
-        discord: "https://your-website.com/discord",
         spotify: "https://your-website.com/spotify",
       }}
+      environment="DEVELOPMENT"
     >
       <div>Your app</div>
     </CampProvider>
@@ -605,15 +567,15 @@ The `CampProvider` component sets up the context for the Origin SDK and provides
 
 ## CampModal
 
-![@campnetwork/origin](https://imgur.com/n9o0rJ3.png)
+![@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 the Auth Hub and link and unlink social accounts.
+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 Camp**" and the modal will display the user's Camp profile information and allow them to link and unlink social accounts.
+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:
 
@@ -621,7 +583,6 @@ The **CampModal** can take the following props:
 - `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.
-- `allowAnalytics` - `boolean` - Whether to allow analytics to be collected. Defaults to `true`.
 
 ### Usage
 
@@ -680,7 +641,7 @@ Users can be authenticated either via the Camp Modal as outlined above or progra
 
 ### 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 the Auth Hub using that provider. Otherwise, you can set up the default provider to be whatever provider you are using.
+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/)
 
@@ -696,7 +657,7 @@ The **LinkButton** component is a button that can be used to link and unlink soc
 
 The **LinkButton** can take the following props:
 
-- `social` - `string` - The social account to link or unlink. Can be one of: `twitter`, `discord`, `spotify`.
+- `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`.
 
@@ -714,10 +675,25 @@ function App() {
     <div>
       <CampModal />
       <LinkButton social="twitter" />
-      <LinkButton social="discord" variant="icon" />
       <LinkButton social="spotify" theme="camp" />
       <LinkButton social="tiktok" variant="icon" theme="camp" />
-      <LinkButton social="telegram" />
+    </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>
   );
 }
@@ -850,7 +826,7 @@ function App() {
   return (
     <div>
       <div>Twitter: {data.twitter ? "Linked" : "Not linked"}</div>
-      <div>Discord: {data.discord ? "Linked" : "Not linked"}</div>
+      <div>Tiktok: {data.tiktok ? "Linked" : "Not linked"}</div>
       <div>Spotify: {data.spotify ? "Linked" : "Not linked"}</div>
     </div>
   );
@@ -867,35 +843,22 @@ import { useLinkSocials } from "@campnetwork/origin/react";
 function App() {
   const {
     linkTwitter,
-    linkDiscord,
     linkSpotify,
     linkTiktok,
-    linkTelegram,
-    sendTelegramOTP,
     unlinkTwitter,
-    unlinkDiscord,
     unlinkSpotify,
     unlinkTiktok,
-    unlinkTelegram,
   } = useLinkSocials();
 
   return (
     <div>
       <button onClick={linkTwitter}>Link Twitter</button>
-      <button onClick={linkDiscord}>Link Discord</button>
       <button onClick={linkSpotify}>Link Spotify</button>
       <button onClick={() => linkTiktok("tiktokhandle")}>Link TikTok</button>
-      <button onClick={() => sendTelegramOTP("+1234567890")}>
-        Send Telegram OTP
-      </button>
-      <button onClick={() => linkTelegram("+1234567890", "123456", "abc123")}>
-        Link Telegram
       </button>
       <button onClick={unlinkTwitter}>Unlink Twitter</button>
-      <button onClick={unlinkDiscord}>Unlink Discord</button>
-      <button onClick={unlinkSpotify}>Unlink Spotify</button>
       <button onClick={unlinkTiktok}>Unlink TikTok</button>
-      <button onClick={unlinkTelegram}>Unlink Telegram</button>
+      <button onClick={unlinkSpotify}>Unlink Spotify</button>
     </div>
   );
 }
@@ -903,7 +866,7 @@ function App() {
 
 ### useModal
 
-The `useModal` hook returns the state of the Auth and My Camp modals, as well as functions to show and hide them.
+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.**
 
@@ -923,7 +886,7 @@ function App() {
 }
 ```
 
-The state and functions returned by the `useModal` hook can be used to show and hide the Auth and My Camp modals, as well as to check if they are currently open. The modal being controlled is dictated by the user's authentication state.
+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
 
@@ -950,20 +913,15 @@ It returns the following properties and functions:
 
 - `isLinkingOpen` - `boolean` - Whether the Link Socials modal is open or not.
 - `openTwitterModal` - `() => void`
-- `openDiscordModal` - `() => void`
 - `openSpotifyModal` - `() => void`
 - `openTiktokModal` - `() => void`
-- `openTelegramModal` - `() => void`
 - `linkTwitter` - `() => void`
-- `linkDiscord` - `() => void`
 - `linkSpotify` - `() => void`
 - `linkTiktok` - `() => void`
 - `linkTelegram` - `() => void`
 - `unlinkTwitter` - `() => void`
-- `unlinkDiscord` - `() => void`
 - `unlinkSpotify` - `() => void`
 - `unlinkTiktok` - `() => void`
-- `unlinkTelegram` - `() => 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.
@@ -972,7 +930,7 @@ For example, if the user is linked to Twitter, calling `openTwitterModal` will o
 
 ## Origin Methods (`auth.origin`)
 
-The `Origin` class provides methods for interacting with Origin IpNFTs, uploading files, managing user stats, and more. You can access these methods via `auth.origin` after authentication.
+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
 
@@ -984,124 +942,100 @@ The license terms object used in minting and updating methods:
 type LicenseTerms = {
   price: bigint; // Price in wei
   duration: number; // Duration in seconds
-  royaltyBps: number; // Royalty in basis points (0-10000)
+  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 at least `86400` seconds (1 day).
+
 ### File Upload & Minting
 
-#### `mintFile(file: File, metadata: Record<string, unknown>, license: LicenseTerms, parentId?: bigint, options?: { progressCallback?: (percent: number) => void })`
+#### `mintFile(file, metadata, license, parents?, options?)`
 
 Uploads a file and mints an IpNFT for it.
 
-- `file`: The file to upload and mint.
-- `metadata`: Additional metadata for the IpNFT.
-- `license`: License terms for the IpNFT (price, duration, royalty, payment token).
-- `parentId`: Optional parent token ID for derivative works.
-- `options.progressCallback`: Optional progress callback.
-- **Returns:** The minted token ID as a string, or throws an error on failure.
+- `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: "spotify" | "twitter" | "tiktok", license: LicenseTerms)`
+#### `mintSocial(source, metadata, license)`
 
 Mints an IpNFT for a connected social account.
 
-- `source`: The social platform.
-- `license`: License terms for the IpNFT.
-- **Returns:** The minted token ID as a string, or throws an error on failure.
+- `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
 
-The following methods are available for interacting with IpNFTs and the marketplace. All methods mirror the smart contract functions and require appropriate permissions.
+Most methods mirror smart contract functions and require appropriate permissions.
 
 #### Core IpNFT Methods
 
-- `mintWithSignature(account: string, tokenId: bigint, parentId: bigint, creatorContentHash: string, uri: string, license: LicenseTerms, deadline: bigint, signature: string)` - Mint an IpNFT with a signature
-- `registerIpNFT(source: string, deadline: bigint, license: LicenseTerms, metadata: Record<string, unknown>, fileKey?: string, parentId?: bigint)` - Register an IpNFT for minting
-- `updateTerms(tokenId: bigint, license: LicenseTerms)` - Update license terms for an IpNFT
-- `requestDelete(tokenId: bigint)` - Request deletion of an IpNFT
-- `getTerms(tokenId: bigint)` - Get license terms for an IpNFT
-- `ownerOf(tokenId: bigint)` - Get the owner of an IpNFT
-- `balanceOf(owner: string)` - Get the balance of IpNFTs for an owner
-- `contentHash(tokenId: bigint)` - Get the content hash of an IpNFT
-- `tokenURI(tokenId: bigint)` - Get the metadata URI of an IpNFT
-- `dataStatus(tokenId: bigint)` - Get the data status of an IpNFT
-- `royaltyInfo(tokenId: bigint, value: bigint)` - Get royalty information
-- `getApproved(tokenId: bigint)` - Get the approved address for an IpNFT
-- `isApprovedForAll(owner: string, operator: string)` - Check if operator is approved for all tokens
-- `transferFrom(from: string, to: string, tokenId: bigint)` - Transfer an IpNFT
-- `safeTransferFrom(from: string, to: string, tokenId: bigint)` - Safely transfer an IpNFT
-- `approve(to: string, tokenId: bigint)` - Approve an address for a specific IpNFT
-- `setApprovalForAll(operator: string, approved: boolean)` - Set approval for all tokens
+- `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(tokenId: bigint, periods: number, value?: bigint)` - Buy access to an IpNFT
-- `renewAccess(tokenId: bigint, periods: number)` - Renew access to an IpNFT
-- `hasAccess(tokenId: bigint, user: string)` - Check if user has access to an IpNFT
-- `subscriptionExpiry(tokenId: bigint, user: string)` - Get subscription expiry for a user
-
-> See the SDK source or contract ABI for full parameter details.
-
-#### `buyAccessSmart(tokenId: bigint, periods: number)`
+- `buyAccess(tokenId, periods, value?)`
+- `hasAccess(tokenId, user)`
+- `subscriptionExpiry(tokenId, user)`
 
-Buys access to an asset, handling payment approval if needed.
+#### Utility & Royalty Methods
 
-- `tokenId`: The IpNFT token ID.
-- `periods`: Number of periods to buy.
-- **Returns:** Result of the buy access transaction.
+- `getRoyalties(token?, owner?)` — Get royalty vault and balance
+- `claimRoyalties(token?, owner?)` — Claim royalties
 
-#### `getData(tokenId: bigint)`
+#### Smart Access & Data
 
-Fetches metadata for a given IpNFT.
-
-- `tokenId`: The IpNFT token ID.
-- **Returns:** Data object for the token.
+- `buyAccessSmart(tokenId)` — Buys access, handles payment approval and license details
+- `getData(tokenId)` — Fetches metadata for a given IpNFT
 
 ### User Data & Stats
 
-#### `getOriginUploads()`
-
-Fetches the user's Origin file uploads.
-
-- **Returns:** Array of upload data, or `null` on failure.
-
-#### `getOriginUsage()`
-
-Fetches the user's Origin stats (multiplier, points, usage, etc).
-
-- **Returns:** Object with user stats including:
-  - `user.multiplier` - User's Origin multiplier
-  - `user.points` - User's Origin points
-  - `user.active` - Whether user's Origin is active
-  - `teams` - Array of team data
-  - `dataSources` - Array of data source information
-
-#### `setOriginConsent(consent: boolean)`
-
-Sets the user's consent for Origin usage.
-
-- `consent`: `true` or `false`.
-- **Returns:** Promise that resolves on success, throws APIError on failure.
+- `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()`
-
-Gets the current JWT token.
+- `getJwt()` — Get current JWT token
+- `setViemClient(client)` — Set viem wallet client for blockchain interactions
 
-- **Returns:** The JWT string.
-
-#### `setViemClient(client: any)`
-
-Sets the viem wallet client for blockchain interactions.
+---
 
-- `client`: The viem wallet client instance.
+Call these methods as `await auth.origin.methodName(...)` after authenticating. See inline code documentation for full details and parameter types.
 
 ---
 
-You can call these methods as `await auth.origin.methodName(...)` after authenticating with the SDK. For more details, see the inline code documentation.
-
 # Contributing
 
 Install the dependencies.
@@ -1127,7 +1061,7 @@ npm run dev
 In order to use the sdk in a local project, you can link the sdk to the project.
 
 ```bash
-npm link
+npm link .
 ```
 
 Then, in the project you want to use the sdk in, run: