@vechain/vechain-kit 2.0.3 → 2.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/README.md CHANGED
@@ -24,11 +24,21 @@ VeChain Kit is a comprehensive SDK designed to make building frontend applicatio
24
24
 
25
25
  #### Install dependencies
26
26
 
27
+ Install the core package along with its peer dependencies:
28
+
29
+
27
30
  ```bash
28
- yarn add @tanstack/react-query@"^5.64.2" @chakra-ui/react@"^2.8.2" @vechain/dapp-kit-react@"2.1.0-rc.1" @vechain/vechain-kit
31
+ yarn add @vechain/vechain-kit \
32
+ @chakra-ui/react@^2.8.2 \
33
+ @emotion/react@^11.14.0 \
34
+ @emotion/styled@^11.14.0 \
35
+ @tanstack/react-query@^5.64.2 \
36
+ @vechain/dapp-kit-react@2.1.0-rc.1 \
37
+ framer-motion@^11.15.0
29
38
  ```
30
39
 
31
- #### Basic Usage
40
+
41
+ #### Setup Provider
32
42
 
33
43
  Wrap your app with the VeChainKitProvider:
34
44
 
@@ -39,14 +49,16 @@ import { VeChainKitProvider } from '@vechain/vechain-kit';
39
49
 
40
50
  export function Providers({ children }: { children: React.ReactNode }) {
41
51
  return (
42
- <VeChainKitProvider network={{ type: 'test' }}>
52
+ <VeChainKitProvider>
43
53
  {children}
44
54
  </VeChainKitProvider>
45
55
  );
46
56
  }
47
57
  ```
48
58
 
49
- #### Login
59
+ That's it! Your app is now ready to connect to VeChain mainnet with VeWorld wallet.
60
+
61
+ #### Add Wallet Button
50
62
 
51
63
  ```typescript
52
64
  'use client';
@@ -58,6 +70,11 @@ export function Page() {
58
70
  }
59
71
  ```
60
72
 
73
+
74
+ For complete configuration options, check the [full documentation](https://docs.vechainkit.vechain.org/).
75
+
76
+ ---
77
+
61
78
  # Troubleshooting
62
79
 
63
80
  Are you having issues using the kit?
@@ -1,2 +1,2 @@
1
- import { C as TwitterLogo, S as VechainLogo, T as GoogleLogo, _ as VechainIcon, a as VeWorldLogoDark, b as VechainLogoLight, c as VETLogo, d as VeBetterIcon, f as VeBetterLogoDark, g as VechainIconLight, h as VechainIconDark, i as PrivyLogo, l as VeBetterIconDark, m as VeBetterLogo, n as BetterSwapLogo, o as VeWorldLogoLight, p as VeBetterLogoLight, r as VechainEnergy, s as VTHOLogo, t as VeTradeLogo, u as VeBetterIconLight, v as VechainLogoHorizontalLight, w as GitHubLogo, x as VechainLogoDark, y as VechainLogoHorizontalDark } from "../index-CWViOs1U.mjs";
1
+ import { C as TwitterLogo, S as VechainLogo, T as GoogleLogo, _ as VechainIcon, a as VeWorldLogoDark, b as VechainLogoLight, c as VETLogo, d as VeBetterIcon, f as VeBetterLogoDark, g as VechainIconLight, h as VechainIconDark, i as PrivyLogo, l as VeBetterIconDark, m as VeBetterLogo, n as BetterSwapLogo, o as VeWorldLogoLight, p as VeBetterLogoLight, r as VechainEnergy, s as VTHOLogo, t as VeTradeLogo, u as VeBetterIconLight, v as VechainLogoHorizontalLight, w as GitHubLogo, x as VechainLogoDark, y as VechainLogoHorizontalDark } from "../index--hSO7Xv4.mjs";
2
2
  export { BetterSwapLogo, GitHubLogo, GoogleLogo, PrivyLogo, TwitterLogo, VETLogo, VTHOLogo, VeBetterIcon, VeBetterIconDark, VeBetterIconLight, VeBetterLogo, VeBetterLogoDark, VeBetterLogoLight, VeTradeLogo, VeWorldLogoDark, VeWorldLogoLight, VechainEnergy, VechainIcon, VechainIconDark, VechainIconLight, VechainLogo, VechainLogoDark, VechainLogoHorizontalDark, VechainLogoHorizontalLight, VechainLogoLight };
@@ -1,6 +1,6 @@
1
1
  import { BoxProps, IconProps, ImageProps } from "@chakra-ui/react";
2
2
  import React from "react";
3
- import * as react_jsx_runtime49 from "react/jsx-runtime";
3
+ import * as react_jsx_runtime6 from "react/jsx-runtime";
4
4
 
5
5
  //#region src/assets/icons/GoogleLogo/GoogleLogo.d.ts
6
6
  type Props$22 = {
@@ -121,7 +121,7 @@ declare const BetterSwapLogo: ({
121
121
  }: {
122
122
  boxSize?: string;
123
123
  [key: string]: any;
124
- }) => react_jsx_runtime49.JSX.Element;
124
+ }) => react_jsx_runtime6.JSX.Element;
125
125
  //#endregion
126
126
  //#region src/assets/icons/VeTradeLogo/VeTradeLogo.d.ts
127
127
  declare const VeTradeLogo: ({
@@ -130,7 +130,7 @@ declare const VeTradeLogo: ({
130
130
  }: {
131
131
  boxSize?: string;
132
132
  [key: string]: any;
133
- }) => react_jsx_runtime49.JSX.Element;
133
+ }) => react_jsx_runtime6.JSX.Element;
134
134
  //#endregion
135
135
  export { TwitterLogo as C, VechainLogo as S, GoogleLogo as T, VechainIcon as _, VeWorldLogoDark as a, VechainLogoLight as b, VETLogo as c, VeBetterIcon as d, VeBetterLogoDark as f, VechainIconLight as g, VechainIconDark as h, PrivyLogo as i, VeBetterIconDark as l, VeBetterLogo as m, BetterSwapLogo as n, VeWorldLogoLight as o, VeBetterLogoLight as p, VechainEnergy as r, VTHOLogo as s, VeTradeLogo as t, VeBetterIconLight as u, VechainLogoHorizontalLight as v, GitHubLogo as w, VechainLogoDark as x, VechainLogoHorizontalDark as y };
136
- //# sourceMappingURL=index-CWViOs1U.d.mts.map
136
+ //# sourceMappingURL=index--hSO7Xv4.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index-CWViOs1U.d.mts","names":[],"sources":["../src/assets/icons/GoogleLogo/GoogleLogo.tsx","../src/assets/icons/GitHubLogo/GitHubLogo.tsx","../src/assets/icons/TwitterLogo/TwitterLogo.tsx","../src/assets/icons/VechainLogo/VechainLogo.tsx","../src/assets/icons/VechainLogo/VechainLogoDark.tsx","../src/assets/icons/VechainLogo/VechainLogoLight.tsx","../src/assets/icons/VechainLogo/VechainLogoHorizontalDark.tsx","../src/assets/icons/VechainLogo/VechainLogoHorizontalLight.tsx","../src/assets/icons/VechainLogo/VechainIcon.tsx","../src/assets/icons/VechainLogo/VechainIconLight.tsx","../src/assets/icons/VechainLogo/VechainIconDark.tsx","../src/assets/icons/VechainLogo/VeBetterLogo.tsx","../src/assets/icons/VechainLogo/VeBetterLogoLight.tsx","../src/assets/icons/VechainLogo/VeBetterLogoDark.tsx","../src/assets/icons/VechainLogo/VeBetterIcon.tsx","../src/assets/icons/VechainLogo/VeBetterIconLight.tsx","../src/assets/icons/VechainLogo/VeBetterIconDark.tsx","../src/assets/icons/VechainLogo/VETLogo.tsx","../src/assets/icons/VechainLogo/VTHOLogo.tsx","../src/assets/icons/VechainLogo/VeWorldLogoLight.tsx","../src/assets/icons/VechainLogo/VeWorldLogoDark.tsx","../src/assets/icons/PrivyLogo/PrivyLogo.tsx","../src/assets/icons/VechainEnergy/VechainEnergy.tsx","../src/assets/icons/BetterSwapLogo/BetterSwapLogo.tsx","../src/assets/icons/VeTradeLogo/VeTradeLogo.tsx"],"sourcesContent":[],"mappings":";;;;;KAIK,QAAA;;IAED,KAAK;AAFJ,cAIQ,UAFJ,EAEgB,KAAA,CAAM,EAF3B,CAE8B,QAF1B,CAAA;;;KCHH,QAAA;;IAED,KAAK;ADDJ,cCSQ,UDPJ,ECOgB,KAAA,CAAM,EDP3B,CCO8B,QDP1B,CAAA;;;KEFH,QAAA;;;AFHqB,CAAA,GEMtB,IFHC,CEGI,QFHC,EAAA,yBAEF,CAAA;AAEK,cECA,WFDqB,EECR,KAAA,CAAM,EFDP,CECU,QFDJ,CAAE;;;KGJ5B,QAAA;;IAED,KAAK;AHFJ,cGIQ,WHFJ,EGEiB,KAAA,CAAM,EHF5B,CGE+B,QHF3B,CAAA;;;KIHH,QAAA,GAAQ,KAAK;cAEL,iBAAiB,KAAA,CAAM,GAAG;;;KCFlC,QAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,QAAA,GAAQ,KAAK;cAEL,2BAA2B,KAAA,CAAM,GAAG;;;KCF5C,QAAA,GAAQ,KAAK;cAEL,4BAA4B,KAAA,CAAM,GAAG;;;KCA7C,QAAA;;IAED,KAAK;ARHJ,cQKQ,WRHJ,EQGiB,KAAA,CAAM,ERH5B,CQG+B,QRH3B,CAAA;;;KSHH,QAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,QAAA,GAAQ,KAAK;cAEL,iBAAiB,KAAA,CAAM,GAAG;;;KCAlC,QAAA;;IAED,KAAK;AXHJ,cWKQ,YXHJ,EWGkB,KAAA,CAAM,EXHzB,CWG4B,QXH5B,CAAA;;;KYHH,QAAA,GAAQ,KAAK;cAEL,mBAAmB,KAAA,CAAM,GAAG;;;KCFpC,OAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCAnC,OAAA;;IAED,KAAK;AdHJ,ccKQ,YdHJ,EcGkB,KAAA,CAAM,EdHzB,CcG4B,OdH5B,CAAA;;;KeHH,OAAA,GAAQ,KAAK;cAEL,mBAAmB,KAAA,CAAM,GAAG;;;KCFpC,OAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,OAAA,GAAQ,KAAK;cAEL,SAAS,KAAA,CAAM,GAAG;;;KCF1B,OAAA,GAAQ,KAAK;cAEL,UAAU,KAAA,CAAM,GAAG;;;KCF3B,OAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,OAAA,GAAQ,KAAK;cAEL,iBAAiB,KAAA,CAAM,GAAG;;;KCFlC,OAAA;;IAED,KAAK;ArBDJ,cqBGQ,SrBDJ,EqBCe,KAAA,CAAM,ErBD1B,CqBC6B,OrBDzB,CAAA;;;KsBFH,KAAA;;;AtBHqB,CAAA,GsBMtB,ItBHC,CsBGI,QtBHC,EAAA,yBAEF,CAAA;AAEK,csBCA,atBDqB,EsBCN,KAAA,CAAM,EtBDT,CsBCY,KtBDJ,CAAA;;;cuBNpB;;;;;;MAA0F,mBAAA,CAAA,GAAA,CAAA;;;cCA1F;;;;;;MAAuF,mBAAA,CAAA,GAAA,CAAA"}
1
+ {"version":3,"file":"index--hSO7Xv4.d.mts","names":[],"sources":["../src/assets/icons/GoogleLogo/GoogleLogo.tsx","../src/assets/icons/GitHubLogo/GitHubLogo.tsx","../src/assets/icons/TwitterLogo/TwitterLogo.tsx","../src/assets/icons/VechainLogo/VechainLogo.tsx","../src/assets/icons/VechainLogo/VechainLogoDark.tsx","../src/assets/icons/VechainLogo/VechainLogoLight.tsx","../src/assets/icons/VechainLogo/VechainLogoHorizontalDark.tsx","../src/assets/icons/VechainLogo/VechainLogoHorizontalLight.tsx","../src/assets/icons/VechainLogo/VechainIcon.tsx","../src/assets/icons/VechainLogo/VechainIconLight.tsx","../src/assets/icons/VechainLogo/VechainIconDark.tsx","../src/assets/icons/VechainLogo/VeBetterLogo.tsx","../src/assets/icons/VechainLogo/VeBetterLogoLight.tsx","../src/assets/icons/VechainLogo/VeBetterLogoDark.tsx","../src/assets/icons/VechainLogo/VeBetterIcon.tsx","../src/assets/icons/VechainLogo/VeBetterIconLight.tsx","../src/assets/icons/VechainLogo/VeBetterIconDark.tsx","../src/assets/icons/VechainLogo/VETLogo.tsx","../src/assets/icons/VechainLogo/VTHOLogo.tsx","../src/assets/icons/VechainLogo/VeWorldLogoLight.tsx","../src/assets/icons/VechainLogo/VeWorldLogoDark.tsx","../src/assets/icons/PrivyLogo/PrivyLogo.tsx","../src/assets/icons/VechainEnergy/VechainEnergy.tsx","../src/assets/icons/BetterSwapLogo/BetterSwapLogo.tsx","../src/assets/icons/VeTradeLogo/VeTradeLogo.tsx"],"sourcesContent":[],"mappings":";;;;;KAIK,QAAA;;IAED,KAAK;AAFJ,cAIQ,UAFJ,EAEgB,KAAA,CAAM,EAF3B,CAE8B,QAF1B,CAAA;;;KCHH,QAAA;;IAED,KAAK;ADDJ,cCSQ,UDPJ,ECOgB,KAAA,CAAM,EDP3B,CCO8B,QDP1B,CAAA;;;KEFH,QAAA;;;AFHqB,CAAA,GEMtB,IFHC,CEGI,QFHC,EAAA,yBAEF,CAAA;AAEK,cECA,WFDqB,EECR,KAAA,CAAM,EFDP,CECU,QFDJ,CAAE;;;KGJ5B,QAAA;;IAED,KAAK;AHFJ,cGIQ,WHFJ,EGEiB,KAAA,CAAM,EHF5B,CGE+B,QHF3B,CAAA;;;KIHH,QAAA,GAAQ,KAAK;cAEL,iBAAiB,KAAA,CAAM,GAAG;;;KCFlC,QAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,QAAA,GAAQ,KAAK;cAEL,2BAA2B,KAAA,CAAM,GAAG;;;KCF5C,QAAA,GAAQ,KAAK;cAEL,4BAA4B,KAAA,CAAM,GAAG;;;KCA7C,QAAA;;IAED,KAAK;ARHJ,cQKQ,WRHJ,EQGiB,KAAA,CAAM,ERH5B,CQG+B,QRH3B,CAAA;;;KSHH,QAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,QAAA,GAAQ,KAAK;cAEL,iBAAiB,KAAA,CAAM,GAAG;;;KCAlC,QAAA;;IAED,KAAK;AXHJ,cWKQ,YXHJ,EWGkB,KAAA,CAAM,EXHzB,CWG4B,QXH5B,CAAA;;;KYHH,QAAA,GAAQ,KAAK;cAEL,mBAAmB,KAAA,CAAM,GAAG;;;KCFpC,OAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCAnC,OAAA;;IAED,KAAK;AdHJ,ccKQ,YdHJ,EcGkB,KAAA,CAAM,EdHzB,CcG4B,OdH5B,CAAA;;;KeHH,OAAA,GAAQ,KAAK;cAEL,mBAAmB,KAAA,CAAM,GAAG;;;KCFpC,OAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,OAAA,GAAQ,KAAK;cAEL,SAAS,KAAA,CAAM,GAAG;;;KCF1B,OAAA,GAAQ,KAAK;cAEL,UAAU,KAAA,CAAM,GAAG;;;KCF3B,OAAA,GAAQ,KAAK;cAEL,kBAAkB,KAAA,CAAM,GAAG;;;KCFnC,OAAA,GAAQ,KAAK;cAEL,iBAAiB,KAAA,CAAM,GAAG;;;KCFlC,OAAA;;IAED,KAAK;ArBDJ,cqBGQ,SrBDJ,EqBCe,KAAA,CAAM,ErBD1B,CqBC6B,OrBDzB,CAAA;;;KsBFH,KAAA;;;AtBHqB,CAAA,GsBMtB,ItBHC,CsBGI,QtBHC,EAAA,yBAEF,CAAA;AAEK,csBCA,atBDqB,EsBCN,KAAA,CAAM,EtBDT,CsBCY,KtBDJ,CAAA;;;cuBNpB;;;;;;MAA0F,kBAAA,CAAA,GAAA,CAAA;;;cCA1F;;;;;;MAAuF,kBAAA,CAAA,GAAA,CAAA"}