Add code snippet to demo pages (#527)

closes #518 The changes include the following - Adds a description of the demo page - Adds a link to github containing the source code snippet.
apibara · Oct 31, 2024 · cc4ecb4 · cc4ecb4
2 parents dceaad0 + f395190
commit cc4ecb4
Show file tree

Hide file tree

Showing 16 changed files with 129 additions and 0 deletions.
diff --git a/docs/pages/demo/account.mdx b/docs/pages/demo/account.mdx
@@ -3,3 +3,10 @@ import Demo from "../../components/demo";
 # Account
 
 <Demo.Account />
+
+This demo shows how to access the currently connected account and its address.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/account.tsx)
+
+Hook(s)
+- `useAccount`
diff --git a/docs/pages/demo/add-chain.mdx b/docs/pages/demo/add-chain.mdx
@@ -3,3 +3,10 @@ import Demo from "../../components/demo";
 # Add Chain
 
 <Demo.AddChain />
+
+This demo shows how to add a new chain to the wallet.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/add-chain.tsx)
+
+Hook(s)
+- `useAddChain`
diff --git a/docs/pages/demo/balance.mdx b/docs/pages/demo/balance.mdx
@@ -4,3 +4,10 @@ import Demo from "../../components/demo";
 
 <Demo.Balance />
 
+This demo shows how to fetch an ERC-20 token balance.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/balance.tsx)
+
+Hooks
+- `useAccount`
+- `useBalance`
diff --git a/docs/pages/demo/change-default-network.mdx b/docs/pages/demo/change-default-network.mdx
@@ -3,3 +3,12 @@ import Demo from "../../components/demo";
 # Change Default Network (Todo)
 
 <Demo.ChangeDefaultNetwork />
+
+This demo shows how to change the default network.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/change-default-network.tsx)
+
+Hooks
+- `publicProvider`
+- `useAccount`
+- `useNetwork`
diff --git a/docs/pages/demo/declare-contract.mdx b/docs/pages/demo/declare-contract.mdx
@@ -3,3 +3,11 @@ import Demo from "../../components/demo";
 # Declare Contract (Todo)
 
 <Demo.DeclareContract />
+
+This demo shows how to declare a contract.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/declare-contract.tsx)
+
+Hooks
+- `useAccount`
+- `useDeclareContract`
diff --git a/docs/pages/demo/estimate-fees.mdx b/docs/pages/demo/estimate-fees.mdx
@@ -3,3 +3,13 @@ import Demo from "../../components/demo";
 # Estimate Fees
 
 <Demo.EstimateFees />
+
+This demo shows a fee estimate fees for smart contract calls.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/estimate-fees.tsx)
+
+Hooks
+- `useAccount`
+- `useContract`
+- `useEstimateFees`
+- `useNetwork`
diff --git a/docs/pages/demo/nonce-for-address.mdx b/docs/pages/demo/nonce-for-address.mdx
@@ -3,3 +3,11 @@ import Demo from "../../components/demo";
 # Nonce for Address
 
 <Demo.NonceForAddress />
+
+This demo shows how to get the nonce for an address.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/nonce-for-address.tsx)
+
+Hooks
+- `useAccount`
+- `useNonceForAddress`
diff --git a/docs/pages/demo/read-contract.mdx b/docs/pages/demo/read-contract.mdx
@@ -3,3 +3,11 @@ import Demo from "../../components/demo";
 # Read Contract
 
 <Demo.ReadContract />
+
+This demo shows how to use the `useReadContract` type-safe API to query a Starknet contract.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/read-contract.tsx)
+
+Hooks
+- `useNetwork`
+- `useReadContract`
diff --git a/docs/pages/demo/send-transaction.mdx b/docs/pages/demo/send-transaction.mdx
@@ -3,3 +3,11 @@ import Demo from "../../components/demo";
 # Send Transaction
 
 <Demo.SendTransaction />
+
+This demo shows how to send transactions to the network.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/send-transaction.tsx)
+
+Hooks
+- `useContract`
+- `useSendTransaction`
diff --git a/docs/pages/demo/sign-typed-data.mdx b/docs/pages/demo/sign-typed-data.mdx
@@ -3,3 +3,10 @@ import Demo from "../../components/demo";
 # Sign Typed Data
 
 <Demo.SignTypedData />
+
+This demo shows how to sign typed data via the wallet of the connected account.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/sign-typed-data.tsx)
+
+Hook(s)
+- `useSignTypedData`
diff --git a/docs/pages/demo/stark-address.mdx b/docs/pages/demo/stark-address.mdx
@@ -3,3 +3,10 @@ import Demo from "../../components/demo";
 # Stark Address
 
 <Demo.StarkAddress />
+
+This demo shows how to get the address associated to a Starknet ID.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/stark-address.tsx)
+
+Hook(s)
+- `useStarkAddress`
diff --git a/docs/pages/demo/stark-name.mdx b/docs/pages/demo/stark-name.mdx
@@ -3,3 +3,10 @@ import Demo from "../../components/demo";
 # Stark Name
 
 <Demo.StarkName />
+
+This demo shows how to get the Starknet ID associated to an address.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/stark-name.tsx)
+
+Hook(s)
+- `useStarkName`
diff --git a/docs/pages/demo/stark-profile.mdx b/docs/pages/demo/stark-profile.mdx
@@ -3,3 +3,10 @@ import Demo from "../../components/demo";
 # Stark Profile
 
 <Demo.StarkProfile />
+
+This demo shows how to get the Starknet ID profile associated to an address.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/stark-profile.tsx)
+
+Hook(s)
+- `useStarkProfile`
diff --git a/docs/pages/demo/starknetkit.mdx b/docs/pages/demo/starknetkit.mdx
@@ -3,3 +3,16 @@ import Demo from "../../components/demo";
 # StarknetKit Integration
 
 <Demo.StarknetKit />
+
+This demo shows how to integrate Starknet React with StarknetKit.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/starknetkit.tsx)
+
+Hooks
+- starknet-react
+  -`publicProvider`
+  - `useAccount`
+  - `useConnect`
+  - `useNetwork`,
+- starknetkitconnector
+  - `useStarknetkitConnectModal`
diff --git a/docs/pages/demo/switch-chain.mdx b/docs/pages/demo/switch-chain.mdx
@@ -3,3 +3,12 @@ import Demo from "../../components/demo";
 # Switch Chain
 
 <Demo.SwitchChain />
+
+This demo shows how to switch between chains.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/switch-chain.tsx)
+
+Hooks
+- `useAccount`
+- `useNetwork`
+- `useSwitchChain`
diff --git a/docs/pages/demo/wallet-permission.mdx b/docs/pages/demo/wallet-permission.mdx
@@ -3,3 +3,10 @@ import Demo from "../../components/demo";
 # Wallet Permission
 
 <Demo.WalletPermission />
+
+This demo shows how to request wallet permissions.
+
+[Link to GitHub](https://github.com/apibara/starknet-react/blob/main/docs/components/demo/wallet-permission.tsx)
+
+Hook(s)
+- `useWalletRequest`