docs: latest (#1443)

coinbase · Oct 17, 2024 · 2a92382 · 2a92382
1 parent 2eb20e7
commit 2a92382
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,12 @@
 
 ### Patch Changes
 
-- b5b8425: -**chore**: Update missing address error handling in the `Identity` components. By @cpcramer #1430
-- 951ea32: -**feat**: Added formatting for scientific notation for Swap amounts. by @0xAlec #1423 -**feat**: Added `paymaster` field to OnchainKitConfig. by @0xAlec #1425 -**feat** Added `isSponsored` to `Pay` component. by 0xAlec #1427 -**feat**: Added `Pay` component theming support. By @cpcramer #1431 -**fix**: Added browser window check in usePreferredColorScheme to fix server side errors. By @cpcramer #1424
+- **chore**: Update missing address error handling in the `Identity` components. By @cpcramer #1430
+- **feat**: Added formatting for scientific notation for Swap amounts. by @0xAlec #1423
+- **feat**: Added `paymaster` field to OnchainKitConfig. by @0xAlec #1425
+- **feat** Added `isSponsored` to `Pay` component. by 0xAlec #1427
+- **feat**: Added `Pay` component theming support. By @cpcramer #1431
+- **fix**: Added browser window check in usePreferredColorScheme to fix server side errors. By @cpcramer #1424
 
 ## 0.34.0
 

diff --git a/site/docs/pages/config/types.mdx b/site/docs/pages/config/types.mdx
@@ -29,9 +29,17 @@ type isEthereumOptions = {
 type OnchainKitConfig = {
   address: Address | null; // Address is optional as we may not have an address for new users
   apiKey: string | null; // ApiKey for Coinbase Developer Platform APIs
-  rpcUrl: string | null; // RPC URL for onchain requests. Defaults to using CDP Node if the API Key is set
   chain: Chain; // Chain must be provided as we need to know which chain to use
+  config?: {
+    appearance?: {
+      mode?: Mode | null; // Optionally determines color scheme based on OS preference or user selection
+      theme?: ComponentTheme | null; // Optionally sets the visual style for components
+    };
+    paymaster?: string | null; // Paymaster URL for sponsorship
+  };
+  rpcUrl: string | null; // RPC URL for onchain requests. Defaults to using CDP Node if the API Key is set
   schemaId: EASSchemaUid | null; // SchemaId is optional as not all apps need to use EAS
+  projectId: string | null; // ProjectId from Coinbase Developer Platform, only required for Coinbase Onramp support
 };
 ```
 
@@ -49,7 +57,15 @@ type OnchainKitProviderReact = {
   apiKey?: string;
   chain: Chain;
   children: ReactNode;
+  config?: {
+    appearance?: {
+      mode?: Mode | null;
+      theme?: ComponentTheme | null;
+    };
+    paymaster?: string;
+  };
   rpcUrl?: string;
   schemaId?: EASSchemaUid;
+  projectId?: string;
 };
 ```
diff --git a/site/docs/pages/pay/types.mdx b/site/docs/pages/pay/types.mdx
@@ -18,6 +18,17 @@ type LifecycleStatus =
       statusName: 'error';
       statusData: TransactionError;
     }
+  | {
+      statusName: 'fetchingData';
+      statusData: LifecycleStatusDataShared;
+    }
+  | {
+      statusName: 'ready';
+      statusData: {
+        chargeId: string;
+        contracts: ContractFunctionParameters[];
+      };
+    }
   | {
       statusName: 'paymentPending';
       statusData: LifecycleStatusDataShared;
@@ -51,6 +62,7 @@ type PayReact = {
   chargeHandler?: () => Promise<string>;
   children: React.ReactNode;
   className?: string;
+  isSponsored?: boolean;
   onStatus?: (status: LifecycleStatus) => void;
   productId?: string;
 };

diff --git a/site/package.json b/site/package.json
@@ -9,7 +9,7 @@
     "sitemap": "node createSitemap.js"
   },
   "dependencies": {
-    "@coinbase/onchainkit": "0.34.0",
+    "@coinbase/onchainkit": "0.34.1",
     "@types/react": "latest",
     "@vercel/edge": "^1.1.1",
     "express": "^4.21.1",

diff --git a/site/yarn.lock b/site/yarn.lock
@@ -479,9 +479,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@coinbase/onchainkit@npm:0.34.0":
-  version: 0.34.0
-  resolution: "@coinbase/onchainkit@npm:0.34.0"
+"@coinbase/onchainkit@npm:0.34.1":
+  version: 0.34.1
+  resolution: "@coinbase/onchainkit@npm:0.34.1"
   dependencies:
     "@rainbow-me/rainbowkit": "npm:^2.1.3"
     "@tanstack/react-query": "npm:^5"
@@ -496,7 +496,7 @@ __metadata:
     "@xmtp/frames-validator": ^0.6.0
     react: ^18
     react-dom: ^18
-  checksum: 70117d6f7680278417c53d301f3db7fd8e9e018e629b0bdd66a67c6fd3ed49d78cf935e944fe19e353f2e164d0349e6fd1ac26e3dcec7124e9424fef6e73014e
+  checksum: 5687e1273fed3e7504d910da68324bb023de68f064c65c914ab6efa1d09c97c27da8926c1a0a60f2989e5a84bec9e77904e5d09b9e19847350671a85e9cfafb2
   languageName: node
   linkType: hard
 
@@ -8528,7 +8528,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "onchainkit@workspace:."
   dependencies:
-    "@coinbase/onchainkit": "npm:0.34.0"
+    "@coinbase/onchainkit": "npm:0.34.1"
     "@types/express": "npm:^4"
     "@types/react": "npm:latest"
     "@types/sitemap-generator": "npm:^8"