fix: add readme

Author: JackHamer09

packages/auth-server-api/.env.example

@@ -11,6 +11,10 @@ DEPLOYER_PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf
 # Blockchain Configuration
 RPC_URL=http://127.0.0.1:8545
 
+# Rate Limiting Configuration
+RATE_LIMIT_DEPLOY_MAX=20
+RATE_LIMIT_DEPLOY_WINDOW_MS=3600000 # 1 hour
+
 # Contract Addresses (OPTIONAL - will fall back to src/contracts.json if not provided)
 # You can provide these via environment variables OR update src/contracts.json
 # To deploy contracts, run: pnpm nx run demo-app:deploy-contracts-erc4337
@@ -27,7 +31,3 @@ RPC_URL=http://127.0.0.1:8545
 # PRIVIDIUM_ADMIN_PRIVATE_KEY=0x...  # Private key of a user with 'admin' role in Prividium
 # PRIVIDIUM_TEMPLATE_KEY=sso-smart-account  # Template key for whitelisting deployed contracts
 # SSO_AUTH_SERVER_BASE_URL=https://sso.example.com  # Base URL of the SSO auth server frontend (used as SIWE domain for admin authorization)
-
-# Rate Limiting Configuration
-RATE_LIMIT_DEPLOY_MAX=20
-RATE_LIMIT_DEPLOY_WINDOW_MS=3600000

packages/auth-server-api/README.md

@@ -7,3 +7,46 @@ API responsible for deploying SSO smart accounts.
 - `POST /api/deploy-account` - Deploy a new smart account with passkey
   authentication
 - `GET /api/health` - Health check endpoint
+
+## Prividium Mode Setup
+
+When Prividium mode is enabled, the auth server requires user authentication via
+Prividium and routes all deployments through the Prividium RPC proxy.
+
+### Configuration
+
+Set the following environment variables to enable Prividium mode:
+
+```env
+PRIVIDIUM_MODE=true
+PRIVIDIUM_RPC_PROXY_BASE_URL=https://rpc.prividium.io
+PRIVIDIUM_PERMISSIONS_BASE_URL=https://permissions.prividium.io
+PRIVIDIUM_ADMIN_PRIVATE_KEY=0x...  # Private key of a user with 'admin' role in Prividium
+PRIVIDIUM_TEMPLATE_KEY=sso-smart-account  # Template key for whitelisting deployed contracts
+SSO_AUTH_SERVER_BASE_URL=https://sso.example.com  # Base URL of the SSO auth server frontend (used as SIWE domain for admin authorization)
+```
+
+### Prividium Admin Panel Setup
+
+1. Create a **Contract Permission Template** in the Prividium admin panel with
+   the key `sso-smart-account` (or the value you set for
+   `PRIVIDIUM_TEMPLATE_KEY`)
+2. Configure the template with the required permissions listed below
+
+### Contract ABI
+
+The SSO smart account contract ABI is available at:
+[`packages/erc4337-contracts/out/ModularSmartAccount.sol/ModularSmartAccount.json`](../erc4337-contracts/out/ModularSmartAccount.sol/ModularSmartAccount.json)
+after compiling the contracts.
+
+### Required Permissions
+
+Configure the following method permissions in your contract template:
+
+| Function          | Permission Level | Access Details |
+| ----------------- | ---------------- | -------------- |
+| `ENTRY_POINT_V08` | All Users        |                |
+| `accountId`       | All Users        |                |
+| `domainSeparator` | All Users        |                |
+| `eip712Domain`    | All Users        |                |
+| `entryPoint`      | All Users        |                |