Updating Base Account Reference section #150

youssefea · 2025-07-29T17:28:38Z

What changed? Why?

Restructure Reference section (Account SDK, Provider, UI Elements, Onchain Contracts)
Expose all of the RPC methods and Capabilities
Add 'createBaseAccountSDK' reference
Add multiple capabilities and RPC methods
Update the Overview page of the Provider sub section

cb-heimdall · 2025-07-29T17:28:41Z

✅ Heimdall Review Status

Requirement Status More Info

Reviews

✅ 1/1

Denominator calculation

Show calculation

1 if user is bot 0

1 if user is external 0

2 if repo is sensitive 0

From .codeflow.yml 1

Additional review requirements

Show calculation

Max	0

0

From CODEOWNERS 0

Global minimum 0

Max 1

1

1 if commit is unverified 0

Sum 1

montycheese · 2025-07-30T14:46:20Z

docs/base-account/reference/base-pay/pay.mdx

+{
+  success: false,
+  error: "Insufficient balance",
+  amount: "10.50",
+  to: "0x1234567890123456789012345678901234567890"
+}
+```
+</ResponseExample>



@spencerstock has an ongoing PR to throw errors instead of returning typed responses base/account-sdk#71

Let's hold off on this section until the PR is resolved

I'll merge this now and update when Spencer merges his PR

docs/base-account/reference/core/getCryptoKeyAccount.mdx

montycheese · 2025-07-30T15:00:50Z

docs/base-account/reference/core/getCryptoKeyAccount.mdx

+- Session expired
+
+Always wrap calls in a try-catch block:
+
+```typescript
+async function safeGetAccount() {
+  try {
+    const cryptoAccount = await getCryptoKeyAccount();
+    return cryptoAccount?.account;
+  } catch (error) {
+    console.error('Error getting crypto account:', error);
+
+    if (error.message.includes('not initialized')) {
+      // SDK not properly initialized
+      throw new Error('Base Account SDK not initialized');
+    } else if (error.message.includes('permission denied')) {
+      // User denied access
+      throw new Error('User denied account access');
+    } else if (error.message.includes('session expired')) {
+      // Session needs refresh
+      throw new Error('Session expired, please reconnect');
+    } else {
+      // Unknown error
+      throw new Error('Failed to access account');
+    }
+  }
+}
+```
+
+## Real-time Account Updates
+
+```typescript
+import { getCryptoKeyAccount } from '@base-org/account';
+
+class AccountMonitor {
+  private account: WebAuthnAccount | LocalAccount | null = null;
+  private listeners: ((account: any) => void)[] = [];
+  private pollInterval: NodeJS.Timeout | null = null;
+
+  async start() {
+    // Initial check
+    await this.checkAccount();
+
+    // Poll for changes every 5 seconds
+    this.pollInterval = setInterval(() => {
+      this.checkAccount();
+    }, 5000);
+  }
+
+  stop() {
+    if (this.pollInterval) {
+      clearInterval(this.pollInterval);
+      this.pollInterval = null;
+    }
+  }
+
+  private async checkAccount() {
+    try {
+      const cryptoAccount = await getCryptoKeyAccount();
+      const newAccount = cryptoAccount?.account;
+
+      // Check if account changed
+      if (newAccount?.address !== this.account?.address) {
+        const previousAccount = this.account;
+        this.account = newAccount;
+
+        // Notify listeners
+        this.listeners.forEach(listener => {
+          listener({
+            previous: previousAccount,
+            current: newAccount
+          });
+        });
+      }
+    } catch (error) {
+      console.error('Error monitoring account:', error);
+    }
+  }
+
+  onAccountChange(listener: (account: any) => void) {
+    this.listeners.push(listener);
+  }
+
+  getCurrentAccount() {
+    return this.account;
+  }
+}
+```
+
+## Best Practices
+
+1. **Check for null returns**: Always check if account exists before using
+2. **Handle errors gracefully**: Wrap calls in try-catch blocks
+3. **Cache results**: Avoid excessive calls by caching account information
+4. **Monitor changes**: Implement account change detection for better UX
+5. **Validate data**: Always verify account data integrity
+
+import PolicyBanner from "/snippets/PolicyBanner.mdx";
+
+<PolicyBanner />


let's delete section, this library is meant to be used to manage sub account signers.

deleted, thanks

montycheese · 2025-07-30T15:02:28Z

docs/base-account/reference/core/getKeypair.mdx

+| Code | Message | Description |
+| ---- | ------- | ----------- |
+| 4100 | Storage access denied | Cannot access secure key storage |
+| 4200 | Storage corruption | Stored key data is corrupted or invalid |
+| 4300 | Browser compatibility | Browser does not support required storage APIs |
+


the AI is hallucinating here, we don't throw these error codes.

montycheese · 2025-07-30T15:04:29Z

docs/base-account/reference/core/getKeypair.mdx

+}
+```
+
+## Integration with Account Management


I would reframe this section as maybe "usage example". I don't want to confuse devs that this is how we want them to do base account account management, since this is not what this library is used for (it's for managing sub account local signers)

I just removed it

docs/base-account/reference/core/getCryptoKeyAccount.mdx

montycheese · 2025-07-30T15:07:19Z

docs/base-account/reference/core/getCryptoKeyAccount.mdx

+```typescript Success Response (WebAuthn Account)
+{
+  account: {
+    address: "0xd46e8dd67c5d32be8058bb8eb970870f07244567",


Suggested change

address: "0xd46e8dd67c5d32be8058bb8eb970870f07244567",

stephancill

Left some comments

stephancill · 2025-07-30T15:08:46Z

docs/base-account/reference/core/provider-rpc-methods/wallet_connect.mdx

+}
+```
+
+```json signInWithEthereum Response


should consider just linking out to the SIWE capability page so that we don't have to maintain this in two places

agree - removed from there for now and added linking to the capability

stephancill · 2025-07-30T15:10:38Z

docs/base-account/reference/core/getCryptoKeyAccount.mdx

+Defined in the [Base Account SDK](https://github.com/base/account-sdk)
+
+<Info>
+Retrieves the current crypto account associated with the user's session. This is the primary function for accessing account information in Base Account applications.


finding this hard to understand

stephancill · 2025-07-30T15:11:23Z

docs/base-account/reference/core/getKeypair.mdx

+Defined in the [Base Account SDK](https://github.com/base/account-sdk)
+
+<Info>
+Retrieves an existing P256 key pair if one has been previously generated and stored. This is useful for checking if keys already exist before generating new ones.


could we maybe combine this, getCryptoKeyAccount, and generateKeyPair into a single page?

will take a look at this in a next PR

Co-authored-by: Montana <[email protected]>

Approved review 3071896399 from ericbrown99 is now dismissed due to new commit. Re-request for approval.

Co-authored-by: Montana <[email protected]>

add base account reference changes

6570c10

mintlify bot deployed to staging - docs July 29, 2025 17:29 View deployment

update rpc methods and capabilities

a17d85e

mintlify bot deployed to staging - docs July 30, 2025 12:49 View deployment

youssefea requested review from ericbrown99 and wilsoncusack July 30, 2025 12:56

ericbrown99 previously approved these changes Jul 30, 2025

View reviewed changes

montycheese reviewed Jul 30, 2025

View reviewed changes

stephancill reviewed Jul 30, 2025

View reviewed changes

Update docs/base-account/reference/core/getCryptoKeyAccount.mdx

ba599bb

Co-authored-by: Montana <[email protected]>

youssefea and others added 3 commits July 30, 2025 16:43

Update docs/base-account/reference/core/getCryptoKeyAccount.mdx

e3a9fa5

Co-authored-by: Montana <[email protected]>

Update docs/base-account/reference/core/getCryptoKeyAccount.mdx

3c2949b

Co-authored-by: Montana <[email protected]>

Update docs/base-account/reference/core/getCryptoKeyAccount.mdx

43ec032

Co-authored-by: Montana <[email protected]>

mintlify bot deployed to staging - docs July 30, 2025 15:43 View deployment

mintlify bot deployed to staging - docs July 30, 2025 15:44 View deployment

update delete section from getCryptoKeyAccount

4f9d8a1

mintlify bot deployed to staging - docs July 30, 2025 15:45 View deployment

Update docs/base-account/reference/core/getCryptoKeyAccount.mdx

f481e31

Co-authored-by: Montana <[email protected]>

mintlify bot deployed to staging - docs July 30, 2025 15:47 View deployment

update getKeyPair section

21ec5cf

mintlify bot deployed to staging - docs July 30, 2025 15:48 View deployment

update wallet connect

00dab00

mintlify bot deployed to staging - docs July 30, 2025 15:52 View deployment

add capability link

f9c750e

mintlify bot deployed to staging - docs July 30, 2025 15:56 View deployment

Merge branch 'master' into update-reference

f56af87

mintlify bot deployed to staging - docs July 30, 2025 21:34 View deployment

ericbrown99 approved these changes Jul 31, 2025

View reviewed changes

youssefea merged commit e1a71ee into master Jul 31, 2025
7 checks passed

youssefea deleted the update-reference branch July 31, 2025 12:50

Updating Base Account Reference section #150

Updating Base Account Reference section #150

Uh oh!

Conversation

youssefea commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cb-heimdall commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Heimdall Review Status

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephancill left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

youssefea commented Jul 29, 2025 •

edited

Loading

cb-heimdall commented Jul 29, 2025 •

edited

Loading