Skip to content

Commit 9932554

Browse files
committed
replaced underscore with asterisk
1 parent c2da9a0 commit 9932554

File tree

7 files changed

+61
-61
lines changed

7 files changed

+61
-61
lines changed

versioned_docs/version-1/reference/spark/spark-create.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ spark-create - Deploy a smart contract.
88

99
### SYNOPSIS
1010

11-
`spark create` [*options*] _contract_
11+
`spark create` [*options*] *contract*
1212

1313
### DESCRIPTION
1414

@@ -29,19 +29,19 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
2929

3030
#### Build Options
3131

32-
`--constructor-args` _args..._
32+
`--constructor-args` *args...*
3333
    The constructor arguments.
3434

35-
`--constructor-args-path` _file_
35+
`--constructor-args-path` *file*
3636
    The path to a file containing the constructor arguments.
3737

3838
`--verify`
3939
    Verify contract after creation. Runs `spark verify-contract` with the appropriate parameters.
4040

41-
`--verifier` _name_
41+
`--verifier` *name*
4242
    The verification provider. Available options: `etherscan`, `sourcify` & `blockscout`. Default: `etherscan`. Note: make sure you add "/api\?" to the end of the Blockscout homepage explorer URL.
4343

44-
`--verifier-url` _url_
44+
`--verifier-url` *url*
4545
    The optional verifier url for submitting the verification request.
4646
    Environment: `VERIFIER_URL`
4747

@@ -50,24 +50,24 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
5050

5151
#### Transaction Options
5252

53-
`--gas-limit` _gas_limit_
53+
`--gas-limit` *gas_limit*
5454
    Gas limit for the transaction.
5555

56-
`--gas-price` _price_
56+
`--gas-price` *price*
5757
    Gas price for the transaction, or max fee per gas for EIP1559 transactions.
5858

59-
`--priority-gas-price` _price_
59+
`--priority-gas-price` *price*
6060
    Max priority fee per gas for EIP1559 transactions.
6161

62-
`--value` _value_
62+
`--value` *value*
6363
    Ether to send in the transaction.
6464

6565
    Either specified as an integer (wei), or as a string with a unit, for example:
6666
    - `1ether`
6767
    - `10gwei`
6868
    - `0.01ether`
6969

70-
`--nonce` _nonce_
70+
`--nonce` *nonce*
7171
    Nonce for the transaction.
7272

7373
`--legacy`
@@ -103,17 +103,17 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
103103

104104
#### Wallet Options - Keystore
105105

106-
`--keystore` _path_
106+
`--keystore` *path*
107107
    Use the keystore in the given folder or file.
108108
    Environment: `ETH_KEYSTORE`
109109

110-
`--account` _account-name_
110+
`--account` *account-name*
111111
    Use a keystore from the default keystores folder (~/.foxar/keystores) by its filename.
112112
    Environment: `ETH_KEYSTORE_ACCOUNT`
113113

114114
`--interactive`
115115

116-
`--password` _password_
116+
`--password` *password*
117117
    The keystore password. Used with `--keystore`.
118118
    Environment: `ETH_PASSWORD`
119119

@@ -129,14 +129,14 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
129129

130130
#### Wallet Options - Remote
131131

132-
`-f` _address_
133-
`--from` _address_
132+
`-f` *address*
133+
`--from` *address*
134134
    Sign the transaction with the specified account on the RPC.
135135
    Environment: `ETH_FROM`
136136

137137
#### RPC Options
138138

139-
`--rpc-url` _url_
139+
`--rpc-url` *url*
140140
    The RPC endpoint. Accepts a URL or an existing alias in the [rpc_endpoints] table, like `mainnet`.
141141
    Environment: `ETH_RPC_URL`
142142

@@ -145,10 +145,10 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
145145

146146
#### Etherscan Options
147147

148-
`--chain` _chain_name_
148+
`--chain` *chain_name*
149149
    The Etherscan chain.
150150

151-
`--etherscan-api-key` _key_
151+
`--etherscan-api-key` *key*
152152
    Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
153153
    Environment: `ETHERSCAN_API_KEY`
154154

@@ -159,7 +159,7 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
159159

160160
#### Linker Options
161161

162-
`--libraries` _libraries_
162+
`--libraries` *libraries*
163163
    Set pre-linked libraries.
164164

165165
&nbsp;&nbsp;&nbsp;&nbsp;The parameter must be in the format `<remapped path to lib>:<library name>:<address>`, e.g. `src/Contract.sol:Library:0x...`.
@@ -171,7 +171,7 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
171171
`--optimize`
172172
&nbsp;&nbsp;&nbsp;&nbsp;Activate the Solidity optimizer.
173173

174-
`--optimizer-runs` _runs_
174+
`--optimizer-runs` *runs*
175175
&nbsp;&nbsp;&nbsp;&nbsp;The number of optimizer runs.
176176

177177
`--via-ir`
@@ -180,7 +180,7 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
180180
`--revert-strings`
181181
&nbsp;&nbsp;&nbsp;&nbsp;How to treat revert and require reason strings.
182182

183-
`--use` _solc_version_
183+
`--use` *solc_version*
184184
&nbsp;&nbsp;&nbsp;&nbsp;Specify the solc version, or a path to a local solc, to build with.
185185

186186
&nbsp;&nbsp;&nbsp;&nbsp;Valid values are in the format `x.y.z`, `solc:x.y.z` or `path/to/solc`.
@@ -191,24 +191,24 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
191191
`--no-auto-detect`
192192
&nbsp;&nbsp;&nbsp;&nbsp;Do not auto-detect solc.
193193

194-
`--ignored-error-codes` _error_codes_
194+
`--ignored-error-codes` *error_codes*
195195
&nbsp;&nbsp;&nbsp;&nbsp;Ignore solc warnings by error code. The parameter is a comma-separated list of error codes.
196196

197-
`--extra-output` _selector_
197+
`--extra-output` *selector*
198198
&nbsp;&nbsp;&nbsp;&nbsp;Extra output to include in the contract's artifact.
199199

200200
&nbsp;&nbsp;&nbsp;&nbsp;Example keys: `abi`, `storageLayout`, `evm.assembly`, `ewasm`, `ir`, `ir-optimized`, `metadata`.
201201

202202
&nbsp;&nbsp;&nbsp;&nbsp;For a full description, see the [Solidity docs][output-desc].
203203

204-
`--extra-output-files` _selector_
204+
`--extra-output-files` *selector*
205205
&nbsp;&nbsp;&nbsp;&nbsp;Extra output to write to separate files.
206206

207207
&nbsp;&nbsp;&nbsp;&nbsp;Example keys: `abi`, `storageLayout`, `evm.assembly`, `ewasm`, `ir`, `ir-optimized`, `metadata`.
208208

209209
&nbsp;&nbsp;&nbsp;&nbsp;For a full description, see the [Solidity docs][output-desc].
210210

211-
`--evm-version` _version_
211+
`--evm-version` *version*
212212
&nbsp;&nbsp;&nbsp;&nbsp;The target EVM version.
213213

214214
[output-desc]: https://docs.soliditylang.org/en/latest/using-the-compiler.html#compiler-api
@@ -218,38 +218,38 @@ Dynamic linking is not supported: you should predeploy your libraries and manual
218218
`--build-info`
219219
&nbsp;&nbsp;&nbsp;&nbsp;Generate build info files.
220220

221-
`--build-info-path` _path_
221+
`--build-info-path` *path*
222222
&nbsp;&nbsp;&nbsp;&nbsp;Output path to directory that build info files will be written to.
223223

224-
`--root` _path_
224+
`--root` *path*
225225
&nbsp;&nbsp;&nbsp;&nbsp;The project's root path. By default, this is the root directory of the current git repository, or the current working directory.
226226

227-
`-C` _path_
228-
`--contracts` _path_
227+
`-C` *path*
228+
`--contracts` *path*
229229
&nbsp;&nbsp;&nbsp;&nbsp;The contracts source directory.
230230
&nbsp;&nbsp;&nbsp;&nbsp;Environment: `DAPP_SRC`
231231

232-
`--lib-paths` _path_
232+
`--lib-paths` *path*
233233
&nbsp;&nbsp;&nbsp;&nbsp;The path to the library folder.
234234

235-
`-R` _remappings_
236-
`--remappings` _remappings_
235+
`-R` *remappings*
236+
`--remappings` *remappings*
237237
&nbsp;&nbsp;&nbsp;&nbsp;The project's remappings.
238238

239239
&nbsp;&nbsp;&nbsp;&nbsp;The parameter is a comma-separated list of remappings in the format `<source>=<dest>`.
240240

241-
`--cache-path` _path_
241+
`--cache-path` *path*
242242
&nbsp;&nbsp;&nbsp;&nbsp;The path to the compiler cache.
243243

244-
`--config-path` _file_
244+
`--config-path` *file*
245245
&nbsp;&nbsp;&nbsp;&nbsp;Path to the config file.
246246

247247
`--hh`
248248
`--hardhat`
249249
&nbsp;&nbsp;&nbsp;&nbsp;This is a convenience flag, and is the same as passing `--contracts contracts --lib-paths node-modules`.
250250

251-
`-o` _path_
252-
`--out` _path_
251+
`-o` *path*
252+
`--out` *path*
253253
&nbsp;&nbsp;&nbsp;&nbsp;The project's artifacts directory.
254254

255255
`--silent`

versioned_docs/version-1/spark/fork-testing.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ Forking cheatcodes allow you to enter forking mode programmatically in your Soli
6262

6363
#### Usage
6464

65-
Important to keep in mind that _all_ test functions are isolated, meaning each test function is executed with a _copy_ of the state _after_ `setUp` and is executed in its own stand-alone EVM.
65+
Important to keep in mind that *all* test functions are isolated, meaning each test function is executed with a *copy* of the state *after* `setUp` and is executed in its own stand-alone EVM.
6666

67-
Therefore forks created during `setUp` are available in tests. The code example below uses [`createFork`](../reference/cheatcodes/create-fork) to create two forks, but does _not_ select one initially. Each fork is identified with a unique identifier (`uint256 forkId`), which is assigned when it is first created.
67+
Therefore forks created during `setUp` are available in tests. The code example below uses [`createFork`](../reference/cheatcodes/create-fork) to create two forks, but does *not* select one initially. Each fork is identified with a unique identifier (`uint256 forkId`), which is assigned when it is first created.
6868

6969
Enabling a specific fork is done via passing that `forkId` to [`selectFork`](../reference/cheatcodes/select-fork.md).
7070

@@ -77,9 +77,9 @@ Similar to [`roll`](../reference/cheatcodes/roll), you can set `block.number` of
7777
To understand what happens when a fork is selected, it is important to know how the forking mode works in general:
7878

7979
Each fork is a standalone EVM, i.e. all forks use completely independent storage. The only exception is the state of the `msg.sender` and the test contract itself, which are persistent across fork swaps.
80-
In other words all changes that are made while fork `A` is active (`selectFork(A)`) are only recorded in fork `A`'s storage and are not available if another fork is selected. However, changes recorded in the test contract itself (variables) are still available because the test contract is a _persistent_ account.
80+
In other words all changes that are made while fork `A` is active (`selectFork(A)`) are only recorded in fork `A`'s storage and are not available if another fork is selected. However, changes recorded in the test contract itself (variables) are still available because the test contract is a *persistent* account.
8181

82-
The `selectFork` cheatcode sets the _remote_ section with the fork's data source, however the _local_ memory remains persistent across fork swaps. This also means `selectFork` can be called at all times with any fork, to set the _remote_ data source. However, it is important to keep in mind the above rules for `read/write` access always apply, meaning _writes_ are persistent across fork swaps.
82+
The `selectFork` cheatcode sets the *remote* section with the fork's data source, however the *local* memory remains persistent across fork swaps. This also means `selectFork` can be called at all times with any fork, to set the *remote* data source. However, it is important to keep in mind the above rules for `read/write` access always apply, meaning *writes* are persistent across fork swaps.
8383

8484
#### Examples
8585

@@ -98,7 +98,7 @@ contract ForkTest is Test {
9898
//string MAINNET_RPC_URL = vm.envString("MAINNET_RPC_URL");
9999
//string OPTIMISM_RPC_URL = vm.envString("OPTIMISM_RPC_URL");
100100
101-
// create two _different_ forks during setup
101+
// create two *different* forks during setup
102102
function setUp() public {
103103
mainnetFork = vm.createFork(MAINNET_RPC_URL);
104104
optimismFork = vm.createFork(OPTIMISM_RPC_URL);
@@ -150,7 +150,7 @@ As mentioned each fork is essentially an independent EVM with separated storage.
150150

151151
Only the accounts of `msg.sender` and the test contract (`ForkTest`) are persistent when forks are selected. But any account can be turned into a persistent account: [`makePersistent`](../reference/cheatcodes/make-persistent).
152152

153-
An account that is _persistent_ is unique, i.e. it exists on all forks
153+
An account that is *persistent* is unique, i.e. it exists on all forks
154154

155155
```solidity
156156
contract ForkTest is Test {
@@ -165,7 +165,7 @@ contract ForkTest is Test {
165165
//string MAINNET_RPC_URL = vm.envString("MAINNET_RPC_URL");
166166
//string OPTIMISM_RPC_URL = vm.envString("OPTIMISM_RPC_URL");
167167
168-
// create two _different_ forks during setup
168+
// create two *different* forks during setup
169169
function setUp() public {
170170
mainnetFork = vm.createFork(MAINNET_RPC_URL);
171171
optimismFork = vm.createFork(OPTIMISM_RPC_URL);
@@ -195,7 +195,7 @@ contract ForkTest is Test {
195195
simple.value();
196196
}
197197
198-
// creates a new _persistent_ contract while a fork is active
198+
// creates a new *persistent* contract while a fork is active
199199
function testCreatePersistentContract() public {
200200
vm.selectFork(mainnetFork);
201201
SimpleStorageContract simple = new SimpleStorageContract();

versioned_docs/version-1/spark/fuzz-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Test result: ok. 1 passed; 0 failed; 0 skipped; finished in 3.97ms
5757
Ran 1 test suites: 1 tests passed, 0 failed, 0 skipped (1 total tests)
5858
```
5959

60-
This unit test _does test_ that we can withdraw ether from our safe. However, who is to say that it works for all amounts, not just 1 ether?
60+
This unit test *does test* that we can withdraw ether from our safe. However, who is to say that it works for all amounts, not just 1 ether?
6161

6262
The general property here is: given a safe balance, when we withdraw, we should get whatever is in the safe.
6363

versioned_docs/version-1/spark/invariant-testing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Invariants are conditions expressions that should always hold true over the cour
2828

2929
Examples of invariants are:
3030

31-
- _"The xy=k formula always holds"_ for Uniswap
32-
- _"The sum of all user balances is equal to the total supply"_ for an ERC-20 token.
31+
- *"The xy=k formula always holds"* for Uniswap
32+
- *"The sum of all user balances is equal to the total supply"* for an ERC-20 token.
3333

3434
There are different ways to assert invariants, as outlined in the table below:
3535

@@ -106,7 +106,7 @@ function invariant_example() external {
106106
}
107107
```
108108

109-
Another approach to handle different invariants across protocol states is to utilize dedicated invariant testing contracts for different scenarios. These scenarios can be bootstrapped using the `setUp` function, but it is more powerful to leverage _invariant targets_ to govern the fuzzer to behave in a way that will only yield certain results (e.g., avoid liquidations).
109+
Another approach to handle different invariants across protocol states is to utilize dedicated invariant testing contracts for different scenarios. These scenarios can be bootstrapped using the `setUp` function, but it is more powerful to leverage *invariant targets* to govern the fuzzer to behave in a way that will only yield certain results (e.g., avoid liquidations).
110110

111111
## Invariant Targets
112112

0 commit comments

Comments
 (0)