Skip to content

Commit d90ec9a

Browse files
committed
docs: rename
1 parent df3bb88 commit d90ec9a

7 files changed

+19
-19
lines changed

docs/eth-stark/useDynamicAccount.md docs/eth-stark/useEthStarkAccount.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
sidebar_position: 6
33
---
44

5-
# useDynamicAccount
5+
# useEthStarkAccount
66

77
This is the hook that wraps the `useAccount` hook from starknet-react and wagmi. Use this hook to get your account details.
88

99
```ts
10-
const { address } = useDynamicAccount();
10+
const { address } = useEthStarkAccount();
1111
```
1212

1313
## Return Value

docs/eth-stark/useDynamicContract.md docs/eth-stark/useEthStarkContract.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
sidebar_position: 5
33
---
44

5-
# useDynamicContract
5+
# useEthStarkContract
66

77
This is the hook that wraps the `useScaffoldContract` hook from Scaffold-Stark and Scaffold-ETH for both Starknet and Ethereum. Use this hook to get your contract instance by providing the contract name. It enables you to interact with your contract methods.
8-
For reading data or sending transactions, it's recommended to use `useDynamicReadContract` and `useDynamicWriteContract`.
8+
For reading data or sending transactions, it's recommended to use `useEthStarkReadContract` and `useEthStarkWriteContract`.
99

1010
```ts
11-
const { data: yourContract, isLoading: yourContractLoading } = useDynamicContract({
11+
const { data: yourContract, isLoading: yourContractLoading } = useEthStarkContract({
1212
eth: {
1313
contractName: "YourContract",
1414
},
@@ -17,7 +17,7 @@ const { data: yourContract, isLoading: yourContractLoading } = useDynamicContrac
1717
},
1818
});
1919

20-
// Returns the greeting and can be called in any function, unlike useDynamicReadContract
20+
// Returns the greeting and can be called in any function, unlike useEthStarkReadContract
2121

2222
// for eth contract
2323
await yourContract?.read.greeting();
@@ -32,7 +32,7 @@ import { useWalletClient } from "wagmi";
3232
const { account } = useAccount();
3333
const { data: walletClient } = useWalletClient();
3434

35-
const { data: yourContract, isLoading: yourContractLoading } = useDynamicContract({
35+
const { data: yourContract, isLoading: yourContractLoading } = useEthStarkContract({
3636
eth: {
3737
contractName: "YourContract",
3838
walletClient: walletClient,
@@ -53,7 +53,7 @@ const setGreeting = async () => {
5353
};
5454
```
5555

56-
This example uses the `useDynamicContract` hook to obtain a contract instance for the `YourContract` smart contract.
56+
This example uses the `useEthStarkContract` hook to obtain a contract instance for the `YourContract` smart contract.
5757

5858
## Configuration
5959

docs/eth-stark/useDynamicDeployContract.md docs/eth-stark/useEthStarkDeployedContract.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 4
33
---
44

5-
# useDynamicDeployContract
5+
# useEthStarkDeployedContract
66

77
This is the hook that wraps the `useDeployedContractInfo` hook from Scaffold-Stark and Scaffold-ETH for both Starknet and Ethereum. Use this hook to fetch details about a deployed smart contract, including the ABI and address.
88

@@ -11,7 +11,7 @@ const {
1111
data: deployedContractInfo,
1212
isLoading: deployedContractLoading,
1313
error: deployedContractError,
14-
} = useDynamicDeployContract({
14+
} = useEthStarkDeployedContract({
1515
eth: { contractName: "YourContract" },
1616
strk: { contractName: "YourContract" },
1717
});

docs/eth-stark/useDynamicEventHistory.md docs/eth-stark/useEthStarkEventHistory.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
sidebar_position: 3
33
---
44

5-
# useDynamicEventHistory
5+
# useEthStarkEventHistory
66

77
This is the hook that wraps the `useScaffoldEventHistory` hook from Scaffold-Stark and Scaffold-ETH for both Starknet and Ethereum. This hook allows you to read events from a deployed smart contract.
88

99
```ts
10-
const { data, isLoading, error } = useDynamicEventHistory({
10+
const { data, isLoading, error } = useEthStarkEventHistory({
1111
strk: {
1212
contractName: "YourContract",
1313
eventName: "contracts::YourContract::YourContract::GreetingChanged",

docs/eth-stark/useDynamicReadContract.md docs/eth-stark/useEthStarkReadContract.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
sidebar_position: 1
33
---
44

5-
# useDynamicReadContract
5+
# useEthStarkReadContract
66

77
This is the hook that wraps the `useScaffoldReadContract` hook from Scaffold-Stark and Scaffold-ETH for both Starknet and Ethereum. Use this hook to read public variables and get data from read-only functions of your Starknet and Ethereum smart contracts.
88

99
```ts
10-
const { data: totalCounter } = useDynamicReadContract({
10+
const { data: totalCounter } = useEthStarkReadContract({
1111
strk: {
1212
contractName: "YourContract",
1313
functionName: "userGreetingCounter",

docs/eth-stark/useDynamicTargetNetwork.md docs/eth-stark/useEthStarkTargetNetwork.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
sidebar_position: 7
33
---
44

5-
# useDynamicTargetNetwork
5+
# useEthStarkTargetNetwork
66

77
This is the hook that wraps the `useTargetNetwork` hook from Scaffold-Stark and Scaffold-ETH. Use this hook to get the current connected network.
88

99
```ts
10-
const targetNetwork = useDynamicTargetNetwork();
10+
const targetNetwork = useEthStarkTargetNetwork();
1111
```
1212

1313
## Return Value

docs/eth-stark/useDynamicWriteContract.md docs/eth-stark/useEthStarkWriteContract.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
sidebar_position: 2
33
---
44

5-
# useDynamicWriteContract
5+
# useEthStarkWriteContract
66

77
This is the hook that wraps the `useScaffoldWriteContract` hook from Scaffold-Stark and Scaffold-ETH for both Starknet and Ethereum. Use this hook to write to your smart contract by calling state-mutating functions.
88

99
```ts
10-
const { writeAsync, isPending: greetingPending } = useDynamicWriteContract({
10+
const { writeAsync, isPending: greetingPending } = useEthStarkWriteContract({
1111
strk: {
1212
contractName: "YourContract",
1313
functionName: "updateGreeting",
@@ -26,7 +26,7 @@ This example calls the updateGreeting function of the YourContract smart contrac
2626
## Usage Example
2727

2828
```tsx
29-
const { writeAsync, isPending: isUpdateGreetingPending } = useDynamicWriteContract({
29+
const { writeAsync, isPending: isUpdateGreetingPending } = useEthStarkWriteContract({
3030
strk: {
3131
contractName: "YourContract",
3232
functionName: "updateGreeting",

0 commit comments

Comments
 (0)