Skip to content

Commit c8f8c0b

Browse files
Merge pull request #7 from bchainhub/test/build
Test/build
2 parents 654d9d0 + ccb4039 commit c8f8c0b

33 files changed

+53
-149
lines changed

versioned_docs/version-1/config/hardhat.md

Lines changed: 0 additions & 95 deletions
This file was deleted.

versioned_docs/version-1/config/static-analyzers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To run Slither on a single file, use this command:
2626
slither src/Contract.sol
2727
```
2828

29-
Note, this requires configuring the [solc version in the foxar config file](https://book.getfoxar.sh/reference/config/solidity-compiler#solc_version).
29+
Note, this requires configuring the [solc version in the foxar config file](../reference/config/solidity-compiler#solc_version).
3030

3131
You do not need to provide remappings via the `solc_remaps` option as Slither will automatically detect remappings in a Foxar project. Slither will invoke `spark` to perform the build.
3232

versioned_docs/version-1/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ This document will help you get started. Do not let the document intimidate you.
1212

1313
The [dev Telegram](https://t.me/foxar_rs) is available for any concerns you may have that are not covered in this guide.
1414

15-
First check the [Contribution guidelines](https://github.com/foxar-rs/foxar/blob/master/CONTRIBUTING.md)
15+
First check the [Contribution guidelines](https://github.com/bchainhub/foxar/blob/master/CONTRIBUTING.md)
1616

1717
Some articles to walk you through the first steps:
1818

1919
- [Make a first contribution](https://dev.to/teddav/foxar-open-source-contribution-1k2d)
20-
- [Add a cheatcode](https://dev.to/teddav/foxar-add-a-cheatcode-5hc8) (outdated, see the [Foxar dev docs](https://github.com/foxar-rs/foxar/blob/master/docs/dev/cheatcodes.md#adding-a-new-cheatcode) for a shorter but up-to-date tutorial)
20+
- [Add a cheatcode](https://dev.to/teddav/foxar-add-a-cheatcode-5hc8) (outdated, see the [Foxar dev docs](https://github.com/bchainhub/foxar/blob/master/docs/dev/cheatcodes.md#adding-a-new-cheatcode) for a shorter but up-to-date tutorial)

versioned_docs/version-1/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Failed to create artifact parent folder "/.../MyProject/out/IsolationModeMagic.s
189189

190190
Then there's likely a folder permission issue. Ensure `user` has write access in the project root's folder.
191191

192-
It has been [reported](https://github.com/foxar-rs/foxar/issues/3268) that on linux, canonicalizing paths can result in weird paths (`/_1/...`). This can be resolved by nuking the entire project folder and initializing again.
192+
It has been [reported](https://github.com/bchainhub/foxar/issues/3268) that on linux, canonicalizing paths can result in weird paths (`/_1/...`). This can be resolved by nuking the entire project folder and initializing again.
193193

194194
### Connection refused when running `spark build`
195195

@@ -211,5 +211,5 @@ You could run `export http_proxy=http://127.0.0.1:7890 https_proxy=http://127.0.
211211
[config]: ./config/configuration
212212
[spark-build]: ./reference/spark/spark-build.md
213213
[console-log]: ./reference/spark-std/console-log.md
214-
[spark-std]: https://github.com/foxar-rs/spark-std
214+
[spark-std]: https://github.com/bchainhub/spark-std
215215
[dstestplus]: https://github.com/transmissions11/solmate/blob/19a4f345970ed39ee6369f343d145e0d4071c18a/src/test/utils/DSTestPlus.sol#L10

versioned_docs/version-1/getting-started/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ If you face any issues while installing, check out the [FAQ](../faq.md).
66

77
### Precompiled binaries
88

9-
Precompiled binaries are available from the [GitHub releases page](https://github.com/foxar-rs/foxar/releases).
9+
Precompiled binaries are available from the [GitHub releases page](https://github.com/bchainhub/foxar/releases).
1010
These are better managed by using [Foxarup](#using-foxarup).
1111

1212
### Using Foxarup
1313

14-
Foxarup is the Foxar toolchain installer. You can find more about it [here](https://github.com/foxar-rs/foxar/blob/master/foxarup/README.md).
14+
Foxarup is the Foxar toolchain installer. You can find more about it [here](https://github.com/bchainhub/foxar/blob/master/foxarup/README.md).
1515

1616
Open your terminal and run the following command:
1717

@@ -62,7 +62,7 @@ Or, by using a single Cargo command:
6262
cargo install --git https://github.com/foxar-rs/foxar --profile local --locked spark probe pilot shuttle
6363
```
6464

65-
Or, by manually building from a local copy of the [Foxar repository](https://github.com/foxar-rs/foxar):
65+
Or, by manually building from a local copy of the [Foxar repository](https://github.com/bchainhub/foxar):
6666

6767
```sh
6868
# clone the repository

versioned_docs/version-1/intro.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ Guides on configuring Foxar.
5252
- [Integrating with VSCode](./config/vscode.md)
5353
- [Shell Autocompletion](./config/shell-autocompletion.md)
5454
- [Static Analyzers](./config/static-analyzers.md)
55-
- [Integrating with Hardhat](./config/hardhat.md)
5655

5756
## Tutorials
5857

@@ -75,10 +74,10 @@ References, troubleshooting, and more.
7574

7675
- [FAQ](./faq.md)
7776
- [CLI Reference](./reference/cli/cli-reference)
78-
- [spark Commands](./reference/spark/)
79-
- [probe Commands](./reference/probe/)
80-
- [shuttle Commands](./reference/shuttle/shuttle-reference)
81-
- [pilot Commands](./reference/pilot/pilot-reference)
77+
- [Spark Commands](./reference/spark/)
78+
- [Probe Commands](./reference/probe/)
79+
- [Shuttle Commands](./reference/shuttle/shuttle-reference)
80+
- [Pilot Commands](./reference/pilot/pilot-reference)
8281
- [Config Reference](./reference/config/config-reference)
8382
- [Cheatcodes Reference](./reference/cheatcodes/cheatcodes-reference)
8483
- [Spark Standard Library Reference](./reference/spark-std/spark-standart)

versioned_docs/version-1/reference/cheatcodes/cheatcodes-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Cheatcodes are made available through use of the cheatcode address (`0x7109709EC
1515
> vm.assume(address_ != 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D);
1616
> ```
1717
18-
You can also access cheatcodes easily via `vm` available in Spark Standard Library's [`Test`](../spark-std/spark-standart/#spark-stds-test) contract.
18+
You can also access cheatcodes easily via `vm` available in Spark Standard Library's [`Test`](../spark-std/spark-standart#spark-stds-test) contract.
1919
2020
### Spark Standard Library Cheatcodes
2121
2222
Spark Std implements wrappers around cheatcodes, which combine multiple standard cheatcodes to improve development experience. These are not technically cheatcodes, but rather compositions of Spark's cheatcodes.
2323
24-
You can view the list of Spark Standard Library's cheatcode wrappers [in the references section](../spark-std/std-cheats). You can reference the [Spark Std source code](https://github.com/foxar-rs/spark-std/blob/master/src/Test.sol) to learn more about how the wrappers work under the hood.
24+
You can view the list of Spark Standard Library's cheatcode wrappers [in the references section](../spark-std/std-cheats). You can reference the [Spark Std source code](https://github.com/bchainhub/spark-std/blob/master/src/Test.sol) to learn more about how the wrappers work under the hood.
2525
2626
### Cheatcode Types
2727

versioned_docs/version-1/reference/cheatcodes/ffi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ function ffi(string[] calldata) external returns (bytes memory);
1010

1111
### Description
1212

13-
Calls an arbitrary command if [`ffi`](../config/testing/#ffi) is enabled.
13+
Calls an arbitrary command if [`ffi`](../config/testing#ffi) is enabled.
1414

1515
It is generally advised to use this cheat code as a last resort, and to not enable it by default, as anyone who can change the tests of a project will be able to execute arbitrary commands on devices that run the tests.
1616

versioned_docs/version-1/reference/cheatcodes/fs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ function isDir(string calldata) external returns (bool);
3737

3838
### Description
3939

40-
These cheatcodes provided by [spark-std](https://github.com/foxar-rs/spark-std) can be used for filesystem manipulation operations.
40+
These cheatcodes provided by [spark-std](https://github.com/bchainhub/spark-std) can be used for filesystem manipulation operations.
4141

4242
By default, filesystem access is disallowed and requires the `fs_permission` setting in `foxar.toml`:
4343

versioned_docs/version-1/reference/cheatcodes/rpc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ assertEq(hex"10b7c11bcb51e6", result);
7070

7171
Spark Config
7272

73-
[Config Reference](../config/testing/#rpc_endpoints)
73+
[Config Reference](../config/testing#rpc_endpoints)

versioned_docs/version-1/reference/config/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Exceptions are:
3939

4040
Configuration files are written in the [TOML format](https://toml.io), with simple key-value pairs inside of sections.
4141

42-
This page describes each configuration key in detail. To see the default values, either refer to the specific key in this document, or see the [default config](../../../static/config.default.toml).
42+
This page describes each configuration key in detail. To see the default values, either refer to the specific key in this document, or see the [default config](../../../../static/config.default.toml).
4343

4444
### Configuration keys
4545

versioned_docs/version-1/reference/probe/probe-access-list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Use the Flashbots RPC URL (https://rpc.flashbots.net).
106106
The Etherscan chain.
107107

108108
`--etherscan-api-key` _key_
109-
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
109+
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan).
110110
Environment: `ETHERSCAN_API_KEY`
111111

112112
#### Common Options

versioned_docs/version-1/reference/probe/probe-call.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Use the Flashbots RPC URL (https://rpc.flashbots.net).
118118
The Etherscan chain.
119119

120120
`--etherscan-api-key` _key_
121-
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
121+
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan).
122122
Environment: `ETHERSCAN_API_KEY`
123123

124124
#### Common Options

versioned_docs/version-1/reference/probe/probe-estimate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Use the Flashbots RPC URL (https://rpc.flashbots.net).
5050
The Etherscan chain.
5151

5252
`--etherscan-api-key` _key_
53-
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
53+
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan).
5454
Environment: `ETHERSCAN_API_KEY`
5555

5656
#### Common Options

versioned_docs/version-1/reference/probe/probe-etherscan-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If not provided, the source will be outputted to stdout.
3030
The Etherscan chain.
3131

3232
`--etherscan-api-key` _key_
33-
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
33+
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan).
3434
Environment: `ETHERSCAN_API_KEY`
3535

3636
#### Common Options

versioned_docs/version-1/reference/probe/probe-interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Output the contract's JSON ABI.
4747
The Etherscan chain.
4848

4949
`--etherscan-api-key` _key_
50-
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
50+
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan).
5151
Environment: `ETHERSCAN_API_KEY`
5252

5353
#### Common Options

versioned_docs/version-1/reference/probe/probe-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Use the Flashbots RPC URL (https://rpc.flashbots.net).
109109
The Etherscan chain.
110110

111111
`--etherscan-api-key` _key_
112-
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
112+
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan).
113113
Environment: `ETHERSCAN_API_KEY`
114114

115115
### EXAMPLES

versioned_docs/version-1/reference/probe/probe-send.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Use the Flashbots RPC URL (https://rpc.flashbots.net).
148148
The Etherscan chain.
149149

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

154154
#### Display Options

versioned_docs/version-1/reference/spark-std/spark-standart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Using Spark Std is the preferred way of writing tests with Foxar.
88

99
What's included:
1010

11-
- `Vm.sol`: Up-to-date [cheatcodes interface](../cheatcodes/cheatcodes-reference/#cheatcodes-interface)
11+
- `Vm.sol`: Up-to-date [cheatcodes interface](../cheatcodes/cheatcodes-reference#cheatcodes-interface)
1212

1313
```solidity
1414
import "spark-std/Vm.sol";

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Use the Flashbots RPC URL (https://rpc.flashbots.net).
150150
The Etherscan chain.
151151

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

156156
#### Cache Options

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Note: To set the gas price in the execution environment of the script use `--gas
7272
The Etherscan chain.
7373

7474
`--etherscan-api-key` _key_
75-
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).
75+
Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan).
7676
Environment: `ETHERSCAN_API_KEY`
7777

7878
#### Verification Options

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,4 +166,4 @@ The location of the Spark-managed solc binaries.
166166

167167
### BUGS
168168

169-
See https://github.com/foxar-rs/foxar/issues for issues.
169+
See https://github.com/bchainhub/foxar/issues for issues.

versioned_docs/version-1/spark/deploying.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ $ spark create --rpc-url <your_rpc_url> \
6060
## Verifying a pre-existing contract
6161

6262
It is recommended to use the `--verify` flag with `spark create` to automatically verify the contract on explorer after a deployment.
63-
Note that for Etherscan [`ETHERSCAN_API_KEY`](../reference/config/etherscan#etherscan_api_key) must be set.
63+
Note that for Etherscan [`ETHERSCAN_API_KEY`](../reference/config/etherscan) must be set.
6464

6565
If you are verifying an already deployed contract, read on.
6666

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ This is something to be mindful of when designing target contracts, as target co
146146

147147
### Invariant Test Helper Functions
148148

149-
Invariant test helper functions are included in [`spark-std`](https://github.com/foxar-rs/spark-std/blob/master/src/StdInvariant.sol) to allow for configurable invariant test setup. The helper functions are outlined below:
149+
Invariant test helper functions are included in [`spark-std`](https://github.com/bchainhub/spark-std/blob/master/src/StdInvariant.sol) to allow for configurable invariant test setup. The helper functions are outlined below:
150150

151151
| Function | Description |
152152
| -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

versioned_docs/version-1/spark/writing-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Writing Tests
44

55
Tests are written in Solidity. If the test function reverts, the test fails, otherwise it passes.
66

7-
Let's go over the most common way of writing tests, using the [Spark Standard Library](https://github.com/foxar-rs/spark-std)'s `Test` contract, which is the preferred way of writing tests with Spark.
7+
Let's go over the most common way of writing tests, using the [Spark Standard Library](https://github.com/bchainhub/spark-std)'s `Test` contract, which is the preferred way of writing tests with Spark.
88

99
In this section, we'll go over the basics using the functions from the Spark Std's `Test` contract, which is itself a superset of [DSTest](https://github.com/dapphub/ds-test). You will learn how to use more advanced stuff from the Spark Standard Library [soon](./spark-std.md).
1010

0 commit comments

Comments
 (0)