@dogeos/dogeos-sdk 3.3.0-beta.3 → 4.0.0-beta.5

package/README.md

@@ -7,6 +7,24 @@ A lightweight React SDK for integrating crypto wallet connection functionality i
 - React 18 or higher
 - TypeScript 5 or higher (recommended)
 
+## SDK deployment configuration
+
+The npm package is built with deployment-owned public service destinations. The release job must provide:
+
+- `DOGEOS_SDK_WEB3_ASSETS_BASE_URL`
+- `DOGEOS_OIDC_AUTH_RELAY_BASE_URL`
+- `DOGEOS_EMBEDDED_WALLET_BASE_URL`
+- `DOGEOS_EMBEDDED_WALLET_STAGE`
+- `DOGEOS_SDK_AUTH_SERVICE_ORIGINS` (comma-separated gateway/service origins)
+
+The build fails when any required value is missing or invalid. These values are compiled into the published SDK and are not consumer provider options. The reference demo supplies only its normal `WalletConnectProvider` configuration; it cannot replace SDK service destinations or provider credentials.
+
+The SDK directory is a library-only package. The private reference consumer,
+its Vite entrypoint and application tests live in
+[`apps/sdk-demo`](../../apps/sdk-demo/README.md). Use `pnpm watch:demo` from the
+repository root for the supported SDK-and-app development loop; the app still
+resolves this package through its public `dist` export.
+
 ## Installation
 
 Install Wallet Connect Kit using your preferred package manager:
@@ -161,9 +179,9 @@ export function SignInButton() {
 
   const handleSignIn = async () => {
     try {
-      const token = await signInWithWallet();
-      console.log("Authentication token:", token);
-      // Save token to localStorage or send to backend
+      const proof = await signInWithWallet();
+      // Send the short-lived proof directly to your backend. Never log it or persist it in localStorage.
+      await sendProofToBackend(proof);
     } catch (error) {
       console.error("Sign in failed:", error);
     }
@@ -179,7 +197,7 @@ export function SignInButton() {
 
 ## Configuration
 
-`WalletConnectProvider` accepts an optional `config` prop to customize the SDK's behavior.
+`WalletConnectProvider` accepts a `config` prop to customize the SDK's behavior.
 
 ### Basic Configuration
 
@@ -188,17 +206,7 @@ import { WalletConnectProvider } from "@dogeos/dogeos-sdk";
 import type { WalletConnectKitConfig } from "@dogeos/dogeos-sdk";
 
 const dogeConfig: WalletConnectKitConfig = {
-  // WalletConnect project ID (obtain from https://cloud.walletconnect.com)
-  walletConnectProjectId: "your-project-id",
-
   clientId: "your-client-id",
-  // Application metadata
-  metadata: {
-    name: "My DApp",
-    description: "My decentralized application",
-    url: "https://myapp.com",
-    icons: ["https://myapp.com/icon.png"],
-  },
 };
 
 export function App() {
@@ -213,6 +221,7 @@ export function App() {
 ### Configure Supported Chains
 
 Chains are automatically loaded by default. If you need to customize chains, use the `getChains()` method:
+The examples below extend the `dogeConfig` object from the basic configuration example.
 
 ```tsx
 import { WalletConnectProvider, getChains } from "@dogeos/dogeos-sdk";
@@ -228,7 +237,7 @@ export function App() {
   }, []);
 
   return (
-    <WalletConnectProvider config={{ chains, clientId: "your-client-id" }}>
+    <WalletConnectProvider config={{ ...dogeConfig, chains }}>
       <YourApp />
     </WalletConnectProvider>
   );
@@ -253,7 +262,7 @@ export function App() {
   }, []);
 
   return (
-    <WalletConnectProvider config={{ connectors, clientId: "your-client-id" }}>
+    <WalletConnectProvider config={{ ...dogeConfig, connectors }}>
       <YourApp />
     </WalletConnectProvider>
   );
@@ -268,6 +277,7 @@ You can configure supported login methods, including basic logins (email, extern
 import { WalletConnectProvider } from "@dogeos/dogeos-sdk";
 
 const config = {
+  ...dogeConfig,
   login: {
     // Basic login methods
     basicLogins: ["email", "externalWallets"], // or ["email"] or ["externalWallets"]
@@ -278,7 +288,6 @@ const config = {
       { type: "x" },
     ],
   },
-  clientId: "your-client-id",
 };
 
 export function App() {
@@ -290,7 +299,11 @@ export function App() {
 }
 ```
 
-When a social login provider does not include a `clientId`, the SDK uses the default DogeOS Google and X client IDs configured for the embedded wallet.
+Provider credentials, browser delivery, session reconciliation, and service
+destinations are SDK-owned. Consumer applications select the enabled login
+controls and provide their registered DogeOS client ID. A successful SDK login
+continues to the associated embedded wallet automatically; returning wallet
+connections are restored by the provider without consumer session plumbing.
 
 ### Configure Theme
 
@@ -301,6 +314,7 @@ import { WalletConnectProvider } from "@dogeos/dogeos-sdk";
 import type { ThemeConfig } from "@dogeos/dogeos-sdk";
 
 const config = {
+  ...dogeConfig,
   theme: {
     themes: {
       light: {
@@ -325,7 +339,6 @@ const config = {
       },
     },
   } as ThemeConfig,
-  clientId: "your-client-id",
 };
 
 export function App() {
@@ -389,7 +402,10 @@ export function App() {
     // Login configuration
     login: {
       basicLogins: ["email", "externalWallets"],
-      socialLogins: [{ type: "google" }, { type: "x" }],
+      socialLogins: [
+        { type: "google" },
+        { type: "x" },
+      ],
     },
 
     // Theme configuration
@@ -433,7 +449,7 @@ Main Provider component for wrapping your application.
 ```tsx
 interface WalletConnectProviderProps {
   children: React.ReactNode;
-  config?: WalletConnectKitConfig;
+  config: WalletConnectKitConfig;
 }
 ```
 
@@ -550,7 +566,7 @@ export function MyComponent() {
   }, []);
 
   // Use chains in your config
-  const config = { chains };
+  const config = { ...dogeConfig, chains };
 }
 ```
 
@@ -702,7 +718,7 @@ import { config } from "./wagmi-config";
 export function App() {
   return (
     <WagmiProvider config={config}>
-      <WalletConnectProvider>
+      <WalletConnectProvider config={dogeConfig}>
         <YourApp />
       </WalletConnectProvider>
     </WagmiProvider>
@@ -840,14 +856,9 @@ type ChainType = "evm" | "solana" | "aptos" | "dogecoin";
 
 ### What Content Security Policy entries are required?
 
-If your app uses a restrictive CSP, allow the DogeOS embedded wallet iframe and Tomo social login relay:
+If your app uses a restrictive CSP, allow the embedded-wallet, Social Relay, and Web3 Assets origins documented for the published SDK release you install. Those origins are compiled into the SDK by the release pipeline and cannot be overridden by the consumer app.
 
-```tsx
-<meta
-  httpEquiv="Content-Security-Policy"
-  content="frame-src 'self' https://dogeos.embedded-wallet.tomo.inc; connect-src 'self' https://mydoge-wallet.tomo.inc https://social-relay.tomo.inc;"
-/>
-```
+Use the exact origins from that release in `frame-src` and `connect-src`; do not substitute consumer-controlled endpoints.
 
 ### How to get WalletConnect Project ID?
 
@@ -869,7 +880,7 @@ const chains = await getChains();
 const connectors = await getConnectors();
 
 // Use in config
-const config = { chains, connectors };
+const config = { ...dogeConfig, chains, connectors };
 ```
 
 The `getChains()` method automatically fetches chains from the backend API and includes EVM, Solana, Aptos, and Dogecoin chains. The `getConnectors()` method loads all available connectors including EIP6963, Wallet Standard, and WalletConnect wallets.