chore: documenation

vechain · Nov 14, 2024 · d7e34c9 · d7e34c9
1 parent 1ef08e0
commit d7e34c9
Show file tree

Hide file tree

Showing 7 changed files with 112 additions and 108 deletions.
diff --git a/.yarn/install-state.gz b/.yarn/install-state.gz
diff --git a/examples/sample-react-app/src/App.tsx b/examples/sample-react-app/src/App.tsx
@@ -23,7 +23,9 @@ function App() {
 
     useEffect(() => {
         const loadCounter = async () => {
-            const counter = await counterContract.read.counter();
+            const counter = await counterContract.read.counter({
+                revision: {},
+            });
             setCount(counter[0]);
         };
 

diff --git a/packages/dapp-kit-react/src/DAppKitProvider.tsx b/packages/dapp-kit-react/src/DAppKitProvider.tsx
@@ -150,7 +150,7 @@ export const useThor = (): DAppKitContext['thor'] => {
     const context = useContext(Context);
 
     if (!context) {
-        throw new Error('"useThor" must be used within a ConnexProvider');
+        throw new Error('"useThor" must be used within a DAppKitProvider');
     }
 
     return context.thor;
@@ -160,7 +160,7 @@ export const useWallet = (): DAppKitContext['wallet'] => {
     const context = useContext(Context);
 
     if (!context) {
-        throw new Error('"useWallet" must be used within a ConnexProvider');
+        throw new Error('"useWallet" must be used within a DAppKitProvider');
     }
 
     return context.wallet;
@@ -171,7 +171,7 @@ export const useWalletModal = (): DAppKitContext['modal'] => {
 
     if (!context) {
         throw new Error(
-            '"useWalletModal" must be used within a ConnexProvider',
+            '"useWalletModal" must be used within a DAppKitProvider',
         );
     }
     return context.modal;

diff --git a/packages/dapp-kit-react/src/types.ts b/packages/dapp-kit-react/src/types.ts
@@ -17,16 +17,16 @@ export interface AccountState {
 }
 
 /**
- * Connex Provider Options
+ * DAppKit Provider Options
  * @param children - React children
  */
 export type DAppKitProviderOptions = DAppKitUIOptions & {
     children: React.ReactNode;
 };
 
 /**
- * Connex Context
- * This context is used to provide the Connex instance and the Connex Vendor instance
+ * DAppKit Context
+ * This context is used to provide the Wallet and Thor instances
  * to the application.
  */
 

diff --git a/packages/dapp-kit-ui/README.md b/packages/dapp-kit-ui/README.md
@@ -1,6 +1,7 @@
 # `@vechain/dapp-kit-ui`
 
-The Vechain DApp Kit serves as a sophisticated layer built upon @vechain/connex, providing a simplified and efficient
+The Vechain DApp Kit serves as a sophisticated layer built upon @vechain/sdk-network, providing a simplified and
+efficient
 avenue for engaging with a multitude of Vechain wallets. This innovative toolkit enhances the ease of interaction,
 offering developers a seamless bridge to connect with diverse Vechain wallet functionalities. For more information,
 please refer to the official [Vechain Docs](https://docs.vechain.org/developer-resources/sdks-and-providers/dapp-kit)

diff --git a/packages/dapp-kit/README.md b/packages/dapp-kit/README.md
@@ -1,6 +1,7 @@
 # `@vechain/dapp-kit`
 
-The Vechain DApp Kit serves as a sophisticated layer built upon @vechain/connex, providing a simplified and efficient
+The Vechain DApp Kit serves as a sophisticated layer built upon @vechain/sdk-network, providing a simplified and
+efficient
 avenue for engaging with a multitude of Vechain wallets. This innovative toolkit enhances the ease of interaction,
 offering developers a seamless bridge to connect with diverse Vechain wallet functionalities. For more information,
 please refer to the official [Vechain Docs](https://docs.vechain.org/developer-resources/sdks-and-providers/dapp-kit)
@@ -41,7 +42,7 @@ const { thor, vendor, wallet } = new DAppKit({
 ```
 
 -   You can set the wallet source when the user selects a wallet, or if you want to default to a specific wallet.
--   Connex is ready to use as normal
+-   Thor and the Wallet instances are ready to use
 
 ```typescript
 import type { WalletSource } from '@vechain/dapp-kit';