@satoshai/kit 0.1.0

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.
package/dist/index.js ADDED
@@ -0,0 +1,610 @@
1
+ import { WalletConnect, setSelectedProviderId, request, getSelectedProvider, clearSelectedProviderId } from '@stacks/connect';
2
+ import { createContext, useState, useEffect, useCallback, useMemo, useContext } from 'react';
3
+ import { jsx } from 'react/jsx-runtime';
4
+ import { PostConditionMode, postConditionToHex, cvToHex } from '@stacks/transactions';
5
+ import { getPrimaryName } from 'bns-v2-sdk';
6
+
7
+ // src/constants/stacks-provider-mapping.ts
8
+ var STACKS_TO_STACKS_CONNECT_PROVIDERS = {
9
+ xverse: "XverseProviders.BitcoinProvider",
10
+ leather: "LeatherProvider",
11
+ asigna: "AsignaProvider",
12
+ fordefi: "FordefiProviders.UtxoProvider",
13
+ "wallet-connect": "WalletConnectProvider"
14
+ };
15
+
16
+ // src/constants/storage-keys.ts
17
+ var LOCAL_STORAGE_STACKS = "@satoshai/kit";
18
+
19
+ // src/constants/wallets.ts
20
+ var SUPPORTED_STACKS_WALLETS = [
21
+ "xverse",
22
+ "leather",
23
+ "okx",
24
+ "asigna",
25
+ "fordefi",
26
+ "wallet-connect"
27
+ ];
28
+
29
+ // src/utils/get-stacks-wallets.ts
30
+ var getStacksWallets = () => {
31
+ const supported = [...SUPPORTED_STACKS_WALLETS];
32
+ const installed = supported.filter(
33
+ (wallet) => checkIfStacksProviderIsInstalled(wallet)
34
+ );
35
+ return { supported, installed };
36
+ };
37
+ var checkIfStacksProviderIsInstalled = (wallet) => {
38
+ if (typeof window === "undefined") return true;
39
+ switch (wallet) {
40
+ case "xverse":
41
+ return !!window.XverseProviders;
42
+ case "leather":
43
+ return !!window.LeatherProvider || !!window.HiroWalletProvider;
44
+ case "asigna":
45
+ return !!window.AsignaProvider;
46
+ case "okx":
47
+ return !!window.okxwallet;
48
+ case "fordefi":
49
+ return !!window.FordefiProviders?.UtxoProvider;
50
+ case "wallet-connect":
51
+ return true;
52
+ }
53
+ };
54
+ var STACKS_CHAIN_MAPPING = {
55
+ mainnet: WalletConnect.Chains.Stacks.Mainnet,
56
+ testnet: WalletConnect.Chains.Stacks.Testnet
57
+ };
58
+ var buildWalletConnectConfig = (projectId, metadata, chains) => {
59
+ const selectedChains = chains ?? ["mainnet"];
60
+ const walletConnectChains = selectedChains.map(
61
+ (chain) => STACKS_CHAIN_MAPPING[chain]
62
+ );
63
+ return {
64
+ projectId,
65
+ metadata: {
66
+ name: "Universal Connector",
67
+ description: "Universal Connector",
68
+ url: "https://appkit.reown.com",
69
+ icons: ["https://appkit.reown.com/icon.png"],
70
+ ...metadata
71
+ },
72
+ networks: [
73
+ {
74
+ ...WalletConnect.Networks.Stacks,
75
+ chains: walletConnectChains
76
+ }
77
+ ]
78
+ };
79
+ };
80
+ var getOKXStacksAddress = async () => {
81
+ if (!window.okxwallet) {
82
+ throw new Error("\u{1F6A8} OKX Wallet is not installed");
83
+ }
84
+ const stacksResponse = await window.okxwallet.stacks.connect();
85
+ if (!stacksResponse) {
86
+ throw new Error("\u{1F6A8} Failed to connect with OKX Wallet");
87
+ }
88
+ return {
89
+ address: stacksResponse.address,
90
+ provider: "okx"
91
+ };
92
+ };
93
+ var extractStacksAddress = (typedProvider, addresses) => {
94
+ if (!addresses.length) {
95
+ throw new Error(`No addresses provided for ${typedProvider} wallet`);
96
+ }
97
+ if (typedProvider === "leather" || typedProvider === "asigna") {
98
+ const stxAddress = addresses.find(
99
+ (addr) => addr.symbol === "STX"
100
+ )?.address;
101
+ if (stxAddress) return stxAddress;
102
+ }
103
+ const stacksAddress = addresses.find(
104
+ (addr) => addr.address?.startsWith("S")
105
+ )?.address;
106
+ if (stacksAddress) return stacksAddress;
107
+ const legacyAddress = addresses[2]?.address;
108
+ if (legacyAddress?.startsWith("S")) return legacyAddress;
109
+ throw new Error(
110
+ `No valid Stacks address found for ${typedProvider} wallet`
111
+ );
112
+ };
113
+ var getXverseProductInfo = async () => await window.XverseProviders?.StacksProvider?.getProductInfo?.() ?? null;
114
+ var shouldSupportAccountChange = (version) => version !== void 0 && version !== "1.0.0";
115
+ var waitForXverseProvider = async (maxAttempts = 10, initialDelay = 200) => {
116
+ for (let i = 0; i < maxAttempts; i++) {
117
+ const provider = getSelectedProvider();
118
+ if (provider?.request && provider?.addListener) return true;
119
+ await new Promise(
120
+ (resolve) => setTimeout(resolve, initialDelay * Math.min(i + 1, 5))
121
+ );
122
+ }
123
+ return false;
124
+ };
125
+ var extractAndValidateStacksAddress = (addresses, currentAddress, onAddressChange, connect) => {
126
+ if (!addresses || !Array.isArray(addresses)) {
127
+ void connect();
128
+ return;
129
+ }
130
+ const stacksAccount = addresses.find(
131
+ (acc) => acc.purpose === "stacks" || acc.addressType === "stacks"
132
+ );
133
+ if (!stacksAccount?.address) {
134
+ void connect();
135
+ return;
136
+ }
137
+ if (stacksAccount.address !== currentAddress) {
138
+ onAddressChange(stacksAccount.address);
139
+ }
140
+ };
141
+
142
+ // src/hooks/use-xverse/use-xverse.ts
143
+ var useXverse = ({
144
+ address,
145
+ provider,
146
+ onAddressChange,
147
+ connect
148
+ }) => {
149
+ const [isProviderReady, setIsProviderReady] = useState(false);
150
+ useEffect(() => {
151
+ if (provider !== "xverse") return;
152
+ const checkProvider = async () => {
153
+ const ready = await waitForXverseProvider();
154
+ setIsProviderReady(ready);
155
+ if (!ready) {
156
+ console.error("Xverse provider failed to initialize");
157
+ }
158
+ };
159
+ void checkProvider();
160
+ }, [provider]);
161
+ useEffect(() => {
162
+ if (provider !== "xverse" || !address || !isProviderReady) return;
163
+ let removeListener;
164
+ const setupXverse = async () => {
165
+ try {
166
+ const productInfo = await getXverseProductInfo();
167
+ if (!shouldSupportAccountChange(productInfo?.version)) return;
168
+ const response = await getSelectedProvider()?.request(
169
+ "wallet_connect",
170
+ null
171
+ );
172
+ extractAndValidateStacksAddress(
173
+ response?.result?.addresses,
174
+ address,
175
+ onAddressChange,
176
+ () => connect("xverse")
177
+ );
178
+ removeListener = getSelectedProvider()?.addListener(
179
+ "accountChange",
180
+ (event) => {
181
+ extractAndValidateStacksAddress(
182
+ event?.addresses,
183
+ address,
184
+ onAddressChange,
185
+ () => connect("xverse")
186
+ );
187
+ }
188
+ );
189
+ } catch (error) {
190
+ console.error("Failed to setup Xverse:", error);
191
+ }
192
+ };
193
+ void setupXverse();
194
+ return () => {
195
+ if (!removeListener) return;
196
+ try {
197
+ removeListener();
198
+ } catch (error) {
199
+ console.error("Failed to remove Xverse listener:", error);
200
+ }
201
+ };
202
+ }, [address, isProviderReady, onAddressChange, connect, provider]);
203
+ };
204
+
205
+ // src/utils/get-local-storage-wallet.ts
206
+ var getLocalStorageWallet = () => {
207
+ if (typeof window === "undefined") return null;
208
+ const stored = localStorage.getItem(LOCAL_STORAGE_STACKS);
209
+ if (!stored) return null;
210
+ try {
211
+ const data = JSON.parse(stored);
212
+ const isValid = SUPPORTED_STACKS_WALLETS.find(
213
+ (wallet) => wallet === data.provider
214
+ );
215
+ return isValid ? data : null;
216
+ } catch {
217
+ return null;
218
+ }
219
+ };
220
+ var StacksWalletContext = createContext(
221
+ void 0
222
+ );
223
+ var StacksWalletProvider = ({
224
+ children,
225
+ walletConnect,
226
+ onConnect,
227
+ onAddressChange,
228
+ onDisconnect
229
+ }) => {
230
+ const [address, setAddress] = useState();
231
+ const [provider, setProvider] = useState();
232
+ const [isConnecting, setIsConnecting] = useState(false);
233
+ useEffect(() => {
234
+ const loadPersistedWallet = async () => {
235
+ const persisted = getLocalStorageWallet();
236
+ if (!persisted) return;
237
+ setIsConnecting(true);
238
+ try {
239
+ if (persisted.provider === "okx") {
240
+ const data = await getOKXStacksAddress();
241
+ setAddress(data.address);
242
+ setProvider(data.provider);
243
+ return;
244
+ }
245
+ setAddress(persisted.address);
246
+ setProvider(persisted.provider);
247
+ setSelectedProviderId(
248
+ STACKS_TO_STACKS_CONNECT_PROVIDERS[persisted.provider]
249
+ );
250
+ } catch (error) {
251
+ console.error("Failed to restore wallet connection:", error);
252
+ } finally {
253
+ setIsConnecting(false);
254
+ }
255
+ };
256
+ void loadPersistedWallet();
257
+ }, []);
258
+ const connect = useCallback(
259
+ async (providerId, options) => {
260
+ const typedProvider = SUPPORTED_STACKS_WALLETS.find(
261
+ (wallet) => wallet === providerId
262
+ );
263
+ if (!typedProvider) {
264
+ const error = new Error(
265
+ "The wallet provider selected is not supported!"
266
+ );
267
+ console.error("\u{1F6A8}", error.message);
268
+ options?.onError?.(error);
269
+ return;
270
+ }
271
+ if (!checkIfStacksProviderIsInstalled(typedProvider)) {
272
+ const error = new Error(
273
+ `${typedProvider} wallet is not installed. Please install the wallet extension to continue.`
274
+ );
275
+ console.error("\u{1F6A8}", error.message);
276
+ options?.onError?.(error);
277
+ return;
278
+ }
279
+ if (typedProvider === "wallet-connect" && !walletConnect?.projectId) {
280
+ const error = new Error(
281
+ "WalletConnect requires a project ID. Please provide walletConnect.projectId to the StacksWalletProvider."
282
+ );
283
+ console.error("\u{1F6A8}", error.message);
284
+ options?.onError?.(error);
285
+ return;
286
+ }
287
+ setIsConnecting(true);
288
+ try {
289
+ if (typedProvider === "okx") {
290
+ const data2 = await getOKXStacksAddress();
291
+ setAddress(data2.address);
292
+ setProvider(data2.provider);
293
+ options?.onSuccess?.(data2.address, data2.provider);
294
+ return;
295
+ }
296
+ setSelectedProviderId(
297
+ STACKS_TO_STACKS_CONNECT_PROVIDERS[typedProvider]
298
+ );
299
+ const data = walletConnect ? await request(
300
+ {
301
+ walletConnect: buildWalletConnectConfig(
302
+ walletConnect.projectId,
303
+ walletConnect.metadata,
304
+ walletConnect.chains
305
+ )
306
+ },
307
+ "getAddresses",
308
+ {}
309
+ ) : await request("getAddresses");
310
+ const extractedAddress = extractStacksAddress(
311
+ typedProvider,
312
+ data.addresses
313
+ );
314
+ setAddress(extractedAddress);
315
+ setProvider(typedProvider);
316
+ options?.onSuccess?.(extractedAddress, typedProvider);
317
+ } catch (error) {
318
+ console.error("Failed to connect wallet:", error);
319
+ getSelectedProvider()?.disconnect?.();
320
+ clearSelectedProviderId();
321
+ options?.onError?.(error);
322
+ } finally {
323
+ setIsConnecting(false);
324
+ }
325
+ },
326
+ [walletConnect]
327
+ );
328
+ const disconnect = useCallback(
329
+ (callback) => {
330
+ localStorage.removeItem(LOCAL_STORAGE_STACKS);
331
+ setAddress(void 0);
332
+ setProvider(void 0);
333
+ getSelectedProvider()?.disconnect?.();
334
+ clearSelectedProviderId();
335
+ callback?.();
336
+ onDisconnect?.();
337
+ },
338
+ [onDisconnect]
339
+ );
340
+ useEffect(() => {
341
+ if (!address || !provider) return;
342
+ localStorage.setItem(
343
+ LOCAL_STORAGE_STACKS,
344
+ JSON.stringify({ address, provider })
345
+ );
346
+ }, [address, provider]);
347
+ useEffect(() => {
348
+ if (!address || !provider || !onConnect) return;
349
+ onConnect(provider, address);
350
+ }, [address, provider, onConnect]);
351
+ useXverse({
352
+ address,
353
+ provider,
354
+ onAddressChange: (newAddress) => {
355
+ setAddress(newAddress);
356
+ onAddressChange?.(newAddress);
357
+ },
358
+ connect
359
+ });
360
+ const value = useMemo(() => {
361
+ const walletState = isConnecting ? { status: "connecting", address: void 0, provider: void 0 } : address && provider ? { status: "connected", address, provider } : {
362
+ status: "disconnected",
363
+ address: void 0,
364
+ provider: void 0
365
+ };
366
+ return {
367
+ ...walletState,
368
+ connect,
369
+ disconnect
370
+ };
371
+ }, [address, provider, isConnecting, connect, disconnect]);
372
+ return /* @__PURE__ */ jsx(StacksWalletContext.Provider, { value, children });
373
+ };
374
+ var useStacksWalletContext = () => {
375
+ const context = useContext(StacksWalletContext);
376
+ if (context === void 0) {
377
+ throw new Error(
378
+ "\u{1F6A8} Stacks wallet hooks must be used within StacksWalletProvider"
379
+ );
380
+ }
381
+ return context;
382
+ };
383
+ var useAddress = () => {
384
+ const { address, status, provider } = useStacksWalletContext();
385
+ return useMemo(() => {
386
+ if (status === "connected" && address && provider) {
387
+ return {
388
+ address,
389
+ isConnected: true,
390
+ isConnecting: false,
391
+ isDisconnected: false,
392
+ provider
393
+ };
394
+ }
395
+ return {
396
+ address: void 0,
397
+ isConnected: false,
398
+ isConnecting: status === "connecting",
399
+ isDisconnected: status === "disconnected",
400
+ provider: void 0
401
+ };
402
+ }, [address, status, provider]);
403
+ };
404
+ var useConnect = () => {
405
+ const { connect, status } = useStacksWalletContext();
406
+ const value = useMemo(
407
+ () => ({
408
+ connect,
409
+ connectors: SUPPORTED_STACKS_WALLETS,
410
+ isPending: status === "connecting"
411
+ }),
412
+ [connect, status]
413
+ );
414
+ return value;
415
+ };
416
+ var useDisconnect = () => {
417
+ const { disconnect } = useStacksWalletContext();
418
+ return useMemo(
419
+ () => ({
420
+ disconnect
421
+ }),
422
+ [disconnect]
423
+ );
424
+ };
425
+ var useSignMessage = () => {
426
+ const { isConnected, provider } = useAddress();
427
+ const [data, setData] = useState(void 0);
428
+ const [error, setError] = useState(null);
429
+ const [isPending, setIsPending] = useState(false);
430
+ const signMessageAsync = useCallback(
431
+ async (variables) => {
432
+ if (!isConnected) {
433
+ throw new Error("Wallet is not connected");
434
+ }
435
+ setIsPending(true);
436
+ setError(null);
437
+ setData(void 0);
438
+ try {
439
+ let result;
440
+ if (provider === "okx") {
441
+ if (!window.okxwallet) {
442
+ throw new Error("OKX wallet not found");
443
+ }
444
+ result = await window.okxwallet.stacks.signMessage({
445
+ message: variables.message
446
+ });
447
+ } else {
448
+ result = await request("stx_signMessage", {
449
+ message: variables.message,
450
+ ...variables.publicKey && {
451
+ publicKey: variables.publicKey
452
+ }
453
+ });
454
+ }
455
+ setData(result);
456
+ setIsPending(false);
457
+ return result;
458
+ } catch (err) {
459
+ const error2 = err instanceof Error ? err : new Error(String(err));
460
+ setError(error2);
461
+ setIsPending(false);
462
+ throw error2;
463
+ }
464
+ },
465
+ [isConnected, provider]
466
+ );
467
+ const signMessage = useCallback(
468
+ (variables, options) => {
469
+ signMessageAsync(variables).then((data2) => {
470
+ options?.onSuccess?.(data2);
471
+ options?.onSettled?.(data2, null);
472
+ }).catch((error2) => {
473
+ options?.onError?.(error2);
474
+ options?.onSettled?.(void 0, error2);
475
+ });
476
+ },
477
+ [signMessageAsync]
478
+ );
479
+ return {
480
+ signMessage,
481
+ signMessageAsync,
482
+ data,
483
+ error,
484
+ isPending
485
+ };
486
+ };
487
+
488
+ // src/utils/get-network-from-address.ts
489
+ var getNetworkFromAddress = (address) => {
490
+ if (address.startsWith("SP") || address.startsWith("SM")) {
491
+ return "mainnet";
492
+ }
493
+ if (address.startsWith("ST") || address.startsWith("SN")) {
494
+ return "testnet";
495
+ }
496
+ throw new Error(`Invalid Stacks address: ${address}`);
497
+ };
498
+ var preparePostConditionsForOKX = (postConditions) => postConditions.map((pc) => postConditionToHex(pc));
499
+ var prepareArgsForOKX = (args) => args.map((arg) => cvToHex(arg));
500
+
501
+ // src/hooks/use-write-contract/use-write-contract.ts
502
+ var useWriteContract = () => {
503
+ const { isConnected, address, provider } = useAddress();
504
+ const [data, setData] = useState(void 0);
505
+ const [error, setError] = useState(null);
506
+ const [isPending, setIsPending] = useState(false);
507
+ const writeContractAsync = useCallback(
508
+ async (variables) => {
509
+ if (!isConnected || !address) {
510
+ throw new Error("Wallet is not connected");
511
+ }
512
+ setIsPending(true);
513
+ setError(null);
514
+ setData(void 0);
515
+ try {
516
+ if (provider === "okx") {
517
+ if (!window.okxwallet) {
518
+ throw new Error("OKX wallet not found");
519
+ }
520
+ const response2 = await window.okxwallet.stacks.signTransaction({
521
+ contractAddress: variables.address,
522
+ contractName: variables.contract,
523
+ functionName: variables.functionName,
524
+ functionArgs: prepareArgsForOKX(variables.args),
525
+ postConditions: preparePostConditionsForOKX(
526
+ variables.pc.postConditions
527
+ ),
528
+ postConditionMode: variables.pc.mode,
529
+ stxAddress: address,
530
+ txType: "contract_call",
531
+ anchorMode: 3
532
+ });
533
+ setData(response2.txHash);
534
+ setIsPending(false);
535
+ return response2.txHash;
536
+ }
537
+ const response = await request("stx_callContract", {
538
+ address,
539
+ contract: `${variables.address}.${variables.contract}`,
540
+ functionName: variables.functionName,
541
+ functionArgs: variables.args,
542
+ postConditions: variables.pc.postConditions,
543
+ postConditionMode: variables.pc.mode === PostConditionMode.Allow ? "allow" : "deny",
544
+ network: getNetworkFromAddress(address)
545
+ });
546
+ if (!response.txid) {
547
+ throw new Error("No transaction ID returned");
548
+ }
549
+ setData(response.txid);
550
+ setIsPending(false);
551
+ return response.txid;
552
+ } catch (err) {
553
+ const error2 = err instanceof Error ? err : new Error(String(err));
554
+ setError(error2);
555
+ setIsPending(false);
556
+ throw error2;
557
+ }
558
+ },
559
+ [isConnected, address, provider]
560
+ );
561
+ const writeContract = useCallback(
562
+ (variables, options) => {
563
+ writeContractAsync(variables).then((data2) => {
564
+ options?.onSuccess?.(data2);
565
+ options?.onSettled?.(data2, null);
566
+ }).catch((error2) => {
567
+ options?.onError?.(error2);
568
+ options?.onSettled?.(void 0, error2);
569
+ });
570
+ },
571
+ [writeContractAsync]
572
+ );
573
+ return {
574
+ writeContract,
575
+ writeContractAsync,
576
+ data,
577
+ error,
578
+ isPending
579
+ };
580
+ };
581
+ var useBnsName = (address) => {
582
+ const [bnsName, setBnsName] = useState(null);
583
+ const [isLoading, setIsLoading] = useState(false);
584
+ useEffect(() => {
585
+ if (!address) {
586
+ setBnsName(null);
587
+ setIsLoading(false);
588
+ return;
589
+ }
590
+ const fetchBnsName = async () => {
591
+ setIsLoading(true);
592
+ try {
593
+ const network = getNetworkFromAddress(address);
594
+ const result = await getPrimaryName({ address, network });
595
+ const fullName = result ? `${result.name}.${result.namespace}` : null;
596
+ setBnsName(fullName);
597
+ } catch {
598
+ setBnsName(null);
599
+ } finally {
600
+ setIsLoading(false);
601
+ }
602
+ };
603
+ void fetchBnsName();
604
+ }, [address]);
605
+ return { bnsName, isLoading };
606
+ };
607
+
608
+ export { SUPPORTED_STACKS_WALLETS, StacksWalletProvider, getLocalStorageWallet, getNetworkFromAddress, getStacksWallets, useAddress, useBnsName, useConnect, useDisconnect, useSignMessage, useWriteContract };
609
+ //# sourceMappingURL=index.js.map
610
+ //# sourceMappingURL=index.js.map