@dngbuilds/zapkit-react 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +30 -30
  2. package/package.json +23 -22
package/README.md CHANGED
@@ -91,18 +91,18 @@ Wraps your application and initializes ZapKit + TanStack Query.
91
91
  ```tsx
92
92
  <ZapProvider
93
93
  config={{ network: "mainnet" }}
94
- queryClient={customQueryClient} // optional — bring your own
95
- showDevPanel={false} // optional — error overlay for dev
94
+ queryClient={customQueryClient} // optional — bring your own
95
+ showDevPanel={false} // optional — error overlay for dev
96
96
  >
97
97
  <App />
98
98
  </ZapProvider>
99
99
  ```
100
100
 
101
- | Prop | Type | Default | Description |
102
- | ------------- | -------------- | ------- | ---------------------------------------- |
103
- | `config` | `ZapKitConfig` | — | Network and SDK configuration |
104
- | `queryClient` | `QueryClient` | auto | Custom TanStack Query client |
105
- | `showDevPanel`| `boolean` | `false` | Show developer error panel |
101
+ | Prop | Type | Default | Description |
102
+ | -------------- | -------------- | ------- | ----------------------------- |
103
+ | `config` | `ZapKitConfig` | — | Network and SDK configuration |
104
+ | `queryClient` | `QueryClient` | auto | Custom TanStack Query client |
105
+ | `showDevPanel` | `boolean` | `false` | Show developer error panel |
106
106
 
107
107
  ## Hooks
108
108
 
@@ -112,15 +112,15 @@ Returns wallet connection state and actions.
112
112
 
113
113
  ```ts
114
114
  const {
115
- address, // string | null — connected wallet address
116
- ens, // string | null — resolved StarkNet ID
117
- status, // "idle" | "connecting" | "connected" | "error"
118
- balances, // Record<string, string>
119
- loading, // boolean
120
- error, // Error | null
121
- connect, // (options: OnboardOptions) => Promise<void>
115
+ address, // string | null — connected wallet address
116
+ ens, // string | null — resolved StarkNet ID
117
+ status, // "idle" | "connecting" | "connected" | "error"
118
+ balances, // Record<string, string>
119
+ loading, // boolean
120
+ error, // Error | null
121
+ connect, // (options: OnboardOptions) => Promise<void>
122
122
  disconnect, // () => void
123
- ensureReady,// () => Promise<void>
123
+ ensureReady, // () => Promise<void>
124
124
  } = useWallet();
125
125
  ```
126
126
 
@@ -135,19 +135,19 @@ await zapkit?.stake({ poolAddress: "0x…", amount });
135
135
 
136
136
  ### Query Hooks (TanStack Query)
137
137
 
138
- | Hook | Description |
139
- | ------------------- | ---------------------------------- |
140
- | `useBalance()` | Fetch token balance |
141
- | `useStakingPools()` | List available staking pools |
142
- | `useBridgingTokens()` | List available bridging tokens |
138
+ | Hook | Description |
139
+ | --------------------- | ------------------------------ |
140
+ | `useBalance()` | Fetch token balance |
141
+ | `useStakingPools()` | List available staking pools |
142
+ | `useBridgingTokens()` | List available bridging tokens |
143
143
 
144
144
  ### Mutation Hooks (TanStack Query)
145
145
 
146
- | Hook | Description |
147
- | --------------- | ----------------------------------- |
148
- | `useSwap()` | Execute a token swap |
149
- | `useStaking()` | Stake / unstake / claim rewards |
150
- | `useLending()` | Lending protocol interactions |
146
+ | Hook | Description |
147
+ | -------------- | ------------------------------- |
148
+ | `useSwap()` | Execute a token swap |
149
+ | `useStaking()` | Stake / unstake / claim rewards |
150
+ | `useLending()` | Lending protocol interactions |
151
151
 
152
152
  ## Pre-built UI Components
153
153
 
@@ -180,11 +180,11 @@ export type { EnsureReadyOptions, ExecuteOptions, RpcProvider, Call };
180
180
 
181
181
  ## Wallet Strategies
182
182
 
183
- | Strategy | Import | Description |
184
- | ---------- | ------------------------- | ----------------------------------- |
185
- | Cartridge | `OnboardStrategy.Cartridge` | Social login & passkeys |
186
- | Signer | `OnboardStrategy.Signer` | Direct private-key signing |
187
- | Privy | `OnboardStrategy.Privy` | Email & social auth via Privy |
183
+ | Strategy | Import | Description |
184
+ | --------- | --------------------------- | ----------------------------- |
185
+ | Cartridge | `OnboardStrategy.Cartridge` | Social login & passkeys |
186
+ | Signer | `OnboardStrategy.Signer` | Direct private-key signing |
187
+ | Privy | `OnboardStrategy.Privy` | Email & social auth via Privy |
188
188
 
189
189
  ## Vite Configuration
190
190
 
package/package.json CHANGED
@@ -1,7 +1,16 @@
1
1
  {
2
2
  "name": "@dngbuilds/zapkit-react",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "React hooks and provider for Starknet — wallet connection in minutes, not hours.",
5
+ "keywords": [
6
+ "defi",
7
+ "hooks",
8
+ "react",
9
+ "starknet",
10
+ "wallet",
11
+ "web3",
12
+ "zapkit"
13
+ ],
5
14
  "homepage": "https://zapkit.vercel.app",
6
15
  "bugs": {
7
16
  "url": "https://github.com/DngBuilds/zapkit/issues"
@@ -13,15 +22,6 @@
13
22
  "url": "git+https://github.com/DngBuilds/zapkit.git",
14
23
  "directory": "packages/react"
15
24
  },
16
- "keywords": [
17
- "starknet",
18
- "wallet",
19
- "react",
20
- "hooks",
21
- "web3",
22
- "defi",
23
- "zapkit"
24
- ],
25
25
  "files": [
26
26
  "dist"
27
27
  ],
@@ -33,15 +33,22 @@
33
33
  "publishConfig": {
34
34
  "access": "public"
35
35
  },
36
+ "scripts": {
37
+ "build": "vp pack",
38
+ "dev": "vp pack --watch",
39
+ "test": "vp test",
40
+ "check": "vp check",
41
+ "prepublishOnly": "vp run build"
42
+ },
36
43
  "dependencies": {
37
- "@tanstack/react-query": "^5.95.2",
38
- "react": "^19.2.4",
39
- "react-dom": "^19.2.4",
40
- "@dngbuilds/zapkit-core": "0.1.0"
44
+ "@dngbuilds/zapkit-core": "workspace:*",
45
+ "@tanstack/react-query": "catalog:",
46
+ "react": "catalog:",
47
+ "react-dom": "catalog:"
41
48
  },
42
49
  "devDependencies": {
43
50
  "@types/node": "^25.5.0",
44
- "@types/react": "^19.2.14",
51
+ "@types/react": "catalog:",
45
52
  "@typescript/native-preview": "7.0.0-dev.20260316.1",
46
53
  "bumpp": "^11.0.1",
47
54
  "typescript": "^5.9.3",
@@ -56,11 +63,5 @@
56
63
  "starknet": "9.4.2",
57
64
  "starkzap": "2.0.0",
58
65
  "ts-mixer": "6.0.4"
59
- },
60
- "scripts": {
61
- "build": "vp pack",
62
- "dev": "vp pack --watch",
63
- "test": "vp test",
64
- "check": "vp check"
65
66
  }
66
- }
67
+ }