Skip to content

Commit 3179bf9

Browse files
yosriadyclaude
andauthored
Point the Solana JSDoc at the packages that actually exist (#319)
The @example blocks on SolanaOptions.store and SolanaManager.setStore told users to `import { createClient } from '@solana-foundation/framework-kit'`. That package does not exist; npm returns a 404. framework-kit ships as `@solana/client` and `@solana/react-hooks`, which is what examples/with-solana depends on and what the docs instruct. SolanaOptions is the type users hover in their editor when wiring the Solana integration, so this is the first import they copy. The two prose mentions keep calling it framework-kit, which is correct as the project name; they just drop the bogus package scope. The examples also import `autoDiscover`, since both examples call it. Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 42f1b49 commit 3179bf9

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

src/solana/SolanaManager.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export class SolanaManager {
4747
*
4848
* @example
4949
* ```tsx
50-
* import { createClient } from '@solana-foundation/framework-kit';
50+
* import { createClient, autoDiscover } from '@solana/client';
5151
*
5252
* const client = createClient({ endpoint: '...', walletConnectors: autoDiscover() });
5353
* formo.solana.setStore(client.store);

src/solana/storeTypes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* Type definitions for framework-kit's zustand store integration.
33
*
4-
* These types mirror the state shape of @solana-foundation/framework-kit's
4+
* These types mirror the state shape of framework-kit's
55
* vanilla zustand store, allowing the SDK to subscribe to wallet and
66
* transaction state changes without wrapping any wallet methods.
77
*

src/solana/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ export interface SolanaOptions {
7575
* When provided, wallet connect/disconnect and transaction events are tracked
7676
* automatically by subscribing to zustand store state changes.
7777
*
78-
* This is the recommended approach for apps using @solana-foundation/framework-kit.
78+
* This is the recommended approach for apps using framework-kit.
7979
*
8080
* @example
8181
* ```tsx
82-
* import { createClient } from '@solana-foundation/framework-kit';
82+
* import { createClient, autoDiscover } from '@solana/client';
8383
* const client = createClient({ endpoint, walletConnectors: autoDiscover() });
8484
* const formo = await Formo.init(writeKey, { solana: { store: client.store } });
8585
* ```

0 commit comments

Comments
 (0)