Skip to content

Commit 7301e02

Browse files
committed
Update forking docs [skip ci]
1 parent 7972703 commit 7301e02

File tree

4 files changed

+20
-2
lines changed

4 files changed

+20
-2
lines changed

crates/starknet-devnet-core/src/starknet/defaulter.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ impl OriginError {
2828
"This means your program is making Devnet send too many requests to the forking \
2929
origin. 1) It could be a temporary issue, so try re-running your program. 2) If \
3030
forking is not crucial for your use-case, disable it. 3) Try changing the forking \
31-
URL 4) Consider adding short sleeps to the program from which you are interacting \
32-
with Devnet."
31+
URL. 4) Consider adding short sleeps to the program from which you are \
32+
interacting with Devnet."
3333
}
3434
_ => "",
3535
};

website/docs/forking.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ $ starknet-devnet --fork-network <URL> [--fork-block <BLOCK_NUMBER>]
88

99
The value passed to `--fork-network` should be the URL to a Starknet JSON-RPC API provider. Specifying a `--fork-block` is optional; it defaults to the `"latest"` block at the time of Devnet's start-up. All calls will first try Devnet's state and then fall back to the forking block.
1010

11+
:::note How it works
12+
13+
When you send a request to a forked Devnet instance, it first queries Devnet's local state, then it tries the forking origin. The forking is not simply performed on Devnet startup, but happens continuously while the Devnet instance is alive.
14+
15+
:::
16+
1117
## Account impersonation
1218

1319
[Here](./account-impersonation) you can read more about acting as an account deployed on the origin.

website/versioned_docs/version-0.2.4/forking.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ $ starknet-devnet --fork-network <URL> [--fork-block <BLOCK_NUMBER>]
88

99
The value passed to `--fork-network` should be the URL to a Starknet JSON-RPC API provider. Specifying a `--fork-block` is optional; it defaults to the `"latest"` block at the time of Devnet's start-up. All calls will first try Devnet's state and then fall back to the forking block.
1010

11+
:::note How it works
12+
13+
When you send a request to a forked Devnet instance, it first queries Devnet's local state, then it tries the forking origin. The forking is not simply performed on Devnet startup, but happens continuously while the Devnet instance is alive.
14+
15+
:::
16+
1117
## Account impersonation
1218

1319
[Here](./account-impersonation) you can read more about acting as an account deployed on the origin.

website/versioned_docs/version-0.3.0/forking.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ $ starknet-devnet --fork-network <URL> [--fork-block <BLOCK_NUMBER>]
88

99
The value passed to `--fork-network` should be the URL to a Starknet JSON-RPC API provider. Specifying a `--fork-block` is optional; it defaults to the `"latest"` block at the time of Devnet's start-up. All calls will first try Devnet's state and then fall back to the forking block.
1010

11+
:::note How it works
12+
13+
When you send a request to a forked Devnet instance, it first queries Devnet's local state, then it tries the forking origin. The forking is not simply performed on Devnet startup, but happens continuously while the Devnet instance is alive.
14+
15+
:::
16+
1117
## Account impersonation
1218

1319
[Here](./account-impersonation) you can read more about acting as an account deployed on the origin.

0 commit comments

Comments
 (0)