prividium 0.1.1 → 0.1.3

package/README.md

@@ -1,8 +1,8 @@
-# Prividium SDK & CLI
+# Prividium™ SDK & CLI
 
-A TypeScript SDK and CLI for integrating with the Prividium authorization system. The SDK provides popup OAuth, token
-management, and a viem transport for secure RPC; the CLI runs a local authenticated JSON-RPC proxy to your Prividium RPC
-and manages basic configuration.
+A TypeScript SDK and CLI for integrating with the Prividium™ authorization system. The SDK provides popup OAuth, token
+management, and a viem transport for secure RPC; the CLI runs a local authenticated JSON-RPC proxy to your Prividium™
+RPC and manages basic configuration.
 
 ## Features
 
@@ -31,7 +31,7 @@ npx prividium proxy
 
 ## Quick Start
 
-### 1. Create a Prividium Chain
+### 1. Create a Prividium™ Chain
 
 ```typescript
 import { createPrividiumChain } from 'prividium';
@@ -40,7 +40,7 @@ import { defineChain, createPublicClient, http } from 'viem';
 // Define your chain
 const prividiumChain = defineChain({
   id: 7777,
-  name: 'Prividium Chain',
+  name: 'Prividium™ Chain',
   nativeCurrency: { name: 'Ether', symbol: 'ETH', decimals: 18 },
   rpcUrls: { default: { http: [] } },
   blockExplorers: { default: { name: 'Explorer', url: 'https://explorer.prividium.io' } }
@@ -48,12 +48,13 @@ const prividiumChain = defineChain({
 
 // Create SDK instance
 // Note: replace the URLs and clientId with your actual values
-// Make sure clientId is registered in User Panel (OAUTH_CLIENTS)
+// Make sure clientId & redirectUrl are from a registered Application in the Admin Panel
 const prividium = createPrividiumChain({
   clientId: 'your-client-id',
   chain: prividiumChain,
   rpcUrl: 'https://rpc.prividium.io',
   authBaseUrl: 'https://auth.prividium.io',
+  permissionsApiBaseUrl: 'https://permissions.prividium.io/api',
   redirectUrl: window.location.origin + '/auth/callback',
   onAuthExpiry: () => {
     console.log('Authentication expired - please reconnect');
@@ -88,13 +89,13 @@ const balance = await client.getBalance({
 
 ### 4. Sending Transactions with Injected Wallets (MetaMask)
 
-Before sending transactions through injected wallets, you need to add the Prividium network and enable wallet RPC for
+Before sending transactions through injected wallets, you need to add the Prividium™ network and enable wallet RPC for
 each transaction.
 
 ```typescript
 import { createWalletClient, custom, encodeFunctionData } from 'viem';
 
-// Add Prividium network to MetaMask
+// Add Prividium™ network to MetaMask
 await prividium.addNetworkToWallet();
 
 // Create wallet client for MetaMask
@@ -172,7 +173,7 @@ page at the `redirectUrl` you configured:
 
 **How it works:**
 
-1. User clicks "Login" → SDK opens popup to Prividium user panel
+1. User clicks "Login" → SDK opens popup to Prividium™ user panel
 2. User authenticates → user panel redirects popup to your callback page
 3. Callback page calls `handleAuthCallback()` → token is posted back to parent via `postMessage`
 4. SDK receives token, validates state parameter (CSRF protection), and closes popup
@@ -194,12 +195,16 @@ const prividium = createPrividiumChain({
   chain: prividiumChain,
   rpcUrl: 'https://rpc.prividium.io',
   authBaseUrl: 'https://auth.prividium.io',
+  permissionsApiBaseUrl: 'https://permissions.prividium.io/api',
   redirectUrl: window.location.origin + '/auth/callback',
-  scope: ['wallet:required', 'network:required'], // Request specific scopes
   onAuthExpiry: () => {
     console.log('Authentication expired');
   }
 });
+
+await prividium.authorize({
+  scope: ['wallet:required', 'network:required'] // Request specific scopes
+});
 ```
 
 ### Available Scopes
@@ -214,7 +219,7 @@ are not met, the user panel will guide them through the necessary setup steps be
 
 ### `createPrividiumChain(config)`
 
-Creates a new Prividium SDK instance.
+Creates a new Prividium™ SDK instance.
 
 **Parameters:**
 
@@ -224,8 +229,8 @@ interface PrividiumConfig {
   chain: Chain; // Viem chain configuration (without rpcUrls)
   rpcUrl: string; // Private RPC endpoint URL
   authBaseUrl: string; // Authorization service base URL
+  permissionsApiBaseUrl: string; // Permissions API service base URL
   redirectUrl: string; // OAuth redirect URL
-  scope?: OauthScope[]; // Optional OAuth scopes to request (optional)
   storage?: Storage; // Custom storage implementation (optional)
   onAuthExpiry?: () => void; // Called when authentication expires (optional)
 }
@@ -242,6 +247,7 @@ Opens authentication popup and handles OAuth flow.
 ```typescript
 await prividium.authorize({
   popupSize: { w: 600, h: 700 } // Optional custom popup dimensions
+  scopes: ['wallet:required', 'network:required'], // Optional scope requests
 });
 ```
 
@@ -330,7 +336,7 @@ const prividium = createPrividiumChain({
 
 ### Multiple Chains
 
-Support multiple Prividium chains:
+Support multiple Prividium™ chains:
 
 ```typescript
 const testnetPrividium = createPrividiumChain({
@@ -338,6 +344,7 @@ const testnetPrividium = createPrividiumChain({
   chain: testnetChain,
   rpcUrl: 'https://testnet-rpc.prividium.io',
   authBaseUrl: 'https://testnet-auth.prividium.io',
+  permissionsApiBaseUrl: 'https://testnet-permissions.prividium.io/api',
   redirectUrl: window.location.origin + '/auth/callback'
 });
 
@@ -346,6 +353,7 @@ const mainnetPrividium = createPrividiumChain({
   chain: mainnetChain,
   rpcUrl: 'https://mainnet-rpc.prividium.io',
   authBaseUrl: 'https://mainnet-auth.prividium.io',
+  permissionsApiBaseUrl: 'https://mainnet-permissions.prividium.io/api',
   redirectUrl: window.location.origin + '/auth/callback'
 });
 ```
@@ -401,9 +409,13 @@ The SDK uses the following localStorage keys:
 
 ## CLI
 
-Run a local, authenticated RPC proxy that forwards JSON-RPC requests to your Prividium RPC while injecting the OAuth
+Run a local, authenticated RPC proxy that forwards JSON-RPC requests to your Prividium™ RPC while injecting the OAuth
 token obtained via a quick browser sign-in.
 
+The proxy CLI is particularly useful for deploying contracts with standard Ethereum tools (like Foundry or Hardhat)
+without having to manage authentication manually. The proxy automatically handles authentication headers, allowing you
+to use your existing deployment workflows.
+
 ### Install & Run
 
 - Use without installing: `npx prividium proxy`
@@ -427,8 +439,8 @@ What happens:
 
 Flags:
 
-- `--rpc-url, -r` (string): Target Prividium RPC URL.
-- `--user-panel-url, -u` (string): URL used to log in to Prividium.
+- `--rpc-url, -r` (string): Target Prividium™ RPC URL.
+- `--user-panel-url, -u` (string): URL used to log in to Prividium™.
 - `--port, -p` (number, default `24101`): Local proxy port. This has to match with the port configured in the admin
   panel, which by default uses this same port.
 - `--host, -h` (string, default `127.0.0.1`): host binded to server. By default only connections comming from local

package/dist/cli/commands/config.js

@@ -23,13 +23,13 @@ export const addConfig = (cli) => {
         .command('set', 'Updates config', (yargs) => yargs
         .option('rpcUrl', {
         alias: ['rpc-url', 'r'],
-        description: 'Specifies target Prividium rpc url. These takes precedence over config file and env variable.',
+        description: 'Specifies target Prividium™ rpc url. These takes precedence over config file and env variable.',
         demandOption: true,
         type: 'string'
     })
         .option('userPanelUrl', {
         alias: ['user-panel-url', 'u'],
-        description: 'Specifies url used to log in into the Prividium network. Takes precedence over config file and env variable',
+        description: 'Specifies url used to log in into the Prividium™ network. Takes precedence over config file and env variable',
         type: 'string',
         demandOption: true
     }), (args) => updateConfig({

package/dist/cli/commands/proxy.js

@@ -35,13 +35,13 @@ export const addProxy = (cli) => {
     return cli.command('proxy', 'Starts authenticated rpc proxy server', (yargs) => yargs
         .option('rpcUrl', {
         alias: ['rpc-url', 'r'],
-        description: 'Specifies target Prividium rpc url. These takes precedence over config file and env variable.',
+        description: 'Specifies target Prividium™ rpc url. These takes precedence over config file and env variable.',
         demandOption: false,
         type: 'string'
     })
         .option('userPanelUrl', {
         alias: ['user-panel-url', 'u'],
-        description: 'Specifies url used to log in into the Prividium network. Takes precedence over config file and env variable',
+        description: 'Specifies url used to log in into the Prividium™ network. Takes precedence over config file and env variable',
         type: 'string'
     })
         .option('configPath', {
@@ -52,7 +52,7 @@ export const addProxy = (cli) => {
     })
         .option('port', {
         alias: ['p'],
-        description: 'Port used for local proxy. This has to match with the port configured in your Prividium network.',
+        description: 'Port used for local proxy. This has to match with the port configured in your Prividium™ network.',
         default: 24101,
         type: 'number'
     })

package/dist/cli/server/config-file.js

@@ -49,7 +49,7 @@ export class ConfigFile {
     }
     print() {
         const { prividiumRpcUrl, userPanelUrl } = this.read();
-        console.log(`${color.bold('Prividium rpc url')}: ${prividiumRpcUrl}`);
+        console.log(`${color.bold('Prividium™ rpc url')}: ${prividiumRpcUrl}`);
         console.log(`${color.bold('Log in url')}: ${userPanelUrl}`);
     }
     printPath() {

package/dist/cli/server/connection-workflow.js

@@ -19,7 +19,7 @@ export class CreationWorkflow {
     start() {
         console.log(color.blue(HEADER));
         console.log('');
-        intro('Starting prividium proxy');
+        intro('Starting Prividium™ proxy');
     }
     async gatherData(maybePrividiumRpcUrl, maybeUserPanelUrl) {
         const { url: prividiumRpcUrl, prompted: prompted1 } = await this.askForUrl(maybePrividiumRpcUrl, 'prividium rpc');

package/dist/cli/static/callback.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <title>Prividium</title>
+    <title>Prividium™</title>
     <script src="https://cdn.tailwindcss.com"></script>
   </head>
   <body
@@ -16,7 +16,7 @@
         id="main-title"
         class="text-2xl md:text-3xl font-bold bg-gradient-to-r from-blue-700 to-blue-900 bg-clip-text text-transparent"
       >
-        Finalizing Prividium sign-in...
+        Finalizing Prividium™ sign-in...
       </h1>
       <div class="mt-4">
         <svg
@@ -35,7 +35,7 @@
       </div>
       <div id="proxy-url" style="display: none" class="mt-6 text-blue-700 text-center">
         <img src="https://www.zksync.io/faq/faq-brackets.svg" alt="Success" class="h-12 w-auto mx-auto mb-3" />
-        <span>You can now access your Prividium RPC proxy at: </span>
+        <span>You can now access your Prividium™ RPC proxy at: </span>
         <span class="font-bold">http://127.0.0.1:24101/rpc</span>
       </div>
     </div>

package/dist/sdk/index.d.ts

@@ -2,5 +2,5 @@ export { createPrividiumChain } from './prividium-chain.js';
 export type { PrividiumConfig, PrividiumChain, PopupOptions, Storage, TokenData, UserProfile, UserRole, AddNetworkParams } from './types.js';
 export { AUTH_ERRORS, STORAGE_KEYS } from './types.js';
 export { LocalStorage, TokenManager } from './storage.js';
-export { parseToken, isTokenExpired, generateRandomState } from './token-utils.js';
+export { generateRandomState } from './token-utils.js';
 export { PopupAuth, handleAuthCallback, type AuthCallbackMessage, type OauthScope } from './popup-auth.js';

package/dist/sdk/index.js

@@ -1,5 +1,5 @@
 export { createPrividiumChain } from './prividium-chain.js';
 export { AUTH_ERRORS, STORAGE_KEYS } from './types.js';
 export { LocalStorage, TokenManager } from './storage.js';
-export { parseToken, isTokenExpired, generateRandomState } from './token-utils.js';
+export { generateRandomState } from './token-utils.js';
 export { PopupAuth, handleAuthCallback } from './popup-auth.js';

package/dist/sdk/prividium-chain.js

@@ -1,5 +1,5 @@
 import { http } from 'viem';
-import { chainConfig } from 'viem/zksync';
+import { mainnet } from 'viem/chains';
 import { LocalStorage, TokenManager } from './storage.js';
 import { PopupAuth } from './popup-auth.js';
 export function createPrividiumChain(config) {
@@ -43,14 +43,15 @@ export function createPrividiumChain(config) {
     });
     return {
         chain: {
-            ...chainConfig,
+            ...mainnet,
             ...config.chain,
+            id: config.chain.id,
             contracts: {
-                ...chainConfig.contracts,
                 ...config.chain.contracts,
-                multicall3: undefined // Prividium doesn't support multicall yet
+                multicall3: undefined // Prividium™ doesn't support multicall yet
             },
-            rpcUrls: { default: { http: [config.rpcUrl] } }
+            rpcUrls: { default: { http: [config.rpcUrl] } },
+            blockExplorers: config.chain.blockExplorers
         },
         transport,
         async authorize(options) {

package/dist/sdk/storage.js

@@ -1,5 +1,4 @@
 import { STORAGE_KEYS } from './types.js';
-import { parseToken, isTokenExpired } from './token-utils.js';
 export class LocalStorage {
     getItem(key) {
         if (typeof localStorage === 'undefined') {
@@ -33,26 +32,22 @@ export class TokenManager {
         return `${STORAGE_KEYS.STATE_PREFIX}${this.chainId}`;
     }
     getToken() {
-        if (this.tokenCache && !isTokenExpired(this.tokenCache)) {
+        if (this.tokenCache) {
             return this.tokenCache;
         }
         const rawToken = this.storage.getItem(this.tokenKey);
         if (!rawToken) {
-            this.tokenCache = null;
-            return null;
-        }
-        try {
-            this.tokenCache = parseToken(rawToken);
-            return this.tokenCache;
-        }
-        catch {
-            this.clearToken();
             return null;
         }
+        const tokenData = {
+            rawToken
+        };
+        this.tokenCache = tokenData;
+        return tokenData;
     }
     setToken(rawToken) {
         try {
-            const tokenData = parseToken(rawToken);
+            const tokenData = { rawToken };
             this.storage.setItem(this.tokenKey, rawToken);
             this.tokenCache = tokenData;
             return tokenData;
@@ -63,12 +58,12 @@ export class TokenManager {
         }
     }
     clearToken() {
-        this.storage.removeItem(this.tokenKey);
         this.tokenCache = null;
+        this.storage.removeItem(this.tokenKey);
     }
     isAuthorized() {
         const token = this.getToken();
-        return token !== null && !isTokenExpired(token);
+        return token !== null;
     }
     setState(state) {
         this.storage.setItem(this.stateKey, state);

package/dist/sdk/token-utils.d.ts

@@ -1,4 +1 @@
-import { type TokenData } from './types.js';
-export declare function parseToken(rawToken: string): TokenData;
-export declare function isTokenExpired(tokenData: TokenData): boolean;
 export declare function generateRandomState(): string;

package/dist/sdk/token-utils.js

@@ -1,53 +1,3 @@
-import { z } from 'zod';
-import { AUTH_ERRORS } from './types.js';
-const tokenSchema = z.object({
-    exp: z.coerce.number().int(),
-    sub: z.string().min(1),
-    preferred_username: z.string().optional()
-});
-function base64UrlDecode(str) {
-    const base64Encoded = str.replace(/-/g, '+').replace(/_/g, '/');
-    const padding = str.length % 4 === 0 ? '' : '='.repeat(4 - (str.length % 4));
-    const base64WithPadding = base64Encoded + padding;
-    return atob(base64WithPadding)
-        .split('')
-        .map((char) => String.fromCharCode(char.charCodeAt(0)))
-        .join('');
-}
-export function parseToken(rawToken) {
-    const parts = rawToken.split('.');
-    if (parts.length < 3) {
-        throw new Error(AUTH_ERRORS.INVALID_JWT);
-    }
-    let parsed;
-    try {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        parsed = JSON.parse(base64UrlDecode(parts[1]));
-    }
-    catch (e) {
-        if (!(e instanceof SyntaxError)) {
-            console.error(e);
-        }
-        throw new Error(AUTH_ERRORS.INVALID_JWT);
-    }
-    const validated = tokenSchema.safeParse(parsed);
-    if (!validated.success) {
-        throw new Error(`Invalid JWT body format: ${validated.error.message}`);
-    }
-    const expirationDate = new Date(validated.data.exp * 1000);
-    if (expirationDate <= new Date()) {
-        throw new Error(AUTH_ERRORS.EXPIRED_TOKEN);
-    }
-    return {
-        rawToken,
-        expirationDate,
-        sub: validated.data.sub,
-        preferred_username: validated.data.preferred_username
-    };
-}
-export function isTokenExpired(tokenData) {
-    return tokenData.expirationDate <= new Date();
-}
 export function generateRandomState() {
     const array = new Uint8Array(32);
     crypto.getRandomValues(array);

package/dist/sdk/types.d.ts

@@ -62,9 +62,6 @@ export interface PrividiumChain {
 }
 export interface TokenData {
     rawToken: string;
-    expirationDate: Date;
-    sub: string;
-    preferred_username?: string;
 }
 export interface PopupOptions {
     popupSize?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prividium",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "bin": {
     "prividium": "./bin/cli.js"
   },