From 5adb3dba594a11b9f5422967557838d4055a7e00 Mon Sep 17 00:00:00 2001 From: Rastislav Date: Thu, 16 May 2024 20:05:01 +0200 Subject: [PATCH] More fixes --- .github/.markdownlint.json | 36 + .github/workflows/markdownlint.yml | 25 + README.md | 14 +- docs/intro.md | 72 +- docusaurus.config.ts | 6 +- sidebars.ts | 1084 +--------------- src/pages/versions.tsx | 7 +- .../compile-successful.png | Bin .../contract-verified.png | Bin .../set-up-commands.png | Bin static/img/icons/icon-128.png | Bin 0 -> 4268 bytes static/img/icons/icon-256.png | Bin 0 -> 7227 bytes static/img/icons/icon-32.png | Bin 0 -> 2281 bytes static/img/icons/icon-48.png | Bin 0 -> 2628 bytes static/img/icons/icon-64.png | Bin 0 -> 2928 bytes static/manifest.json | 29 +- .../version-1}/config/configuration.md | 0 .../config/continuous-integration.md | 0 .../version-1}/config/hardhat.md | 0 .../version-1}/config/shell-autocompletion.md | 0 .../version-1}/config/static-analyzers.md | 0 .../version-1}/config/vscode.md | 0 .../version-1}/contributing.md | 0 {docs => versioned_docs/version-1}/faq.md | 0 .../version-1}/getting-started/first-steps.md | 0 .../getting-started/installation.md | 2 +- versioned_docs/version-1/intro.md | 86 ++ .../version-1}/misc/miscellaneous.md | 0 .../version-1}/misc/precompile-registry.md | 0 .../version-1}/misc/struct-encoding.md | 0 .../version-1}/pilot/pilot-overview.md | 0 .../version-1}/probe/probe-overview.md | 0 .../projects/creating-a-new-project.md | 0 .../version-1}/projects/dependencies.md | 0 .../version-1}/projects/project-layout.md | 0 .../working-on-an-existing-project.md | 0 .../reference/cheatcodes/accesses.md | 0 .../reference/cheatcodes/active-fork.md | 0 .../version-1}/reference/cheatcodes/addr.md | 0 .../reference/cheatcodes/allow-cheatcodes.md | 0 .../reference/cheatcodes/assertions.md | 0 .../version-1}/reference/cheatcodes/assume.md | 0 .../reference/cheatcodes/breakpoint.md | 0 .../reference/cheatcodes/broadcast.md | 0 .../reference/cheatcodes/chain-id.md | 0 .../cheatcodes/cheatcodes-reference.md | 0 .../cheatcodes/clear-mocked-calls.md | 0 .../reference/cheatcodes/coinbase.md | 0 .../reference/cheatcodes/create-fork.md | 0 .../cheatcodes/create-select-fork.md | 0 .../reference/cheatcodes/create-wallet.md | 0 .../version-1}/reference/cheatcodes/deal.md | 0 .../reference/cheatcodes/derive-key.md | 0 .../reference/cheatcodes/difficulty.md | 0 .../reference/cheatcodes/env-address.md | 0 .../reference/cheatcodes/env-bool.md | 0 .../reference/cheatcodes/env-bytes.md | 0 .../reference/cheatcodes/env-bytes32.md | 0 .../reference/cheatcodes/env-int.md | 0 .../version-1}/reference/cheatcodes/env-or.md | 0 .../reference/cheatcodes/env-string.md | 0 .../reference/cheatcodes/env-uint.md | 0 .../reference/cheatcodes/environment.md | 0 .../version-1}/reference/cheatcodes/etch.md | 0 .../reference/cheatcodes/expect-call.md | 0 .../reference/cheatcodes/expect-emit.md | 0 .../reference/cheatcodes/expect-revert.md | 0 .../reference/cheatcodes/external.md | 0 .../version-1}/reference/cheatcodes/fee.md | 0 .../version-1}/reference/cheatcodes/ffi.md | 0 .../reference/cheatcodes/forking.md | 0 .../version-1}/reference/cheatcodes/fs.md | 0 .../version-1}/reference/cheatcodes/fuzzer.md | 0 .../reference/cheatcodes/get-block-number.md | 0 .../cheatcodes/get-block-timestamp.md | 0 .../reference/cheatcodes/get-code.md | 0 .../reference/cheatcodes/get-deployed-code.md | 0 .../reference/cheatcodes/get-label.md | 0 .../reference/cheatcodes/get-nonce.md | 0 .../reference/cheatcodes/get-recorded-logs.md | 0 .../reference/cheatcodes/is-persistent.md | 0 .../reference/cheatcodes/key-exists.md | 0 .../version-1}/reference/cheatcodes/label.md | 0 .../version-1}/reference/cheatcodes/load.md | 0 .../reference/cheatcodes/make-persistent.md | 0 .../reference/cheatcodes/mock-call-revert.md | 0 .../reference/cheatcodes/mock-call.md | 0 .../reference/cheatcodes/parse-address.md | 0 .../reference/cheatcodes/parse-bool.md | 0 .../reference/cheatcodes/parse-bytes.md | 0 .../reference/cheatcodes/parse-bytes32.md | 0 .../reference/cheatcodes/parse-int.md | 0 .../reference/cheatcodes/parse-json-keys.md | 0 .../reference/cheatcodes/parse-json.md | 0 .../reference/cheatcodes/parse-uint.md | 0 .../cheatcodes/pause-gas-metering.md | 0 .../version-1}/reference/cheatcodes/prank.md | 0 .../reference/cheatcodes/prevrandao.md | 0 .../reference/cheatcodes/project-root.md | 0 .../reference/cheatcodes/read-callers.md | 0 .../reference/cheatcodes/record-logs.md | 0 .../version-1}/reference/cheatcodes/record.md | 0 .../reference/cheatcodes/remember-key.md | 0 .../cheatcodes/resume-gas-metering.md | 0 .../reference/cheatcodes/revoke-persistent.md | 0 .../reference/cheatcodes/roll-fork.md | 0 .../version-1}/reference/cheatcodes/roll.md | 0 .../version-1}/reference/cheatcodes/rpc.md | 0 .../reference/cheatcodes/select-fork.md | 0 .../reference/cheatcodes/serialize-json.md | 0 .../reference/cheatcodes/set-env.md | 0 .../reference/cheatcodes/set-nonce.md | 0 .../version-1}/reference/cheatcodes/sign.md | 0 .../version-1}/reference/cheatcodes/skip.md | 0 .../version-1}/reference/cheatcodes/sleep.md | 0 .../reference/cheatcodes/snapshots.md | 0 .../reference/cheatcodes/start-broadcast.md | 0 .../reference/cheatcodes/start-prank.md | 0 .../cheatcodes/start-state-diff-recording.md | 0 .../cheatcodes/stop-and-return-state-diff.md | 0 .../reference/cheatcodes/stop-broadcast.md | 0 .../reference/cheatcodes/stop-prank.md | 0 .../version-1}/reference/cheatcodes/store.md | 0 .../reference/cheatcodes/to-string.md | 0 .../reference/cheatcodes/transact.md | 0 .../reference/cheatcodes/tx-gas-price.md | 0 .../reference/cheatcodes/unix-time.md | 0 .../reference/cheatcodes/utilities.md | 0 .../version-1}/reference/cheatcodes/warp.md | 0 .../reference/cheatcodes/write-json.md | 0 .../version-1}/reference/cli/SUMMARY.md | 0 .../version-1}/reference/cli/cli-reference.md | 0 .../version-1}/reference/cli/pilot.md | 0 .../reference/cli/pilot/clear-cache.md | 0 .../version-1}/reference/cli/pilot/list.md | 0 .../version-1}/reference/cli/pilot/load.md | 0 .../version-1}/reference/cli/pilot/view.md | 0 .../version-1}/reference/cli/probe.md | 0 .../reference/cli/probe/4byte-decode.md | 0 .../reference/cli/probe/4byte-event.md | 0 .../version-1}/reference/cli/probe/4byte.md | 0 .../reference/cli/probe/abi-decode.md | 0 .../reference/cli/probe/abi-encode.md | 0 .../reference/cli/probe/access-list.md | 0 .../reference/cli/probe/address-zero.md | 0 .../version-1}/reference/cli/probe/admin.md | 0 .../version-1}/reference/cli/probe/age.md | 0 .../version-1}/reference/cli/probe/balance.md | 0 .../reference/cli/probe/base-fee.md | 0 .../version-1}/reference/cli/probe/bind.md | 0 .../reference/cli/probe/block-number.md | 0 .../version-1}/reference/cli/probe/block.md | 0 .../version-1}/reference/cli/probe/call.md | 0 .../reference/cli/probe/call/--create.md | 0 .../reference/cli/probe/calldata-decode.md | 0 .../reference/cli/probe/calldata.md | 0 .../reference/cli/probe/chain-id.md | 0 .../version-1}/reference/cli/probe/chain.md | 0 .../version-1}/reference/cli/probe/client.md | 0 .../version-1}/reference/cli/probe/code.md | 0 .../reference/cli/probe/codesize.md | 0 .../reference/cli/probe/completions.md | 0 .../reference/cli/probe/compute-address.md | 0 .../reference/cli/probe/concat-hex.md | 0 .../version-1}/reference/cli/probe/create2.md | 0 .../reference/cli/probe/decode-transaction.md | 0 .../reference/cli/probe/disassemble.md | 0 .../reference/cli/probe/estimate.md | 0 .../reference/cli/probe/estimate/--create.md | 0 .../reference/cli/probe/etherscan-source.md | 0 .../reference/cli/probe/find-block.md | 0 .../cli/probe/format-bytes32-string.md | 0 .../reference/cli/probe/from-bin.md | 0 .../reference/cli/probe/from-fixed-point.md | 0 .../reference/cli/probe/from-rlp.md | 0 .../reference/cli/probe/from-utf8.md | 0 .../reference/cli/probe/from-wei.md | 0 .../reference/cli/probe/gas-price.md | 0 .../reference/cli/probe/generate-fig-spec.md | 0 .../reference/cli/probe/hash-zero.md | 0 .../reference/cli/probe/implementation.md | 0 .../version-1}/reference/cli/probe/index.md | 0 .../reference/cli/probe/interface.md | 0 .../version-1}/reference/cli/probe/keccak.md | 0 .../version-1}/reference/cli/probe/logs.md | 0 .../reference/cli/probe/lookup-address.md | 0 .../version-1}/reference/cli/probe/max-int.md | 0 .../reference/cli/probe/max-uint.md | 0 .../version-1}/reference/cli/probe/min-int.md | 0 .../reference/cli/probe/namehash.md | 0 .../version-1}/reference/cli/probe/nonce.md | 0 .../cli/probe/parse-bytes32-address.md | 0 .../cli/probe/parse-bytes32-string.md | 0 .../reference/cli/probe/pretty-calldata.md | 0 .../version-1}/reference/cli/probe/proof.md | 0 .../version-1}/reference/cli/probe/publish.md | 0 .../version-1}/reference/cli/probe/receipt.md | 0 .../reference/cli/probe/resolve-name.md | 0 .../version-1}/reference/cli/probe/rpc.md | 0 .../version-1}/reference/cli/probe/run.md | 0 .../reference/cli/probe/selectors.md | 0 .../version-1}/reference/cli/probe/send.md | 0 .../reference/cli/probe/send/--create.md | 0 .../version-1}/reference/cli/probe/shl.md | 0 .../version-1}/reference/cli/probe/shr.md | 0 .../reference/cli/probe/sig-event.md | 0 .../version-1}/reference/cli/probe/sig.md | 0 .../version-1}/reference/cli/probe/storage.md | 0 .../reference/cli/probe/to-ascii.md | 0 .../version-1}/reference/cli/probe/to-base.md | 0 .../reference/cli/probe/to-bytes32.md | 0 .../cli/probe/to-check-sum-address.md | 0 .../version-1}/reference/cli/probe/to-dec.md | 0 .../reference/cli/probe/to-fixed-point.md | 0 .../version-1}/reference/cli/probe/to-hex.md | 0 .../reference/cli/probe/to-hexdata.md | 0 .../reference/cli/probe/to-int256.md | 0 .../version-1}/reference/cli/probe/to-rlp.md | 0 .../reference/cli/probe/to-uint256.md | 0 .../version-1}/reference/cli/probe/to-unit.md | 0 .../version-1}/reference/cli/probe/to-wei.md | 0 .../version-1}/reference/cli/probe/tx.md | 0 .../reference/cli/probe/upload-signature.md | 0 .../version-1}/reference/cli/probe/wallet.md | 0 .../reference/cli/probe/wallet/address.md | 0 .../cli/probe/wallet/derive-private-key.md | 0 .../reference/cli/probe/wallet/import.md | 0 .../reference/cli/probe/wallet/list.md | 0 .../cli/probe/wallet/new-mnemonic.md | 0 .../reference/cli/probe/wallet/new.md | 0 .../reference/cli/probe/wallet/sign.md | 0 .../reference/cli/probe/wallet/vanity.md | 0 .../reference/cli/probe/wallet/verify.md | 0 .../version-1}/reference/cli/shuttle.md | 0 .../reference/cli/shuttle/completions.md | 0 .../cli/shuttle/generate-fig-spec.md | 0 .../version-1}/reference/cli/spark.md | 0 .../version-1}/reference/cli/spark/bind.md | 0 .../version-1}/reference/cli/spark/build.md | 0 .../version-1}/reference/cli/spark/cache.md | 0 .../reference/cli/spark/cache/clean.md | 0 .../reference/cli/spark/cache/ls.md | 0 .../version-1}/reference/cli/spark/clean.md | 0 .../reference/cli/spark/completions.md | 0 .../version-1}/reference/cli/spark/config.md | 0 .../reference/cli/spark/coverage.md | 0 .../version-1}/reference/cli/spark/create.md | 0 .../version-1}/reference/cli/spark/debug.md | 0 .../version-1}/reference/cli/spark/doc.md | 0 .../version-1}/reference/cli/spark/flatten.md | 0 .../version-1}/reference/cli/spark/fmt.md | 0 .../version-1}/reference/cli/spark/geiger.md | 0 .../reference/cli/spark/generate-fig-spec.md | 0 .../reference/cli/spark/generate.md | 0 .../reference/cli/spark/generate/test.md | 0 .../version-1}/reference/cli/spark/init.md | 0 .../version-1}/reference/cli/spark/inspect.md | 0 .../version-1}/reference/cli/spark/install.md | 0 .../reference/cli/spark/remappings.md | 0 .../version-1}/reference/cli/spark/remove.md | 0 .../version-1}/reference/cli/spark/script.md | 0 .../reference/cli/spark/selectors.md | 0 .../cli/spark/selectors/collision.md | 0 .../reference/cli/spark/selectors/list.md | 0 .../reference/cli/spark/selectors/upload.md | 0 .../reference/cli/spark/snapshot.md | 0 .../version-1}/reference/cli/spark/test.md | 0 .../version-1}/reference/cli/spark/tree.md | 0 .../version-1}/reference/cli/spark/update.md | 0 .../reference/cli/spark/verify-check.md | 0 .../reference/cli/spark/verify-contract.md | 0 .../reference/config/config-reference.md | 0 .../reference/config/doc-generator.md | 0 .../version-1}/reference/config/etherscan.md | 0 .../version-1}/reference/config/formatter.md | 0 .../reference/config/inline-test-config.md | 0 .../version-1}/reference/config/overview.md | 0 .../version-1}/reference/config/project.md | 0 .../reference/config/solidity-compiler.md | 0 .../version-1}/reference/config/testing.md | 0 .../version-1}/reference/ds-test.md | 0 .../reference/pilot/pilot-reference.md | 0 .../reference/probe/abi-commands.md | 0 .../reference/probe/account-commands.md | 0 .../reference/probe/block-commands.md | 0 .../reference/probe/chain-commands.md | 0 .../reference/probe/common-options.md | 0 .../reference/probe/conversion-commands.md | 0 .../reference/probe/ens-commands.md | 0 .../reference/probe/etherscan-commands.md | 0 .../reference/probe/general-commands.md | 0 .../reference/probe/probe-4byte-decode.md | 0 .../reference/probe/probe-4byte-event.md | 0 .../version-1}/reference/probe/probe-4byte.md | 0 .../reference/probe/probe-abi-decode.md | 0 .../reference/probe/probe-abi-encode.md | 0 .../reference/probe/probe-access-list.md | 0 .../version-1}/reference/probe/probe-age.md | 0 .../reference/probe/probe-balance.md | 0 .../reference/probe/probe-basefee.md | 0 .../reference/probe/probe-block-number.md | 0 .../version-1}/reference/probe/probe-block.md | 0 .../version-1}/reference/probe/probe-call.md | 0 .../reference/probe/probe-calldata-decode.md | 0 .../reference/probe/probe-calldata.md | 0 .../reference/probe/probe-chain-id.md | 0 .../version-1}/reference/probe/probe-chain.md | 0 .../reference/probe/probe-client.md | 0 .../version-1}/reference/probe/probe-code.md | 0 .../reference/probe/probe-codesize.md | 0 .../reference/probe/probe-commands.md | 0 .../reference/probe/probe-completions.md | 0 .../reference/probe/probe-compute-address.md | 0 .../reference/probe/probe-concat-hex.md | 0 .../reference/probe/probe-create2.md | 0 .../reference/probe/probe-estimate.md | 0 .../reference/probe/probe-etherscan-source.md | 0 .../reference/probe/probe-find-block.md | 0 .../probe/probe-format-bytes32-string.md | 0 .../reference/probe/probe-from-bin.md | 0 .../reference/probe/probe-from-fixed-point.md | 0 .../reference/probe/probe-from-rlp.md | 0 .../reference/probe/probe-from-utf8.md | 0 .../reference/probe/probe-from-wei.md | 0 .../reference/probe/probe-gas-price.md | 0 .../version-1}/reference/probe/probe-help.md | 0 .../version-1}/reference/probe/probe-index.md | 0 .../reference/probe/probe-interface.md | 0 .../reference/probe/probe-keccak.md | 0 .../version-1}/reference/probe/probe-logs.md | 0 .../reference/probe/probe-lookup-address.md | 0 .../reference/probe/probe-max-int.md | 0 .../reference/probe/probe-max-uint.md | 0 .../reference/probe/probe-min-int.md | 0 .../reference/probe/probe-namehash.md | 0 .../version-1}/reference/probe/probe-nonce.md | 0 .../probe/probe-parse-bytes32-address.md | 0 .../probe/probe-parse-bytes32-string.md | 0 .../reference/probe/probe-pretty-calldata.md | 0 .../version-1}/reference/probe/probe-proof.md | 0 .../reference/probe/probe-publish.md | 0 .../reference/probe/probe-receipt.md | 0 .../reference/probe/probe-resolve-name.md | 0 .../version-1}/reference/probe/probe-rpc.md | 0 .../version-1}/reference/probe/probe-run.md | 0 .../reference/probe/probe-selectors.md | 0 .../version-1}/reference/probe/probe-send.md | 0 .../version-1}/reference/probe/probe-shl.md | 0 .../version-1}/reference/probe/probe-shr.md | 0 .../reference/probe/probe-sig-event.md | 0 .../version-1}/reference/probe/probe-sig.md | 0 .../reference/probe/probe-storage.md | 0 .../reference/probe/probe-to-ascii.md | 0 .../reference/probe/probe-to-base.md | 0 .../reference/probe/probe-to-bytes32.md | 0 .../probe/probe-to-check-sum-address.md | 0 .../reference/probe/probe-to-dec.md | 0 .../reference/probe/probe-to-fixed-point.md | 0 .../reference/probe/probe-to-hex.md | 0 .../reference/probe/probe-to-hexdata.md | 0 .../reference/probe/probe-to-int256.md | 0 .../reference/probe/probe-to-rlp.md | 0 .../reference/probe/probe-to-uint256.md | 0 .../reference/probe/probe-to-unit.md | 0 .../reference/probe/probe-to-wei.md | 0 .../version-1}/reference/probe/probe-tx.md | 0 .../reference/probe/probe-upload-signature.md | 0 .../reference/probe/probe-wallet-address.md | 0 .../reference/probe/probe-wallet-import.md | 0 .../reference/probe/probe-wallet-list.md | 0 .../probe/probe-wallet-new-mnemonic.md | 0 .../reference/probe/probe-wallet-new.md | 0 .../reference/probe/probe-wallet-sign.md | 0 .../reference/probe/probe-wallet-vanity.md | 0 .../reference/probe/probe-wallet-verify.md | 0 .../reference/probe/probe-wallet.md | 0 .../version-1}/reference/probe/probe.md | 0 .../reference/probe/sig-description.md | 0 .../reference/probe/transaction-commands.md | 0 .../reference/probe/utility-commands.md | 0 .../reference/probe/wallet-commands.md | 0 .../version-1}/reference/reference.md | 0 .../reference/shuttle/shuttle-reference.md | 0 .../version-1}/reference/spark-std/abs.md | 0 .../reference/spark-std/arithmeticError.md | 0 .../reference/spark-std/assertApproxEqAbs.md | 0 .../reference/spark-std/assertApproxEqRel.md | 0 .../reference/spark-std/assertEq.md | 0 .../reference/spark-std/assertFalse.md | 0 .../reference/spark-std/assertionError.md | 0 .../spark-std/assume-no-precompiles.md | 0 .../reference/spark-std/assume-payable.md | 0 .../version-1}/reference/spark-std/bound.md | 0 .../reference/spark-std/change-prank.md | 0 .../reference/spark-std/checked_write.md | 0 .../spark-std/compute-create-address.md | 0 .../reference/spark-std/console-log.md | 0 .../version-1}/reference/spark-std/deal.md | 0 .../version-1}/reference/spark-std/delta.md | 0 .../reference/spark-std/deployCode.md | 0 .../reference/spark-std/deployCodeTo.md | 0 .../version-1}/reference/spark-std/depth.md | 0 .../spark-std/derive-remember-key.md | 0 .../reference/spark-std/divisionError.md | 0 .../reference/spark-std/encodeStorageError.md | 0 .../spark-std/enumConversionError.md | 0 .../version-1}/reference/spark-std/fail.md | 0 .../version-1}/reference/spark-std/find.md | 0 .../version-1}/reference/spark-std/hoax.md | 0 .../reference/spark-std/indexOOBError.md | 0 .../reference/spark-std/make-addr-and-key.md | 0 .../reference/spark-std/make-addr.md | 0 .../reference/spark-std/memOverflowError.md | 0 .../reference/spark-std/noGasMetering.md | 0 .../reference/spark-std/percentDelta.md | 0 .../reference/spark-std/popError.md | 0 .../version-1}/reference/spark-std/read.md | 0 .../version-1}/reference/spark-std/rewind.md | 0 .../reference/spark-std/script-utils.md | 0 .../version-1}/reference/spark-std/sig.md | 0 .../version-1}/reference/spark-std/skip.md | 0 .../reference/spark-std/spark-standart.md | 2 +- .../reference/spark-std/startHoax.md | 0 .../reference/spark-std/std-assertions.md | 0 .../reference/spark-std/std-cheats.md | 0 .../reference/spark-std/std-errors.md | 0 .../reference/spark-std/std-logs.md | 0 .../reference/spark-std/std-math.md | 0 .../reference/spark-std/std-storage.md | 0 .../version-1}/reference/spark-std/target.md | 0 .../reference/spark-std/with_key.md | 0 .../reference/spark-std/zeroVarError.md | 0 .../reference/spark/build-commands.md | 0 .../version-1}/reference/spark/commands.md | 0 .../reference/spark/common-options.md | 0 .../reference/spark/compiler-options.md | 0 .../reference/spark/core-build-options.md | 0 .../reference/spark/deploy-commands.md | 0 .../version-1}/reference/spark/evm-options.md | 0 .../reference/spark/executor-options.md | 0 .../reference/spark/general-commands.md | 0 .../reference/spark/project-commands.md | 0 .../reference/spark/project-options.md | 0 .../version-1}/reference/spark/spark-bind.md | 0 .../version-1}/reference/spark/spark-build.md | 0 .../reference/spark/spark-cache-clean.md | 0 .../reference/spark/spark-cache-ls.md | 0 .../version-1}/reference/spark/spark-cache.md | 0 .../version-1}/reference/spark/spark-clean.md | 0 .../reference/spark/spark-completions.md | 0 .../reference/spark/spark-config.md | 0 .../reference/spark/spark-coverage.md | 0 .../reference/spark/spark-create.md | 0 .../version-1}/reference/spark/spark-debug.md | 0 .../version-1}/reference/spark/spark-doc.md | 0 .../reference/spark/spark-flatten.md | 0 .../reference/spark/spark-geiger.md | 0 .../version-1}/reference/spark/spark-help.md | 0 .../version-1}/reference/spark/spark-init.md | 0 .../reference/spark/spark-inspect.md | 0 .../reference/spark/spark-install.md | 0 .../reference/spark/spark-remappings.md | 0 .../reference/spark/spark-remove.md | 0 .../reference/spark/spark-script.md | 224 ++-- .../reference/spark/spark-snapshot.md | 0 .../version-1}/reference/spark/spark-test.md | 0 .../version-1}/reference/spark/spark-tree.md | 0 .../reference/spark/spark-update.md | 0 .../reference/spark/spark-upload-selectors.md | 0 .../reference/spark/spark-verify-check.md | 0 .../reference/spark/spark-verify-contract.md | 0 .../version-1}/reference/spark/spark.md | 0 .../reference/spark/test-commands.md | 0 .../reference/spark/test-options.md | 0 .../reference/spark/utility-commands.md | 0 .../reference/spark/watch-options.md | 0 .../version-1}/shuttle/anvil.png | Bin .../version-1}/shuttle/shuttle-overview.md | 0 .../version-1}/spark/advanced-testing.md | 0 .../version-1}/spark/cheatcodes.md | 0 .../version-1}/spark/debugger.md | 0 .../version-1}/spark/deploying.md | 0 .../spark/differential-ffi-testing.md | 0 .../version-1}/spark/fork-testing.md | 0 .../version-1}/spark/fuzz-testing.md | 0 .../version-1}/spark/gas-reports.md | 0 .../version-1}/spark/gas-snapshots.md | 0 .../version-1}/spark/gas-tracking.md | 0 .../version-1}/spark/invariant-testing.md | 0 .../version-1}/spark/overview-spark.md | 0 .../version-1}/spark/spark-std.md | 2 +- .../version-1}/spark/tests.md | 0 .../version-1}/spark/traces.md | 0 .../version-1}/spark/writing-tests.md | 0 .../version-1}/tutorials/best-practices.md | 0 .../version-1}/tutorials/create2-tutorial.md | 0 .../forking-mainnet-with-probe-shuttle.md | 0 .../version-1}/tutorials/foxar-docker.md | 0 .../invariant-testing-bonding-curve.md | 0 .../version-1}/tutorials/learn-foxar.md | 0 .../version-1}/tutorials/solmate-nft.md | 2 +- .../version-1}/tutorials/testing-eip712.md | 0 .../version-1/tutorials/ylem-scripting.md | 12 +- versioned_sidebars/version-1-sidebars.ts | 1097 +++++++++++++++++ versions.json | 2 +- 505 files changed, 1413 insertions(+), 1289 deletions(-) create mode 100644 .github/.markdownlint.json create mode 100644 .github/workflows/markdownlint.yml rename static/img/docs/{solidity-scripting => ylem-scripting}/compile-successful.png (100%) rename static/img/docs/{solidity-scripting => ylem-scripting}/contract-verified.png (100%) rename static/img/docs/{solidity-scripting => ylem-scripting}/set-up-commands.png (100%) create mode 100644 static/img/icons/icon-128.png create mode 100644 static/img/icons/icon-256.png create mode 100644 static/img/icons/icon-32.png create mode 100644 static/img/icons/icon-48.png create mode 100644 static/img/icons/icon-64.png rename {docs => versioned_docs/version-1}/config/configuration.md (100%) rename {docs => versioned_docs/version-1}/config/continuous-integration.md (100%) rename {docs => versioned_docs/version-1}/config/hardhat.md (100%) rename {docs => versioned_docs/version-1}/config/shell-autocompletion.md (100%) rename {docs => versioned_docs/version-1}/config/static-analyzers.md (100%) rename {docs => versioned_docs/version-1}/config/vscode.md (100%) rename {docs => versioned_docs/version-1}/contributing.md (100%) rename {docs => versioned_docs/version-1}/faq.md (100%) rename {docs => versioned_docs/version-1}/getting-started/first-steps.md (100%) rename {docs => versioned_docs/version-1}/getting-started/installation.md (98%) create mode 100644 versioned_docs/version-1/intro.md rename {docs => versioned_docs/version-1}/misc/miscellaneous.md (100%) rename {docs => versioned_docs/version-1}/misc/precompile-registry.md (100%) rename {docs => versioned_docs/version-1}/misc/struct-encoding.md (100%) rename {docs => versioned_docs/version-1}/pilot/pilot-overview.md (100%) rename {docs => versioned_docs/version-1}/probe/probe-overview.md (100%) rename {docs => versioned_docs/version-1}/projects/creating-a-new-project.md (100%) rename {docs => versioned_docs/version-1}/projects/dependencies.md (100%) rename {docs => versioned_docs/version-1}/projects/project-layout.md (100%) rename {docs => versioned_docs/version-1}/projects/working-on-an-existing-project.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/accesses.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/active-fork.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/addr.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/allow-cheatcodes.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/assertions.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/assume.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/breakpoint.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/broadcast.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/chain-id.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/cheatcodes-reference.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/clear-mocked-calls.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/coinbase.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/create-fork.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/create-select-fork.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/create-wallet.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/deal.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/derive-key.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/difficulty.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-address.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-bool.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-bytes.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-bytes32.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-int.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-or.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-string.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/env-uint.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/environment.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/etch.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/expect-call.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/expect-emit.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/expect-revert.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/external.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/fee.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/ffi.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/forking.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/fs.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/fuzzer.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/get-block-number.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/get-block-timestamp.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/get-code.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/get-deployed-code.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/get-label.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/get-nonce.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/get-recorded-logs.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/is-persistent.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/key-exists.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/label.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/load.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/make-persistent.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/mock-call-revert.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/mock-call.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-address.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-bool.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-bytes.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-bytes32.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-int.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-json-keys.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-json.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/parse-uint.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/pause-gas-metering.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/prank.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/prevrandao.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/project-root.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/read-callers.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/record-logs.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/record.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/remember-key.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/resume-gas-metering.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/revoke-persistent.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/roll-fork.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/roll.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/rpc.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/select-fork.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/serialize-json.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/set-env.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/set-nonce.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/sign.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/skip.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/sleep.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/snapshots.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/start-broadcast.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/start-prank.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/start-state-diff-recording.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/stop-and-return-state-diff.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/stop-broadcast.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/stop-prank.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/store.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/to-string.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/transact.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/tx-gas-price.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/unix-time.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/utilities.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/warp.md (100%) rename {docs => versioned_docs/version-1}/reference/cheatcodes/write-json.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/SUMMARY.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/cli-reference.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/pilot.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/pilot/clear-cache.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/pilot/list.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/pilot/load.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/pilot/view.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/4byte-decode.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/4byte-event.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/4byte.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/abi-decode.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/abi-encode.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/access-list.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/address-zero.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/admin.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/age.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/balance.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/base-fee.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/bind.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/block-number.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/block.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/call.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/call/--create.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/calldata-decode.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/calldata.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/chain-id.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/chain.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/client.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/code.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/codesize.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/completions.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/compute-address.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/concat-hex.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/create2.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/decode-transaction.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/disassemble.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/estimate.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/estimate/--create.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/etherscan-source.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/find-block.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/format-bytes32-string.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/from-bin.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/from-fixed-point.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/from-rlp.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/from-utf8.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/from-wei.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/gas-price.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/generate-fig-spec.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/hash-zero.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/implementation.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/index.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/interface.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/keccak.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/logs.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/lookup-address.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/max-int.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/max-uint.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/min-int.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/namehash.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/nonce.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/parse-bytes32-address.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/parse-bytes32-string.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/pretty-calldata.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/proof.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/publish.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/receipt.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/resolve-name.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/rpc.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/run.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/selectors.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/send.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/send/--create.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/shl.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/shr.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/sig-event.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/sig.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/storage.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-ascii.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-base.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-bytes32.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-check-sum-address.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-dec.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-fixed-point.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-hex.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-hexdata.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-int256.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-rlp.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-uint256.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-unit.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/to-wei.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/tx.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/upload-signature.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/address.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/derive-private-key.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/import.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/list.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/new-mnemonic.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/new.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/sign.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/vanity.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/probe/wallet/verify.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/shuttle.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/shuttle/completions.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/shuttle/generate-fig-spec.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/bind.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/build.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/cache.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/cache/clean.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/cache/ls.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/clean.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/completions.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/config.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/coverage.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/create.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/debug.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/doc.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/flatten.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/fmt.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/geiger.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/generate-fig-spec.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/generate.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/generate/test.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/init.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/inspect.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/install.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/remappings.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/remove.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/script.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/selectors.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/selectors/collision.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/selectors/list.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/selectors/upload.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/snapshot.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/test.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/tree.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/update.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/verify-check.md (100%) rename {docs => versioned_docs/version-1}/reference/cli/spark/verify-contract.md (100%) rename {docs => versioned_docs/version-1}/reference/config/config-reference.md (100%) rename {docs => versioned_docs/version-1}/reference/config/doc-generator.md (100%) rename {docs => versioned_docs/version-1}/reference/config/etherscan.md (100%) rename {docs => versioned_docs/version-1}/reference/config/formatter.md (100%) rename {docs => versioned_docs/version-1}/reference/config/inline-test-config.md (100%) rename {docs => versioned_docs/version-1}/reference/config/overview.md (100%) rename {docs => versioned_docs/version-1}/reference/config/project.md (100%) rename {docs => versioned_docs/version-1}/reference/config/solidity-compiler.md (100%) rename {docs => versioned_docs/version-1}/reference/config/testing.md (100%) rename {docs => versioned_docs/version-1}/reference/ds-test.md (100%) rename {docs => versioned_docs/version-1}/reference/pilot/pilot-reference.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/abi-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/account-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/block-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/chain-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/common-options.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/conversion-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/ens-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/etherscan-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/general-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-4byte-decode.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-4byte-event.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-4byte.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-abi-decode.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-abi-encode.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-access-list.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-age.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-balance.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-basefee.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-block-number.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-block.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-call.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-calldata-decode.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-calldata.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-chain-id.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-chain.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-client.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-code.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-codesize.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-completions.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-compute-address.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-concat-hex.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-create2.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-estimate.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-etherscan-source.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-find-block.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-format-bytes32-string.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-from-bin.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-from-fixed-point.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-from-rlp.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-from-utf8.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-from-wei.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-gas-price.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-help.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-index.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-interface.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-keccak.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-logs.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-lookup-address.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-max-int.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-max-uint.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-min-int.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-namehash.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-nonce.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-parse-bytes32-address.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-parse-bytes32-string.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-pretty-calldata.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-proof.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-publish.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-receipt.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-resolve-name.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-rpc.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-run.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-selectors.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-send.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-shl.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-shr.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-sig-event.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-sig.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-storage.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-ascii.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-base.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-bytes32.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-check-sum-address.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-dec.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-fixed-point.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-hex.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-hexdata.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-int256.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-rlp.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-uint256.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-unit.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-to-wei.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-tx.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-upload-signature.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-address.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-import.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-list.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-new-mnemonic.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-new.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-sign.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-vanity.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet-verify.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe-wallet.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/probe.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/sig-description.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/transaction-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/utility-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/probe/wallet-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/reference.md (100%) rename {docs => versioned_docs/version-1}/reference/shuttle/shuttle-reference.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/abs.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/arithmeticError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/assertApproxEqAbs.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/assertApproxEqRel.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/assertEq.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/assertFalse.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/assertionError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/assume-no-precompiles.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/assume-payable.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/bound.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/change-prank.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/checked_write.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/compute-create-address.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/console-log.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/deal.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/delta.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/deployCode.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/deployCodeTo.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/depth.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/derive-remember-key.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/divisionError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/encodeStorageError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/enumConversionError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/fail.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/find.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/hoax.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/indexOOBError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/make-addr-and-key.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/make-addr.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/memOverflowError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/noGasMetering.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/percentDelta.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/popError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/read.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/rewind.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/script-utils.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/sig.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/skip.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/spark-standart.md (96%) rename {docs => versioned_docs/version-1}/reference/spark-std/startHoax.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/std-assertions.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/std-cheats.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/std-errors.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/std-logs.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/std-math.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/std-storage.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/target.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/with_key.md (100%) rename {docs => versioned_docs/version-1}/reference/spark-std/zeroVarError.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/build-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/commands.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/common-options.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/compiler-options.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/core-build-options.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/deploy-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/evm-options.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/executor-options.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/general-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/project-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/project-options.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-bind.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-build.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-cache-clean.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-cache-ls.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-cache.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-clean.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-completions.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-config.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-coverage.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-create.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-debug.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-doc.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-flatten.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-geiger.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-help.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-init.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-inspect.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-install.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-remappings.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-remove.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-script.md (79%) rename {docs => versioned_docs/version-1}/reference/spark/spark-snapshot.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-test.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-tree.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-update.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-upload-selectors.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-verify-check.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark-verify-contract.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/spark.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/test-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/test-options.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/utility-commands.md (100%) rename {docs => versioned_docs/version-1}/reference/spark/watch-options.md (100%) rename {docs => versioned_docs/version-1}/shuttle/anvil.png (100%) rename {docs => versioned_docs/version-1}/shuttle/shuttle-overview.md (100%) rename {docs => versioned_docs/version-1}/spark/advanced-testing.md (100%) rename {docs => versioned_docs/version-1}/spark/cheatcodes.md (100%) rename {docs => versioned_docs/version-1}/spark/debugger.md (100%) rename {docs => versioned_docs/version-1}/spark/deploying.md (100%) rename {docs => versioned_docs/version-1}/spark/differential-ffi-testing.md (100%) rename {docs => versioned_docs/version-1}/spark/fork-testing.md (100%) rename {docs => versioned_docs/version-1}/spark/fuzz-testing.md (100%) rename {docs => versioned_docs/version-1}/spark/gas-reports.md (100%) rename {docs => versioned_docs/version-1}/spark/gas-snapshots.md (100%) rename {docs => versioned_docs/version-1}/spark/gas-tracking.md (100%) rename {docs => versioned_docs/version-1}/spark/invariant-testing.md (100%) rename {docs => versioned_docs/version-1}/spark/overview-spark.md (100%) rename {docs => versioned_docs/version-1}/spark/spark-std.md (99%) rename {docs => versioned_docs/version-1}/spark/tests.md (100%) rename {docs => versioned_docs/version-1}/spark/traces.md (100%) rename {docs => versioned_docs/version-1}/spark/writing-tests.md (100%) rename {docs => versioned_docs/version-1}/tutorials/best-practices.md (100%) rename {docs => versioned_docs/version-1}/tutorials/create2-tutorial.md (100%) rename {docs => versioned_docs/version-1}/tutorials/forking-mainnet-with-probe-shuttle.md (100%) rename {docs => versioned_docs/version-1}/tutorials/foxar-docker.md (100%) rename {docs => versioned_docs/version-1}/tutorials/invariant-testing-bonding-curve.md (100%) rename {docs => versioned_docs/version-1}/tutorials/learn-foxar.md (100%) rename {docs => versioned_docs/version-1}/tutorials/solmate-nft.md (99%) rename {docs => versioned_docs/version-1}/tutorials/testing-eip712.md (100%) rename docs/tutorials/solidity-scripting.md => versioned_docs/version-1/tutorials/ylem-scripting.md (95%) create mode 100644 versioned_sidebars/version-1-sidebars.ts diff --git a/.github/.markdownlint.json b/.github/.markdownlint.json new file mode 100644 index 0000000..9141d93 --- /dev/null +++ b/.github/.markdownlint.json @@ -0,0 +1,36 @@ +{ + "default": true, + "MD001": false, + "MD003": { + "style": "atx" + }, + "MD004": false, + "MD012": false, + "MD013": false, + "MD014": false, + "MD022": false, + "MD024": false, + "MD025": false, + "MD026": false, + "MD028": false, + "MD031": false, + "MD032": false, + "MD033": { + "allowed_elements": [ + "a", + "kbd", + "sub", + "sup" + ] + }, + "MD034": false, + "MD035": { + "style": "---" + }, + "MD036": false, + "MD040": false, + "MD041": false, + "MD048": { + "style": "backtick" + } +} diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml new file mode 100644 index 0000000..b355042 --- /dev/null +++ b/.github/workflows/markdownlint.yml @@ -0,0 +1,25 @@ +name: Docs linter +on: + pull_request: + branches: + - master + paths: + - "docs/**/*.md" + - "versioned_docs/**/*.md" + - ".github/workflows/markdownlint.yml" + - ".github/.markdownlint.json" + +jobs: + docs-linter: + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - uses: actions/checkout@v3 + + - name: Markdown Lint + uses: ruzickap/action-my-markdown-linter@v1 + with: + config_file: .github/lintconfig.yml + search_paths: | + docs/**/*.md + versioned_docs/**/*.md diff --git a/README.md b/README.md index 3767d73..f022eb5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# CorePass Developer Hub +# Foxar Documentation -Welcome to the CorePass Developer Hub! This repository hosts the documentation for CorePass, a revolutionary platform for digital identity management that empowers users with full control over their personal data. Our documentation is built using Docusaurus system. +Welcome to the Foxar Documentation! This repository hosts the documentation for Foxar. The documentation is built using Docusaurus system. -## About CorePass +## About Foxar -CorePass is dedicated to revolutionizing the way digital identities are managed. By giving users control over their personal data, CorePass paves the way for a more secure and privacy-respecting digital environment. +Foxar is a blazing fast, portable and modular toolkit for Core BC app development. ## Getting Started with the Documentation @@ -67,12 +67,8 @@ We welcome contributions to the CorePass Developer Hub! Whether it's improving t ## License -This project is licensed under the CORE license - see the [LICENSE](LICENSE) file for details. +This project is licensed under the CORE license. ## Support For support, please open an issue in the GitHub issue tracker. - -## Stay in Touch - -For the latest updates and news about CorePass, follow us on social media or visit our [official website](https://corepass.net). diff --git a/docs/intro.md b/docs/intro.md index 965dd93..d51cbf1 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -5,74 +5,4 @@ sidebar_position: 1 -> Foxar is a blazing fast, portable and modular toolkit for Core BC app development. - -Foxar manages your dependencies, compiles your project, runs tests, deploys, and lets you interact with the chain from the command-line and via Ylem scripts. - -## Sections - -**[Getting Started](getting-started/installation)** - -To get started with Foxar, install Foxar and set up your first project. - -**[Projects](projects/creating-a-new-project.md)** - -This section will give you an overview of how to create and work with existing projects. - -**[Spark Overview](spark/overview-spark)** - -The overview will give you all you need to know about how to use `spark` to develop, test, and deploy smart contracts. - -**[Probe Overview](probe/probe-overview)** - -Learn how to use `probe` to interact with smart contracts, send transactions, and get chain data from the command-line. - -**[Shuttle Overview](shuttle/shuttle-overview)** - -Learn about `shuttle`, Foxar's local node. - -**[Pilot Overview](pilot/pilot-overview)** - -Learn how to use `pilot`, Foxar's integrated Solidity REPL. - -## Configuration - -Guides on configuring Foxar. - -- [Configuring with `foxar.toml`](./config/configuration/) -- [Continuous Integration](./config/continuous-integration.md) -- [Integrating with VSCode](./config/vscode.md) -- [Shell Autocompletion](./config/shell-autocompletion.md) -- [Static Analyzers](./config/static-analyzers.md) -- [Integrating with Hardhat](./config/hardhat.md) - -## Tutorials - -Tutorials on building smart contracts with Foxar. - -- [Creating an NFT with Solmate](./tutorials/solmate-nft.md) -- [Docker and Foxar](./tutorials/foxar-docker.md) -- [Testing EIP-712 Signatures](./tutorials/testing-eip712.md) -- [Solidity Scripting](./tutorials/solidity-scripting.md) -- [Forking Mainnet with Probe and Shuttle](./tutorials/forking-mainnet-with-probe-shuttle.md) -- [Learning Foxar Videos](./tutorials/learn-foxar.md) - -## Contributing - -Help us improve Foxar: [Contributing](./contributing.md) - -## Appendix - -References, troubleshooting, and more. - -- [FAQ](./faq.md) -- [CLI Reference](./reference/cli/cli-reference) -- [spark Commands](./reference/spark/) -- [probe Commands](./reference/probe/) -- [shuttle Commands](./reference/shuttle/shuttle-reference) -- [pilot Commands](./reference/pilot/pilot-reference) -- [Config Reference](./reference/config/config-reference) -- [Cheatcodes Reference](./reference/cheatcodes/cheatcodes-reference) -- [Spark Standard Library Reference](./reference/spark-std/spark-standart) -- [DSTest Reference](./reference/ds-test) -- [Miscellaneous](misc/miscellaneous) +> Canary version of Foxar documentation. diff --git a/docusaurus.config.ts b/docusaurus.config.ts index f93618b..bfc5e68 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -35,7 +35,7 @@ function getLastVersion() { } function getNextVersionName() { - return "1.0.0"; + return "Canary"; } const config: Config = { @@ -48,8 +48,8 @@ const config: Config = { organizationName: "bchainhub", projectName: "foxar-docs", - onBrokenLinks: "warn", - onBrokenAnchors: "warn", + onBrokenLinks: "throw", + onBrokenAnchors: "throw", onBrokenMarkdownLinks: "warn", i18n: { diff --git a/sidebars.ts b/sidebars.ts index d5531ef..acc7685 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -1,4 +1,4 @@ -import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; +import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; /** * Creating a sidebar enables you to: @@ -12,1086 +12,20 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; */ const sidebars: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], // But you can create a sidebar manually - + /* tutorialSidebar: [ - "intro", - { - type: "category", - label: "Getting Started", - items: ["getting-started/installation", "getting-started/first-steps"], - }, - { - type: "category", - label: "Projects", - items: [ - "projects/creating-a-new-project", - "projects/working-on-an-existing-project", - "projects/dependencies", - "projects/project-layout", - ], - }, - { - type: "category", - label: "Spark Overview", - items: [ - "spark/overview-spark", - { - type: "category", - label: "Tests", - link: { - type: "doc", - - id: "spark/tests", - }, - - items: [ - "spark/writing-tests", - "spark/cheatcodes", - "spark/spark-std", - "spark/traces", - "spark/fork-testing", - ], - }, - { - type: "category", - label: "Advanced Testing", - link: { - type: "doc", - - id: "spark/advanced-testing", - }, - - items: [ - "spark/fuzz-testing", - "spark/invariant-testing", - "spark/differential-ffi-testing", - ], - }, - "spark/deploying", - { - type: "category", - label: "Gas Tracking", - link: { - type: "doc", - - id: "spark/gas-tracking", - }, - - items: ["spark/gas-reports", "spark/gas-snapshots"], - }, - "spark/debugger", - ], - }, - { - type: "category", - label: "Probe Overview", - items: ["probe/probe-overview"], - }, - { - type: "category", - label: "Shuttle Overview", - items: ["shuttle/shuttle-overview"], - }, - { - type: "category", - label: "Pilot Overview", - items: ["pilot/pilot-overview"], - }, - { - type: "category", - label: "Configuration", - items: [ - "config/configuration", - "config/continuous-integration", - "config/vscode", - "config/shell-autocompletion", - "config/static-analyzers", - "config/hardhat", - ], - }, + 'intro', + 'hello', { - type: "category", - label: "Tutorials", - items: [ - "tutorials/best-practices", - "tutorials/solmate-nft", - "tutorials/foxar-docker", - "tutorials/testing-eip712", - "tutorials/solidity-scripting", - "tutorials/create2-tutorial", - "tutorials/forking-mainnet-with-probe-shuttle", - "tutorials/learn-foxar", - ], - }, - { - type: "category", - label: "Appendix", - items: [ - "faq", - "contributing", - - { - type: "category", - label: "References", - link: { - type: "doc", - - id: "reference/reference", - }, - items: [ - { - type: "category", - label: "CLI Reference", - link: { - type: "doc", - - id: "reference/cli/cli-reference", - }, - items: [ - { - type: "category", - label: "spark", - link: { - type: "doc", - - id: "reference/cli/spark", - }, - items: [ - "reference/cli/spark/bind", - "reference/cli/spark/build", - { - type: "category", - label: "spark cache", - link: { - type: "doc", - - id: "reference/cli/spark/cache", - }, - items: [ - "reference/cli/spark/cache/clean", - "reference/cli/spark/cache/ls", - ], - }, - "reference/cli/spark/clean", - "reference/cli/spark/completions", - "reference/cli/spark/config", - "reference/cli/spark/coverage", - "reference/cli/spark/create", - "reference/cli/spark/debug", - "reference/cli/spark/doc", - "reference/cli/spark/flatten", - "reference/cli/spark/fmt", - "reference/cli/spark/geiger", - { - type: "category", - label: "spark generate", - link: { - type: "doc", - - id: "reference/cli/spark/generate", - }, - items: ["reference/cli/spark/generate/test"], - }, - "reference/cli/spark/generate-fig-spec", - "reference/cli/spark/init", - "reference/cli/spark/inspect", - "reference/cli/spark/install", - "reference/cli/spark/remappings", - "reference/cli/spark/remove", - "reference/cli/spark/script", - { - type: "category", - label: "spark selectors", - link: { - type: "doc", - - id: "reference/cli/spark/selectors", - }, - items: [ - "reference/cli/spark/selectors/collision", - "reference/cli/spark/selectors/upload", - "reference/cli/spark/selectors/list", - ], - }, - "reference/cli/spark/snapshot", - "reference/cli/spark/test", - "reference/cli/spark/tree", - "reference/cli/spark/update", - "reference/cli/spark/verify-check", - "reference/cli/spark/verify-contract", - ], - }, - { - type: "category", - label: "probe", - link: { - type: "doc", - - id: "reference/cli/probe", - }, - items: [ - "reference/cli/probe/4byte", - "reference/cli/probe/4byte-decode", - "reference/cli/probe/4byte-event", - "reference/cli/probe/abi-decode", - "reference/cli/probe/abi-encode", - "reference/cli/probe/access-list", - "reference/cli/probe/address-zero", - "reference/cli/probe/admin", - "reference/cli/probe/age", - "reference/cli/probe/balance", - "reference/cli/probe/base-fee", - "reference/cli/probe/bind", - "reference/cli/probe/block", - "reference/cli/probe/block-number", - "reference/cli/probe/call", - "reference/cli/probe/call/--create", - "reference/cli/probe/calldata", - "reference/cli/probe/calldata-decode", - "reference/cli/probe/chain", - "reference/cli/probe/chain-id", - "reference/cli/probe/client", - "reference/cli/probe/code", - "reference/cli/probe/codesize", - "reference/cli/probe/completions", - "reference/cli/probe/compute-address", - "reference/cli/probe/concat-hex", - "reference/cli/probe/create2", - "reference/cli/probe/decode-transaction", - "reference/cli/probe/disassemble", - { - type: "category", - label: "probe estimate", - link: { - type: "doc", - - id: "reference/cli/probe/estimate", - }, - items: ["reference/cli/probe/estimate/--create"], - }, - "reference/cli/probe/etherscan-source", - "reference/cli/probe/format-bytes32-string", - "reference/cli/probe/find-block", - "reference/cli/probe/from-bin", - "reference/cli/probe/from-fixed-point", - "reference/cli/probe/from-rlp", - "reference/cli/probe/from-utf8", - "reference/cli/probe/from-wei", - "reference/cli/probe/gas-price", - "reference/cli/probe/generate-fig-spec", - "reference/cli/probe/hash-zero", - "reference/cli/probe/implementation", - "reference/cli/probe/index", - "reference/cli/probe/interface", - "reference/cli/probe/keccak", - "reference/cli/probe/logs", - "reference/cli/probe/lookup-address", - "reference/cli/probe/max-int", - "reference/cli/probe/max-uint", - "reference/cli/probe/min-int", - "reference/cli/probe/namehash", - "reference/cli/probe/nonce", - "reference/cli/probe/parse-bytes32-address", - "reference/cli/probe/parse-bytes32-string", - "reference/cli/probe/pretty-calldata", - "reference/cli/probe/proof", - "reference/cli/probe/publish", - "reference/cli/probe/receipt", - "reference/cli/probe/resolve-name", - "reference/cli/probe/rpc", - "reference/cli/probe/run", - "reference/cli/probe/selectors", - - { - type: "category", - label: "probe send", - link: { - type: "doc", - - id: "reference/cli/probe/send", - }, - items: ["reference/cli/probe/send/--create"], - }, - "reference/cli/probe/shl", - "reference/cli/probe/shr", - "reference/cli/probe/sig", - "reference/cli/probe/sig-event", - "reference/cli/probe/storage", - "reference/cli/probe/to-ascii", - "reference/cli/probe/to-base", - "reference/cli/probe/to-bytes32", - "reference/cli/probe/to-check-sum-address", - "reference/cli/probe/to-dec", - "reference/cli/probe/to-fixed-point", - "reference/cli/probe/to-hex", - "reference/cli/probe/to-hexdata", - "reference/cli/probe/to-int256", - "reference/cli/probe/to-rlp", - "reference/cli/probe/to-uint256", - "reference/cli/probe/to-unit", - "reference/cli/probe/to-wei", - "reference/cli/probe/tx", - "reference/cli/probe/upload-signature", - - { - type: "category", - label: "probe wallet", - link: { - type: "doc", - - id: "reference/cli/probe/wallet", - }, - items: [ - "reference/cli/probe/wallet/new", - "reference/cli/probe/wallet/new-mnemonic", - "reference/cli/probe/wallet/vanity", - "reference/cli/probe/wallet/address", - "reference/cli/probe/wallet/sign", - - "reference/cli/probe/wallet/verify", - "reference/cli/probe/wallet/import", - "reference/cli/probe/wallet/list", - "reference/cli/probe/wallet/derive-private-key", - ], - }, - ], - }, - { - type: "category", - label: "shuttle", - link: { - type: "doc", - - id: "reference/cli/shuttle", - }, - items: [ - "reference/cli/shuttle/completions", - "reference/cli/shuttle/generate-fig-spec", - ], - }, - { - type: "category", - label: "pilot", - link: { - type: "doc", - - id: "reference/cli/pilot", - }, - items: [ - "reference/cli/pilot/list", - "reference/cli/pilot/load", - "reference/cli/pilot/view", - "reference/cli/pilot/clear-cache", - ], - }, - ], - }, - { - type: "category", - label: "Spark Commands", - link: { - type: "doc", - - id: "reference/spark/commands", - }, - items: [ - { - type: "category", - label: "General Commands", - link: { - type: "doc", - - id: "reference/spark/general-commands", - }, - items: [ - "reference/spark/spark", - "reference/spark/spark-help", - "reference/spark/spark-completions", - ], - }, - { - type: "category", - label: "Project Commands", - link: { - type: "doc", - - id: "reference/spark/project-commands", - }, - items: [ - "reference/spark/spark-init", - "reference/spark/spark-install", - "reference/spark/spark-update", - "reference/spark/spark-remove", - "reference/spark/spark-config", - "reference/spark/spark-remappings", - "reference/spark/spark-tree", - "reference/spark/spark-geiger", - ], - }, - { - type: "category", - label: "Build Commands", - link: { - type: "doc", - - id: "reference/spark/build-commands", - }, - items: [ - "reference/spark/spark-build", - "reference/spark/spark-clean", - "reference/spark/spark-inspect", - ], - }, - { - type: "category", - label: "Test Commands", - link: { - type: "doc", - - id: "reference/spark/test-commands", - }, - items: [ - "reference/spark/spark-test", - "reference/spark/spark-snapshot", - "reference/spark/spark-coverage", - ], - }, - { - type: "category", - label: "Deploy Commands", - link: { - type: "doc", - - id: "reference/spark/deploy-commands", - }, - items: [ - "reference/spark/spark-create", - "reference/spark/spark-verify-contract", - "reference/spark/spark-verify-check", - "reference/spark/spark-flatten", - ], - }, - { - type: "category", - label: "Utility Commands", - link: { - type: "doc", - - id: "reference/spark/utility-commands", - }, - items: [ - "reference/spark/spark-debug", - "reference/spark/spark-bind", - "reference/spark/spark-cache", - "reference/spark/spark-cache-clean", - "reference/spark/spark-cache-ls", - "reference/spark/spark-script", - "reference/spark/spark-upload-selectors", - "reference/spark/spark-doc", - ], - }, - ], - }, - { - type: "category", - label: "Probe Commands", - link: { - type: "doc", - - id: "reference/probe/probe-commands", - }, - items: [ - { - type: "category", - label: "General Commands", - link: { - type: "doc", - - id: "reference/probe/general-commands", - }, - items: [ - "reference/probe/probe", - "reference/probe/probe-help", - "reference/probe/probe-completions", - ], - }, - { - type: "category", - label: "Chain Commands", - link: { - type: "doc", - - id: "reference/probe/chain-commands", - }, - items: [ - "reference/probe/probe-chain-id", - "reference/probe/probe-chain", - "reference/probe/probe-client", - ], - }, - { - type: "category", - label: "Transaction Commands", - link: { - type: "doc", - - id: "reference/probe/transaction-commands", - }, - items: [ - "reference/probe/probe-publish", - "reference/probe/probe-receipt", - "reference/probe/probe-send", - "reference/probe/probe-call", - "reference/probe/probe-rpc", - "reference/probe/probe-tx", - "reference/probe/probe-run", - "reference/probe/probe-estimate", - "reference/probe/probe-access-list", - "reference/probe/probe-logs", - ], - }, - { - type: "category", - label: "Block Commands", - link: { - type: "doc", - - id: "reference/probe/block-commands", - }, - items: [ - "reference/probe/probe-find-block", - "reference/probe/probe-gas-price", - "reference/probe/probe-block-number", - "reference/probe/probe-basefee", - "reference/probe/probe-block", - "reference/probe/probe-age", - ], - }, - { - type: "category", - label: "Account Commands", - link: { - type: "doc", - - id: "reference/probe/account-commands", - }, - items: [ - "reference/probe/probe-balance", - "reference/probe/probe-storage", - "reference/probe/probe-proof", - "reference/probe/probe-nonce", - "reference/probe/probe-code", - "reference/probe/probe-codesize", - ], - }, - { - type: "category", - label: "ENS Commands", - link: { - type: "doc", - - id: "reference/probe/ens-commands", - }, - items: [ - "reference/probe/probe-lookup-address", - "reference/probe/probe-resolve-name", - "reference/probe/probe-namehash", - ], - }, - { - type: "category", - label: "Etherscan Commands", - link: { - type: "doc", - - id: "reference/probe/etherscan-commands", - }, - items: ["reference/probe/probe-etherscan-source"], - }, - { - type: "category", - label: "ABI Commands", - link: { - type: "doc", - - id: "reference/probe/abi-commands", - }, - items: [ - "reference/probe/probe-abi-decode", - "reference/probe/probe-abi-encode", - "reference/probe/probe-4byte", - "reference/probe/probe-4byte-decode", - "reference/probe/probe-4byte-event", - "reference/probe/probe-calldata", - "reference/probe/probe-calldata-decode", - "reference/probe/probe-pretty-calldata", - "reference/probe/probe-selectors", - "reference/probe/probe-upload-signature", - ], - }, - { - type: "category", - label: "Conversion Commands", - link: { - type: "doc", - - id: "reference/probe/conversion-commands", - }, - items: [ - "reference/probe/probe-format-bytes32-string", - "reference/probe/probe-from-bin", - "reference/probe/probe-from-fixed-point", - "reference/probe/probe-from-rlp", - "reference/probe/probe-from-utf8", - "reference/probe/probe-from-wei", - "reference/probe/probe-parse-bytes32-address", - "reference/probe/probe-parse-bytes32-string", - "reference/probe/probe-to-ascii", - "reference/probe/probe-to-base", - "reference/probe/probe-to-bytes32", - "reference/probe/probe-to-dec", - "reference/probe/probe-to-fixed-point", - "reference/probe/probe-to-hex", - "reference/probe/probe-to-hexdata", - "reference/probe/probe-to-int256", - "reference/probe/probe-to-rlp", - "reference/probe/probe-to-uint256", - "reference/probe/probe-to-unit", - "reference/probe/probe-to-wei", - "reference/probe/probe-shl", - "reference/probe/probe-shr", - ], - }, - { - type: "category", - label: "Utility Commands", - link: { - type: "doc", - - id: "reference/probe/utility-commands", - }, - items: [ - "reference/probe/probe-sig", - "reference/probe/probe-sig-event", - "reference/probe/probe-keccak", - "reference/probe/probe-compute-address", - "reference/probe/probe-create2", - "reference/probe/probe-interface", - "reference/probe/probe-index", - "reference/probe/probe-concat-hex", - "reference/probe/probe-max-int", - "reference/probe/probe-min-int", - "reference/probe/probe-max-uint", - "reference/probe/probe-to-check-sum-address", - ], - }, - { - type: "category", - label: "Wallet Commands", - link: { - type: "doc", - - id: "reference/probe/wallet-commands", - }, - items: [ - "reference/probe/probe-wallet", - "reference/probe/probe-wallet-new", - "reference/probe/probe-wallet-new-mnemonic", - "reference/probe/probe-wallet-address", - "reference/probe/probe-wallet-sign", - "reference/probe/probe-wallet-vanity", - "reference/probe/probe-wallet-verify", - "reference/probe/probe-wallet-import", - "reference/probe/probe-wallet-list", - ], - }, - ], - }, - { - type: "category", - label: "Shuttle Reference", - link: { - type: "doc", - - id: "reference/shuttle/shuttle-reference", - }, - items: [], - }, - { - type: "category", - label: "Pilot Reference", - link: { - type: "doc", - - id: "reference/pilot/pilot-reference", - }, - items: [], - }, - { - type: "category", - label: "Config Reference", - link: { - type: "doc", - - id: "reference/config/config-reference", - }, - items: [ - "reference/config/overview", - "reference/config/project", - "reference/config/solidity-compiler", - "reference/config/testing", - "reference/config/inline-test-config", - "reference/config/formatter", - "reference/config/doc-generator", - "reference/config/etherscan", - ], - }, - { - type: "category", - label: "Cheatcodes Reference", - link: { - type: "doc", - - id: "reference/cheatcodes/cheatcodes-reference", - }, - items: [ - { - type: "category", - label: "Environment", - link: { - type: "doc", - - id: "reference/cheatcodes/environment", - }, - items: [ - "reference/cheatcodes/warp", - "reference/cheatcodes/roll", - "reference/cheatcodes/fee", - "reference/cheatcodes/get-block-timestamp", - "reference/cheatcodes/get-block-number", - "reference/cheatcodes/difficulty", - "reference/cheatcodes/prevrandao", - "reference/cheatcodes/chain-id", - "reference/cheatcodes/store", - "reference/cheatcodes/load", - "reference/cheatcodes/etch", - "reference/cheatcodes/deal", - "reference/cheatcodes/prank", - "reference/cheatcodes/start-prank", - "reference/cheatcodes/stop-prank", - "reference/cheatcodes/read-callers", - "reference/cheatcodes/record", - "reference/cheatcodes/accesses", - "reference/cheatcodes/prank", - "reference/cheatcodes/record-logs", - "reference/cheatcodes/get-recorded-logs", - "reference/cheatcodes/set-nonce", - "reference/cheatcodes/get-nonce", - "reference/cheatcodes/mock-call", - "reference/cheatcodes/mock-call-revert", - "reference/cheatcodes/clear-mocked-calls", - "reference/cheatcodes/coinbase", - "reference/cheatcodes/broadcast", - "reference/cheatcodes/start-broadcast", - "reference/cheatcodes/stop-broadcast", - "reference/cheatcodes/pause-gas-metering", - "reference/cheatcodes/resume-gas-metering", - "reference/cheatcodes/tx-gas-price", - "reference/cheatcodes/start-state-diff-recording", - "reference/cheatcodes/stop-and-return-state-diff", - ], - }, - { - type: "category", - label: "Assertions", - link: { - type: "doc", - - id: "reference/cheatcodes/assertions", - }, - items: [ - "reference/cheatcodes/expect-revert", - "reference/cheatcodes/expect-emit", - "reference/cheatcodes/expect-call", - ], - }, - { - type: "category", - label: "Fuzzer", - link: { - type: "doc", - - id: "reference/cheatcodes/fuzzer", - }, - items: ["reference/cheatcodes/assume"], - }, - { - type: "category", - label: "Forking", - link: { - type: "doc", - - id: "reference/cheatcodes/forking", - }, - items: [ - "reference/cheatcodes/create-fork", - "reference/cheatcodes/select-fork", - "reference/cheatcodes/create-select-fork", - "reference/cheatcodes/active-fork", - "reference/cheatcodes/roll-fork", - "reference/cheatcodes/make-persistent", - "reference/cheatcodes/revoke-persistent", - "reference/cheatcodes/is-persistent", - "reference/cheatcodes/allow-cheatcodes", - "reference/cheatcodes/transact", - ], - }, - { - type: "category", - label: "External", - link: { - type: "doc", - - id: "reference/cheatcodes/external", - }, - items: [ - "reference/cheatcodes/ffi", - "reference/cheatcodes/project-root", - "reference/cheatcodes/get-code", - "reference/cheatcodes/get-deployed-code", - "reference/cheatcodes/sleep", - "reference/cheatcodes/unix-time", - "reference/cheatcodes/set-env", - "reference/cheatcodes/env-or", - "reference/cheatcodes/env-bool", - "reference/cheatcodes/env-uint", - "reference/cheatcodes/env-int", - "reference/cheatcodes/env-address", - "reference/cheatcodes/env-bytes32", - "reference/cheatcodes/env-string", - "reference/cheatcodes/env-bytes", - "reference/cheatcodes/parse-json", - "reference/cheatcodes/key-exists", - "reference/cheatcodes/parse-json-keys", - "reference/cheatcodes/serialize-json", - "reference/cheatcodes/write-json", - ], - }, - { - type: "category", - label: "Utilities", - link: { - type: "doc", - - id: "reference/cheatcodes/utilities", - }, - items: [ - "reference/cheatcodes/addr", - "reference/cheatcodes/sign", - "reference/cheatcodes/skip", - "reference/cheatcodes/label", - "reference/cheatcodes/get-label", - "reference/cheatcodes/derive-key", - "reference/cheatcodes/parse-bytes", - "reference/cheatcodes/parse-address", - "reference/cheatcodes/parse-uint", - "reference/cheatcodes/parse-int", - "reference/cheatcodes/parse-bytes32", - "reference/cheatcodes/parse-bool", - "reference/cheatcodes/remember-key", - "reference/cheatcodes/to-string", - "reference/cheatcodes/breakpoint", - "reference/cheatcodes/create-wallet", - ], - }, - { - type: "category", - label: "Snapshots", - link: { - type: "doc", - - id: "reference/cheatcodes/snapshots", - }, - items: [], - }, - { - type: "category", - label: "RPC", - link: { - type: "doc", - - id: "reference/cheatcodes/rpc", - }, - items: [], - }, - { - type: "category", - label: "Files", - link: { - type: "doc", - - id: "reference/cheatcodes/fs", - }, - items: [], - }, - ], - }, - { - type: "category", - label: "Spark Standard Library Reference", - link: { - type: "doc", - - id: "reference/spark-std/spark-standart", - }, - items: [ - "reference/spark-std/std-logs", - { - type: "category", - label: "Std Assertions", - link: { - type: "doc", - - id: "reference/spark-std/std-assertions", - }, - items: [ - "reference/spark-std/fail", - "reference/spark-std/assertFalse", - "reference/spark-std/assertEq", - "reference/spark-std/assertApproxEqAbs", - "reference/spark-std/assertApproxEqRel", - ], - }, - { - type: "category", - label: "Std Cheats", - link: { - type: "doc", - - id: "reference/spark-std/std-cheats", - }, - items: [ - "reference/spark-std/skip", - "reference/spark-std/rewind", - "reference/spark-std/hoax", - "reference/spark-std/startHoax", - "reference/spark-std/deal", - "reference/spark-std/deployCode", - "reference/spark-std/deployCodeTo", - "reference/spark-std/bound", - "reference/spark-std/change-prank", - "reference/spark-std/make-addr", - "reference/spark-std/make-addr-and-key", - "reference/spark-std/noGasMetering", - "reference/spark-std/assume-no-precompiles", - "reference/spark-std/assume-payable", - ], - }, - { - type: "category", - label: "Std Errors", - link: { - type: "doc", - - id: "reference/spark-std/std-errors", - }, - items: [ - "reference/spark-std/assertionError", - "reference/spark-std/arithmeticError", - "reference/spark-std/divisionError", - "reference/spark-std/enumConversionError", - "reference/spark-std/encodeStorageError", - "reference/spark-std/popError", - "reference/spark-std/indexOOBError", - "reference/spark-std/memOverflowError", - "reference/spark-std/zeroVarError", - ], - }, - { - type: "category", - label: "Std Storage", - link: { - type: "doc", - - id: "reference/spark-std/std-storage", - }, - items: [ - "reference/spark-std/target", - "reference/spark-std/sig", - "reference/spark-std/with_key", - "reference/spark-std/depth", - "reference/spark-std/checked_write", - "reference/spark-std/find", - "reference/spark-std/read", - ], - }, - { - type: "category", - label: "Std Math", - link: { - type: "doc", - - id: "reference/spark-std/std-math", - }, - items: [ - "reference/spark-std/abs", - "reference/spark-std/delta", - "reference/spark-std/percentDelta", - ], - }, - { - type: "category", - label: "Script Utils", - link: { - type: "doc", - - id: "reference/spark-std/script-utils", - }, - items: [ - "reference/spark-std/compute-create-address", - "reference/spark-std/derive-remember-key", - ], - }, - { - type: "category", - label: "Console Logging", - link: { - type: "doc", - - id: "reference/spark-std/console-log", - }, - items: [], - }, - ], - }, - { - type: "category", - label: "DSTest Reference", - link: { - type: "doc", - - id: "reference/ds-test", - }, - items: [], - }, - ], - }, - { - type: "category", - label: "Miscellaneous", - link: { - type: "doc", - - id: "misc/miscellaneous", - }, - items: ["misc/struct-encoding", "misc/precompile-registry"], - }, - ], + type: 'category', + label: 'Tutorial', + items: ['tutorial-basics/create-a-document'], }, ], + */ }; export default sidebars; diff --git a/src/pages/versions.tsx b/src/pages/versions.tsx index feb2fa7..befceb4 100644 --- a/src/pages/versions.tsx +++ b/src/pages/versions.tsx @@ -44,11 +44,11 @@ export default function Version(): JSX.Element { return (
- CorePass versions + Foxar versions
@@ -113,8 +113,7 @@ export default function Version(): JSX.Element {

- Here you can find documentation for previous versions of - CorePass. + Here you can find documentation for previous versions of Foxar.

diff --git a/static/img/docs/solidity-scripting/compile-successful.png b/static/img/docs/ylem-scripting/compile-successful.png similarity index 100% rename from static/img/docs/solidity-scripting/compile-successful.png rename to static/img/docs/ylem-scripting/compile-successful.png diff --git a/static/img/docs/solidity-scripting/contract-verified.png b/static/img/docs/ylem-scripting/contract-verified.png similarity index 100% rename from static/img/docs/solidity-scripting/contract-verified.png rename to static/img/docs/ylem-scripting/contract-verified.png diff --git a/static/img/docs/solidity-scripting/set-up-commands.png b/static/img/docs/ylem-scripting/set-up-commands.png similarity index 100% rename from static/img/docs/solidity-scripting/set-up-commands.png rename to static/img/docs/ylem-scripting/set-up-commands.png diff --git a/static/img/icons/icon-128.png b/static/img/icons/icon-128.png new file mode 100644 index 0000000000000000000000000000000000000000..9dc10d73cdeb7780de516a4d9032c98522d90f85 GIT binary patch literal 4268 zcmai2c|6ql|Npo~j9a-v(@-L2#>g?_J{v>~%9YHT88b0vjKSns!>(V*T`U&4k6k3^ zbU4!H>=2S%kq*_0S}T?G{fzq7?yue7?~l*Syx-5)>-m1&@6ThBU7Qb!izYdVtz(?{qdP;fI*m5XjYOk$Knb0&lOZeuTPGw;jYsi`!-fLO6czlyV{W8ID0CJ*j6!F8 zao}%9e1X4F1jF~wDr^GdpM;&9{%>&_?Qd>`v1}v2Kzt7B-)#Et0b%YZ86+g06h;qc z29RtcNFgk>tw`|Vf_0&?Nx_~rR2nHH42-TRTo-NhzfiA#L#^q-bfz0vRwPhuONkdd ztUZkoNIFU-vM68Kz5<6xA%Wi@JnMqPdFk~Cp@ROPzp{CL#Z2LbXyjiG^7=>UOD?cm z_Bqjspm};*gkK?hYik!KolFe|u`v8WE112lwSg|iz(5C$_;do8I4r13C7-k*us|s^ z3VlEarLUuF;EqONQF>TigZ(Hp7KPek-jW9Ufk>7pA;2x{n_vIJLrj>EfNW3+sayBlo{-3 z57Tpj-)20C`QvBIseC>E(^WaCcZ>w{gZ(lDKio>Zz9%p&f3Gr2H{G~OVUlR1T-MO> zVATJ*&v}nuH!sH3)AR}ZhKJ!MrIaW?wzpAB@jdNX>6fnf3m)@&gbalI_Ri*2cH)qn z#{LcJ1=Tdc?k7?adxMPpt~of|-ZnH8N*WP*{KjnDaZ>jFTTJqYhp`Ga+aC4}h`9-_ z=xWEl8dyR1l+@LnF<(7n?&!?ik*}Y!SeK=4tC~?GR9l=`lTw_SRYm#pBmKB|II9BR zF(c`8yXq|#xH+}rfxelcHoAd@yqEPQ|N8c#wL-LPhx=V$;o*xSPmg-&bVB8QhTqp* zU!BMx%D2~QT`9EcgR>r3ykJ%acD*k&v0zzuK37^>yQ=fl_-H3z$!!WCn*ELfUKt_` zoL3kCKxKIkA5c)J005#=_BNL8?82p@*kKP_l|J+Shf_F*6cRT*8?vWUZ*pH%nZYB} zCF@jl!A*`=fL1~h4wuBC!*VP}-QCj3gtXRlG+F!*_VJ?%k}D)XpXN_Y#Y(+y!o_Xe zYCY8_T>O4IZ24_b$D5eVn3o;R$0xvrX>>%_R7Q$b^6Z*`8FU(=T=d~BW)8p5v)}f` z{pv-CasJ}cKsPe}{oA;w0;z(z`*CIG?8=MmRwJZPyVm)KC8+YxKd5N7C$q+ZYxIFP)!WQMCo0umm% zZiYF01s1DoV*Z-wg2O3;048Zx6*8SDwwfJN_KVms;B~PJk|!*N&pmT`5QtTeir$NV zdHBxwh?thZnEmP+V@{Q*WH`WlAe+M%wL5BR7gr(=s$8dC{mdOQ0lhQToHbA=+tS(s zGMh?unDTpW^DV8fyz35Gv|1ep&SV{J6$rn(-I~NnU0k}@zqrXJX(o=mf+WpK@Vyj5 zjEg7#?7ZSa&y=m<q#Vy8p-xEZ-SH7vm!%(ehx5pCYk9jc zpcntFdvlPf^foc#?snBqsau$~?`-3KHyFmxins(ejz-$jC{Mwdh>WT#e zfV3X`AVt%`u(vBd+EKiI=cq#fsL+=gxmw=Z`e^QaH*ujycGBv(?F?vQd_VlgK!q{# zg3x`L&VFvAlh2{!F8UU^`OW<6nN{h9Cj8SB-}O^%nRYH<+}3RTcZe)iF86xRMJ*%@ zIu?>kv;CzzR3LTgH*Y-0(WG=b&^Kw&+dIKdNWo62=%W;BhPzVGmU*O%z-fxyJTZq| z=oy`~N-0^zLLkStRx?y*X6rBv(dzmB5QS40=pZqSRYE*oMpHUw=uSnbN&3djg zC$9b`kf;%9#_|)I5Q-7bqx!Osx#3pVVu;5A%>6Hh&SS(?iin)2SXEtG6+{HLQHy(zcTL|B*Sou96La+Npf5Y6e zl6(X;8TV{BDMGi~d2VNS@Iuc{Z#drMK$(iz%6{U@&J{*tLq!zDW)L#L5wtX^@qH<* z_Tr-kepCL~@@`v!-)$ONFujTGEjC2WhxdT?Gb^RiwTg4pis|#?+od~9p&~3Jd$)sn zxa+`qK0`(M&hwgZpPMX6MrBnx86P2FqyCQ65K1^xu+3h&OVvwt%}ht7-r^dtJodK3 zqu=U=ypLv;Vbk_kd%CwdsnlCt1CW2derujpdCy$i>PB%t{x^9(*#qG%1wDbaO}4q_ z&*#gRx@Wo>H*aOkN+iwBiq)0gG~Tt^3!KTMPKopf%p8sv>P>8Qhys#k{gTeUClp{) zY+@h6qoxjr!8Jx1+q2=DR40{gj4cx95hvX~%g#cFi9$ek;VAl=W`GDOMt(~p6u1V7g ze|@fOr+b`Ou#i{X@Achj6|(!^BNuw4!OoA^0Xv;@Ow5y}6HBbLE2jl;w2wrHFyh;C zA+Gikhi3s$LwOD|l9p3M@@3nU&sT^`b#y3Wo|rx^ygHQ%jil%oKZ2p6jQPFf+39V$ z%5~O$(dKoUa80loB_U7v?`4PlIhlUL{)Qf6`o zF3seO?1T-;`iT}+*6$In#HiI6SL%a<3Y`1*Cufd>!{Y4A)RLEHZ}FzH=zU*|rn3Z&GDh^fW>1b7Tqvw~HH*PHnipPH0(h_q=q(0~b@v>;VR5*Wm@@Y{{Xm4+5+ zV}GopPb62hE6LA}$q9&T9wa9h4sk|XS|62c&+pAF;hUQ|G<$n@5G1?*(TqSBq?cOk zlvlxbf>=8Z<=l2lx39PJ{6YPP4WIH?72+;xQPEmVpBlrTx`H>Pjc#*Y)}IW!pD&m} zAvWZUWEEk*_}XI>`C?ql=i5*KZagz|{`)z#{@j(KODXSC2a9{#xI(Ko;Ls$>JPQU( zut`9{eU+TmRtwDNA~vpaS44=`_M#dbNee=6Gfmv(8h6E1eLYkcZGN0Adc5r38U#Qg zg3*XW0?v@{OSP-rSwHffP>|mw`Wi_l*Bq;^uNGsS1#S0fI;A$%mhCr||5N$_fD=k+ z4kbXC-hoX+m;M;J0I4DPdItHftD{u6O-7|uEr5OvEh?s8@tcW$U$InME7)WL_}cIrw~@aV(j1R}vbmZ#2#EXpPLO@`BxAN$ramCM zD#C<&6OX1r7dX1z$6Nk9U#!kt`=GO3ghJAP6_qXr+`~4xl&pFR|&U2n~`JB^P2Yc#TlnM%h zptXB#t(_nU2L6OWYox(1PgY4F1WDD>UEJ7ib_dA*j4+~K0OKf)7!$?>bO!^U=cc1$Z;Fx@teMRSg`ckz!4@h1gnP(_x9upQC9!ZWd*I1ED27gPIbv4viSlA)v8g6zD>Q)REP2HGiOw`lZg;FFSe6BwalNT>}FG;2=cChO_-*2;q^NBqCO2 zSkof?S#&0w&InhR$n-nP;IPd#Gyq-w58<>J`d`w+BmcNQFodpzqN`8T)BRU=Ha+ma zuuCX^V`m04*o??v2J_Dg{M!+KlK-|5nD0MtiSc9pCuTdl|C>E5?BA{t$+n3ChWNv% z|EAMF4~TS$Wzuw=XpsyK%b#WwMGI$dTCs%0E@TIK3@y~nnjS_Aj|A2=*Dx?P`CnA` z|3q`g*F4lG6>JrvL)ov4=Tdu^;t z^hqWr1Owvg3E<(#U@tu|*4mE^xD50Rj0k$h1bq`113j{y0omASJNQ>mZ$zLk7P4gu`5ffuI@~WSp8c445hF5xVrkvOOyTlB}OvWV6qqi z9DiEC%HcrVDm9W3$d2}7(RK%cM>f~k9T-Rl=8RQ$ka(}UK2cwfX!`FvqJwFYH~+79 z)BQs;T}jmaQ#CW)zbS9F!tgI)3ihq8f$#@;MEB1`0zUpsMYM2`e^?;VD8)Z$0LknG z9X!k5o&$n3GdYZ!I+@RfHM)X?AsKm|YK!^N#T_ zt-bnMXXx8WN2hAnw}yV{M8)+@H8U|O9SYmFf2CKerAZ0iuZ!9mV(R^P-@X@XIyxd~ zJ;<@yUA_AU#I+sJPK|=ZeC}(b?x zQoqQ&rq??pv2b0fH80U>M0Vu3;FRv%c%$Ggk^gDNJmft^*OFPzt(^Ke zelNrRj$lR-P9;rILQZFHJGQF= z3K$s^?vN%*4-G%LG}v&y@|Bx5r0hmoa7`{1XbJj=%?a4otuBy325TlBR+Id^yhhdl z%azT-iDO2-^Yt0ktSEqIBxe-*tTip2Hf}Ms4=I88zp-W(9hQD&9L+BZbAft*I6JNJ z`S>G2^zB%#kv%U_R&TB8w{EXY?QfMrd`G|ytKt6E;#dY`?P=>~NGG6jg7b^EYD4-L z3pb+kqz}Lj>GPabvD}=e-JcG+PsWRM>YQM?Q5Vn zV9EoMc0KJ*S~DkAmB~?v<)JL%w5iR;wEefuQw!Vn1JfRSC-gz)eS=FI3Q8+lR+_kn z6F(Bz2tvwh+B%$Jwy)m_>x*<|qiZ@ftP0^7-*$ATBRZvbNtcJ>sE4>Hi&F$D1!XGL z0J#mD@?=kfg)P)(RXv%$C*!joMx+ zf!<-qgxegl7k7FDWllQ5+E`=4*RW0`hT0)M1U}Ed6CQ^13UFUTHne7{frV>r-Jh)8 zCmD=eM*78`%XXEp!Wh z6R>?bqoxKHE)aqUT&_K*f>2&l`^-`Vi3{LL4y1)Nt&_$S-~6JY$vRAzoHiGBq0k4J zgUUmt8uMNTYD4sFoY-3s>T4*{A=IyLXeC=yN+4+qUZNTEo2tr)ERTfODYb%?RTUj- zvkKE`JR~(DFE^ouY|&f-seqT38>?K}+Uu?zNtp^0trOpX2j}3##aYu|A6C@3{2Hv- zuObU#G0^64&+c}C%I?wu{K)qtkalrfEAk$F3@&hKUG>|^DS`3pw+zFC$dQWq&-qkinLJ2RTg9l_O(PD zySvU*v7s%cwvBvXLkZ-)C#W$=iK$j~J0fqu3xWG&dG7_;_DTtqy@^VJ#mf-?Iz8=HUU~yI%Y4* zxyjIXVj*Cvvv+x?C|@Qf@mx!oyW1XjPQK7GH%N8QxdD@koRgSDGzGz9;l*9#Gha)O z9RhOGlH;DvhOFd#d!j9m&}1ky!lbpJ%q;DOih#@14H< zvUrZOuDZ~fyPzXY1h2%II&8n4d+%r4{^(_*NWDi^n@ir@&d;v|F>?<05D^7km7Xl; zs3oHc2Cu>b;o}V%S8Fl;6*cBHvqNl9-H4+&koj5T}d@zW*o%^LxF6V>gIS@|ZaaBevM;=?veKF>~ z7#AkJw_I>#TrfU~Dlk`Y91@NUO{Z5e@76;&ODW{dtL-6nj41yHs}B1v>fB8@!^&D#saCcg=?J-|oYGL_dg( za#6l|1gTCLA{%cWrrP4cOEhBQXltITc*XTUzdu7xD~2nXEnCjtT5ev|lsMunQ1D8e z(7v1L43p(8U(Xv)Y9-ssv-dpol6^2t?ofAz84WuNNP+{3JsKjtUe?Sl_%`Szx4I=l z`YNiRf9Wy{{YktkOwHFMce=}1n;UrV%IB`mwX3Uf?a9sQob0=fFryCmNa)Bf9vkgr zn{eV|f~SJLf@3Wa9($2pxMisWrElL~xDG1U{>HZ1IFU|RF}!MaKe%c9ikxO;kRdK{ zvQSvf=}ve%HeX?sC7 zT=>2zw%#H9ePiAEN>UYTMxIL&@Os??o`86yeEK28>_Dv1@B0*c?hqdgS#)$)BJ!y7 z9hKiWBg(Sjb5GYKMt#Fn)*DPQYTh3!eTbL1rJb}S>l+5Dv!$z1J$hpI$gh51h0g^b zHaDw&1@3v-srcF+nWXJM-GOsio7&X`3s!SOu~}Zhw|iI{Su-MpB6Ql}X;gn*NipPU zD>p9O2KSK~s?B2@v7G<9AgkCjdK~@QAwOb(>Nxo>zAgeck$emV2~ybc<7L0Q_-afk zwENU97o@&i0_ocO{`b!_3y0I3PQ3vzXs9%f^t!QN%+vOTTM!6s@u{qvzhmxn9u2*R zrk~=R@xFBoIc1rDf0jKpy*yf*USxK&xfmR9p$u&SxOZyqoDQYs+brxyI#lDtAzGug zl;C`uP=Ii<3Vl-UEKbq|zqUmDn1L!VAT2~YXD?nk67+4nHg_KYg4D~kHP<)_bPU#_ zgVRF4W~+SDyv3Afl!_{N0+6qBOK8}!e4AY0)&NV{Y050c19(&e;Lv6&<2O9IZX9&wIJ&DcM2- zY#ew?Ck5NOOh0;;{Zh@u3ZSRm&6zC4;hg}gSRmD(19W}ibIzoGa9$MUYk5t2fCvB- zA~k6p?Idq4;CW{NkQG2UB{;DOs7OPB`9%f?A)h;#Ze4BesR>|fQ<|au^Vgzgw3jWq z+-l}LssK-({vC5YwAnnXqN8Xryx`f6@;$GvoG`KBCGG?l@G7ry`7kTE64E#~t5X5V zN^D}KT<7{EtN7HymMWhx8A>qH_ePECe9dU>Yhy{7MV#(s4=pFGf*uQiZUDezr9&?P zx^a`K=EH>-aN>JrJM51%NAHvr7C=Y`NwavzQIJX&sZK5QN*eBF)G`t`X1Txs;eH)1 z1c>Bz)|J@1HJwf*yLfN#I&$xXI|>r6F7FUVhiWvs4`cz{K*0?~Mep0?E{$|8Nq;v7e0p$c% zRK>Lkxzj6Xrx19~LF#C2#UOjG7(Qz@Bu zJ~g$_-`qRR8cFK-6XaZFxssHqrGu93&KDFxNdc*916F_rtw3Sw%U#N8FYiXJ1px1O z@9u$p$SE_@!mLyAui>D{Vnrib8!~Q#WEeG&QoMkSTd)FrqyIjA|y*tGl(ZzF>Ouu%`%jku;FPF6FGzIz~aptc!U@wx$J+3n_z_ z&#JeSdBZ@D(wsc`rDjS`Z|z*(mx&tZMHJLt^R6dJ1V0Q>+Pe={VVt*DKsS7_b6cmv zMLO6cs00PmCn+;$I5`safPVT}tp|qvB#z{y*0>Zef$e(6U0P6Azsu2$Bhy*wr9ZX| z2!gm9$A!^%FwTey$QvL}Lt6CkM-Uj{%0(FmqwwYds>Ky9knVNEPSKk7NFnH{N(U2s z$;`_Vkd*_<*n?D@m@FV=8FWqjqvDNLq&WO8re~`*7Y~}zgCs&RFQ(90k_}^MW`4WM@rjYL9XG3aP0mU*wq3XKey*PO0h+z_H@I&zir$*3^4SXF`=9^QOX1~v5f#b!mqLLv{4;|6|xISS};yF z)U1KmwVtT(ao9!Z+A1j*!W%g8p{&cv_lo+44kv37H-DU+GFWK@meuv-V=4gTCKPy9 zJ^V4HwvT*3z7&evOl>BQJ<8S+Xai-V6=~aUY^XSCl!hv3WzAf13`8##aTMN$WbL(* z;A9lm;@UeQg4R0{Gpbn^|6LC384GXjui65tXgYZjllRlS$8%HrkBN39LP;Dv6D6?V zE&VRoB3LZ1SyQ9=Lct|=e>F+~lA3vzAD>YLu9YN%DTx?{VY$_vSHE{oc9uYmV^KTw z9!a`5TgrrTv_Fw=L*z$t3CWd5#!LGY1Y?qpYdiN8==b+FUSaMBaZ3InWyXEAYb(Hs zgMAIgF3%c+hU-0kq^>T(y2P0)&B7C+@LtyL*@^w+gS1}6m->|)C>@D^&cUlneZc(e zmw!`(>LDXk%!kXK0qBtj?}WF2r15Bg$e-`U$AL3pZ!O!2{Qj($CvJ5?7rfv6xSFK_ zBEO2BSl50ip#I1>T^|fGE}1Qd!h=m`a1YJ00&x=L#%tN$NEq73u_DZX>;2f zGt{E-cG7ndO^kdhsGsUkL&hW%{}F?e`Z`2TpE-@PSo$74(E*gZYymKfc`-agF#>P? z)-o6Ml{958GV9r?4Y?B)dvv{QKS^OABZrz47wGdjko%qQYBfV8N9%v~C;>wdPuqiF zxFvlTS*BLf59T}Wcq0G4m#uuV95j1mJTub~)>Z{F8Ej}x9zqAqG9L5c8GfL18M7p> zjge>ObJW};z<^3$v4`Pl8;@9oH`jG;vbqV+xE+B%F5h>~;K4gO05?+F(1f;P&r2fT zFu5W*ByF^9yJX@6ZpFbrlN4d$08^c~PSB2~7@hoF z{nofQ_8kex*`U~SoXD4hqDXLP^n zjXhQbU*}BZ%Xr$#K=JTs_wmv+l!eNp6!s<>;vb~~`Id+>FurSHN*wh$KTjb6I4UR# zJ*GrHs2nG`=G>iWqqVtUPe%${o_7E9Q^Dv8o>otLzv`Cx=PKdZ%G6_6FopxL%}lWe zF9;WW?2R3;M5-e|_OxnezT7MDUqSO0(mask&~yy#=lP4mTHih}%BupntuX_Gh=PUJ zbQ+!kD^tKhpq+3kJUwcHb}J{n1PmB~h8(g|mX)Ys+17&)*bsvO? z$S9ST^cOO{(fGPV)3QTQ&psmmh}LUqjEtK1qm7i}Qztjp!ZT0+g~L0GJvX_{W1Gac zi2UYBFxTutS$MoiF&a)WI?GxXG=J_v*k6P5q%j|YOhT4r499hDo(<6>NdC`nuZ_L+ JZA;%1{{z9Gg3SN` literal 0 HcmV?d00001 diff --git a/static/img/icons/icon-32.png b/static/img/icons/icon-32.png new file mode 100644 index 0000000000000000000000000000000000000000..d445a9ac17838be570322fc272d16cccc73a071f GIT binary patch literal 2281 zcmai0YgiLk8Xhz#1cA1+axtsJ(7G;~OfDqAm=GaBK@D;(Sg8_{Niv#bLS~QvWoy}@ zwt&R4wxZNpKpuE3sE<^l1h6X7N)f15E%j2c##){#6jo5N?j%sus=GfX$vN-)z2A4< z@0>IFAU0;1JKc{C0DyaRlr*0D2JMf_4C<4}$r%9v+CeNag-nsHL=?D=C0F9mE)bX1M$MbMq5RtUtDA}E9l$RF^M3DE<*jbPs0%CppY9xP>L)Tl;B1b7H(9-oY2rvn9YT`Tqea}64`oEZer?*0K3G5h7=_fM$ABB zxE{1?%G2>oQUpO14o-@rChW1go|s%dWdv+TU=E87KS?Js)eGo$Mh;GTHy8>vT^ogCHX}QbtUg`czGSCLj{C4JaIs5_qOjfktjb z^<;p<3A-;yEM`KrDN;;_>IuqS5ya#E1zi0CP=af5V*<6QP!Ys&#MqrfqIGgLnv5w) z&6L*T`IV?%{a3(VnKskj+9W+jtz{y=BPQiBCW3;w@DpiPKNp(n1LCMohAXM!c#h&8 zL(vjRtPxjXS_&iLmqmclkrDwXR3Kn-SrZwkrXf@;rplJeNs7f~bAy;{K9eIzK*p)WkMVKr<#r6GJWL*xw-N z=rST#*i8~a1|zP_RG>;na!PIjC2$p)B{!nsYO28^C|sq&C_A&kSo_WeIV=vF74mdM zmIkHNUc5GVvNG6y;{Gg62tQN2&_Q_Oh*EJAbJWqN?httD5}^iD*AS|w?j9p`$pmX$ zrvrdfK1Q|WnRWocg6)~xJ61%5zq+NhVL^^Lu5dQ<^>249^)&a={vm(w{hi?limzJz z#w?fjzu(~AOLvajy|(ba+xj^T9{Ck66<-ci2wrO>c(G8I!S>GZ?$9k|ytKmV9YsAM zv@-45657MF1#NGriL&_&lCy1bwNI}ygi%r7eC=FX+nNJO`~NulZk>)VU(nqR2|w55 ztTnwA(y-^^qN^|8j*CB()W?&Tu)JSwIXq%2=$QTYh2z+vxy7{OwwE@}-w?9)kNd{O1wA&OMW?if_K+DeJ1fhX9>F4kmFsO9IY~ zBQqX&rKRqg`-)8e9~ z;fW~)%@GXfo{0)6vG=HmQt3}hJVV-TWxLqS`*3s{OV1x|k+D1iP<-bTYxLW+yL13PMy}hFZgsk&=rN!S=fS`uTN2O4c%5ggJCPw2 zoVK`vRYv!V)js0dA3u8guurhlO3vIhzVGguv!pXaylwq~qE80HKTA94y|SqB)_2W^ zdrZDFGoUJCuHB9|t{iyt&dng-O23zN1)5crq2t>U>TGp@+t|`kQlj9o&NEhBV9e7y zX>w-nwT%_s7MbcfKOd`)&f|M;ay{i|-5g-5;%L`J-Dtu}D|f|3-DowR!L(ngYux39 zd8NEhiy{JpBLWLev&EiY&)d29INjXgzr)#@FIKNsu+%5bXMC?5VYIi7GSa4H@Tz`i t9qDV&^*A`~=jBmo@ZCPo@_}=YJeM(QuUDwm$6g8jL6i@)M|pepVt6dZp`Uz{k*xq=dR!VBj)ZfUF@$g;Ng#sPKqOV79K`{E>8+9r zgz*qUSOdjMWh`)@stzPbMJ$l-&ZThW{*XkvBuxQ@q%98>ro{{CBGB6l$5b&;fkX%q z5LAf?G9^RB0*$&1^xd#c1_?$A63+s|xjceDtbhpaBzF=8^uiIC3Xzx*%wF`)7+tYI z34+KOWO7PM3Mpki30B0CsdPG>Oreo!G$P6%DpO^MKt+@(oeUDA8f-`@R7mBB6qXST znu0ZO62byO6eqkBhg8z{>N4fKj~(D6 z7h~`zhG_aeZ=w>&KS$u@GM> zLL_5a@AsEMve=-fM-w$5@~zjr@U|m7j&i>cB8Y$Av{`aPy6V z@1a0{f1UysOA}B`8NAq!5E$U^L8W_m5NV`Q4`|UCsI63-$`&9fi$5o|Hr%+sLt~OZ37%;rd~iikyU{)L>Z3D+JT^qo#n>2vWa#Ws zphJdJx4!`ZFd0&`ET5DE0GxA^a<6gxd?#$-nafqA$@E9{Ftn= zeLGqgnC2%$XPdscvE|aNSY`g~X$W=K!ZLfEXu&ki(VFhIm`f4I!j8PH+*Fb1E^uyX z0h!-R(xO$X7Mw2rk89VYKZ1f!g!Rl9WRs>$u08cswdI=K9GBP96OKDg>-#1q&yHUZ z{qxeL%@)_Lt%ZIuyZ_wl7Ds3E>j-`Oo8ArfY>VD2SI38#4pLn=3|$?hT_`En?(u%Q z$D6ZUVVm!s`LH~9W`JY1*6eU`jyAJ6C$~&8{1?0$pM)F?uDN5yZ7v&O0M~C1hS9EP zJGH%LjC*AhDLyh%>2JTzrY7`eq91AJg>UQ?+S=? z`#e@0imiK9#PmV@YadO0_N;;UU?IO2Q_?H}aJyeh(4UL1+NpG4wfK8 zDt41)Ybl(|Yih*p#{G79j&A^U=yD54CTLZK(T;r^JC-K*6(}nzyc0Tpcfag?rS93P z_+6WBxNn;SG*r!~2V3>Ob|6ca zTXe4xH6NJR{E|b*p6!`7_`P;Rlwa`Se9Nv1vyCO?FK*Y1OR7$*w1ZZr1I1WUQ1aaY ztX-Dwgvl;*-l6?`m&@mVRzsR+T=83{p!?R1l|3-#JB&@CvtvR3mW|``GIc|H^?5Fj z%}CpHwe7wI6XjE1__Wt@xRT0~QS3R%o+{7i_8VpQZq3z?Yq5H|eN`~orrNhp{o3y%eCmL39OEccA4g&ovn|%{rqwL>=N&!k{ijbe_JkY@6=8x#>Hbunkpf+5BfR zo7er?FrPu0{c-DXPQD8#ZL?oZo?>?E-s;FD!!_Ci96ZSmtyu0uEAhTy%xd7sk(p5U z#fGX$?8Rqs_QluQE^J&=xIr7Y=IEg!f9B&T`bgpnhwvG3tM6NfMn_w94P%Q>_QE#n zO8(g0I|JSn6Ma=pd~LCQUL4AMdF5EKh&FtJ^?WmtHIP3WGb`n3Z{LmC!*W43H59b{`?-RLd*`t4z zToxa7Czs1MEbZHpRc{|uwZ}Sgo#(2yrcS3g^AMBxZn5o|JsJ-ORpG-9MNV~>uEXnu z_6@tUDdL+g_^cl#NNGg7EK@hvNlKUcJ-G$FuvV=#w-( zl`G6+uXOL5cqT$~YjM%_=X?KTo&A=@?l0F4o3yD*t)|z0+xVoTd&Q(PtJ58OCp@s# fPtI{O2RhBAz+d;FQ+pp8{`>_7EN36}i^=#e`3V4- literal 0 HcmV?d00001 diff --git a/static/img/icons/icon-64.png b/static/img/icons/icon-64.png new file mode 100644 index 0000000000000000000000000000000000000000..2c75d3098027f9f4626d37da07a45d32cd0a66ac GIT binary patch literal 2928 zcmai0dmxj0AAj6(7a@yIcGgA2He;HxT(;3-a$6Qoj6J)=_RKc3lxz1?NO@CBwNBDe zQAgxNMx~_C<(xOd@ut!_y68rf&iiaST~77Be>~g1zt89U`QCoN-?Po3A%UhwwnhK| zn9>$g!r^aU^Y&i|+`l)Nt=ZUjb+U|i8y%%^lIpYsj68u@}Q;z3eK!h=K~3ivF< z2lxv|xP4!Dk+Vc!Bh%^sn=TN1R)$1MmBEd8-_*}?`a6Ima+L_ggo6?&Rh$S?WuQu;ol095KJv>}+=*bB1(1@@vpRlEN$;7U%AQ#k;tAMB=bS ztQ!%JUx39Cu~?0=h7F$uHcQI-e|+_hMtZ{@bUJY{Um}IXt29fK+dKkHnY1R&WWHv9 zBaxaZ6IqGsCXrAgF~m+y1lgM4u-qgnfjH7MmKgNo!UHCu{5Tvw+|E_VQ1#A5x}sgN zXu{_nX*>{C`*v-Z_nBeTC+_dmyfI%S@2w$xaztUj$u;=s!*>Yg!zBV6AFd%#2;V(o z_>w8kn5X~%tz14lmM_Ku0P_n|3)_PH{j4@NR?kl_2+N!9GUw{9fT;!Dx{j=zb-Vp4 zxAoQAzCP1av98**+ej~L?~1%}?`%hjp#QEfm!uda&ljUeApsZt;0# zyS82@=$0g}$k&}{Uw?5fS5h)>rqp%2R~e$4O_-@X(eV4t_=_=>jEZ-4S;qx<*8I*+ zl=nei`U-h8p}O?n&V3e7!op87{^Q2VN84DP`}w7OecN=01#kH$XKm9}JusKeOCqc| zzhp^=L0el2cth|0=%U|(x-GlLJU36=%|K8L?p|s&iO?N(b9&N1i$6svBEjjS^4F9M@tLJx0DtXmhoQw1;v@BN`DM*=$%UMC>tXJ*X|56aM$u@ z-+W7)^2RcjQ!!RYMy$4Mi2OBHzq8J8FpA-F&e$fV^G*51m$&oTHnm5c>J|Q%P}1Lh zhs1}ujc*j*zEbkJKW#@wnp_6GqRwd@=->fHJH~nN>%vg9c)0`sj4joV7O+QwfL|}S zX%xRmx#HKo(57WntCp;aM2lSs#a;WyqI2eLnZAcPJuG9(A7n)F0?x4?>x#iJTFf2+ zf6i%ijKM_CqIHzus`b=>$j~_mYM8lQtD||$`2Mo(N%rk;uGBOXx9_VP9bdC1?tv$_ z)N8c8WU%K>i{YmJ$9xsp*8yt~%T=tgIFEM%6F{VVwdF9r%9b#LF!hW}amSo13%qh` zi*l~1>ZfPr=iNWv05sh>sXDJR!rhBW(#ox^1?+NYbqTk^v-=-MO6xkVeOIweTNk>d zHIxmi9^w*y^Uv-V*i{+GwRbZ)kFMw$^o8iB=X5bHR0hKy@_16!PNSj18+ttF(Yd}0 zMVzi@fyzi&*X{cKOn$Pg1(nM}pn#+=Of!zs@NVM?~)6ev)q z_D~eK#;MN&0X%UJ8IQ1-XMvP^=^yVsa=1S!C*xsFT@#^e|Bf>SfGM}khRNJH7fyR@|RsopH0>|Uw2RfUc?_#GpD zR|;yznHc3J;K;l-e|o!hORJZmXTBlhY;zVcsvS|W+dFbdzh1j1QSsJ1$h>}^mWi#y z*#ys@%=?4-%?9o@FmwAKQ+=n3@K~$*h89BCtn-XApz+{{EI(yhf`M&npiR{@#Ld^M ztg!awrvZ#k#kQi}le$fJ^vbE3!o0>y)vq7#E{MtQxPJegpR?bv%qW@@SLj^9x;$4^ z$$N2X;YfLR)n$9F;-Y8%hvzLasn_k{DjseAo+sb%7*>!q_e8_F&vtn2Sk*%qn_rBT zdzq4Ae^`dB9Pqc$D%CmRUm3n|_*e?gihK*!p}IT|C;HPV#_YuMF;#Z($@L`aVzGO`17+L9-CI4TkMuo&-j>#LO17ij z>_K3uwsCk$jjvBPV#Z=BlbPLr+^=Ks2h|_z-BxbXsYQ_;=naZ zF_+uQI|-iVK|AOGA$+z}iEq9g%vzx@bPq9WF===5wQRaW#l_M z#&m~_ARKD7CE5EJ_rn?-k8ax;)LBW%M0;i4*9H&{9M-nb z^s&ab!vd~G8+NWsIi+KLP-nv3!)~P`Ftg63=D=C1eTguy+X%*<7p0ss$q3C<>}ed) zc4sLbQSLm*8%s-iH_Gg@3;=+EdsQjVQRy)+0j<{-@ + +> Foxar is a blazing fast, portable and modular toolkit for Core BC app development. + +**Spark:** Core testing framework (like Truffle, Hardhat and DappTools). + +**Probe:** Swiss army knife for interacting with CVM smart contracts, sending transactions and getting chain data. + +**Shuttle:** Local Core node, akin to Ganache, Hardhat Network. + +**Pilot:** Fast, utilitarian, and verbose solidity REPL. + +Foxar manages your dependencies, compiles your project, runs tests, deploys, and lets you interact with the chain from the command-line and via Ylem scripts. + +## Sections + +**[Getting Started](getting-started/installation)** + +To get started with Foxar, install Foxar and set up your first project. + +**[Projects](projects/creating-a-new-project.md)** + +This section will give you an overview of how to create and work with existing projects. + +**[Spark Overview](spark/overview-spark)** + +The overview will give you all you need to know about how to use `spark` to develop, test, and deploy smart contracts. + +**[Probe Overview](probe/probe-overview)** + +Learn how to use `probe` to interact with smart contracts, send transactions, and get chain data from the command-line. + +**[Shuttle Overview](shuttle/shuttle-overview)** + +Learn about `shuttle`, Foxar's local node. + +**[Pilot Overview](pilot/pilot-overview)** + +Learn how to use `pilot`, Foxar's integrated Solidity REPL. + +## Configuration + +Guides on configuring Foxar. + +- [Configuring with `foxar.toml`](./config/configuration/) +- [Continuous Integration](./config/continuous-integration.md) +- [Integrating with VSCode](./config/vscode.md) +- [Shell Autocompletion](./config/shell-autocompletion.md) +- [Static Analyzers](./config/static-analyzers.md) +- [Integrating with Hardhat](./config/hardhat.md) + +## Tutorials + +Tutorials on building smart contracts with Foxar. + +- [Creating an NFT with Solmate](./tutorials/solmate-nft.md) +- [Docker and Foxar](./tutorials/foxar-docker.md) +- [Testing EIP-712 Signatures](./tutorials/testing-eip712.md) +- [Solidity Scripting](./tutorials/ylem-scripting.md) +- [Forking Mainnet with Probe and Shuttle](./tutorials/forking-mainnet-with-probe-shuttle.md) +- [Learning Foxar Videos](./tutorials/learn-foxar.md) + +## Contributing + +Help us improve Foxar: [Contributing](./contributing.md) + +## Appendix + +References, troubleshooting, and more. + +- [FAQ](./faq.md) +- [CLI Reference](./reference/cli/cli-reference) +- [spark Commands](./reference/spark/) +- [probe Commands](./reference/probe/) +- [shuttle Commands](./reference/shuttle/shuttle-reference) +- [pilot Commands](./reference/pilot/pilot-reference) +- [Config Reference](./reference/config/config-reference) +- [Cheatcodes Reference](./reference/cheatcodes/cheatcodes-reference) +- [Spark Standard Library Reference](./reference/spark-std/spark-standart) +- [DSTest Reference](./reference/ds-test) +- [Miscellaneous](misc/miscellaneous) diff --git a/docs/misc/miscellaneous.md b/versioned_docs/version-1/misc/miscellaneous.md similarity index 100% rename from docs/misc/miscellaneous.md rename to versioned_docs/version-1/misc/miscellaneous.md diff --git a/docs/misc/precompile-registry.md b/versioned_docs/version-1/misc/precompile-registry.md similarity index 100% rename from docs/misc/precompile-registry.md rename to versioned_docs/version-1/misc/precompile-registry.md diff --git a/docs/misc/struct-encoding.md b/versioned_docs/version-1/misc/struct-encoding.md similarity index 100% rename from docs/misc/struct-encoding.md rename to versioned_docs/version-1/misc/struct-encoding.md diff --git a/docs/pilot/pilot-overview.md b/versioned_docs/version-1/pilot/pilot-overview.md similarity index 100% rename from docs/pilot/pilot-overview.md rename to versioned_docs/version-1/pilot/pilot-overview.md diff --git a/docs/probe/probe-overview.md b/versioned_docs/version-1/probe/probe-overview.md similarity index 100% rename from docs/probe/probe-overview.md rename to versioned_docs/version-1/probe/probe-overview.md diff --git a/docs/projects/creating-a-new-project.md b/versioned_docs/version-1/projects/creating-a-new-project.md similarity index 100% rename from docs/projects/creating-a-new-project.md rename to versioned_docs/version-1/projects/creating-a-new-project.md diff --git a/docs/projects/dependencies.md b/versioned_docs/version-1/projects/dependencies.md similarity index 100% rename from docs/projects/dependencies.md rename to versioned_docs/version-1/projects/dependencies.md diff --git a/docs/projects/project-layout.md b/versioned_docs/version-1/projects/project-layout.md similarity index 100% rename from docs/projects/project-layout.md rename to versioned_docs/version-1/projects/project-layout.md diff --git a/docs/projects/working-on-an-existing-project.md b/versioned_docs/version-1/projects/working-on-an-existing-project.md similarity index 100% rename from docs/projects/working-on-an-existing-project.md rename to versioned_docs/version-1/projects/working-on-an-existing-project.md diff --git a/docs/reference/cheatcodes/accesses.md b/versioned_docs/version-1/reference/cheatcodes/accesses.md similarity index 100% rename from docs/reference/cheatcodes/accesses.md rename to versioned_docs/version-1/reference/cheatcodes/accesses.md diff --git a/docs/reference/cheatcodes/active-fork.md b/versioned_docs/version-1/reference/cheatcodes/active-fork.md similarity index 100% rename from docs/reference/cheatcodes/active-fork.md rename to versioned_docs/version-1/reference/cheatcodes/active-fork.md diff --git a/docs/reference/cheatcodes/addr.md b/versioned_docs/version-1/reference/cheatcodes/addr.md similarity index 100% rename from docs/reference/cheatcodes/addr.md rename to versioned_docs/version-1/reference/cheatcodes/addr.md diff --git a/docs/reference/cheatcodes/allow-cheatcodes.md b/versioned_docs/version-1/reference/cheatcodes/allow-cheatcodes.md similarity index 100% rename from docs/reference/cheatcodes/allow-cheatcodes.md rename to versioned_docs/version-1/reference/cheatcodes/allow-cheatcodes.md diff --git a/docs/reference/cheatcodes/assertions.md b/versioned_docs/version-1/reference/cheatcodes/assertions.md similarity index 100% rename from docs/reference/cheatcodes/assertions.md rename to versioned_docs/version-1/reference/cheatcodes/assertions.md diff --git a/docs/reference/cheatcodes/assume.md b/versioned_docs/version-1/reference/cheatcodes/assume.md similarity index 100% rename from docs/reference/cheatcodes/assume.md rename to versioned_docs/version-1/reference/cheatcodes/assume.md diff --git a/docs/reference/cheatcodes/breakpoint.md b/versioned_docs/version-1/reference/cheatcodes/breakpoint.md similarity index 100% rename from docs/reference/cheatcodes/breakpoint.md rename to versioned_docs/version-1/reference/cheatcodes/breakpoint.md diff --git a/docs/reference/cheatcodes/broadcast.md b/versioned_docs/version-1/reference/cheatcodes/broadcast.md similarity index 100% rename from docs/reference/cheatcodes/broadcast.md rename to versioned_docs/version-1/reference/cheatcodes/broadcast.md diff --git a/docs/reference/cheatcodes/chain-id.md b/versioned_docs/version-1/reference/cheatcodes/chain-id.md similarity index 100% rename from docs/reference/cheatcodes/chain-id.md rename to versioned_docs/version-1/reference/cheatcodes/chain-id.md diff --git a/docs/reference/cheatcodes/cheatcodes-reference.md b/versioned_docs/version-1/reference/cheatcodes/cheatcodes-reference.md similarity index 100% rename from docs/reference/cheatcodes/cheatcodes-reference.md rename to versioned_docs/version-1/reference/cheatcodes/cheatcodes-reference.md diff --git a/docs/reference/cheatcodes/clear-mocked-calls.md b/versioned_docs/version-1/reference/cheatcodes/clear-mocked-calls.md similarity index 100% rename from docs/reference/cheatcodes/clear-mocked-calls.md rename to versioned_docs/version-1/reference/cheatcodes/clear-mocked-calls.md diff --git a/docs/reference/cheatcodes/coinbase.md b/versioned_docs/version-1/reference/cheatcodes/coinbase.md similarity index 100% rename from docs/reference/cheatcodes/coinbase.md rename to versioned_docs/version-1/reference/cheatcodes/coinbase.md diff --git a/docs/reference/cheatcodes/create-fork.md b/versioned_docs/version-1/reference/cheatcodes/create-fork.md similarity index 100% rename from docs/reference/cheatcodes/create-fork.md rename to versioned_docs/version-1/reference/cheatcodes/create-fork.md diff --git a/docs/reference/cheatcodes/create-select-fork.md b/versioned_docs/version-1/reference/cheatcodes/create-select-fork.md similarity index 100% rename from docs/reference/cheatcodes/create-select-fork.md rename to versioned_docs/version-1/reference/cheatcodes/create-select-fork.md diff --git a/docs/reference/cheatcodes/create-wallet.md b/versioned_docs/version-1/reference/cheatcodes/create-wallet.md similarity index 100% rename from docs/reference/cheatcodes/create-wallet.md rename to versioned_docs/version-1/reference/cheatcodes/create-wallet.md diff --git a/docs/reference/cheatcodes/deal.md b/versioned_docs/version-1/reference/cheatcodes/deal.md similarity index 100% rename from docs/reference/cheatcodes/deal.md rename to versioned_docs/version-1/reference/cheatcodes/deal.md diff --git a/docs/reference/cheatcodes/derive-key.md b/versioned_docs/version-1/reference/cheatcodes/derive-key.md similarity index 100% rename from docs/reference/cheatcodes/derive-key.md rename to versioned_docs/version-1/reference/cheatcodes/derive-key.md diff --git a/docs/reference/cheatcodes/difficulty.md b/versioned_docs/version-1/reference/cheatcodes/difficulty.md similarity index 100% rename from docs/reference/cheatcodes/difficulty.md rename to versioned_docs/version-1/reference/cheatcodes/difficulty.md diff --git a/docs/reference/cheatcodes/env-address.md b/versioned_docs/version-1/reference/cheatcodes/env-address.md similarity index 100% rename from docs/reference/cheatcodes/env-address.md rename to versioned_docs/version-1/reference/cheatcodes/env-address.md diff --git a/docs/reference/cheatcodes/env-bool.md b/versioned_docs/version-1/reference/cheatcodes/env-bool.md similarity index 100% rename from docs/reference/cheatcodes/env-bool.md rename to versioned_docs/version-1/reference/cheatcodes/env-bool.md diff --git a/docs/reference/cheatcodes/env-bytes.md b/versioned_docs/version-1/reference/cheatcodes/env-bytes.md similarity index 100% rename from docs/reference/cheatcodes/env-bytes.md rename to versioned_docs/version-1/reference/cheatcodes/env-bytes.md diff --git a/docs/reference/cheatcodes/env-bytes32.md b/versioned_docs/version-1/reference/cheatcodes/env-bytes32.md similarity index 100% rename from docs/reference/cheatcodes/env-bytes32.md rename to versioned_docs/version-1/reference/cheatcodes/env-bytes32.md diff --git a/docs/reference/cheatcodes/env-int.md b/versioned_docs/version-1/reference/cheatcodes/env-int.md similarity index 100% rename from docs/reference/cheatcodes/env-int.md rename to versioned_docs/version-1/reference/cheatcodes/env-int.md diff --git a/docs/reference/cheatcodes/env-or.md b/versioned_docs/version-1/reference/cheatcodes/env-or.md similarity index 100% rename from docs/reference/cheatcodes/env-or.md rename to versioned_docs/version-1/reference/cheatcodes/env-or.md diff --git a/docs/reference/cheatcodes/env-string.md b/versioned_docs/version-1/reference/cheatcodes/env-string.md similarity index 100% rename from docs/reference/cheatcodes/env-string.md rename to versioned_docs/version-1/reference/cheatcodes/env-string.md diff --git a/docs/reference/cheatcodes/env-uint.md b/versioned_docs/version-1/reference/cheatcodes/env-uint.md similarity index 100% rename from docs/reference/cheatcodes/env-uint.md rename to versioned_docs/version-1/reference/cheatcodes/env-uint.md diff --git a/docs/reference/cheatcodes/environment.md b/versioned_docs/version-1/reference/cheatcodes/environment.md similarity index 100% rename from docs/reference/cheatcodes/environment.md rename to versioned_docs/version-1/reference/cheatcodes/environment.md diff --git a/docs/reference/cheatcodes/etch.md b/versioned_docs/version-1/reference/cheatcodes/etch.md similarity index 100% rename from docs/reference/cheatcodes/etch.md rename to versioned_docs/version-1/reference/cheatcodes/etch.md diff --git a/docs/reference/cheatcodes/expect-call.md b/versioned_docs/version-1/reference/cheatcodes/expect-call.md similarity index 100% rename from docs/reference/cheatcodes/expect-call.md rename to versioned_docs/version-1/reference/cheatcodes/expect-call.md diff --git a/docs/reference/cheatcodes/expect-emit.md b/versioned_docs/version-1/reference/cheatcodes/expect-emit.md similarity index 100% rename from docs/reference/cheatcodes/expect-emit.md rename to versioned_docs/version-1/reference/cheatcodes/expect-emit.md diff --git a/docs/reference/cheatcodes/expect-revert.md b/versioned_docs/version-1/reference/cheatcodes/expect-revert.md similarity index 100% rename from docs/reference/cheatcodes/expect-revert.md rename to versioned_docs/version-1/reference/cheatcodes/expect-revert.md diff --git a/docs/reference/cheatcodes/external.md b/versioned_docs/version-1/reference/cheatcodes/external.md similarity index 100% rename from docs/reference/cheatcodes/external.md rename to versioned_docs/version-1/reference/cheatcodes/external.md diff --git a/docs/reference/cheatcodes/fee.md b/versioned_docs/version-1/reference/cheatcodes/fee.md similarity index 100% rename from docs/reference/cheatcodes/fee.md rename to versioned_docs/version-1/reference/cheatcodes/fee.md diff --git a/docs/reference/cheatcodes/ffi.md b/versioned_docs/version-1/reference/cheatcodes/ffi.md similarity index 100% rename from docs/reference/cheatcodes/ffi.md rename to versioned_docs/version-1/reference/cheatcodes/ffi.md diff --git a/docs/reference/cheatcodes/forking.md b/versioned_docs/version-1/reference/cheatcodes/forking.md similarity index 100% rename from docs/reference/cheatcodes/forking.md rename to versioned_docs/version-1/reference/cheatcodes/forking.md diff --git a/docs/reference/cheatcodes/fs.md b/versioned_docs/version-1/reference/cheatcodes/fs.md similarity index 100% rename from docs/reference/cheatcodes/fs.md rename to versioned_docs/version-1/reference/cheatcodes/fs.md diff --git a/docs/reference/cheatcodes/fuzzer.md b/versioned_docs/version-1/reference/cheatcodes/fuzzer.md similarity index 100% rename from docs/reference/cheatcodes/fuzzer.md rename to versioned_docs/version-1/reference/cheatcodes/fuzzer.md diff --git a/docs/reference/cheatcodes/get-block-number.md b/versioned_docs/version-1/reference/cheatcodes/get-block-number.md similarity index 100% rename from docs/reference/cheatcodes/get-block-number.md rename to versioned_docs/version-1/reference/cheatcodes/get-block-number.md diff --git a/docs/reference/cheatcodes/get-block-timestamp.md b/versioned_docs/version-1/reference/cheatcodes/get-block-timestamp.md similarity index 100% rename from docs/reference/cheatcodes/get-block-timestamp.md rename to versioned_docs/version-1/reference/cheatcodes/get-block-timestamp.md diff --git a/docs/reference/cheatcodes/get-code.md b/versioned_docs/version-1/reference/cheatcodes/get-code.md similarity index 100% rename from docs/reference/cheatcodes/get-code.md rename to versioned_docs/version-1/reference/cheatcodes/get-code.md diff --git a/docs/reference/cheatcodes/get-deployed-code.md b/versioned_docs/version-1/reference/cheatcodes/get-deployed-code.md similarity index 100% rename from docs/reference/cheatcodes/get-deployed-code.md rename to versioned_docs/version-1/reference/cheatcodes/get-deployed-code.md diff --git a/docs/reference/cheatcodes/get-label.md b/versioned_docs/version-1/reference/cheatcodes/get-label.md similarity index 100% rename from docs/reference/cheatcodes/get-label.md rename to versioned_docs/version-1/reference/cheatcodes/get-label.md diff --git a/docs/reference/cheatcodes/get-nonce.md b/versioned_docs/version-1/reference/cheatcodes/get-nonce.md similarity index 100% rename from docs/reference/cheatcodes/get-nonce.md rename to versioned_docs/version-1/reference/cheatcodes/get-nonce.md diff --git a/docs/reference/cheatcodes/get-recorded-logs.md b/versioned_docs/version-1/reference/cheatcodes/get-recorded-logs.md similarity index 100% rename from docs/reference/cheatcodes/get-recorded-logs.md rename to versioned_docs/version-1/reference/cheatcodes/get-recorded-logs.md diff --git a/docs/reference/cheatcodes/is-persistent.md b/versioned_docs/version-1/reference/cheatcodes/is-persistent.md similarity index 100% rename from docs/reference/cheatcodes/is-persistent.md rename to versioned_docs/version-1/reference/cheatcodes/is-persistent.md diff --git a/docs/reference/cheatcodes/key-exists.md b/versioned_docs/version-1/reference/cheatcodes/key-exists.md similarity index 100% rename from docs/reference/cheatcodes/key-exists.md rename to versioned_docs/version-1/reference/cheatcodes/key-exists.md diff --git a/docs/reference/cheatcodes/label.md b/versioned_docs/version-1/reference/cheatcodes/label.md similarity index 100% rename from docs/reference/cheatcodes/label.md rename to versioned_docs/version-1/reference/cheatcodes/label.md diff --git a/docs/reference/cheatcodes/load.md b/versioned_docs/version-1/reference/cheatcodes/load.md similarity index 100% rename from docs/reference/cheatcodes/load.md rename to versioned_docs/version-1/reference/cheatcodes/load.md diff --git a/docs/reference/cheatcodes/make-persistent.md b/versioned_docs/version-1/reference/cheatcodes/make-persistent.md similarity index 100% rename from docs/reference/cheatcodes/make-persistent.md rename to versioned_docs/version-1/reference/cheatcodes/make-persistent.md diff --git a/docs/reference/cheatcodes/mock-call-revert.md b/versioned_docs/version-1/reference/cheatcodes/mock-call-revert.md similarity index 100% rename from docs/reference/cheatcodes/mock-call-revert.md rename to versioned_docs/version-1/reference/cheatcodes/mock-call-revert.md diff --git a/docs/reference/cheatcodes/mock-call.md b/versioned_docs/version-1/reference/cheatcodes/mock-call.md similarity index 100% rename from docs/reference/cheatcodes/mock-call.md rename to versioned_docs/version-1/reference/cheatcodes/mock-call.md diff --git a/docs/reference/cheatcodes/parse-address.md b/versioned_docs/version-1/reference/cheatcodes/parse-address.md similarity index 100% rename from docs/reference/cheatcodes/parse-address.md rename to versioned_docs/version-1/reference/cheatcodes/parse-address.md diff --git a/docs/reference/cheatcodes/parse-bool.md b/versioned_docs/version-1/reference/cheatcodes/parse-bool.md similarity index 100% rename from docs/reference/cheatcodes/parse-bool.md rename to versioned_docs/version-1/reference/cheatcodes/parse-bool.md diff --git a/docs/reference/cheatcodes/parse-bytes.md b/versioned_docs/version-1/reference/cheatcodes/parse-bytes.md similarity index 100% rename from docs/reference/cheatcodes/parse-bytes.md rename to versioned_docs/version-1/reference/cheatcodes/parse-bytes.md diff --git a/docs/reference/cheatcodes/parse-bytes32.md b/versioned_docs/version-1/reference/cheatcodes/parse-bytes32.md similarity index 100% rename from docs/reference/cheatcodes/parse-bytes32.md rename to versioned_docs/version-1/reference/cheatcodes/parse-bytes32.md diff --git a/docs/reference/cheatcodes/parse-int.md b/versioned_docs/version-1/reference/cheatcodes/parse-int.md similarity index 100% rename from docs/reference/cheatcodes/parse-int.md rename to versioned_docs/version-1/reference/cheatcodes/parse-int.md diff --git a/docs/reference/cheatcodes/parse-json-keys.md b/versioned_docs/version-1/reference/cheatcodes/parse-json-keys.md similarity index 100% rename from docs/reference/cheatcodes/parse-json-keys.md rename to versioned_docs/version-1/reference/cheatcodes/parse-json-keys.md diff --git a/docs/reference/cheatcodes/parse-json.md b/versioned_docs/version-1/reference/cheatcodes/parse-json.md similarity index 100% rename from docs/reference/cheatcodes/parse-json.md rename to versioned_docs/version-1/reference/cheatcodes/parse-json.md diff --git a/docs/reference/cheatcodes/parse-uint.md b/versioned_docs/version-1/reference/cheatcodes/parse-uint.md similarity index 100% rename from docs/reference/cheatcodes/parse-uint.md rename to versioned_docs/version-1/reference/cheatcodes/parse-uint.md diff --git a/docs/reference/cheatcodes/pause-gas-metering.md b/versioned_docs/version-1/reference/cheatcodes/pause-gas-metering.md similarity index 100% rename from docs/reference/cheatcodes/pause-gas-metering.md rename to versioned_docs/version-1/reference/cheatcodes/pause-gas-metering.md diff --git a/docs/reference/cheatcodes/prank.md b/versioned_docs/version-1/reference/cheatcodes/prank.md similarity index 100% rename from docs/reference/cheatcodes/prank.md rename to versioned_docs/version-1/reference/cheatcodes/prank.md diff --git a/docs/reference/cheatcodes/prevrandao.md b/versioned_docs/version-1/reference/cheatcodes/prevrandao.md similarity index 100% rename from docs/reference/cheatcodes/prevrandao.md rename to versioned_docs/version-1/reference/cheatcodes/prevrandao.md diff --git a/docs/reference/cheatcodes/project-root.md b/versioned_docs/version-1/reference/cheatcodes/project-root.md similarity index 100% rename from docs/reference/cheatcodes/project-root.md rename to versioned_docs/version-1/reference/cheatcodes/project-root.md diff --git a/docs/reference/cheatcodes/read-callers.md b/versioned_docs/version-1/reference/cheatcodes/read-callers.md similarity index 100% rename from docs/reference/cheatcodes/read-callers.md rename to versioned_docs/version-1/reference/cheatcodes/read-callers.md diff --git a/docs/reference/cheatcodes/record-logs.md b/versioned_docs/version-1/reference/cheatcodes/record-logs.md similarity index 100% rename from docs/reference/cheatcodes/record-logs.md rename to versioned_docs/version-1/reference/cheatcodes/record-logs.md diff --git a/docs/reference/cheatcodes/record.md b/versioned_docs/version-1/reference/cheatcodes/record.md similarity index 100% rename from docs/reference/cheatcodes/record.md rename to versioned_docs/version-1/reference/cheatcodes/record.md diff --git a/docs/reference/cheatcodes/remember-key.md b/versioned_docs/version-1/reference/cheatcodes/remember-key.md similarity index 100% rename from docs/reference/cheatcodes/remember-key.md rename to versioned_docs/version-1/reference/cheatcodes/remember-key.md diff --git a/docs/reference/cheatcodes/resume-gas-metering.md b/versioned_docs/version-1/reference/cheatcodes/resume-gas-metering.md similarity index 100% rename from docs/reference/cheatcodes/resume-gas-metering.md rename to versioned_docs/version-1/reference/cheatcodes/resume-gas-metering.md diff --git a/docs/reference/cheatcodes/revoke-persistent.md b/versioned_docs/version-1/reference/cheatcodes/revoke-persistent.md similarity index 100% rename from docs/reference/cheatcodes/revoke-persistent.md rename to versioned_docs/version-1/reference/cheatcodes/revoke-persistent.md diff --git a/docs/reference/cheatcodes/roll-fork.md b/versioned_docs/version-1/reference/cheatcodes/roll-fork.md similarity index 100% rename from docs/reference/cheatcodes/roll-fork.md rename to versioned_docs/version-1/reference/cheatcodes/roll-fork.md diff --git a/docs/reference/cheatcodes/roll.md b/versioned_docs/version-1/reference/cheatcodes/roll.md similarity index 100% rename from docs/reference/cheatcodes/roll.md rename to versioned_docs/version-1/reference/cheatcodes/roll.md diff --git a/docs/reference/cheatcodes/rpc.md b/versioned_docs/version-1/reference/cheatcodes/rpc.md similarity index 100% rename from docs/reference/cheatcodes/rpc.md rename to versioned_docs/version-1/reference/cheatcodes/rpc.md diff --git a/docs/reference/cheatcodes/select-fork.md b/versioned_docs/version-1/reference/cheatcodes/select-fork.md similarity index 100% rename from docs/reference/cheatcodes/select-fork.md rename to versioned_docs/version-1/reference/cheatcodes/select-fork.md diff --git a/docs/reference/cheatcodes/serialize-json.md b/versioned_docs/version-1/reference/cheatcodes/serialize-json.md similarity index 100% rename from docs/reference/cheatcodes/serialize-json.md rename to versioned_docs/version-1/reference/cheatcodes/serialize-json.md diff --git a/docs/reference/cheatcodes/set-env.md b/versioned_docs/version-1/reference/cheatcodes/set-env.md similarity index 100% rename from docs/reference/cheatcodes/set-env.md rename to versioned_docs/version-1/reference/cheatcodes/set-env.md diff --git a/docs/reference/cheatcodes/set-nonce.md b/versioned_docs/version-1/reference/cheatcodes/set-nonce.md similarity index 100% rename from docs/reference/cheatcodes/set-nonce.md rename to versioned_docs/version-1/reference/cheatcodes/set-nonce.md diff --git a/docs/reference/cheatcodes/sign.md b/versioned_docs/version-1/reference/cheatcodes/sign.md similarity index 100% rename from docs/reference/cheatcodes/sign.md rename to versioned_docs/version-1/reference/cheatcodes/sign.md diff --git a/docs/reference/cheatcodes/skip.md b/versioned_docs/version-1/reference/cheatcodes/skip.md similarity index 100% rename from docs/reference/cheatcodes/skip.md rename to versioned_docs/version-1/reference/cheatcodes/skip.md diff --git a/docs/reference/cheatcodes/sleep.md b/versioned_docs/version-1/reference/cheatcodes/sleep.md similarity index 100% rename from docs/reference/cheatcodes/sleep.md rename to versioned_docs/version-1/reference/cheatcodes/sleep.md diff --git a/docs/reference/cheatcodes/snapshots.md b/versioned_docs/version-1/reference/cheatcodes/snapshots.md similarity index 100% rename from docs/reference/cheatcodes/snapshots.md rename to versioned_docs/version-1/reference/cheatcodes/snapshots.md diff --git a/docs/reference/cheatcodes/start-broadcast.md b/versioned_docs/version-1/reference/cheatcodes/start-broadcast.md similarity index 100% rename from docs/reference/cheatcodes/start-broadcast.md rename to versioned_docs/version-1/reference/cheatcodes/start-broadcast.md diff --git a/docs/reference/cheatcodes/start-prank.md b/versioned_docs/version-1/reference/cheatcodes/start-prank.md similarity index 100% rename from docs/reference/cheatcodes/start-prank.md rename to versioned_docs/version-1/reference/cheatcodes/start-prank.md diff --git a/docs/reference/cheatcodes/start-state-diff-recording.md b/versioned_docs/version-1/reference/cheatcodes/start-state-diff-recording.md similarity index 100% rename from docs/reference/cheatcodes/start-state-diff-recording.md rename to versioned_docs/version-1/reference/cheatcodes/start-state-diff-recording.md diff --git a/docs/reference/cheatcodes/stop-and-return-state-diff.md b/versioned_docs/version-1/reference/cheatcodes/stop-and-return-state-diff.md similarity index 100% rename from docs/reference/cheatcodes/stop-and-return-state-diff.md rename to versioned_docs/version-1/reference/cheatcodes/stop-and-return-state-diff.md diff --git a/docs/reference/cheatcodes/stop-broadcast.md b/versioned_docs/version-1/reference/cheatcodes/stop-broadcast.md similarity index 100% rename from docs/reference/cheatcodes/stop-broadcast.md rename to versioned_docs/version-1/reference/cheatcodes/stop-broadcast.md diff --git a/docs/reference/cheatcodes/stop-prank.md b/versioned_docs/version-1/reference/cheatcodes/stop-prank.md similarity index 100% rename from docs/reference/cheatcodes/stop-prank.md rename to versioned_docs/version-1/reference/cheatcodes/stop-prank.md diff --git a/docs/reference/cheatcodes/store.md b/versioned_docs/version-1/reference/cheatcodes/store.md similarity index 100% rename from docs/reference/cheatcodes/store.md rename to versioned_docs/version-1/reference/cheatcodes/store.md diff --git a/docs/reference/cheatcodes/to-string.md b/versioned_docs/version-1/reference/cheatcodes/to-string.md similarity index 100% rename from docs/reference/cheatcodes/to-string.md rename to versioned_docs/version-1/reference/cheatcodes/to-string.md diff --git a/docs/reference/cheatcodes/transact.md b/versioned_docs/version-1/reference/cheatcodes/transact.md similarity index 100% rename from docs/reference/cheatcodes/transact.md rename to versioned_docs/version-1/reference/cheatcodes/transact.md diff --git a/docs/reference/cheatcodes/tx-gas-price.md b/versioned_docs/version-1/reference/cheatcodes/tx-gas-price.md similarity index 100% rename from docs/reference/cheatcodes/tx-gas-price.md rename to versioned_docs/version-1/reference/cheatcodes/tx-gas-price.md diff --git a/docs/reference/cheatcodes/unix-time.md b/versioned_docs/version-1/reference/cheatcodes/unix-time.md similarity index 100% rename from docs/reference/cheatcodes/unix-time.md rename to versioned_docs/version-1/reference/cheatcodes/unix-time.md diff --git a/docs/reference/cheatcodes/utilities.md b/versioned_docs/version-1/reference/cheatcodes/utilities.md similarity index 100% rename from docs/reference/cheatcodes/utilities.md rename to versioned_docs/version-1/reference/cheatcodes/utilities.md diff --git a/docs/reference/cheatcodes/warp.md b/versioned_docs/version-1/reference/cheatcodes/warp.md similarity index 100% rename from docs/reference/cheatcodes/warp.md rename to versioned_docs/version-1/reference/cheatcodes/warp.md diff --git a/docs/reference/cheatcodes/write-json.md b/versioned_docs/version-1/reference/cheatcodes/write-json.md similarity index 100% rename from docs/reference/cheatcodes/write-json.md rename to versioned_docs/version-1/reference/cheatcodes/write-json.md diff --git a/docs/reference/cli/SUMMARY.md b/versioned_docs/version-1/reference/cli/SUMMARY.md similarity index 100% rename from docs/reference/cli/SUMMARY.md rename to versioned_docs/version-1/reference/cli/SUMMARY.md diff --git a/docs/reference/cli/cli-reference.md b/versioned_docs/version-1/reference/cli/cli-reference.md similarity index 100% rename from docs/reference/cli/cli-reference.md rename to versioned_docs/version-1/reference/cli/cli-reference.md diff --git a/docs/reference/cli/pilot.md b/versioned_docs/version-1/reference/cli/pilot.md similarity index 100% rename from docs/reference/cli/pilot.md rename to versioned_docs/version-1/reference/cli/pilot.md diff --git a/docs/reference/cli/pilot/clear-cache.md b/versioned_docs/version-1/reference/cli/pilot/clear-cache.md similarity index 100% rename from docs/reference/cli/pilot/clear-cache.md rename to versioned_docs/version-1/reference/cli/pilot/clear-cache.md diff --git a/docs/reference/cli/pilot/list.md b/versioned_docs/version-1/reference/cli/pilot/list.md similarity index 100% rename from docs/reference/cli/pilot/list.md rename to versioned_docs/version-1/reference/cli/pilot/list.md diff --git a/docs/reference/cli/pilot/load.md b/versioned_docs/version-1/reference/cli/pilot/load.md similarity index 100% rename from docs/reference/cli/pilot/load.md rename to versioned_docs/version-1/reference/cli/pilot/load.md diff --git a/docs/reference/cli/pilot/view.md b/versioned_docs/version-1/reference/cli/pilot/view.md similarity index 100% rename from docs/reference/cli/pilot/view.md rename to versioned_docs/version-1/reference/cli/pilot/view.md diff --git a/docs/reference/cli/probe.md b/versioned_docs/version-1/reference/cli/probe.md similarity index 100% rename from docs/reference/cli/probe.md rename to versioned_docs/version-1/reference/cli/probe.md diff --git a/docs/reference/cli/probe/4byte-decode.md b/versioned_docs/version-1/reference/cli/probe/4byte-decode.md similarity index 100% rename from docs/reference/cli/probe/4byte-decode.md rename to versioned_docs/version-1/reference/cli/probe/4byte-decode.md diff --git a/docs/reference/cli/probe/4byte-event.md b/versioned_docs/version-1/reference/cli/probe/4byte-event.md similarity index 100% rename from docs/reference/cli/probe/4byte-event.md rename to versioned_docs/version-1/reference/cli/probe/4byte-event.md diff --git a/docs/reference/cli/probe/4byte.md b/versioned_docs/version-1/reference/cli/probe/4byte.md similarity index 100% rename from docs/reference/cli/probe/4byte.md rename to versioned_docs/version-1/reference/cli/probe/4byte.md diff --git a/docs/reference/cli/probe/abi-decode.md b/versioned_docs/version-1/reference/cli/probe/abi-decode.md similarity index 100% rename from docs/reference/cli/probe/abi-decode.md rename to versioned_docs/version-1/reference/cli/probe/abi-decode.md diff --git a/docs/reference/cli/probe/abi-encode.md b/versioned_docs/version-1/reference/cli/probe/abi-encode.md similarity index 100% rename from docs/reference/cli/probe/abi-encode.md rename to versioned_docs/version-1/reference/cli/probe/abi-encode.md diff --git a/docs/reference/cli/probe/access-list.md b/versioned_docs/version-1/reference/cli/probe/access-list.md similarity index 100% rename from docs/reference/cli/probe/access-list.md rename to versioned_docs/version-1/reference/cli/probe/access-list.md diff --git a/docs/reference/cli/probe/address-zero.md b/versioned_docs/version-1/reference/cli/probe/address-zero.md similarity index 100% rename from docs/reference/cli/probe/address-zero.md rename to versioned_docs/version-1/reference/cli/probe/address-zero.md diff --git a/docs/reference/cli/probe/admin.md b/versioned_docs/version-1/reference/cli/probe/admin.md similarity index 100% rename from docs/reference/cli/probe/admin.md rename to versioned_docs/version-1/reference/cli/probe/admin.md diff --git a/docs/reference/cli/probe/age.md b/versioned_docs/version-1/reference/cli/probe/age.md similarity index 100% rename from docs/reference/cli/probe/age.md rename to versioned_docs/version-1/reference/cli/probe/age.md diff --git a/docs/reference/cli/probe/balance.md b/versioned_docs/version-1/reference/cli/probe/balance.md similarity index 100% rename from docs/reference/cli/probe/balance.md rename to versioned_docs/version-1/reference/cli/probe/balance.md diff --git a/docs/reference/cli/probe/base-fee.md b/versioned_docs/version-1/reference/cli/probe/base-fee.md similarity index 100% rename from docs/reference/cli/probe/base-fee.md rename to versioned_docs/version-1/reference/cli/probe/base-fee.md diff --git a/docs/reference/cli/probe/bind.md b/versioned_docs/version-1/reference/cli/probe/bind.md similarity index 100% rename from docs/reference/cli/probe/bind.md rename to versioned_docs/version-1/reference/cli/probe/bind.md diff --git a/docs/reference/cli/probe/block-number.md b/versioned_docs/version-1/reference/cli/probe/block-number.md similarity index 100% rename from docs/reference/cli/probe/block-number.md rename to versioned_docs/version-1/reference/cli/probe/block-number.md diff --git a/docs/reference/cli/probe/block.md b/versioned_docs/version-1/reference/cli/probe/block.md similarity index 100% rename from docs/reference/cli/probe/block.md rename to versioned_docs/version-1/reference/cli/probe/block.md diff --git a/docs/reference/cli/probe/call.md b/versioned_docs/version-1/reference/cli/probe/call.md similarity index 100% rename from docs/reference/cli/probe/call.md rename to versioned_docs/version-1/reference/cli/probe/call.md diff --git a/docs/reference/cli/probe/call/--create.md b/versioned_docs/version-1/reference/cli/probe/call/--create.md similarity index 100% rename from docs/reference/cli/probe/call/--create.md rename to versioned_docs/version-1/reference/cli/probe/call/--create.md diff --git a/docs/reference/cli/probe/calldata-decode.md b/versioned_docs/version-1/reference/cli/probe/calldata-decode.md similarity index 100% rename from docs/reference/cli/probe/calldata-decode.md rename to versioned_docs/version-1/reference/cli/probe/calldata-decode.md diff --git a/docs/reference/cli/probe/calldata.md b/versioned_docs/version-1/reference/cli/probe/calldata.md similarity index 100% rename from docs/reference/cli/probe/calldata.md rename to versioned_docs/version-1/reference/cli/probe/calldata.md diff --git a/docs/reference/cli/probe/chain-id.md b/versioned_docs/version-1/reference/cli/probe/chain-id.md similarity index 100% rename from docs/reference/cli/probe/chain-id.md rename to versioned_docs/version-1/reference/cli/probe/chain-id.md diff --git a/docs/reference/cli/probe/chain.md b/versioned_docs/version-1/reference/cli/probe/chain.md similarity index 100% rename from docs/reference/cli/probe/chain.md rename to versioned_docs/version-1/reference/cli/probe/chain.md diff --git a/docs/reference/cli/probe/client.md b/versioned_docs/version-1/reference/cli/probe/client.md similarity index 100% rename from docs/reference/cli/probe/client.md rename to versioned_docs/version-1/reference/cli/probe/client.md diff --git a/docs/reference/cli/probe/code.md b/versioned_docs/version-1/reference/cli/probe/code.md similarity index 100% rename from docs/reference/cli/probe/code.md rename to versioned_docs/version-1/reference/cli/probe/code.md diff --git a/docs/reference/cli/probe/codesize.md b/versioned_docs/version-1/reference/cli/probe/codesize.md similarity index 100% rename from docs/reference/cli/probe/codesize.md rename to versioned_docs/version-1/reference/cli/probe/codesize.md diff --git a/docs/reference/cli/probe/completions.md b/versioned_docs/version-1/reference/cli/probe/completions.md similarity index 100% rename from docs/reference/cli/probe/completions.md rename to versioned_docs/version-1/reference/cli/probe/completions.md diff --git a/docs/reference/cli/probe/compute-address.md b/versioned_docs/version-1/reference/cli/probe/compute-address.md similarity index 100% rename from docs/reference/cli/probe/compute-address.md rename to versioned_docs/version-1/reference/cli/probe/compute-address.md diff --git a/docs/reference/cli/probe/concat-hex.md b/versioned_docs/version-1/reference/cli/probe/concat-hex.md similarity index 100% rename from docs/reference/cli/probe/concat-hex.md rename to versioned_docs/version-1/reference/cli/probe/concat-hex.md diff --git a/docs/reference/cli/probe/create2.md b/versioned_docs/version-1/reference/cli/probe/create2.md similarity index 100% rename from docs/reference/cli/probe/create2.md rename to versioned_docs/version-1/reference/cli/probe/create2.md diff --git a/docs/reference/cli/probe/decode-transaction.md b/versioned_docs/version-1/reference/cli/probe/decode-transaction.md similarity index 100% rename from docs/reference/cli/probe/decode-transaction.md rename to versioned_docs/version-1/reference/cli/probe/decode-transaction.md diff --git a/docs/reference/cli/probe/disassemble.md b/versioned_docs/version-1/reference/cli/probe/disassemble.md similarity index 100% rename from docs/reference/cli/probe/disassemble.md rename to versioned_docs/version-1/reference/cli/probe/disassemble.md diff --git a/docs/reference/cli/probe/estimate.md b/versioned_docs/version-1/reference/cli/probe/estimate.md similarity index 100% rename from docs/reference/cli/probe/estimate.md rename to versioned_docs/version-1/reference/cli/probe/estimate.md diff --git a/docs/reference/cli/probe/estimate/--create.md b/versioned_docs/version-1/reference/cli/probe/estimate/--create.md similarity index 100% rename from docs/reference/cli/probe/estimate/--create.md rename to versioned_docs/version-1/reference/cli/probe/estimate/--create.md diff --git a/docs/reference/cli/probe/etherscan-source.md b/versioned_docs/version-1/reference/cli/probe/etherscan-source.md similarity index 100% rename from docs/reference/cli/probe/etherscan-source.md rename to versioned_docs/version-1/reference/cli/probe/etherscan-source.md diff --git a/docs/reference/cli/probe/find-block.md b/versioned_docs/version-1/reference/cli/probe/find-block.md similarity index 100% rename from docs/reference/cli/probe/find-block.md rename to versioned_docs/version-1/reference/cli/probe/find-block.md diff --git a/docs/reference/cli/probe/format-bytes32-string.md b/versioned_docs/version-1/reference/cli/probe/format-bytes32-string.md similarity index 100% rename from docs/reference/cli/probe/format-bytes32-string.md rename to versioned_docs/version-1/reference/cli/probe/format-bytes32-string.md diff --git a/docs/reference/cli/probe/from-bin.md b/versioned_docs/version-1/reference/cli/probe/from-bin.md similarity index 100% rename from docs/reference/cli/probe/from-bin.md rename to versioned_docs/version-1/reference/cli/probe/from-bin.md diff --git a/docs/reference/cli/probe/from-fixed-point.md b/versioned_docs/version-1/reference/cli/probe/from-fixed-point.md similarity index 100% rename from docs/reference/cli/probe/from-fixed-point.md rename to versioned_docs/version-1/reference/cli/probe/from-fixed-point.md diff --git a/docs/reference/cli/probe/from-rlp.md b/versioned_docs/version-1/reference/cli/probe/from-rlp.md similarity index 100% rename from docs/reference/cli/probe/from-rlp.md rename to versioned_docs/version-1/reference/cli/probe/from-rlp.md diff --git a/docs/reference/cli/probe/from-utf8.md b/versioned_docs/version-1/reference/cli/probe/from-utf8.md similarity index 100% rename from docs/reference/cli/probe/from-utf8.md rename to versioned_docs/version-1/reference/cli/probe/from-utf8.md diff --git a/docs/reference/cli/probe/from-wei.md b/versioned_docs/version-1/reference/cli/probe/from-wei.md similarity index 100% rename from docs/reference/cli/probe/from-wei.md rename to versioned_docs/version-1/reference/cli/probe/from-wei.md diff --git a/docs/reference/cli/probe/gas-price.md b/versioned_docs/version-1/reference/cli/probe/gas-price.md similarity index 100% rename from docs/reference/cli/probe/gas-price.md rename to versioned_docs/version-1/reference/cli/probe/gas-price.md diff --git a/docs/reference/cli/probe/generate-fig-spec.md b/versioned_docs/version-1/reference/cli/probe/generate-fig-spec.md similarity index 100% rename from docs/reference/cli/probe/generate-fig-spec.md rename to versioned_docs/version-1/reference/cli/probe/generate-fig-spec.md diff --git a/docs/reference/cli/probe/hash-zero.md b/versioned_docs/version-1/reference/cli/probe/hash-zero.md similarity index 100% rename from docs/reference/cli/probe/hash-zero.md rename to versioned_docs/version-1/reference/cli/probe/hash-zero.md diff --git a/docs/reference/cli/probe/implementation.md b/versioned_docs/version-1/reference/cli/probe/implementation.md similarity index 100% rename from docs/reference/cli/probe/implementation.md rename to versioned_docs/version-1/reference/cli/probe/implementation.md diff --git a/docs/reference/cli/probe/index.md b/versioned_docs/version-1/reference/cli/probe/index.md similarity index 100% rename from docs/reference/cli/probe/index.md rename to versioned_docs/version-1/reference/cli/probe/index.md diff --git a/docs/reference/cli/probe/interface.md b/versioned_docs/version-1/reference/cli/probe/interface.md similarity index 100% rename from docs/reference/cli/probe/interface.md rename to versioned_docs/version-1/reference/cli/probe/interface.md diff --git a/docs/reference/cli/probe/keccak.md b/versioned_docs/version-1/reference/cli/probe/keccak.md similarity index 100% rename from docs/reference/cli/probe/keccak.md rename to versioned_docs/version-1/reference/cli/probe/keccak.md diff --git a/docs/reference/cli/probe/logs.md b/versioned_docs/version-1/reference/cli/probe/logs.md similarity index 100% rename from docs/reference/cli/probe/logs.md rename to versioned_docs/version-1/reference/cli/probe/logs.md diff --git a/docs/reference/cli/probe/lookup-address.md b/versioned_docs/version-1/reference/cli/probe/lookup-address.md similarity index 100% rename from docs/reference/cli/probe/lookup-address.md rename to versioned_docs/version-1/reference/cli/probe/lookup-address.md diff --git a/docs/reference/cli/probe/max-int.md b/versioned_docs/version-1/reference/cli/probe/max-int.md similarity index 100% rename from docs/reference/cli/probe/max-int.md rename to versioned_docs/version-1/reference/cli/probe/max-int.md diff --git a/docs/reference/cli/probe/max-uint.md b/versioned_docs/version-1/reference/cli/probe/max-uint.md similarity index 100% rename from docs/reference/cli/probe/max-uint.md rename to versioned_docs/version-1/reference/cli/probe/max-uint.md diff --git a/docs/reference/cli/probe/min-int.md b/versioned_docs/version-1/reference/cli/probe/min-int.md similarity index 100% rename from docs/reference/cli/probe/min-int.md rename to versioned_docs/version-1/reference/cli/probe/min-int.md diff --git a/docs/reference/cli/probe/namehash.md b/versioned_docs/version-1/reference/cli/probe/namehash.md similarity index 100% rename from docs/reference/cli/probe/namehash.md rename to versioned_docs/version-1/reference/cli/probe/namehash.md diff --git a/docs/reference/cli/probe/nonce.md b/versioned_docs/version-1/reference/cli/probe/nonce.md similarity index 100% rename from docs/reference/cli/probe/nonce.md rename to versioned_docs/version-1/reference/cli/probe/nonce.md diff --git a/docs/reference/cli/probe/parse-bytes32-address.md b/versioned_docs/version-1/reference/cli/probe/parse-bytes32-address.md similarity index 100% rename from docs/reference/cli/probe/parse-bytes32-address.md rename to versioned_docs/version-1/reference/cli/probe/parse-bytes32-address.md diff --git a/docs/reference/cli/probe/parse-bytes32-string.md b/versioned_docs/version-1/reference/cli/probe/parse-bytes32-string.md similarity index 100% rename from docs/reference/cli/probe/parse-bytes32-string.md rename to versioned_docs/version-1/reference/cli/probe/parse-bytes32-string.md diff --git a/docs/reference/cli/probe/pretty-calldata.md b/versioned_docs/version-1/reference/cli/probe/pretty-calldata.md similarity index 100% rename from docs/reference/cli/probe/pretty-calldata.md rename to versioned_docs/version-1/reference/cli/probe/pretty-calldata.md diff --git a/docs/reference/cli/probe/proof.md b/versioned_docs/version-1/reference/cli/probe/proof.md similarity index 100% rename from docs/reference/cli/probe/proof.md rename to versioned_docs/version-1/reference/cli/probe/proof.md diff --git a/docs/reference/cli/probe/publish.md b/versioned_docs/version-1/reference/cli/probe/publish.md similarity index 100% rename from docs/reference/cli/probe/publish.md rename to versioned_docs/version-1/reference/cli/probe/publish.md diff --git a/docs/reference/cli/probe/receipt.md b/versioned_docs/version-1/reference/cli/probe/receipt.md similarity index 100% rename from docs/reference/cli/probe/receipt.md rename to versioned_docs/version-1/reference/cli/probe/receipt.md diff --git a/docs/reference/cli/probe/resolve-name.md b/versioned_docs/version-1/reference/cli/probe/resolve-name.md similarity index 100% rename from docs/reference/cli/probe/resolve-name.md rename to versioned_docs/version-1/reference/cli/probe/resolve-name.md diff --git a/docs/reference/cli/probe/rpc.md b/versioned_docs/version-1/reference/cli/probe/rpc.md similarity index 100% rename from docs/reference/cli/probe/rpc.md rename to versioned_docs/version-1/reference/cli/probe/rpc.md diff --git a/docs/reference/cli/probe/run.md b/versioned_docs/version-1/reference/cli/probe/run.md similarity index 100% rename from docs/reference/cli/probe/run.md rename to versioned_docs/version-1/reference/cli/probe/run.md diff --git a/docs/reference/cli/probe/selectors.md b/versioned_docs/version-1/reference/cli/probe/selectors.md similarity index 100% rename from docs/reference/cli/probe/selectors.md rename to versioned_docs/version-1/reference/cli/probe/selectors.md diff --git a/docs/reference/cli/probe/send.md b/versioned_docs/version-1/reference/cli/probe/send.md similarity index 100% rename from docs/reference/cli/probe/send.md rename to versioned_docs/version-1/reference/cli/probe/send.md diff --git a/docs/reference/cli/probe/send/--create.md b/versioned_docs/version-1/reference/cli/probe/send/--create.md similarity index 100% rename from docs/reference/cli/probe/send/--create.md rename to versioned_docs/version-1/reference/cli/probe/send/--create.md diff --git a/docs/reference/cli/probe/shl.md b/versioned_docs/version-1/reference/cli/probe/shl.md similarity index 100% rename from docs/reference/cli/probe/shl.md rename to versioned_docs/version-1/reference/cli/probe/shl.md diff --git a/docs/reference/cli/probe/shr.md b/versioned_docs/version-1/reference/cli/probe/shr.md similarity index 100% rename from docs/reference/cli/probe/shr.md rename to versioned_docs/version-1/reference/cli/probe/shr.md diff --git a/docs/reference/cli/probe/sig-event.md b/versioned_docs/version-1/reference/cli/probe/sig-event.md similarity index 100% rename from docs/reference/cli/probe/sig-event.md rename to versioned_docs/version-1/reference/cli/probe/sig-event.md diff --git a/docs/reference/cli/probe/sig.md b/versioned_docs/version-1/reference/cli/probe/sig.md similarity index 100% rename from docs/reference/cli/probe/sig.md rename to versioned_docs/version-1/reference/cli/probe/sig.md diff --git a/docs/reference/cli/probe/storage.md b/versioned_docs/version-1/reference/cli/probe/storage.md similarity index 100% rename from docs/reference/cli/probe/storage.md rename to versioned_docs/version-1/reference/cli/probe/storage.md diff --git a/docs/reference/cli/probe/to-ascii.md b/versioned_docs/version-1/reference/cli/probe/to-ascii.md similarity index 100% rename from docs/reference/cli/probe/to-ascii.md rename to versioned_docs/version-1/reference/cli/probe/to-ascii.md diff --git a/docs/reference/cli/probe/to-base.md b/versioned_docs/version-1/reference/cli/probe/to-base.md similarity index 100% rename from docs/reference/cli/probe/to-base.md rename to versioned_docs/version-1/reference/cli/probe/to-base.md diff --git a/docs/reference/cli/probe/to-bytes32.md b/versioned_docs/version-1/reference/cli/probe/to-bytes32.md similarity index 100% rename from docs/reference/cli/probe/to-bytes32.md rename to versioned_docs/version-1/reference/cli/probe/to-bytes32.md diff --git a/docs/reference/cli/probe/to-check-sum-address.md b/versioned_docs/version-1/reference/cli/probe/to-check-sum-address.md similarity index 100% rename from docs/reference/cli/probe/to-check-sum-address.md rename to versioned_docs/version-1/reference/cli/probe/to-check-sum-address.md diff --git a/docs/reference/cli/probe/to-dec.md b/versioned_docs/version-1/reference/cli/probe/to-dec.md similarity index 100% rename from docs/reference/cli/probe/to-dec.md rename to versioned_docs/version-1/reference/cli/probe/to-dec.md diff --git a/docs/reference/cli/probe/to-fixed-point.md b/versioned_docs/version-1/reference/cli/probe/to-fixed-point.md similarity index 100% rename from docs/reference/cli/probe/to-fixed-point.md rename to versioned_docs/version-1/reference/cli/probe/to-fixed-point.md diff --git a/docs/reference/cli/probe/to-hex.md b/versioned_docs/version-1/reference/cli/probe/to-hex.md similarity index 100% rename from docs/reference/cli/probe/to-hex.md rename to versioned_docs/version-1/reference/cli/probe/to-hex.md diff --git a/docs/reference/cli/probe/to-hexdata.md b/versioned_docs/version-1/reference/cli/probe/to-hexdata.md similarity index 100% rename from docs/reference/cli/probe/to-hexdata.md rename to versioned_docs/version-1/reference/cli/probe/to-hexdata.md diff --git a/docs/reference/cli/probe/to-int256.md b/versioned_docs/version-1/reference/cli/probe/to-int256.md similarity index 100% rename from docs/reference/cli/probe/to-int256.md rename to versioned_docs/version-1/reference/cli/probe/to-int256.md diff --git a/docs/reference/cli/probe/to-rlp.md b/versioned_docs/version-1/reference/cli/probe/to-rlp.md similarity index 100% rename from docs/reference/cli/probe/to-rlp.md rename to versioned_docs/version-1/reference/cli/probe/to-rlp.md diff --git a/docs/reference/cli/probe/to-uint256.md b/versioned_docs/version-1/reference/cli/probe/to-uint256.md similarity index 100% rename from docs/reference/cli/probe/to-uint256.md rename to versioned_docs/version-1/reference/cli/probe/to-uint256.md diff --git a/docs/reference/cli/probe/to-unit.md b/versioned_docs/version-1/reference/cli/probe/to-unit.md similarity index 100% rename from docs/reference/cli/probe/to-unit.md rename to versioned_docs/version-1/reference/cli/probe/to-unit.md diff --git a/docs/reference/cli/probe/to-wei.md b/versioned_docs/version-1/reference/cli/probe/to-wei.md similarity index 100% rename from docs/reference/cli/probe/to-wei.md rename to versioned_docs/version-1/reference/cli/probe/to-wei.md diff --git a/docs/reference/cli/probe/tx.md b/versioned_docs/version-1/reference/cli/probe/tx.md similarity index 100% rename from docs/reference/cli/probe/tx.md rename to versioned_docs/version-1/reference/cli/probe/tx.md diff --git a/docs/reference/cli/probe/upload-signature.md b/versioned_docs/version-1/reference/cli/probe/upload-signature.md similarity index 100% rename from docs/reference/cli/probe/upload-signature.md rename to versioned_docs/version-1/reference/cli/probe/upload-signature.md diff --git a/docs/reference/cli/probe/wallet.md b/versioned_docs/version-1/reference/cli/probe/wallet.md similarity index 100% rename from docs/reference/cli/probe/wallet.md rename to versioned_docs/version-1/reference/cli/probe/wallet.md diff --git a/docs/reference/cli/probe/wallet/address.md b/versioned_docs/version-1/reference/cli/probe/wallet/address.md similarity index 100% rename from docs/reference/cli/probe/wallet/address.md rename to versioned_docs/version-1/reference/cli/probe/wallet/address.md diff --git a/docs/reference/cli/probe/wallet/derive-private-key.md b/versioned_docs/version-1/reference/cli/probe/wallet/derive-private-key.md similarity index 100% rename from docs/reference/cli/probe/wallet/derive-private-key.md rename to versioned_docs/version-1/reference/cli/probe/wallet/derive-private-key.md diff --git a/docs/reference/cli/probe/wallet/import.md b/versioned_docs/version-1/reference/cli/probe/wallet/import.md similarity index 100% rename from docs/reference/cli/probe/wallet/import.md rename to versioned_docs/version-1/reference/cli/probe/wallet/import.md diff --git a/docs/reference/cli/probe/wallet/list.md b/versioned_docs/version-1/reference/cli/probe/wallet/list.md similarity index 100% rename from docs/reference/cli/probe/wallet/list.md rename to versioned_docs/version-1/reference/cli/probe/wallet/list.md diff --git a/docs/reference/cli/probe/wallet/new-mnemonic.md b/versioned_docs/version-1/reference/cli/probe/wallet/new-mnemonic.md similarity index 100% rename from docs/reference/cli/probe/wallet/new-mnemonic.md rename to versioned_docs/version-1/reference/cli/probe/wallet/new-mnemonic.md diff --git a/docs/reference/cli/probe/wallet/new.md b/versioned_docs/version-1/reference/cli/probe/wallet/new.md similarity index 100% rename from docs/reference/cli/probe/wallet/new.md rename to versioned_docs/version-1/reference/cli/probe/wallet/new.md diff --git a/docs/reference/cli/probe/wallet/sign.md b/versioned_docs/version-1/reference/cli/probe/wallet/sign.md similarity index 100% rename from docs/reference/cli/probe/wallet/sign.md rename to versioned_docs/version-1/reference/cli/probe/wallet/sign.md diff --git a/docs/reference/cli/probe/wallet/vanity.md b/versioned_docs/version-1/reference/cli/probe/wallet/vanity.md similarity index 100% rename from docs/reference/cli/probe/wallet/vanity.md rename to versioned_docs/version-1/reference/cli/probe/wallet/vanity.md diff --git a/docs/reference/cli/probe/wallet/verify.md b/versioned_docs/version-1/reference/cli/probe/wallet/verify.md similarity index 100% rename from docs/reference/cli/probe/wallet/verify.md rename to versioned_docs/version-1/reference/cli/probe/wallet/verify.md diff --git a/docs/reference/cli/shuttle.md b/versioned_docs/version-1/reference/cli/shuttle.md similarity index 100% rename from docs/reference/cli/shuttle.md rename to versioned_docs/version-1/reference/cli/shuttle.md diff --git a/docs/reference/cli/shuttle/completions.md b/versioned_docs/version-1/reference/cli/shuttle/completions.md similarity index 100% rename from docs/reference/cli/shuttle/completions.md rename to versioned_docs/version-1/reference/cli/shuttle/completions.md diff --git a/docs/reference/cli/shuttle/generate-fig-spec.md b/versioned_docs/version-1/reference/cli/shuttle/generate-fig-spec.md similarity index 100% rename from docs/reference/cli/shuttle/generate-fig-spec.md rename to versioned_docs/version-1/reference/cli/shuttle/generate-fig-spec.md diff --git a/docs/reference/cli/spark.md b/versioned_docs/version-1/reference/cli/spark.md similarity index 100% rename from docs/reference/cli/spark.md rename to versioned_docs/version-1/reference/cli/spark.md diff --git a/docs/reference/cli/spark/bind.md b/versioned_docs/version-1/reference/cli/spark/bind.md similarity index 100% rename from docs/reference/cli/spark/bind.md rename to versioned_docs/version-1/reference/cli/spark/bind.md diff --git a/docs/reference/cli/spark/build.md b/versioned_docs/version-1/reference/cli/spark/build.md similarity index 100% rename from docs/reference/cli/spark/build.md rename to versioned_docs/version-1/reference/cli/spark/build.md diff --git a/docs/reference/cli/spark/cache.md b/versioned_docs/version-1/reference/cli/spark/cache.md similarity index 100% rename from docs/reference/cli/spark/cache.md rename to versioned_docs/version-1/reference/cli/spark/cache.md diff --git a/docs/reference/cli/spark/cache/clean.md b/versioned_docs/version-1/reference/cli/spark/cache/clean.md similarity index 100% rename from docs/reference/cli/spark/cache/clean.md rename to versioned_docs/version-1/reference/cli/spark/cache/clean.md diff --git a/docs/reference/cli/spark/cache/ls.md b/versioned_docs/version-1/reference/cli/spark/cache/ls.md similarity index 100% rename from docs/reference/cli/spark/cache/ls.md rename to versioned_docs/version-1/reference/cli/spark/cache/ls.md diff --git a/docs/reference/cli/spark/clean.md b/versioned_docs/version-1/reference/cli/spark/clean.md similarity index 100% rename from docs/reference/cli/spark/clean.md rename to versioned_docs/version-1/reference/cli/spark/clean.md diff --git a/docs/reference/cli/spark/completions.md b/versioned_docs/version-1/reference/cli/spark/completions.md similarity index 100% rename from docs/reference/cli/spark/completions.md rename to versioned_docs/version-1/reference/cli/spark/completions.md diff --git a/docs/reference/cli/spark/config.md b/versioned_docs/version-1/reference/cli/spark/config.md similarity index 100% rename from docs/reference/cli/spark/config.md rename to versioned_docs/version-1/reference/cli/spark/config.md diff --git a/docs/reference/cli/spark/coverage.md b/versioned_docs/version-1/reference/cli/spark/coverage.md similarity index 100% rename from docs/reference/cli/spark/coverage.md rename to versioned_docs/version-1/reference/cli/spark/coverage.md diff --git a/docs/reference/cli/spark/create.md b/versioned_docs/version-1/reference/cli/spark/create.md similarity index 100% rename from docs/reference/cli/spark/create.md rename to versioned_docs/version-1/reference/cli/spark/create.md diff --git a/docs/reference/cli/spark/debug.md b/versioned_docs/version-1/reference/cli/spark/debug.md similarity index 100% rename from docs/reference/cli/spark/debug.md rename to versioned_docs/version-1/reference/cli/spark/debug.md diff --git a/docs/reference/cli/spark/doc.md b/versioned_docs/version-1/reference/cli/spark/doc.md similarity index 100% rename from docs/reference/cli/spark/doc.md rename to versioned_docs/version-1/reference/cli/spark/doc.md diff --git a/docs/reference/cli/spark/flatten.md b/versioned_docs/version-1/reference/cli/spark/flatten.md similarity index 100% rename from docs/reference/cli/spark/flatten.md rename to versioned_docs/version-1/reference/cli/spark/flatten.md diff --git a/docs/reference/cli/spark/fmt.md b/versioned_docs/version-1/reference/cli/spark/fmt.md similarity index 100% rename from docs/reference/cli/spark/fmt.md rename to versioned_docs/version-1/reference/cli/spark/fmt.md diff --git a/docs/reference/cli/spark/geiger.md b/versioned_docs/version-1/reference/cli/spark/geiger.md similarity index 100% rename from docs/reference/cli/spark/geiger.md rename to versioned_docs/version-1/reference/cli/spark/geiger.md diff --git a/docs/reference/cli/spark/generate-fig-spec.md b/versioned_docs/version-1/reference/cli/spark/generate-fig-spec.md similarity index 100% rename from docs/reference/cli/spark/generate-fig-spec.md rename to versioned_docs/version-1/reference/cli/spark/generate-fig-spec.md diff --git a/docs/reference/cli/spark/generate.md b/versioned_docs/version-1/reference/cli/spark/generate.md similarity index 100% rename from docs/reference/cli/spark/generate.md rename to versioned_docs/version-1/reference/cli/spark/generate.md diff --git a/docs/reference/cli/spark/generate/test.md b/versioned_docs/version-1/reference/cli/spark/generate/test.md similarity index 100% rename from docs/reference/cli/spark/generate/test.md rename to versioned_docs/version-1/reference/cli/spark/generate/test.md diff --git a/docs/reference/cli/spark/init.md b/versioned_docs/version-1/reference/cli/spark/init.md similarity index 100% rename from docs/reference/cli/spark/init.md rename to versioned_docs/version-1/reference/cli/spark/init.md diff --git a/docs/reference/cli/spark/inspect.md b/versioned_docs/version-1/reference/cli/spark/inspect.md similarity index 100% rename from docs/reference/cli/spark/inspect.md rename to versioned_docs/version-1/reference/cli/spark/inspect.md diff --git a/docs/reference/cli/spark/install.md b/versioned_docs/version-1/reference/cli/spark/install.md similarity index 100% rename from docs/reference/cli/spark/install.md rename to versioned_docs/version-1/reference/cli/spark/install.md diff --git a/docs/reference/cli/spark/remappings.md b/versioned_docs/version-1/reference/cli/spark/remappings.md similarity index 100% rename from docs/reference/cli/spark/remappings.md rename to versioned_docs/version-1/reference/cli/spark/remappings.md diff --git a/docs/reference/cli/spark/remove.md b/versioned_docs/version-1/reference/cli/spark/remove.md similarity index 100% rename from docs/reference/cli/spark/remove.md rename to versioned_docs/version-1/reference/cli/spark/remove.md diff --git a/docs/reference/cli/spark/script.md b/versioned_docs/version-1/reference/cli/spark/script.md similarity index 100% rename from docs/reference/cli/spark/script.md rename to versioned_docs/version-1/reference/cli/spark/script.md diff --git a/docs/reference/cli/spark/selectors.md b/versioned_docs/version-1/reference/cli/spark/selectors.md similarity index 100% rename from docs/reference/cli/spark/selectors.md rename to versioned_docs/version-1/reference/cli/spark/selectors.md diff --git a/docs/reference/cli/spark/selectors/collision.md b/versioned_docs/version-1/reference/cli/spark/selectors/collision.md similarity index 100% rename from docs/reference/cli/spark/selectors/collision.md rename to versioned_docs/version-1/reference/cli/spark/selectors/collision.md diff --git a/docs/reference/cli/spark/selectors/list.md b/versioned_docs/version-1/reference/cli/spark/selectors/list.md similarity index 100% rename from docs/reference/cli/spark/selectors/list.md rename to versioned_docs/version-1/reference/cli/spark/selectors/list.md diff --git a/docs/reference/cli/spark/selectors/upload.md b/versioned_docs/version-1/reference/cli/spark/selectors/upload.md similarity index 100% rename from docs/reference/cli/spark/selectors/upload.md rename to versioned_docs/version-1/reference/cli/spark/selectors/upload.md diff --git a/docs/reference/cli/spark/snapshot.md b/versioned_docs/version-1/reference/cli/spark/snapshot.md similarity index 100% rename from docs/reference/cli/spark/snapshot.md rename to versioned_docs/version-1/reference/cli/spark/snapshot.md diff --git a/docs/reference/cli/spark/test.md b/versioned_docs/version-1/reference/cli/spark/test.md similarity index 100% rename from docs/reference/cli/spark/test.md rename to versioned_docs/version-1/reference/cli/spark/test.md diff --git a/docs/reference/cli/spark/tree.md b/versioned_docs/version-1/reference/cli/spark/tree.md similarity index 100% rename from docs/reference/cli/spark/tree.md rename to versioned_docs/version-1/reference/cli/spark/tree.md diff --git a/docs/reference/cli/spark/update.md b/versioned_docs/version-1/reference/cli/spark/update.md similarity index 100% rename from docs/reference/cli/spark/update.md rename to versioned_docs/version-1/reference/cli/spark/update.md diff --git a/docs/reference/cli/spark/verify-check.md b/versioned_docs/version-1/reference/cli/spark/verify-check.md similarity index 100% rename from docs/reference/cli/spark/verify-check.md rename to versioned_docs/version-1/reference/cli/spark/verify-check.md diff --git a/docs/reference/cli/spark/verify-contract.md b/versioned_docs/version-1/reference/cli/spark/verify-contract.md similarity index 100% rename from docs/reference/cli/spark/verify-contract.md rename to versioned_docs/version-1/reference/cli/spark/verify-contract.md diff --git a/docs/reference/config/config-reference.md b/versioned_docs/version-1/reference/config/config-reference.md similarity index 100% rename from docs/reference/config/config-reference.md rename to versioned_docs/version-1/reference/config/config-reference.md diff --git a/docs/reference/config/doc-generator.md b/versioned_docs/version-1/reference/config/doc-generator.md similarity index 100% rename from docs/reference/config/doc-generator.md rename to versioned_docs/version-1/reference/config/doc-generator.md diff --git a/docs/reference/config/etherscan.md b/versioned_docs/version-1/reference/config/etherscan.md similarity index 100% rename from docs/reference/config/etherscan.md rename to versioned_docs/version-1/reference/config/etherscan.md diff --git a/docs/reference/config/formatter.md b/versioned_docs/version-1/reference/config/formatter.md similarity index 100% rename from docs/reference/config/formatter.md rename to versioned_docs/version-1/reference/config/formatter.md diff --git a/docs/reference/config/inline-test-config.md b/versioned_docs/version-1/reference/config/inline-test-config.md similarity index 100% rename from docs/reference/config/inline-test-config.md rename to versioned_docs/version-1/reference/config/inline-test-config.md diff --git a/docs/reference/config/overview.md b/versioned_docs/version-1/reference/config/overview.md similarity index 100% rename from docs/reference/config/overview.md rename to versioned_docs/version-1/reference/config/overview.md diff --git a/docs/reference/config/project.md b/versioned_docs/version-1/reference/config/project.md similarity index 100% rename from docs/reference/config/project.md rename to versioned_docs/version-1/reference/config/project.md diff --git a/docs/reference/config/solidity-compiler.md b/versioned_docs/version-1/reference/config/solidity-compiler.md similarity index 100% rename from docs/reference/config/solidity-compiler.md rename to versioned_docs/version-1/reference/config/solidity-compiler.md diff --git a/docs/reference/config/testing.md b/versioned_docs/version-1/reference/config/testing.md similarity index 100% rename from docs/reference/config/testing.md rename to versioned_docs/version-1/reference/config/testing.md diff --git a/docs/reference/ds-test.md b/versioned_docs/version-1/reference/ds-test.md similarity index 100% rename from docs/reference/ds-test.md rename to versioned_docs/version-1/reference/ds-test.md diff --git a/docs/reference/pilot/pilot-reference.md b/versioned_docs/version-1/reference/pilot/pilot-reference.md similarity index 100% rename from docs/reference/pilot/pilot-reference.md rename to versioned_docs/version-1/reference/pilot/pilot-reference.md diff --git a/docs/reference/probe/abi-commands.md b/versioned_docs/version-1/reference/probe/abi-commands.md similarity index 100% rename from docs/reference/probe/abi-commands.md rename to versioned_docs/version-1/reference/probe/abi-commands.md diff --git a/docs/reference/probe/account-commands.md b/versioned_docs/version-1/reference/probe/account-commands.md similarity index 100% rename from docs/reference/probe/account-commands.md rename to versioned_docs/version-1/reference/probe/account-commands.md diff --git a/docs/reference/probe/block-commands.md b/versioned_docs/version-1/reference/probe/block-commands.md similarity index 100% rename from docs/reference/probe/block-commands.md rename to versioned_docs/version-1/reference/probe/block-commands.md diff --git a/docs/reference/probe/chain-commands.md b/versioned_docs/version-1/reference/probe/chain-commands.md similarity index 100% rename from docs/reference/probe/chain-commands.md rename to versioned_docs/version-1/reference/probe/chain-commands.md diff --git a/docs/reference/probe/common-options.md b/versioned_docs/version-1/reference/probe/common-options.md similarity index 100% rename from docs/reference/probe/common-options.md rename to versioned_docs/version-1/reference/probe/common-options.md diff --git a/docs/reference/probe/conversion-commands.md b/versioned_docs/version-1/reference/probe/conversion-commands.md similarity index 100% rename from docs/reference/probe/conversion-commands.md rename to versioned_docs/version-1/reference/probe/conversion-commands.md diff --git a/docs/reference/probe/ens-commands.md b/versioned_docs/version-1/reference/probe/ens-commands.md similarity index 100% rename from docs/reference/probe/ens-commands.md rename to versioned_docs/version-1/reference/probe/ens-commands.md diff --git a/docs/reference/probe/etherscan-commands.md b/versioned_docs/version-1/reference/probe/etherscan-commands.md similarity index 100% rename from docs/reference/probe/etherscan-commands.md rename to versioned_docs/version-1/reference/probe/etherscan-commands.md diff --git a/docs/reference/probe/general-commands.md b/versioned_docs/version-1/reference/probe/general-commands.md similarity index 100% rename from docs/reference/probe/general-commands.md rename to versioned_docs/version-1/reference/probe/general-commands.md diff --git a/docs/reference/probe/probe-4byte-decode.md b/versioned_docs/version-1/reference/probe/probe-4byte-decode.md similarity index 100% rename from docs/reference/probe/probe-4byte-decode.md rename to versioned_docs/version-1/reference/probe/probe-4byte-decode.md diff --git a/docs/reference/probe/probe-4byte-event.md b/versioned_docs/version-1/reference/probe/probe-4byte-event.md similarity index 100% rename from docs/reference/probe/probe-4byte-event.md rename to versioned_docs/version-1/reference/probe/probe-4byte-event.md diff --git a/docs/reference/probe/probe-4byte.md b/versioned_docs/version-1/reference/probe/probe-4byte.md similarity index 100% rename from docs/reference/probe/probe-4byte.md rename to versioned_docs/version-1/reference/probe/probe-4byte.md diff --git a/docs/reference/probe/probe-abi-decode.md b/versioned_docs/version-1/reference/probe/probe-abi-decode.md similarity index 100% rename from docs/reference/probe/probe-abi-decode.md rename to versioned_docs/version-1/reference/probe/probe-abi-decode.md diff --git a/docs/reference/probe/probe-abi-encode.md b/versioned_docs/version-1/reference/probe/probe-abi-encode.md similarity index 100% rename from docs/reference/probe/probe-abi-encode.md rename to versioned_docs/version-1/reference/probe/probe-abi-encode.md diff --git a/docs/reference/probe/probe-access-list.md b/versioned_docs/version-1/reference/probe/probe-access-list.md similarity index 100% rename from docs/reference/probe/probe-access-list.md rename to versioned_docs/version-1/reference/probe/probe-access-list.md diff --git a/docs/reference/probe/probe-age.md b/versioned_docs/version-1/reference/probe/probe-age.md similarity index 100% rename from docs/reference/probe/probe-age.md rename to versioned_docs/version-1/reference/probe/probe-age.md diff --git a/docs/reference/probe/probe-balance.md b/versioned_docs/version-1/reference/probe/probe-balance.md similarity index 100% rename from docs/reference/probe/probe-balance.md rename to versioned_docs/version-1/reference/probe/probe-balance.md diff --git a/docs/reference/probe/probe-basefee.md b/versioned_docs/version-1/reference/probe/probe-basefee.md similarity index 100% rename from docs/reference/probe/probe-basefee.md rename to versioned_docs/version-1/reference/probe/probe-basefee.md diff --git a/docs/reference/probe/probe-block-number.md b/versioned_docs/version-1/reference/probe/probe-block-number.md similarity index 100% rename from docs/reference/probe/probe-block-number.md rename to versioned_docs/version-1/reference/probe/probe-block-number.md diff --git a/docs/reference/probe/probe-block.md b/versioned_docs/version-1/reference/probe/probe-block.md similarity index 100% rename from docs/reference/probe/probe-block.md rename to versioned_docs/version-1/reference/probe/probe-block.md diff --git a/docs/reference/probe/probe-call.md b/versioned_docs/version-1/reference/probe/probe-call.md similarity index 100% rename from docs/reference/probe/probe-call.md rename to versioned_docs/version-1/reference/probe/probe-call.md diff --git a/docs/reference/probe/probe-calldata-decode.md b/versioned_docs/version-1/reference/probe/probe-calldata-decode.md similarity index 100% rename from docs/reference/probe/probe-calldata-decode.md rename to versioned_docs/version-1/reference/probe/probe-calldata-decode.md diff --git a/docs/reference/probe/probe-calldata.md b/versioned_docs/version-1/reference/probe/probe-calldata.md similarity index 100% rename from docs/reference/probe/probe-calldata.md rename to versioned_docs/version-1/reference/probe/probe-calldata.md diff --git a/docs/reference/probe/probe-chain-id.md b/versioned_docs/version-1/reference/probe/probe-chain-id.md similarity index 100% rename from docs/reference/probe/probe-chain-id.md rename to versioned_docs/version-1/reference/probe/probe-chain-id.md diff --git a/docs/reference/probe/probe-chain.md b/versioned_docs/version-1/reference/probe/probe-chain.md similarity index 100% rename from docs/reference/probe/probe-chain.md rename to versioned_docs/version-1/reference/probe/probe-chain.md diff --git a/docs/reference/probe/probe-client.md b/versioned_docs/version-1/reference/probe/probe-client.md similarity index 100% rename from docs/reference/probe/probe-client.md rename to versioned_docs/version-1/reference/probe/probe-client.md diff --git a/docs/reference/probe/probe-code.md b/versioned_docs/version-1/reference/probe/probe-code.md similarity index 100% rename from docs/reference/probe/probe-code.md rename to versioned_docs/version-1/reference/probe/probe-code.md diff --git a/docs/reference/probe/probe-codesize.md b/versioned_docs/version-1/reference/probe/probe-codesize.md similarity index 100% rename from docs/reference/probe/probe-codesize.md rename to versioned_docs/version-1/reference/probe/probe-codesize.md diff --git a/docs/reference/probe/probe-commands.md b/versioned_docs/version-1/reference/probe/probe-commands.md similarity index 100% rename from docs/reference/probe/probe-commands.md rename to versioned_docs/version-1/reference/probe/probe-commands.md diff --git a/docs/reference/probe/probe-completions.md b/versioned_docs/version-1/reference/probe/probe-completions.md similarity index 100% rename from docs/reference/probe/probe-completions.md rename to versioned_docs/version-1/reference/probe/probe-completions.md diff --git a/docs/reference/probe/probe-compute-address.md b/versioned_docs/version-1/reference/probe/probe-compute-address.md similarity index 100% rename from docs/reference/probe/probe-compute-address.md rename to versioned_docs/version-1/reference/probe/probe-compute-address.md diff --git a/docs/reference/probe/probe-concat-hex.md b/versioned_docs/version-1/reference/probe/probe-concat-hex.md similarity index 100% rename from docs/reference/probe/probe-concat-hex.md rename to versioned_docs/version-1/reference/probe/probe-concat-hex.md diff --git a/docs/reference/probe/probe-create2.md b/versioned_docs/version-1/reference/probe/probe-create2.md similarity index 100% rename from docs/reference/probe/probe-create2.md rename to versioned_docs/version-1/reference/probe/probe-create2.md diff --git a/docs/reference/probe/probe-estimate.md b/versioned_docs/version-1/reference/probe/probe-estimate.md similarity index 100% rename from docs/reference/probe/probe-estimate.md rename to versioned_docs/version-1/reference/probe/probe-estimate.md diff --git a/docs/reference/probe/probe-etherscan-source.md b/versioned_docs/version-1/reference/probe/probe-etherscan-source.md similarity index 100% rename from docs/reference/probe/probe-etherscan-source.md rename to versioned_docs/version-1/reference/probe/probe-etherscan-source.md diff --git a/docs/reference/probe/probe-find-block.md b/versioned_docs/version-1/reference/probe/probe-find-block.md similarity index 100% rename from docs/reference/probe/probe-find-block.md rename to versioned_docs/version-1/reference/probe/probe-find-block.md diff --git a/docs/reference/probe/probe-format-bytes32-string.md b/versioned_docs/version-1/reference/probe/probe-format-bytes32-string.md similarity index 100% rename from docs/reference/probe/probe-format-bytes32-string.md rename to versioned_docs/version-1/reference/probe/probe-format-bytes32-string.md diff --git a/docs/reference/probe/probe-from-bin.md b/versioned_docs/version-1/reference/probe/probe-from-bin.md similarity index 100% rename from docs/reference/probe/probe-from-bin.md rename to versioned_docs/version-1/reference/probe/probe-from-bin.md diff --git a/docs/reference/probe/probe-from-fixed-point.md b/versioned_docs/version-1/reference/probe/probe-from-fixed-point.md similarity index 100% rename from docs/reference/probe/probe-from-fixed-point.md rename to versioned_docs/version-1/reference/probe/probe-from-fixed-point.md diff --git a/docs/reference/probe/probe-from-rlp.md b/versioned_docs/version-1/reference/probe/probe-from-rlp.md similarity index 100% rename from docs/reference/probe/probe-from-rlp.md rename to versioned_docs/version-1/reference/probe/probe-from-rlp.md diff --git a/docs/reference/probe/probe-from-utf8.md b/versioned_docs/version-1/reference/probe/probe-from-utf8.md similarity index 100% rename from docs/reference/probe/probe-from-utf8.md rename to versioned_docs/version-1/reference/probe/probe-from-utf8.md diff --git a/docs/reference/probe/probe-from-wei.md b/versioned_docs/version-1/reference/probe/probe-from-wei.md similarity index 100% rename from docs/reference/probe/probe-from-wei.md rename to versioned_docs/version-1/reference/probe/probe-from-wei.md diff --git a/docs/reference/probe/probe-gas-price.md b/versioned_docs/version-1/reference/probe/probe-gas-price.md similarity index 100% rename from docs/reference/probe/probe-gas-price.md rename to versioned_docs/version-1/reference/probe/probe-gas-price.md diff --git a/docs/reference/probe/probe-help.md b/versioned_docs/version-1/reference/probe/probe-help.md similarity index 100% rename from docs/reference/probe/probe-help.md rename to versioned_docs/version-1/reference/probe/probe-help.md diff --git a/docs/reference/probe/probe-index.md b/versioned_docs/version-1/reference/probe/probe-index.md similarity index 100% rename from docs/reference/probe/probe-index.md rename to versioned_docs/version-1/reference/probe/probe-index.md diff --git a/docs/reference/probe/probe-interface.md b/versioned_docs/version-1/reference/probe/probe-interface.md similarity index 100% rename from docs/reference/probe/probe-interface.md rename to versioned_docs/version-1/reference/probe/probe-interface.md diff --git a/docs/reference/probe/probe-keccak.md b/versioned_docs/version-1/reference/probe/probe-keccak.md similarity index 100% rename from docs/reference/probe/probe-keccak.md rename to versioned_docs/version-1/reference/probe/probe-keccak.md diff --git a/docs/reference/probe/probe-logs.md b/versioned_docs/version-1/reference/probe/probe-logs.md similarity index 100% rename from docs/reference/probe/probe-logs.md rename to versioned_docs/version-1/reference/probe/probe-logs.md diff --git a/docs/reference/probe/probe-lookup-address.md b/versioned_docs/version-1/reference/probe/probe-lookup-address.md similarity index 100% rename from docs/reference/probe/probe-lookup-address.md rename to versioned_docs/version-1/reference/probe/probe-lookup-address.md diff --git a/docs/reference/probe/probe-max-int.md b/versioned_docs/version-1/reference/probe/probe-max-int.md similarity index 100% rename from docs/reference/probe/probe-max-int.md rename to versioned_docs/version-1/reference/probe/probe-max-int.md diff --git a/docs/reference/probe/probe-max-uint.md b/versioned_docs/version-1/reference/probe/probe-max-uint.md similarity index 100% rename from docs/reference/probe/probe-max-uint.md rename to versioned_docs/version-1/reference/probe/probe-max-uint.md diff --git a/docs/reference/probe/probe-min-int.md b/versioned_docs/version-1/reference/probe/probe-min-int.md similarity index 100% rename from docs/reference/probe/probe-min-int.md rename to versioned_docs/version-1/reference/probe/probe-min-int.md diff --git a/docs/reference/probe/probe-namehash.md b/versioned_docs/version-1/reference/probe/probe-namehash.md similarity index 100% rename from docs/reference/probe/probe-namehash.md rename to versioned_docs/version-1/reference/probe/probe-namehash.md diff --git a/docs/reference/probe/probe-nonce.md b/versioned_docs/version-1/reference/probe/probe-nonce.md similarity index 100% rename from docs/reference/probe/probe-nonce.md rename to versioned_docs/version-1/reference/probe/probe-nonce.md diff --git a/docs/reference/probe/probe-parse-bytes32-address.md b/versioned_docs/version-1/reference/probe/probe-parse-bytes32-address.md similarity index 100% rename from docs/reference/probe/probe-parse-bytes32-address.md rename to versioned_docs/version-1/reference/probe/probe-parse-bytes32-address.md diff --git a/docs/reference/probe/probe-parse-bytes32-string.md b/versioned_docs/version-1/reference/probe/probe-parse-bytes32-string.md similarity index 100% rename from docs/reference/probe/probe-parse-bytes32-string.md rename to versioned_docs/version-1/reference/probe/probe-parse-bytes32-string.md diff --git a/docs/reference/probe/probe-pretty-calldata.md b/versioned_docs/version-1/reference/probe/probe-pretty-calldata.md similarity index 100% rename from docs/reference/probe/probe-pretty-calldata.md rename to versioned_docs/version-1/reference/probe/probe-pretty-calldata.md diff --git a/docs/reference/probe/probe-proof.md b/versioned_docs/version-1/reference/probe/probe-proof.md similarity index 100% rename from docs/reference/probe/probe-proof.md rename to versioned_docs/version-1/reference/probe/probe-proof.md diff --git a/docs/reference/probe/probe-publish.md b/versioned_docs/version-1/reference/probe/probe-publish.md similarity index 100% rename from docs/reference/probe/probe-publish.md rename to versioned_docs/version-1/reference/probe/probe-publish.md diff --git a/docs/reference/probe/probe-receipt.md b/versioned_docs/version-1/reference/probe/probe-receipt.md similarity index 100% rename from docs/reference/probe/probe-receipt.md rename to versioned_docs/version-1/reference/probe/probe-receipt.md diff --git a/docs/reference/probe/probe-resolve-name.md b/versioned_docs/version-1/reference/probe/probe-resolve-name.md similarity index 100% rename from docs/reference/probe/probe-resolve-name.md rename to versioned_docs/version-1/reference/probe/probe-resolve-name.md diff --git a/docs/reference/probe/probe-rpc.md b/versioned_docs/version-1/reference/probe/probe-rpc.md similarity index 100% rename from docs/reference/probe/probe-rpc.md rename to versioned_docs/version-1/reference/probe/probe-rpc.md diff --git a/docs/reference/probe/probe-run.md b/versioned_docs/version-1/reference/probe/probe-run.md similarity index 100% rename from docs/reference/probe/probe-run.md rename to versioned_docs/version-1/reference/probe/probe-run.md diff --git a/docs/reference/probe/probe-selectors.md b/versioned_docs/version-1/reference/probe/probe-selectors.md similarity index 100% rename from docs/reference/probe/probe-selectors.md rename to versioned_docs/version-1/reference/probe/probe-selectors.md diff --git a/docs/reference/probe/probe-send.md b/versioned_docs/version-1/reference/probe/probe-send.md similarity index 100% rename from docs/reference/probe/probe-send.md rename to versioned_docs/version-1/reference/probe/probe-send.md diff --git a/docs/reference/probe/probe-shl.md b/versioned_docs/version-1/reference/probe/probe-shl.md similarity index 100% rename from docs/reference/probe/probe-shl.md rename to versioned_docs/version-1/reference/probe/probe-shl.md diff --git a/docs/reference/probe/probe-shr.md b/versioned_docs/version-1/reference/probe/probe-shr.md similarity index 100% rename from docs/reference/probe/probe-shr.md rename to versioned_docs/version-1/reference/probe/probe-shr.md diff --git a/docs/reference/probe/probe-sig-event.md b/versioned_docs/version-1/reference/probe/probe-sig-event.md similarity index 100% rename from docs/reference/probe/probe-sig-event.md rename to versioned_docs/version-1/reference/probe/probe-sig-event.md diff --git a/docs/reference/probe/probe-sig.md b/versioned_docs/version-1/reference/probe/probe-sig.md similarity index 100% rename from docs/reference/probe/probe-sig.md rename to versioned_docs/version-1/reference/probe/probe-sig.md diff --git a/docs/reference/probe/probe-storage.md b/versioned_docs/version-1/reference/probe/probe-storage.md similarity index 100% rename from docs/reference/probe/probe-storage.md rename to versioned_docs/version-1/reference/probe/probe-storage.md diff --git a/docs/reference/probe/probe-to-ascii.md b/versioned_docs/version-1/reference/probe/probe-to-ascii.md similarity index 100% rename from docs/reference/probe/probe-to-ascii.md rename to versioned_docs/version-1/reference/probe/probe-to-ascii.md diff --git a/docs/reference/probe/probe-to-base.md b/versioned_docs/version-1/reference/probe/probe-to-base.md similarity index 100% rename from docs/reference/probe/probe-to-base.md rename to versioned_docs/version-1/reference/probe/probe-to-base.md diff --git a/docs/reference/probe/probe-to-bytes32.md b/versioned_docs/version-1/reference/probe/probe-to-bytes32.md similarity index 100% rename from docs/reference/probe/probe-to-bytes32.md rename to versioned_docs/version-1/reference/probe/probe-to-bytes32.md diff --git a/docs/reference/probe/probe-to-check-sum-address.md b/versioned_docs/version-1/reference/probe/probe-to-check-sum-address.md similarity index 100% rename from docs/reference/probe/probe-to-check-sum-address.md rename to versioned_docs/version-1/reference/probe/probe-to-check-sum-address.md diff --git a/docs/reference/probe/probe-to-dec.md b/versioned_docs/version-1/reference/probe/probe-to-dec.md similarity index 100% rename from docs/reference/probe/probe-to-dec.md rename to versioned_docs/version-1/reference/probe/probe-to-dec.md diff --git a/docs/reference/probe/probe-to-fixed-point.md b/versioned_docs/version-1/reference/probe/probe-to-fixed-point.md similarity index 100% rename from docs/reference/probe/probe-to-fixed-point.md rename to versioned_docs/version-1/reference/probe/probe-to-fixed-point.md diff --git a/docs/reference/probe/probe-to-hex.md b/versioned_docs/version-1/reference/probe/probe-to-hex.md similarity index 100% rename from docs/reference/probe/probe-to-hex.md rename to versioned_docs/version-1/reference/probe/probe-to-hex.md diff --git a/docs/reference/probe/probe-to-hexdata.md b/versioned_docs/version-1/reference/probe/probe-to-hexdata.md similarity index 100% rename from docs/reference/probe/probe-to-hexdata.md rename to versioned_docs/version-1/reference/probe/probe-to-hexdata.md diff --git a/docs/reference/probe/probe-to-int256.md b/versioned_docs/version-1/reference/probe/probe-to-int256.md similarity index 100% rename from docs/reference/probe/probe-to-int256.md rename to versioned_docs/version-1/reference/probe/probe-to-int256.md diff --git a/docs/reference/probe/probe-to-rlp.md b/versioned_docs/version-1/reference/probe/probe-to-rlp.md similarity index 100% rename from docs/reference/probe/probe-to-rlp.md rename to versioned_docs/version-1/reference/probe/probe-to-rlp.md diff --git a/docs/reference/probe/probe-to-uint256.md b/versioned_docs/version-1/reference/probe/probe-to-uint256.md similarity index 100% rename from docs/reference/probe/probe-to-uint256.md rename to versioned_docs/version-1/reference/probe/probe-to-uint256.md diff --git a/docs/reference/probe/probe-to-unit.md b/versioned_docs/version-1/reference/probe/probe-to-unit.md similarity index 100% rename from docs/reference/probe/probe-to-unit.md rename to versioned_docs/version-1/reference/probe/probe-to-unit.md diff --git a/docs/reference/probe/probe-to-wei.md b/versioned_docs/version-1/reference/probe/probe-to-wei.md similarity index 100% rename from docs/reference/probe/probe-to-wei.md rename to versioned_docs/version-1/reference/probe/probe-to-wei.md diff --git a/docs/reference/probe/probe-tx.md b/versioned_docs/version-1/reference/probe/probe-tx.md similarity index 100% rename from docs/reference/probe/probe-tx.md rename to versioned_docs/version-1/reference/probe/probe-tx.md diff --git a/docs/reference/probe/probe-upload-signature.md b/versioned_docs/version-1/reference/probe/probe-upload-signature.md similarity index 100% rename from docs/reference/probe/probe-upload-signature.md rename to versioned_docs/version-1/reference/probe/probe-upload-signature.md diff --git a/docs/reference/probe/probe-wallet-address.md b/versioned_docs/version-1/reference/probe/probe-wallet-address.md similarity index 100% rename from docs/reference/probe/probe-wallet-address.md rename to versioned_docs/version-1/reference/probe/probe-wallet-address.md diff --git a/docs/reference/probe/probe-wallet-import.md b/versioned_docs/version-1/reference/probe/probe-wallet-import.md similarity index 100% rename from docs/reference/probe/probe-wallet-import.md rename to versioned_docs/version-1/reference/probe/probe-wallet-import.md diff --git a/docs/reference/probe/probe-wallet-list.md b/versioned_docs/version-1/reference/probe/probe-wallet-list.md similarity index 100% rename from docs/reference/probe/probe-wallet-list.md rename to versioned_docs/version-1/reference/probe/probe-wallet-list.md diff --git a/docs/reference/probe/probe-wallet-new-mnemonic.md b/versioned_docs/version-1/reference/probe/probe-wallet-new-mnemonic.md similarity index 100% rename from docs/reference/probe/probe-wallet-new-mnemonic.md rename to versioned_docs/version-1/reference/probe/probe-wallet-new-mnemonic.md diff --git a/docs/reference/probe/probe-wallet-new.md b/versioned_docs/version-1/reference/probe/probe-wallet-new.md similarity index 100% rename from docs/reference/probe/probe-wallet-new.md rename to versioned_docs/version-1/reference/probe/probe-wallet-new.md diff --git a/docs/reference/probe/probe-wallet-sign.md b/versioned_docs/version-1/reference/probe/probe-wallet-sign.md similarity index 100% rename from docs/reference/probe/probe-wallet-sign.md rename to versioned_docs/version-1/reference/probe/probe-wallet-sign.md diff --git a/docs/reference/probe/probe-wallet-vanity.md b/versioned_docs/version-1/reference/probe/probe-wallet-vanity.md similarity index 100% rename from docs/reference/probe/probe-wallet-vanity.md rename to versioned_docs/version-1/reference/probe/probe-wallet-vanity.md diff --git a/docs/reference/probe/probe-wallet-verify.md b/versioned_docs/version-1/reference/probe/probe-wallet-verify.md similarity index 100% rename from docs/reference/probe/probe-wallet-verify.md rename to versioned_docs/version-1/reference/probe/probe-wallet-verify.md diff --git a/docs/reference/probe/probe-wallet.md b/versioned_docs/version-1/reference/probe/probe-wallet.md similarity index 100% rename from docs/reference/probe/probe-wallet.md rename to versioned_docs/version-1/reference/probe/probe-wallet.md diff --git a/docs/reference/probe/probe.md b/versioned_docs/version-1/reference/probe/probe.md similarity index 100% rename from docs/reference/probe/probe.md rename to versioned_docs/version-1/reference/probe/probe.md diff --git a/docs/reference/probe/sig-description.md b/versioned_docs/version-1/reference/probe/sig-description.md similarity index 100% rename from docs/reference/probe/sig-description.md rename to versioned_docs/version-1/reference/probe/sig-description.md diff --git a/docs/reference/probe/transaction-commands.md b/versioned_docs/version-1/reference/probe/transaction-commands.md similarity index 100% rename from docs/reference/probe/transaction-commands.md rename to versioned_docs/version-1/reference/probe/transaction-commands.md diff --git a/docs/reference/probe/utility-commands.md b/versioned_docs/version-1/reference/probe/utility-commands.md similarity index 100% rename from docs/reference/probe/utility-commands.md rename to versioned_docs/version-1/reference/probe/utility-commands.md diff --git a/docs/reference/probe/wallet-commands.md b/versioned_docs/version-1/reference/probe/wallet-commands.md similarity index 100% rename from docs/reference/probe/wallet-commands.md rename to versioned_docs/version-1/reference/probe/wallet-commands.md diff --git a/docs/reference/reference.md b/versioned_docs/version-1/reference/reference.md similarity index 100% rename from docs/reference/reference.md rename to versioned_docs/version-1/reference/reference.md diff --git a/docs/reference/shuttle/shuttle-reference.md b/versioned_docs/version-1/reference/shuttle/shuttle-reference.md similarity index 100% rename from docs/reference/shuttle/shuttle-reference.md rename to versioned_docs/version-1/reference/shuttle/shuttle-reference.md diff --git a/docs/reference/spark-std/abs.md b/versioned_docs/version-1/reference/spark-std/abs.md similarity index 100% rename from docs/reference/spark-std/abs.md rename to versioned_docs/version-1/reference/spark-std/abs.md diff --git a/docs/reference/spark-std/arithmeticError.md b/versioned_docs/version-1/reference/spark-std/arithmeticError.md similarity index 100% rename from docs/reference/spark-std/arithmeticError.md rename to versioned_docs/version-1/reference/spark-std/arithmeticError.md diff --git a/docs/reference/spark-std/assertApproxEqAbs.md b/versioned_docs/version-1/reference/spark-std/assertApproxEqAbs.md similarity index 100% rename from docs/reference/spark-std/assertApproxEqAbs.md rename to versioned_docs/version-1/reference/spark-std/assertApproxEqAbs.md diff --git a/docs/reference/spark-std/assertApproxEqRel.md b/versioned_docs/version-1/reference/spark-std/assertApproxEqRel.md similarity index 100% rename from docs/reference/spark-std/assertApproxEqRel.md rename to versioned_docs/version-1/reference/spark-std/assertApproxEqRel.md diff --git a/docs/reference/spark-std/assertEq.md b/versioned_docs/version-1/reference/spark-std/assertEq.md similarity index 100% rename from docs/reference/spark-std/assertEq.md rename to versioned_docs/version-1/reference/spark-std/assertEq.md diff --git a/docs/reference/spark-std/assertFalse.md b/versioned_docs/version-1/reference/spark-std/assertFalse.md similarity index 100% rename from docs/reference/spark-std/assertFalse.md rename to versioned_docs/version-1/reference/spark-std/assertFalse.md diff --git a/docs/reference/spark-std/assertionError.md b/versioned_docs/version-1/reference/spark-std/assertionError.md similarity index 100% rename from docs/reference/spark-std/assertionError.md rename to versioned_docs/version-1/reference/spark-std/assertionError.md diff --git a/docs/reference/spark-std/assume-no-precompiles.md b/versioned_docs/version-1/reference/spark-std/assume-no-precompiles.md similarity index 100% rename from docs/reference/spark-std/assume-no-precompiles.md rename to versioned_docs/version-1/reference/spark-std/assume-no-precompiles.md diff --git a/docs/reference/spark-std/assume-payable.md b/versioned_docs/version-1/reference/spark-std/assume-payable.md similarity index 100% rename from docs/reference/spark-std/assume-payable.md rename to versioned_docs/version-1/reference/spark-std/assume-payable.md diff --git a/docs/reference/spark-std/bound.md b/versioned_docs/version-1/reference/spark-std/bound.md similarity index 100% rename from docs/reference/spark-std/bound.md rename to versioned_docs/version-1/reference/spark-std/bound.md diff --git a/docs/reference/spark-std/change-prank.md b/versioned_docs/version-1/reference/spark-std/change-prank.md similarity index 100% rename from docs/reference/spark-std/change-prank.md rename to versioned_docs/version-1/reference/spark-std/change-prank.md diff --git a/docs/reference/spark-std/checked_write.md b/versioned_docs/version-1/reference/spark-std/checked_write.md similarity index 100% rename from docs/reference/spark-std/checked_write.md rename to versioned_docs/version-1/reference/spark-std/checked_write.md diff --git a/docs/reference/spark-std/compute-create-address.md b/versioned_docs/version-1/reference/spark-std/compute-create-address.md similarity index 100% rename from docs/reference/spark-std/compute-create-address.md rename to versioned_docs/version-1/reference/spark-std/compute-create-address.md diff --git a/docs/reference/spark-std/console-log.md b/versioned_docs/version-1/reference/spark-std/console-log.md similarity index 100% rename from docs/reference/spark-std/console-log.md rename to versioned_docs/version-1/reference/spark-std/console-log.md diff --git a/docs/reference/spark-std/deal.md b/versioned_docs/version-1/reference/spark-std/deal.md similarity index 100% rename from docs/reference/spark-std/deal.md rename to versioned_docs/version-1/reference/spark-std/deal.md diff --git a/docs/reference/spark-std/delta.md b/versioned_docs/version-1/reference/spark-std/delta.md similarity index 100% rename from docs/reference/spark-std/delta.md rename to versioned_docs/version-1/reference/spark-std/delta.md diff --git a/docs/reference/spark-std/deployCode.md b/versioned_docs/version-1/reference/spark-std/deployCode.md similarity index 100% rename from docs/reference/spark-std/deployCode.md rename to versioned_docs/version-1/reference/spark-std/deployCode.md diff --git a/docs/reference/spark-std/deployCodeTo.md b/versioned_docs/version-1/reference/spark-std/deployCodeTo.md similarity index 100% rename from docs/reference/spark-std/deployCodeTo.md rename to versioned_docs/version-1/reference/spark-std/deployCodeTo.md diff --git a/docs/reference/spark-std/depth.md b/versioned_docs/version-1/reference/spark-std/depth.md similarity index 100% rename from docs/reference/spark-std/depth.md rename to versioned_docs/version-1/reference/spark-std/depth.md diff --git a/docs/reference/spark-std/derive-remember-key.md b/versioned_docs/version-1/reference/spark-std/derive-remember-key.md similarity index 100% rename from docs/reference/spark-std/derive-remember-key.md rename to versioned_docs/version-1/reference/spark-std/derive-remember-key.md diff --git a/docs/reference/spark-std/divisionError.md b/versioned_docs/version-1/reference/spark-std/divisionError.md similarity index 100% rename from docs/reference/spark-std/divisionError.md rename to versioned_docs/version-1/reference/spark-std/divisionError.md diff --git a/docs/reference/spark-std/encodeStorageError.md b/versioned_docs/version-1/reference/spark-std/encodeStorageError.md similarity index 100% rename from docs/reference/spark-std/encodeStorageError.md rename to versioned_docs/version-1/reference/spark-std/encodeStorageError.md diff --git a/docs/reference/spark-std/enumConversionError.md b/versioned_docs/version-1/reference/spark-std/enumConversionError.md similarity index 100% rename from docs/reference/spark-std/enumConversionError.md rename to versioned_docs/version-1/reference/spark-std/enumConversionError.md diff --git a/docs/reference/spark-std/fail.md b/versioned_docs/version-1/reference/spark-std/fail.md similarity index 100% rename from docs/reference/spark-std/fail.md rename to versioned_docs/version-1/reference/spark-std/fail.md diff --git a/docs/reference/spark-std/find.md b/versioned_docs/version-1/reference/spark-std/find.md similarity index 100% rename from docs/reference/spark-std/find.md rename to versioned_docs/version-1/reference/spark-std/find.md diff --git a/docs/reference/spark-std/hoax.md b/versioned_docs/version-1/reference/spark-std/hoax.md similarity index 100% rename from docs/reference/spark-std/hoax.md rename to versioned_docs/version-1/reference/spark-std/hoax.md diff --git a/docs/reference/spark-std/indexOOBError.md b/versioned_docs/version-1/reference/spark-std/indexOOBError.md similarity index 100% rename from docs/reference/spark-std/indexOOBError.md rename to versioned_docs/version-1/reference/spark-std/indexOOBError.md diff --git a/docs/reference/spark-std/make-addr-and-key.md b/versioned_docs/version-1/reference/spark-std/make-addr-and-key.md similarity index 100% rename from docs/reference/spark-std/make-addr-and-key.md rename to versioned_docs/version-1/reference/spark-std/make-addr-and-key.md diff --git a/docs/reference/spark-std/make-addr.md b/versioned_docs/version-1/reference/spark-std/make-addr.md similarity index 100% rename from docs/reference/spark-std/make-addr.md rename to versioned_docs/version-1/reference/spark-std/make-addr.md diff --git a/docs/reference/spark-std/memOverflowError.md b/versioned_docs/version-1/reference/spark-std/memOverflowError.md similarity index 100% rename from docs/reference/spark-std/memOverflowError.md rename to versioned_docs/version-1/reference/spark-std/memOverflowError.md diff --git a/docs/reference/spark-std/noGasMetering.md b/versioned_docs/version-1/reference/spark-std/noGasMetering.md similarity index 100% rename from docs/reference/spark-std/noGasMetering.md rename to versioned_docs/version-1/reference/spark-std/noGasMetering.md diff --git a/docs/reference/spark-std/percentDelta.md b/versioned_docs/version-1/reference/spark-std/percentDelta.md similarity index 100% rename from docs/reference/spark-std/percentDelta.md rename to versioned_docs/version-1/reference/spark-std/percentDelta.md diff --git a/docs/reference/spark-std/popError.md b/versioned_docs/version-1/reference/spark-std/popError.md similarity index 100% rename from docs/reference/spark-std/popError.md rename to versioned_docs/version-1/reference/spark-std/popError.md diff --git a/docs/reference/spark-std/read.md b/versioned_docs/version-1/reference/spark-std/read.md similarity index 100% rename from docs/reference/spark-std/read.md rename to versioned_docs/version-1/reference/spark-std/read.md diff --git a/docs/reference/spark-std/rewind.md b/versioned_docs/version-1/reference/spark-std/rewind.md similarity index 100% rename from docs/reference/spark-std/rewind.md rename to versioned_docs/version-1/reference/spark-std/rewind.md diff --git a/docs/reference/spark-std/script-utils.md b/versioned_docs/version-1/reference/spark-std/script-utils.md similarity index 100% rename from docs/reference/spark-std/script-utils.md rename to versioned_docs/version-1/reference/spark-std/script-utils.md diff --git a/docs/reference/spark-std/sig.md b/versioned_docs/version-1/reference/spark-std/sig.md similarity index 100% rename from docs/reference/spark-std/sig.md rename to versioned_docs/version-1/reference/spark-std/sig.md diff --git a/docs/reference/spark-std/skip.md b/versioned_docs/version-1/reference/spark-std/skip.md similarity index 100% rename from docs/reference/spark-std/skip.md rename to versioned_docs/version-1/reference/spark-std/skip.md diff --git a/docs/reference/spark-std/spark-standart.md b/versioned_docs/version-1/reference/spark-std/spark-standart.md similarity index 96% rename from docs/reference/spark-std/spark-standart.md rename to versioned_docs/version-1/reference/spark-std/spark-standart.md index b826541..012c27e 100644 --- a/docs/reference/spark-std/spark-standart.md +++ b/versioned_docs/version-1/reference/spark-std/spark-standart.md @@ -26,7 +26,7 @@ What's included: import "spark-std/console2.sol"; ``` -- `Script.sol`: Basic utilities for [Solidity scripting](../../tutorials/solidity-scripting.md) +- `Script.sol`: Basic utilities for [Ylem scripting](../../tutorials/ylem-scripting.md) ```solidity import "spark-std/Script.sol"; diff --git a/docs/reference/spark-std/startHoax.md b/versioned_docs/version-1/reference/spark-std/startHoax.md similarity index 100% rename from docs/reference/spark-std/startHoax.md rename to versioned_docs/version-1/reference/spark-std/startHoax.md diff --git a/docs/reference/spark-std/std-assertions.md b/versioned_docs/version-1/reference/spark-std/std-assertions.md similarity index 100% rename from docs/reference/spark-std/std-assertions.md rename to versioned_docs/version-1/reference/spark-std/std-assertions.md diff --git a/docs/reference/spark-std/std-cheats.md b/versioned_docs/version-1/reference/spark-std/std-cheats.md similarity index 100% rename from docs/reference/spark-std/std-cheats.md rename to versioned_docs/version-1/reference/spark-std/std-cheats.md diff --git a/docs/reference/spark-std/std-errors.md b/versioned_docs/version-1/reference/spark-std/std-errors.md similarity index 100% rename from docs/reference/spark-std/std-errors.md rename to versioned_docs/version-1/reference/spark-std/std-errors.md diff --git a/docs/reference/spark-std/std-logs.md b/versioned_docs/version-1/reference/spark-std/std-logs.md similarity index 100% rename from docs/reference/spark-std/std-logs.md rename to versioned_docs/version-1/reference/spark-std/std-logs.md diff --git a/docs/reference/spark-std/std-math.md b/versioned_docs/version-1/reference/spark-std/std-math.md similarity index 100% rename from docs/reference/spark-std/std-math.md rename to versioned_docs/version-1/reference/spark-std/std-math.md diff --git a/docs/reference/spark-std/std-storage.md b/versioned_docs/version-1/reference/spark-std/std-storage.md similarity index 100% rename from docs/reference/spark-std/std-storage.md rename to versioned_docs/version-1/reference/spark-std/std-storage.md diff --git a/docs/reference/spark-std/target.md b/versioned_docs/version-1/reference/spark-std/target.md similarity index 100% rename from docs/reference/spark-std/target.md rename to versioned_docs/version-1/reference/spark-std/target.md diff --git a/docs/reference/spark-std/with_key.md b/versioned_docs/version-1/reference/spark-std/with_key.md similarity index 100% rename from docs/reference/spark-std/with_key.md rename to versioned_docs/version-1/reference/spark-std/with_key.md diff --git a/docs/reference/spark-std/zeroVarError.md b/versioned_docs/version-1/reference/spark-std/zeroVarError.md similarity index 100% rename from docs/reference/spark-std/zeroVarError.md rename to versioned_docs/version-1/reference/spark-std/zeroVarError.md diff --git a/docs/reference/spark/build-commands.md b/versioned_docs/version-1/reference/spark/build-commands.md similarity index 100% rename from docs/reference/spark/build-commands.md rename to versioned_docs/version-1/reference/spark/build-commands.md diff --git a/docs/reference/spark/commands.md b/versioned_docs/version-1/reference/spark/commands.md similarity index 100% rename from docs/reference/spark/commands.md rename to versioned_docs/version-1/reference/spark/commands.md diff --git a/docs/reference/spark/common-options.md b/versioned_docs/version-1/reference/spark/common-options.md similarity index 100% rename from docs/reference/spark/common-options.md rename to versioned_docs/version-1/reference/spark/common-options.md diff --git a/docs/reference/spark/compiler-options.md b/versioned_docs/version-1/reference/spark/compiler-options.md similarity index 100% rename from docs/reference/spark/compiler-options.md rename to versioned_docs/version-1/reference/spark/compiler-options.md diff --git a/docs/reference/spark/core-build-options.md b/versioned_docs/version-1/reference/spark/core-build-options.md similarity index 100% rename from docs/reference/spark/core-build-options.md rename to versioned_docs/version-1/reference/spark/core-build-options.md diff --git a/docs/reference/spark/deploy-commands.md b/versioned_docs/version-1/reference/spark/deploy-commands.md similarity index 100% rename from docs/reference/spark/deploy-commands.md rename to versioned_docs/version-1/reference/spark/deploy-commands.md diff --git a/docs/reference/spark/evm-options.md b/versioned_docs/version-1/reference/spark/evm-options.md similarity index 100% rename from docs/reference/spark/evm-options.md rename to versioned_docs/version-1/reference/spark/evm-options.md diff --git a/docs/reference/spark/executor-options.md b/versioned_docs/version-1/reference/spark/executor-options.md similarity index 100% rename from docs/reference/spark/executor-options.md rename to versioned_docs/version-1/reference/spark/executor-options.md diff --git a/docs/reference/spark/general-commands.md b/versioned_docs/version-1/reference/spark/general-commands.md similarity index 100% rename from docs/reference/spark/general-commands.md rename to versioned_docs/version-1/reference/spark/general-commands.md diff --git a/docs/reference/spark/project-commands.md b/versioned_docs/version-1/reference/spark/project-commands.md similarity index 100% rename from docs/reference/spark/project-commands.md rename to versioned_docs/version-1/reference/spark/project-commands.md diff --git a/docs/reference/spark/project-options.md b/versioned_docs/version-1/reference/spark/project-options.md similarity index 100% rename from docs/reference/spark/project-options.md rename to versioned_docs/version-1/reference/spark/project-options.md diff --git a/docs/reference/spark/spark-bind.md b/versioned_docs/version-1/reference/spark/spark-bind.md similarity index 100% rename from docs/reference/spark/spark-bind.md rename to versioned_docs/version-1/reference/spark/spark-bind.md diff --git a/docs/reference/spark/spark-build.md b/versioned_docs/version-1/reference/spark/spark-build.md similarity index 100% rename from docs/reference/spark/spark-build.md rename to versioned_docs/version-1/reference/spark/spark-build.md diff --git a/docs/reference/spark/spark-cache-clean.md b/versioned_docs/version-1/reference/spark/spark-cache-clean.md similarity index 100% rename from docs/reference/spark/spark-cache-clean.md rename to versioned_docs/version-1/reference/spark/spark-cache-clean.md diff --git a/docs/reference/spark/spark-cache-ls.md b/versioned_docs/version-1/reference/spark/spark-cache-ls.md similarity index 100% rename from docs/reference/spark/spark-cache-ls.md rename to versioned_docs/version-1/reference/spark/spark-cache-ls.md diff --git a/docs/reference/spark/spark-cache.md b/versioned_docs/version-1/reference/spark/spark-cache.md similarity index 100% rename from docs/reference/spark/spark-cache.md rename to versioned_docs/version-1/reference/spark/spark-cache.md diff --git a/docs/reference/spark/spark-clean.md b/versioned_docs/version-1/reference/spark/spark-clean.md similarity index 100% rename from docs/reference/spark/spark-clean.md rename to versioned_docs/version-1/reference/spark/spark-clean.md diff --git a/docs/reference/spark/spark-completions.md b/versioned_docs/version-1/reference/spark/spark-completions.md similarity index 100% rename from docs/reference/spark/spark-completions.md rename to versioned_docs/version-1/reference/spark/spark-completions.md diff --git a/docs/reference/spark/spark-config.md b/versioned_docs/version-1/reference/spark/spark-config.md similarity index 100% rename from docs/reference/spark/spark-config.md rename to versioned_docs/version-1/reference/spark/spark-config.md diff --git a/docs/reference/spark/spark-coverage.md b/versioned_docs/version-1/reference/spark/spark-coverage.md similarity index 100% rename from docs/reference/spark/spark-coverage.md rename to versioned_docs/version-1/reference/spark/spark-coverage.md diff --git a/docs/reference/spark/spark-create.md b/versioned_docs/version-1/reference/spark/spark-create.md similarity index 100% rename from docs/reference/spark/spark-create.md rename to versioned_docs/version-1/reference/spark/spark-create.md diff --git a/docs/reference/spark/spark-debug.md b/versioned_docs/version-1/reference/spark/spark-debug.md similarity index 100% rename from docs/reference/spark/spark-debug.md rename to versioned_docs/version-1/reference/spark/spark-debug.md diff --git a/docs/reference/spark/spark-doc.md b/versioned_docs/version-1/reference/spark/spark-doc.md similarity index 100% rename from docs/reference/spark/spark-doc.md rename to versioned_docs/version-1/reference/spark/spark-doc.md diff --git a/docs/reference/spark/spark-flatten.md b/versioned_docs/version-1/reference/spark/spark-flatten.md similarity index 100% rename from docs/reference/spark/spark-flatten.md rename to versioned_docs/version-1/reference/spark/spark-flatten.md diff --git a/docs/reference/spark/spark-geiger.md b/versioned_docs/version-1/reference/spark/spark-geiger.md similarity index 100% rename from docs/reference/spark/spark-geiger.md rename to versioned_docs/version-1/reference/spark/spark-geiger.md diff --git a/docs/reference/spark/spark-help.md b/versioned_docs/version-1/reference/spark/spark-help.md similarity index 100% rename from docs/reference/spark/spark-help.md rename to versioned_docs/version-1/reference/spark/spark-help.md diff --git a/docs/reference/spark/spark-init.md b/versioned_docs/version-1/reference/spark/spark-init.md similarity index 100% rename from docs/reference/spark/spark-init.md rename to versioned_docs/version-1/reference/spark/spark-init.md diff --git a/docs/reference/spark/spark-inspect.md b/versioned_docs/version-1/reference/spark/spark-inspect.md similarity index 100% rename from docs/reference/spark/spark-inspect.md rename to versioned_docs/version-1/reference/spark/spark-inspect.md diff --git a/docs/reference/spark/spark-install.md b/versioned_docs/version-1/reference/spark/spark-install.md similarity index 100% rename from docs/reference/spark/spark-install.md rename to versioned_docs/version-1/reference/spark/spark-install.md diff --git a/docs/reference/spark/spark-remappings.md b/versioned_docs/version-1/reference/spark/spark-remappings.md similarity index 100% rename from docs/reference/spark/spark-remappings.md rename to versioned_docs/version-1/reference/spark/spark-remappings.md diff --git a/docs/reference/spark/spark-remove.md b/versioned_docs/version-1/reference/spark/spark-remove.md similarity index 100% rename from docs/reference/spark/spark-remove.md rename to versioned_docs/version-1/reference/spark/spark-remove.md diff --git a/docs/reference/spark/spark-script.md b/versioned_docs/version-1/reference/spark/spark-script.md similarity index 79% rename from docs/reference/spark/spark-script.md rename to versioned_docs/version-1/reference/spark/spark-script.md index 6097ebf..8743319 100644 --- a/docs/reference/spark/spark-script.md +++ b/versioned_docs/version-1/reference/spark/spark-script.md @@ -18,89 +18,89 @@ Scripts can be used to apply state transitions on live contracts, or deploy and ### OPTIONS -`--broadcast` +`--broadcast`     Broadcasts the transactions. -`--debug` +`--debug`     Open the script in the [debugger][debugger]. Takes precedence over broadcast. -`-g` -`--gas-estimate-multiplier` _multiplier_ +`-g` +`--gas-estimate-multiplier` _multiplier_     Relative percentage by which to multiply all gas estimates. (i.e. set to 200 to double them)     Default: 130 -`--json` -    Output results in JSON format. +`--json` +    Output results in JSON format.     Note: The output is under development and prone to change. -`--legacy` +`--legacy`     Use legacy transactions instead of EIP1559 ones. This is auto-enabled for common networks without EIP1559. -`--resume` +`--resume`     Resumes submitting transactions that failed or timed-out previously. -`-s` -`--sig` _signature_ -    The signature of the function you want to call in the contract, or raw calldata. +`-s` +`--sig` _signature_ +    The signature of the function you want to call in the contract, or raw calldata.     Default: `run()` -`--skip-simulation` +`--skip-simulation`     Skips on-chain simulation. -`--skip` +`--skip`     Skip compilation of non-essential contract directories like test or script (usage `--skip test`). -`--non-interactive` +`--non-interactive`     Remove interactive prompts which appear if the contract is near the [EIP-170](https://eips.ethereum.org/EIPS/eip-170) size limit. -`--slow` +`--slow`     Makes sure a transaction is sent, only after its previous one has been confirmed and succeeded. -`--target-contract` _contract_name_ +`--target-contract` _contract_name_     The name of the contract you want to run. -`--priority-gas-price` +`--priority-gas-price`     Sets the priority gas price for EIP1559 transactions. Useful for when gas prices are volatile and you want to get your transaction included. -`--with-gas-price` _price_ -    Sets the gas price for **broadcasted** legacy transactions, or the max fee for broadcasted EIP1559 transactions. +`--with-gas-price` _price_ +    Sets the gas price for **broadcasted** legacy transactions, or the max fee for broadcasted EIP1559 transactions.     Note: To set the gas price in the execution environment of the script use `--gas-price` instead (see below). #### Etherscan Options -`--chain` _chain_name_ +`--chain` _chain_name_     The Etherscan chain. -`--etherscan-api-key` _key_ -    Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan). +`--etherscan-api-key` _key_ +    Etherscan API key, or the key of an [Etherscan configuration table](../config/etherscan#etherscan).     Environment: `ETHERSCAN_API_KEY` #### Verification Options -`--verify` +`--verify`     If it finds a matching broadcast log, it tries to verify every contract found in the receipts. -`--verifier` _name_ +`--verifier` _name_     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. -`--verifier-url` _url_ -    The optional verifier url for submitting the verification request. +`--verifier-url` _url_ +    The optional verifier url for submitting the verification request.     Environment: `VERIFIER_URL` -`--delay` _delay_ +`--delay` _delay_     Optional timeout to apply in between attempts in seconds. Defaults to 3. -`--retries` _retries_ +`--retries` _retries_     Number of attempts for retrying. Defaults to 15. #### Cache Options -`--force` +`--force`     Clear the cache and artifacts folder and recompile. #### Linker Options -`--libraries` _libraries_ +`--libraries` _libraries_     Set pre-linked libraries.     The parameter must be in the format `::
`, e.g. `src/Contract.sol:Library:0x...`. @@ -109,170 +109,170 @@ Scripts can be used to apply state transitions on live contracts, or deploy and #### Compiler Options -`--optimize` +`--optimize`     Activate the Solidity optimizer. -`--optimizer-runs` _runs_ +`--optimizer-runs` _runs_     The number of optimizer runs. -`--via-ir` +`--via-ir`     Use the Yul intermediate representation compilation pipeline. -`--revert-strings` +`--revert-strings`     How to treat revert and require reason strings. -`--use` _solc_version_ +`--use` _solc_version_     Specify the solc version, or a path to a local solc, to build with.     Valid values are in the format `x.y.z`, `solc:x.y.z` or `path/to/solc`. -`--offline` +`--offline`     Do not access the network. Missing solc versions will not be installed. -`--no-auto-detect` +`--no-auto-detect`     Do not auto-detect solc. -`--ignored-error-codes` _error_codes_ +`--ignored-error-codes` _error_codes_     Ignore solc warnings by error code. The parameter is a comma-separated list of error codes. -`--extra-output` _selector_ +`--extra-output` _selector_     Extra output to include in the contract's artifact.     Example keys: `abi`, `storageLayout`, `evm.assembly`, `ewasm`, `ir`, `ir-optimized`, `metadata`.     For a full description, see the [Solidity docs][output-desc]. -`--extra-output-files` _selector_ +`--extra-output-files` _selector_     Extra output to write to separate files.     Example keys: `abi`, `storageLayout`, `evm.assembly`, `ewasm`, `ir`, `ir-optimized`, `metadata`.     For a full description, see the [Solidity docs][output-desc]. -`--evm-version` _version_ +`--evm-version` _version_     The target EVM version. [output-desc]: https://docs.soliditylang.org/en/latest/using-the-compiler.html#compiler-api #### Project Options -`--build-info` +`--build-info`     Generate build info files. -`--build-info-path` _path_ +`--build-info-path` _path_     Output path to directory that build info files will be written to. -`--root` _path_ +`--root` _path_     The project's root path. By default, this is the root directory of the current git repository, or the current working directory. -`-C` _path_ -`--contracts` _path_ -    The contracts source directory. +`-C` _path_ +`--contracts` _path_ +    The contracts source directory.     Environment: `DAPP_SRC` -`--lib-paths` _path_ +`--lib-paths` _path_     The path to the library folder. -`-R` _remappings_ -`--remappings` _remappings_ +`-R` _remappings_ +`--remappings` _remappings_     The project's remappings.     The parameter is a comma-separated list of remappings in the format `=`. -`--cache-path` _path_ +`--cache-path` _path_     The path to the compiler cache. -`--config-path` _file_ +`--config-path` _file_     Path to the config file. -`--hh` -`--hardhat` +`--hh` +`--hardhat`     This is a convenience flag, and is the same as passing `--contracts contracts --lib-paths node-modules`. -`-o` _path_ -`--out` _path_ +`-o` _path_ +`--out` _path_     The project's artifacts directory. -`--silent` +`--silent`     Suppress all output. #### Build Options -`--names` +`--names`     Print compiled contract names. -`--sizes` +`--sizes`     Print compiled non-test contract sizes, exiting with code 1 if any of them are above the size limit. #### Watch Options -`-w` [*path...*] -`--watch` [*path...*] +`-w` [*path...*] +`--watch` [*path...*]     Watch specific file(s) or folder(s).     By default, the project's source directory is watched. -`-d` _delay_ -`--delay` _delay_ +`-d` _delay_ +`--delay` _delay_     File update debounce delay. -    During the delay, incoming change events are accumulated and only once the delay has passed, is an action taken. +    During the delay, incoming change events are accumulated and only once the delay has passed, is an action taken.     Note that this does not mean a command will be started: if `--no-restart` is given and a command is already running, the outcome of the action will be to do nothing.     Defaults to 50ms. Parses as decimal seconds by default, but using an integer with the `ms` suffix may be more convenient.     When using `--poll` mode, you'll want a larger duration, or risk overloading disk I/O. -`--no-restart` +`--no-restart`     Do not restart the command while it's running. -`--run-all` +`--run-all`     Explicitly re-run the command on all files when a change is made. #### Wallet Options - Raw `-i` -`--interactives` _num_ -    Open an interactive prompt to enter your private key. Takes a value for the number of keys to enter. +`--interactives` _num_ +    Open an interactive prompt to enter your private key. Takes a value for the number of keys to enter.     Default: 0 -`--mnemonic-indexes` _indexes_ -    Use the private key from the given mnemonic index. Used with --mnemonic-path. +`--mnemonic-indexes` _indexes_ +    Use the private key from the given mnemonic index. Used with --mnemonic-path.     Default: 0 -`--mnemonic-paths` _paths_ +`--mnemonic-paths` _paths_     Use the mnemonic file at the specified path(s). -`--private-key` _raw_private_key_ +`--private-key` _raw_private_key_     Use the provided private key. -`--private-keys` _raw_private_keys_ +`--private-keys` _raw_private_keys_     Use the provided private keys. #### Wallet Options - Keystore -`--keystores` _paths_ -    Use the keystores in the given folders or files. +`--keystores` _paths_ +    Use the keystores in the given folders or files.     Environment: `ETH_KEYSTORE` -`--account` _account-name_ -    Use a keystore from the default keystores folder (~/.foxar/keystores) by its filename. +`--account` _account-name_ +    Use a keystore from the default keystores folder (~/.foxar/keystores) by its filename.     Environment: `ETH_KEYSTORE_ACCOUNT` -`--password` _passwords_ +`--password` _passwords_     The keystore passwords. Used with `--keystore`. #### Wallet Options - Hardware Wallet -`-t` -`--trezor` +`-t` +`--trezor`     Use a Trezor hardware wallet. -`-l` -`--ledger` +`-l` +`--ledger`     Use a Ledger hardware wallet. -`--hd-paths` _paths_ +`--hd-paths` _paths_     The derivation paths to use with hardware wallets. #### Wallet Options - Remote @@ -284,85 +284,85 @@ Scripts can be used to apply state transitions on live contracts, or deploy and #### EVM Options -`-f` _url_ -`--rpc-url` _url_ -`--fork-url` _url_ +`-f` _url_ +`--rpc-url` _url_ +`--fork-url` _url_     Fetch state over a remote endpoint instead of starting from an empty state.     If you want to fetch state from a specific block number, see `--fork-block-number`. -`--fork-block-number` _block_ +`--fork-block-number` _block_     Fetch state from a specific block number over a remote endpoint. See `--fork-url`. -`--fork-retry-backoff ` +`--fork-retry-backoff `      Initial retry backoff on encountering errors. -`--no-storage-caching` +`--no-storage-caching`     Explicitly disables the use of RPC caching.     All storage slots are read entirely from the endpoint. See `--fork-url`. -`-v` -`--verbosity` +`-v` +`--verbosity`     Verbosity of the EVM.     Pass multiple times to increase the verbosity (e.g. `-v`, `-vv`, `-vvv`). -    Verbosity levels: -    - 2: Print logs for all tests -    - 3: Print execution traces for failing tests -    - 4: Print execution traces for all tests, and setup traces for failing tests +    Verbosity levels: +    - 2: Print logs for all tests +    - 3: Print execution traces for failing tests +    - 4: Print execution traces for all tests, and setup traces for failing tests     - 5: Print execution and setup traces for all tests -`--sender` _address_ +`--sender` _address_     The address which will be executing tests -`--initial-balance` _balance_ +`--initial-balance` _balance_     The initial balance of deployed contracts -`--ffi` +`--ffi`     Enables the [FFI cheatcode][ffi-cheatcode] [ffi-cheatcode]: ../cheatcodes/ffi #### Executor Options -`--base-fee ` -`--block-base-fee-per-gas ` +`--base-fee ` +`--block-base-fee-per-gas `     The base fee in a block (in wei). -`--block-coinbase` _address_ +`--block-coinbase` _address_     The coinbase of the block. -`--block-difficulty` _difficulty_ +`--block-difficulty` _difficulty_     The block difficulty. -`--block-gas-limit` _gas_limit_ +`--block-gas-limit` _gas_limit_     The block gas limit. -`--block-number` _block_ +`--block-number` _block_     The block number. -`--block-timestamp` _timestamp_ +`--block-timestamp` _timestamp_     The timestamp of the block (in seconds). -`--chain-id` _chain_id_ +`--chain-id` _chain_id_     The chain ID. -`--gas-limit` _gas_limit_ +`--gas-limit` _gas_limit_     The block gas limit. -`--gas-price` _gas_price_ +`--gas-price` _gas_price_     The gas price (in wei). -`--tx-origin` _address_ +`--tx-origin` _address_     The transaction origin. #### Common Options -`-h` -`--help` +`-h` +`--help`     Prints help information. ### EXAMPLES @@ -374,7 +374,7 @@ Scripts can be used to apply state transitions on live contracts, or deploy and -vvv --fork-url $SEPOLIA_RPC_URL ``` -2. Deploy a contract on Polygon [(see scripting tutorial for an example script)](../../tutorials/solidity-scripting.md). _The verifier url is different for every network._ +2. Deploy a contract on Polygon [(see scripting tutorial for an example script)](../../tutorials/ylem-scripting.md). _The verifier url is different for every network._ ```sh spark script script/NFT.s.sol:MyScript --chain-id 137 --rpc-url $RPC_URL \ diff --git a/docs/reference/spark/spark-snapshot.md b/versioned_docs/version-1/reference/spark/spark-snapshot.md similarity index 100% rename from docs/reference/spark/spark-snapshot.md rename to versioned_docs/version-1/reference/spark/spark-snapshot.md diff --git a/docs/reference/spark/spark-test.md b/versioned_docs/version-1/reference/spark/spark-test.md similarity index 100% rename from docs/reference/spark/spark-test.md rename to versioned_docs/version-1/reference/spark/spark-test.md diff --git a/docs/reference/spark/spark-tree.md b/versioned_docs/version-1/reference/spark/spark-tree.md similarity index 100% rename from docs/reference/spark/spark-tree.md rename to versioned_docs/version-1/reference/spark/spark-tree.md diff --git a/docs/reference/spark/spark-update.md b/versioned_docs/version-1/reference/spark/spark-update.md similarity index 100% rename from docs/reference/spark/spark-update.md rename to versioned_docs/version-1/reference/spark/spark-update.md diff --git a/docs/reference/spark/spark-upload-selectors.md b/versioned_docs/version-1/reference/spark/spark-upload-selectors.md similarity index 100% rename from docs/reference/spark/spark-upload-selectors.md rename to versioned_docs/version-1/reference/spark/spark-upload-selectors.md diff --git a/docs/reference/spark/spark-verify-check.md b/versioned_docs/version-1/reference/spark/spark-verify-check.md similarity index 100% rename from docs/reference/spark/spark-verify-check.md rename to versioned_docs/version-1/reference/spark/spark-verify-check.md diff --git a/docs/reference/spark/spark-verify-contract.md b/versioned_docs/version-1/reference/spark/spark-verify-contract.md similarity index 100% rename from docs/reference/spark/spark-verify-contract.md rename to versioned_docs/version-1/reference/spark/spark-verify-contract.md diff --git a/docs/reference/spark/spark.md b/versioned_docs/version-1/reference/spark/spark.md similarity index 100% rename from docs/reference/spark/spark.md rename to versioned_docs/version-1/reference/spark/spark.md diff --git a/docs/reference/spark/test-commands.md b/versioned_docs/version-1/reference/spark/test-commands.md similarity index 100% rename from docs/reference/spark/test-commands.md rename to versioned_docs/version-1/reference/spark/test-commands.md diff --git a/docs/reference/spark/test-options.md b/versioned_docs/version-1/reference/spark/test-options.md similarity index 100% rename from docs/reference/spark/test-options.md rename to versioned_docs/version-1/reference/spark/test-options.md diff --git a/docs/reference/spark/utility-commands.md b/versioned_docs/version-1/reference/spark/utility-commands.md similarity index 100% rename from docs/reference/spark/utility-commands.md rename to versioned_docs/version-1/reference/spark/utility-commands.md diff --git a/docs/reference/spark/watch-options.md b/versioned_docs/version-1/reference/spark/watch-options.md similarity index 100% rename from docs/reference/spark/watch-options.md rename to versioned_docs/version-1/reference/spark/watch-options.md diff --git a/docs/shuttle/anvil.png b/versioned_docs/version-1/shuttle/anvil.png similarity index 100% rename from docs/shuttle/anvil.png rename to versioned_docs/version-1/shuttle/anvil.png diff --git a/docs/shuttle/shuttle-overview.md b/versioned_docs/version-1/shuttle/shuttle-overview.md similarity index 100% rename from docs/shuttle/shuttle-overview.md rename to versioned_docs/version-1/shuttle/shuttle-overview.md diff --git a/docs/spark/advanced-testing.md b/versioned_docs/version-1/spark/advanced-testing.md similarity index 100% rename from docs/spark/advanced-testing.md rename to versioned_docs/version-1/spark/advanced-testing.md diff --git a/docs/spark/cheatcodes.md b/versioned_docs/version-1/spark/cheatcodes.md similarity index 100% rename from docs/spark/cheatcodes.md rename to versioned_docs/version-1/spark/cheatcodes.md diff --git a/docs/spark/debugger.md b/versioned_docs/version-1/spark/debugger.md similarity index 100% rename from docs/spark/debugger.md rename to versioned_docs/version-1/spark/debugger.md diff --git a/docs/spark/deploying.md b/versioned_docs/version-1/spark/deploying.md similarity index 100% rename from docs/spark/deploying.md rename to versioned_docs/version-1/spark/deploying.md diff --git a/docs/spark/differential-ffi-testing.md b/versioned_docs/version-1/spark/differential-ffi-testing.md similarity index 100% rename from docs/spark/differential-ffi-testing.md rename to versioned_docs/version-1/spark/differential-ffi-testing.md diff --git a/docs/spark/fork-testing.md b/versioned_docs/version-1/spark/fork-testing.md similarity index 100% rename from docs/spark/fork-testing.md rename to versioned_docs/version-1/spark/fork-testing.md diff --git a/docs/spark/fuzz-testing.md b/versioned_docs/version-1/spark/fuzz-testing.md similarity index 100% rename from docs/spark/fuzz-testing.md rename to versioned_docs/version-1/spark/fuzz-testing.md diff --git a/docs/spark/gas-reports.md b/versioned_docs/version-1/spark/gas-reports.md similarity index 100% rename from docs/spark/gas-reports.md rename to versioned_docs/version-1/spark/gas-reports.md diff --git a/docs/spark/gas-snapshots.md b/versioned_docs/version-1/spark/gas-snapshots.md similarity index 100% rename from docs/spark/gas-snapshots.md rename to versioned_docs/version-1/spark/gas-snapshots.md diff --git a/docs/spark/gas-tracking.md b/versioned_docs/version-1/spark/gas-tracking.md similarity index 100% rename from docs/spark/gas-tracking.md rename to versioned_docs/version-1/spark/gas-tracking.md diff --git a/docs/spark/invariant-testing.md b/versioned_docs/version-1/spark/invariant-testing.md similarity index 100% rename from docs/spark/invariant-testing.md rename to versioned_docs/version-1/spark/invariant-testing.md diff --git a/docs/spark/overview-spark.md b/versioned_docs/version-1/spark/overview-spark.md similarity index 100% rename from docs/spark/overview-spark.md rename to versioned_docs/version-1/spark/overview-spark.md diff --git a/docs/spark/spark-std.md b/versioned_docs/version-1/spark/spark-std.md similarity index 99% rename from docs/spark/spark-std.md rename to versioned_docs/version-1/spark/spark-std.md index 6a2d32d..01f53c1 100644 --- a/docs/spark/spark-std.md +++ b/versioned_docs/version-1/spark/spark-std.md @@ -10,7 +10,7 @@ It provides all the essential functionality you need to get started writing test - `Vm.sol`: Up-to-date cheatcodes interface - `console.sol` and `console2.sol`: Hardhat-style logging functionality -- `Script.sol`: Basic utilities for [Solidity scripting](../tutorials/solidity-scripting) +- `Script.sol`: Basic utilities for [Solidity scripting](../tutorials/ylem-scripting) - `Test.sol`: A superset of DSTest containing standard libraries, a cheatcodes instance (`vm`), and Hardhat console Simply import `Test.sol` and inherit from `Test` in your test contract: diff --git a/docs/spark/tests.md b/versioned_docs/version-1/spark/tests.md similarity index 100% rename from docs/spark/tests.md rename to versioned_docs/version-1/spark/tests.md diff --git a/docs/spark/traces.md b/versioned_docs/version-1/spark/traces.md similarity index 100% rename from docs/spark/traces.md rename to versioned_docs/version-1/spark/traces.md diff --git a/docs/spark/writing-tests.md b/versioned_docs/version-1/spark/writing-tests.md similarity index 100% rename from docs/spark/writing-tests.md rename to versioned_docs/version-1/spark/writing-tests.md diff --git a/docs/tutorials/best-practices.md b/versioned_docs/version-1/tutorials/best-practices.md similarity index 100% rename from docs/tutorials/best-practices.md rename to versioned_docs/version-1/tutorials/best-practices.md diff --git a/docs/tutorials/create2-tutorial.md b/versioned_docs/version-1/tutorials/create2-tutorial.md similarity index 100% rename from docs/tutorials/create2-tutorial.md rename to versioned_docs/version-1/tutorials/create2-tutorial.md diff --git a/docs/tutorials/forking-mainnet-with-probe-shuttle.md b/versioned_docs/version-1/tutorials/forking-mainnet-with-probe-shuttle.md similarity index 100% rename from docs/tutorials/forking-mainnet-with-probe-shuttle.md rename to versioned_docs/version-1/tutorials/forking-mainnet-with-probe-shuttle.md diff --git a/docs/tutorials/foxar-docker.md b/versioned_docs/version-1/tutorials/foxar-docker.md similarity index 100% rename from docs/tutorials/foxar-docker.md rename to versioned_docs/version-1/tutorials/foxar-docker.md diff --git a/docs/tutorials/invariant-testing-bonding-curve.md b/versioned_docs/version-1/tutorials/invariant-testing-bonding-curve.md similarity index 100% rename from docs/tutorials/invariant-testing-bonding-curve.md rename to versioned_docs/version-1/tutorials/invariant-testing-bonding-curve.md diff --git a/docs/tutorials/learn-foxar.md b/versioned_docs/version-1/tutorials/learn-foxar.md similarity index 100% rename from docs/tutorials/learn-foxar.md rename to versioned_docs/version-1/tutorials/learn-foxar.md diff --git a/docs/tutorials/solmate-nft.md b/versioned_docs/version-1/tutorials/solmate-nft.md similarity index 99% rename from docs/tutorials/solmate-nft.md rename to versioned_docs/version-1/tutorials/solmate-nft.md index 3c57311..3f8f572 100644 --- a/docs/tutorials/solmate-nft.md +++ b/versioned_docs/version-1/tutorials/solmate-nft.md @@ -361,4 +361,4 @@ As you can see, our implementation using Solmate saves around 500 gas on a succe That's it, I hope this will give you a good practical basis of how to get started with foxar. We think there is no better way to deeply understand solidity than writing your tests in solidity. You will also experience less context switching between javascript and solidity. Happy coding! -> Note: Follow [this](./solidity-scripting.md) tutorial to learn how to deploy the NFT contract used here with solidity scripting. +> Note: Follow [this](./ylem-scripting.md) tutorial to learn how to deploy the NFT contract used here with solidity scripting. diff --git a/docs/tutorials/testing-eip712.md b/versioned_docs/version-1/tutorials/testing-eip712.md similarity index 100% rename from docs/tutorials/testing-eip712.md rename to versioned_docs/version-1/tutorials/testing-eip712.md diff --git a/docs/tutorials/solidity-scripting.md b/versioned_docs/version-1/tutorials/ylem-scripting.md similarity index 95% rename from docs/tutorials/solidity-scripting.md rename to versioned_docs/version-1/tutorials/ylem-scripting.md index 0b5b1c4..ecd1ef1 100644 --- a/docs/tutorials/solidity-scripting.md +++ b/versioned_docs/version-1/tutorials/ylem-scripting.md @@ -24,14 +24,14 @@ Given this flow, it's important to be aware that transactions whose behaviour ca Let’s try to deploy the NFT contract made in the solmate tutorial with solidity scripting. First of all, we would need to create a new Foxar project via: ```sh -spark init solidity-scripting +spark init ylem-scripting ``` Since the NFT contract from the solmate tutorial inherits both `solmate` and `OpenZeppelin` contracts, we’ll have to install them as dependencies by running: ```sh # Enter the project -cd solidity-scripting +cd ylem-scripting # Install Solmate and OpenZeppelin contracts as dependencies spark install transmissions11/solmate Openzeppelin/openzeppelin-contracts @@ -43,7 +43,7 @@ Next, we have to delete the `Counter.sol` file in the `src` folder and create an rm src/Counter.sol test/Counter.t.sol && touch src/NFT.sol && ls src ``` -![set up commands](@site/static/img/docs/solidity-scripting/set-up-commands.png) +![set up commands](@site/static/img/docs/ylem-scripting/set-up-commands.png) Once that’s done, you should open up your preferred code editor and copy the code below into the `NFT.sol` file. @@ -121,7 +121,7 @@ spark build ``` If your output looks like this, the contracts successfully compiled. -![compile successful](@site/static/img/docs/solidity-scripting/compile-successful.png) +![compile successful](@site/static/img/docs/ylem-scripting/compile-successful.png) ### Deploying our contract @@ -244,7 +244,7 @@ spark script script/NFT.s.sol:MyScript --rpc-url $SEPOLIA_RPC_URL --broadcast -- Spark is going to run our script and broadcast the transactions for us - this can take a little while, since Spark will also wait for the transaction receipts. You should see something like this after a minute or so: -![contract verified](@site/static/img/docs/solidity-scripting/contract-verified.png) +![contract verified](@site/static/img/docs/ylem-scripting/contract-verified.png) This confirms that you have successfully deployed the `NFT` contract to the Sepolia testnet and have also verified it on Etherscan, all with one command. @@ -294,4 +294,4 @@ Then run the following script: spark script script/NFT.s.sol:MyScript --fork-url http://localhost:8545 --broadcast ``` -> 💡 Note: A full implementation of this tutorial can be found [here](https://github.com/Perelyn-sama/solidity-scripting) and for further reading about solidity scripting, you can check out the `spark script` [reference](../reference/spark/spark-script.md). +> 💡 Note: A full implementation of this tutorial can be found [here](https://github.com/Perelyn-sama/ylem-scripting) and for further reading about solidity scripting, you can check out the `spark script` [reference](../reference/spark/spark-script.md). diff --git a/versioned_sidebars/version-1-sidebars.ts b/versioned_sidebars/version-1-sidebars.ts new file mode 100644 index 0000000..e0f35bd --- /dev/null +++ b/versioned_sidebars/version-1-sidebars.ts @@ -0,0 +1,1097 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ +const sidebars: SidebarsConfig = { + // By default, Docusaurus generates a sidebar from the docs folder structure + // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + + // But you can create a sidebar manually + + tutorialSidebar: [ + "intro", + { + type: "category", + label: "Getting Started", + items: ["getting-started/installation", "getting-started/first-steps"], + }, + { + type: "category", + label: "Projects", + items: [ + "projects/creating-a-new-project", + "projects/working-on-an-existing-project", + "projects/dependencies", + "projects/project-layout", + ], + }, + { + type: "category", + label: "Spark Overview", + items: [ + "spark/overview-spark", + { + type: "category", + label: "Tests", + link: { + type: "doc", + + id: "spark/tests", + }, + + items: [ + "spark/writing-tests", + "spark/cheatcodes", + "spark/spark-std", + "spark/traces", + "spark/fork-testing", + ], + }, + { + type: "category", + label: "Advanced Testing", + link: { + type: "doc", + + id: "spark/advanced-testing", + }, + + items: [ + "spark/fuzz-testing", + "spark/invariant-testing", + "spark/differential-ffi-testing", + ], + }, + "spark/deploying", + { + type: "category", + label: "Gas Tracking", + link: { + type: "doc", + + id: "spark/gas-tracking", + }, + + items: ["spark/gas-reports", "spark/gas-snapshots"], + }, + "spark/debugger", + ], + }, + { + type: "category", + label: "Probe Overview", + items: ["probe/probe-overview"], + }, + { + type: "category", + label: "Shuttle Overview", + items: ["shuttle/shuttle-overview"], + }, + { + type: "category", + label: "Pilot Overview", + items: ["pilot/pilot-overview"], + }, + { + type: "category", + label: "Configuration", + items: [ + "config/configuration", + "config/continuous-integration", + "config/vscode", + "config/shell-autocompletion", + "config/static-analyzers", + "config/hardhat", + ], + }, + { + type: "category", + label: "Tutorials", + items: [ + "tutorials/best-practices", + "tutorials/solmate-nft", + "tutorials/foxar-docker", + "tutorials/testing-eip712", + "tutorials/ylem-scripting", + "tutorials/create2-tutorial", + "tutorials/forking-mainnet-with-probe-shuttle", + "tutorials/learn-foxar", + ], + }, + { + type: "category", + label: "Appendix", + items: [ + "faq", + "contributing", + + { + type: "category", + label: "References", + link: { + type: "doc", + + id: "reference/reference", + }, + items: [ + { + type: "category", + label: "CLI Reference", + link: { + type: "doc", + + id: "reference/cli/cli-reference", + }, + items: [ + { + type: "category", + label: "spark", + link: { + type: "doc", + + id: "reference/cli/spark", + }, + items: [ + "reference/cli/spark/bind", + "reference/cli/spark/build", + { + type: "category", + label: "spark cache", + link: { + type: "doc", + + id: "reference/cli/spark/cache", + }, + items: [ + "reference/cli/spark/cache/clean", + "reference/cli/spark/cache/ls", + ], + }, + "reference/cli/spark/clean", + "reference/cli/spark/completions", + "reference/cli/spark/config", + "reference/cli/spark/coverage", + "reference/cli/spark/create", + "reference/cli/spark/debug", + "reference/cli/spark/doc", + "reference/cli/spark/flatten", + "reference/cli/spark/fmt", + "reference/cli/spark/geiger", + { + type: "category", + label: "spark generate", + link: { + type: "doc", + + id: "reference/cli/spark/generate", + }, + items: ["reference/cli/spark/generate/test"], + }, + "reference/cli/spark/generate-fig-spec", + "reference/cli/spark/init", + "reference/cli/spark/inspect", + "reference/cli/spark/install", + "reference/cli/spark/remappings", + "reference/cli/spark/remove", + "reference/cli/spark/script", + { + type: "category", + label: "spark selectors", + link: { + type: "doc", + + id: "reference/cli/spark/selectors", + }, + items: [ + "reference/cli/spark/selectors/collision", + "reference/cli/spark/selectors/upload", + "reference/cli/spark/selectors/list", + ], + }, + "reference/cli/spark/snapshot", + "reference/cli/spark/test", + "reference/cli/spark/tree", + "reference/cli/spark/update", + "reference/cli/spark/verify-check", + "reference/cli/spark/verify-contract", + ], + }, + { + type: "category", + label: "probe", + link: { + type: "doc", + + id: "reference/cli/probe", + }, + items: [ + "reference/cli/probe/4byte", + "reference/cli/probe/4byte-decode", + "reference/cli/probe/4byte-event", + "reference/cli/probe/abi-decode", + "reference/cli/probe/abi-encode", + "reference/cli/probe/access-list", + "reference/cli/probe/address-zero", + "reference/cli/probe/admin", + "reference/cli/probe/age", + "reference/cli/probe/balance", + "reference/cli/probe/base-fee", + "reference/cli/probe/bind", + "reference/cli/probe/block", + "reference/cli/probe/block-number", + "reference/cli/probe/call", + "reference/cli/probe/call/--create", + "reference/cli/probe/calldata", + "reference/cli/probe/calldata-decode", + "reference/cli/probe/chain", + "reference/cli/probe/chain-id", + "reference/cli/probe/client", + "reference/cli/probe/code", + "reference/cli/probe/codesize", + "reference/cli/probe/completions", + "reference/cli/probe/compute-address", + "reference/cli/probe/concat-hex", + "reference/cli/probe/create2", + "reference/cli/probe/decode-transaction", + "reference/cli/probe/disassemble", + { + type: "category", + label: "probe estimate", + link: { + type: "doc", + + id: "reference/cli/probe/estimate", + }, + items: ["reference/cli/probe/estimate/--create"], + }, + "reference/cli/probe/etherscan-source", + "reference/cli/probe/format-bytes32-string", + "reference/cli/probe/find-block", + "reference/cli/probe/from-bin", + "reference/cli/probe/from-fixed-point", + "reference/cli/probe/from-rlp", + "reference/cli/probe/from-utf8", + "reference/cli/probe/from-wei", + "reference/cli/probe/gas-price", + "reference/cli/probe/generate-fig-spec", + "reference/cli/probe/hash-zero", + "reference/cli/probe/implementation", + "reference/cli/probe/index", + "reference/cli/probe/interface", + "reference/cli/probe/keccak", + "reference/cli/probe/logs", + "reference/cli/probe/lookup-address", + "reference/cli/probe/max-int", + "reference/cli/probe/max-uint", + "reference/cli/probe/min-int", + "reference/cli/probe/namehash", + "reference/cli/probe/nonce", + "reference/cli/probe/parse-bytes32-address", + "reference/cli/probe/parse-bytes32-string", + "reference/cli/probe/pretty-calldata", + "reference/cli/probe/proof", + "reference/cli/probe/publish", + "reference/cli/probe/receipt", + "reference/cli/probe/resolve-name", + "reference/cli/probe/rpc", + "reference/cli/probe/run", + "reference/cli/probe/selectors", + + { + type: "category", + label: "probe send", + link: { + type: "doc", + + id: "reference/cli/probe/send", + }, + items: ["reference/cli/probe/send/--create"], + }, + "reference/cli/probe/shl", + "reference/cli/probe/shr", + "reference/cli/probe/sig", + "reference/cli/probe/sig-event", + "reference/cli/probe/storage", + "reference/cli/probe/to-ascii", + "reference/cli/probe/to-base", + "reference/cli/probe/to-bytes32", + "reference/cli/probe/to-check-sum-address", + "reference/cli/probe/to-dec", + "reference/cli/probe/to-fixed-point", + "reference/cli/probe/to-hex", + "reference/cli/probe/to-hexdata", + "reference/cli/probe/to-int256", + "reference/cli/probe/to-rlp", + "reference/cli/probe/to-uint256", + "reference/cli/probe/to-unit", + "reference/cli/probe/to-wei", + "reference/cli/probe/tx", + "reference/cli/probe/upload-signature", + + { + type: "category", + label: "probe wallet", + link: { + type: "doc", + + id: "reference/cli/probe/wallet", + }, + items: [ + "reference/cli/probe/wallet/new", + "reference/cli/probe/wallet/new-mnemonic", + "reference/cli/probe/wallet/vanity", + "reference/cli/probe/wallet/address", + "reference/cli/probe/wallet/sign", + + "reference/cli/probe/wallet/verify", + "reference/cli/probe/wallet/import", + "reference/cli/probe/wallet/list", + "reference/cli/probe/wallet/derive-private-key", + ], + }, + ], + }, + { + type: "category", + label: "shuttle", + link: { + type: "doc", + + id: "reference/cli/shuttle", + }, + items: [ + "reference/cli/shuttle/completions", + "reference/cli/shuttle/generate-fig-spec", + ], + }, + { + type: "category", + label: "pilot", + link: { + type: "doc", + + id: "reference/cli/pilot", + }, + items: [ + "reference/cli/pilot/list", + "reference/cli/pilot/load", + "reference/cli/pilot/view", + "reference/cli/pilot/clear-cache", + ], + }, + ], + }, + { + type: "category", + label: "Spark Commands", + link: { + type: "doc", + + id: "reference/spark/commands", + }, + items: [ + { + type: "category", + label: "General Commands", + link: { + type: "doc", + + id: "reference/spark/general-commands", + }, + items: [ + "reference/spark/spark", + "reference/spark/spark-help", + "reference/spark/spark-completions", + ], + }, + { + type: "category", + label: "Project Commands", + link: { + type: "doc", + + id: "reference/spark/project-commands", + }, + items: [ + "reference/spark/spark-init", + "reference/spark/spark-install", + "reference/spark/spark-update", + "reference/spark/spark-remove", + "reference/spark/spark-config", + "reference/spark/spark-remappings", + "reference/spark/spark-tree", + "reference/spark/spark-geiger", + ], + }, + { + type: "category", + label: "Build Commands", + link: { + type: "doc", + + id: "reference/spark/build-commands", + }, + items: [ + "reference/spark/spark-build", + "reference/spark/spark-clean", + "reference/spark/spark-inspect", + ], + }, + { + type: "category", + label: "Test Commands", + link: { + type: "doc", + + id: "reference/spark/test-commands", + }, + items: [ + "reference/spark/spark-test", + "reference/spark/spark-snapshot", + "reference/spark/spark-coverage", + ], + }, + { + type: "category", + label: "Deploy Commands", + link: { + type: "doc", + + id: "reference/spark/deploy-commands", + }, + items: [ + "reference/spark/spark-create", + "reference/spark/spark-verify-contract", + "reference/spark/spark-verify-check", + "reference/spark/spark-flatten", + ], + }, + { + type: "category", + label: "Utility Commands", + link: { + type: "doc", + + id: "reference/spark/utility-commands", + }, + items: [ + "reference/spark/spark-debug", + "reference/spark/spark-bind", + "reference/spark/spark-cache", + "reference/spark/spark-cache-clean", + "reference/spark/spark-cache-ls", + "reference/spark/spark-script", + "reference/spark/spark-upload-selectors", + "reference/spark/spark-doc", + ], + }, + ], + }, + { + type: "category", + label: "Probe Commands", + link: { + type: "doc", + + id: "reference/probe/probe-commands", + }, + items: [ + { + type: "category", + label: "General Commands", + link: { + type: "doc", + + id: "reference/probe/general-commands", + }, + items: [ + "reference/probe/probe", + "reference/probe/probe-help", + "reference/probe/probe-completions", + ], + }, + { + type: "category", + label: "Chain Commands", + link: { + type: "doc", + + id: "reference/probe/chain-commands", + }, + items: [ + "reference/probe/probe-chain-id", + "reference/probe/probe-chain", + "reference/probe/probe-client", + ], + }, + { + type: "category", + label: "Transaction Commands", + link: { + type: "doc", + + id: "reference/probe/transaction-commands", + }, + items: [ + "reference/probe/probe-publish", + "reference/probe/probe-receipt", + "reference/probe/probe-send", + "reference/probe/probe-call", + "reference/probe/probe-rpc", + "reference/probe/probe-tx", + "reference/probe/probe-run", + "reference/probe/probe-estimate", + "reference/probe/probe-access-list", + "reference/probe/probe-logs", + ], + }, + { + type: "category", + label: "Block Commands", + link: { + type: "doc", + + id: "reference/probe/block-commands", + }, + items: [ + "reference/probe/probe-find-block", + "reference/probe/probe-gas-price", + "reference/probe/probe-block-number", + "reference/probe/probe-basefee", + "reference/probe/probe-block", + "reference/probe/probe-age", + ], + }, + { + type: "category", + label: "Account Commands", + link: { + type: "doc", + + id: "reference/probe/account-commands", + }, + items: [ + "reference/probe/probe-balance", + "reference/probe/probe-storage", + "reference/probe/probe-proof", + "reference/probe/probe-nonce", + "reference/probe/probe-code", + "reference/probe/probe-codesize", + ], + }, + { + type: "category", + label: "ENS Commands", + link: { + type: "doc", + + id: "reference/probe/ens-commands", + }, + items: [ + "reference/probe/probe-lookup-address", + "reference/probe/probe-resolve-name", + "reference/probe/probe-namehash", + ], + }, + { + type: "category", + label: "Etherscan Commands", + link: { + type: "doc", + + id: "reference/probe/etherscan-commands", + }, + items: ["reference/probe/probe-etherscan-source"], + }, + { + type: "category", + label: "ABI Commands", + link: { + type: "doc", + + id: "reference/probe/abi-commands", + }, + items: [ + "reference/probe/probe-abi-decode", + "reference/probe/probe-abi-encode", + "reference/probe/probe-4byte", + "reference/probe/probe-4byte-decode", + "reference/probe/probe-4byte-event", + "reference/probe/probe-calldata", + "reference/probe/probe-calldata-decode", + "reference/probe/probe-pretty-calldata", + "reference/probe/probe-selectors", + "reference/probe/probe-upload-signature", + ], + }, + { + type: "category", + label: "Conversion Commands", + link: { + type: "doc", + + id: "reference/probe/conversion-commands", + }, + items: [ + "reference/probe/probe-format-bytes32-string", + "reference/probe/probe-from-bin", + "reference/probe/probe-from-fixed-point", + "reference/probe/probe-from-rlp", + "reference/probe/probe-from-utf8", + "reference/probe/probe-from-wei", + "reference/probe/probe-parse-bytes32-address", + "reference/probe/probe-parse-bytes32-string", + "reference/probe/probe-to-ascii", + "reference/probe/probe-to-base", + "reference/probe/probe-to-bytes32", + "reference/probe/probe-to-dec", + "reference/probe/probe-to-fixed-point", + "reference/probe/probe-to-hex", + "reference/probe/probe-to-hexdata", + "reference/probe/probe-to-int256", + "reference/probe/probe-to-rlp", + "reference/probe/probe-to-uint256", + "reference/probe/probe-to-unit", + "reference/probe/probe-to-wei", + "reference/probe/probe-shl", + "reference/probe/probe-shr", + ], + }, + { + type: "category", + label: "Utility Commands", + link: { + type: "doc", + + id: "reference/probe/utility-commands", + }, + items: [ + "reference/probe/probe-sig", + "reference/probe/probe-sig-event", + "reference/probe/probe-keccak", + "reference/probe/probe-compute-address", + "reference/probe/probe-create2", + "reference/probe/probe-interface", + "reference/probe/probe-index", + "reference/probe/probe-concat-hex", + "reference/probe/probe-max-int", + "reference/probe/probe-min-int", + "reference/probe/probe-max-uint", + "reference/probe/probe-to-check-sum-address", + ], + }, + { + type: "category", + label: "Wallet Commands", + link: { + type: "doc", + + id: "reference/probe/wallet-commands", + }, + items: [ + "reference/probe/probe-wallet", + "reference/probe/probe-wallet-new", + "reference/probe/probe-wallet-new-mnemonic", + "reference/probe/probe-wallet-address", + "reference/probe/probe-wallet-sign", + "reference/probe/probe-wallet-vanity", + "reference/probe/probe-wallet-verify", + "reference/probe/probe-wallet-import", + "reference/probe/probe-wallet-list", + ], + }, + ], + }, + { + type: "category", + label: "Shuttle Reference", + link: { + type: "doc", + + id: "reference/shuttle/shuttle-reference", + }, + items: [], + }, + { + type: "category", + label: "Pilot Reference", + link: { + type: "doc", + + id: "reference/pilot/pilot-reference", + }, + items: [], + }, + { + type: "category", + label: "Config Reference", + link: { + type: "doc", + + id: "reference/config/config-reference", + }, + items: [ + "reference/config/overview", + "reference/config/project", + "reference/config/solidity-compiler", + "reference/config/testing", + "reference/config/inline-test-config", + "reference/config/formatter", + "reference/config/doc-generator", + "reference/config/etherscan", + ], + }, + { + type: "category", + label: "Cheatcodes Reference", + link: { + type: "doc", + + id: "reference/cheatcodes/cheatcodes-reference", + }, + items: [ + { + type: "category", + label: "Environment", + link: { + type: "doc", + + id: "reference/cheatcodes/environment", + }, + items: [ + "reference/cheatcodes/warp", + "reference/cheatcodes/roll", + "reference/cheatcodes/fee", + "reference/cheatcodes/get-block-timestamp", + "reference/cheatcodes/get-block-number", + "reference/cheatcodes/difficulty", + "reference/cheatcodes/prevrandao", + "reference/cheatcodes/chain-id", + "reference/cheatcodes/store", + "reference/cheatcodes/load", + "reference/cheatcodes/etch", + "reference/cheatcodes/deal", + "reference/cheatcodes/prank", + "reference/cheatcodes/start-prank", + "reference/cheatcodes/stop-prank", + "reference/cheatcodes/read-callers", + "reference/cheatcodes/record", + "reference/cheatcodes/accesses", + "reference/cheatcodes/prank", + "reference/cheatcodes/record-logs", + "reference/cheatcodes/get-recorded-logs", + "reference/cheatcodes/set-nonce", + "reference/cheatcodes/get-nonce", + "reference/cheatcodes/mock-call", + "reference/cheatcodes/mock-call-revert", + "reference/cheatcodes/clear-mocked-calls", + "reference/cheatcodes/coinbase", + "reference/cheatcodes/broadcast", + "reference/cheatcodes/start-broadcast", + "reference/cheatcodes/stop-broadcast", + "reference/cheatcodes/pause-gas-metering", + "reference/cheatcodes/resume-gas-metering", + "reference/cheatcodes/tx-gas-price", + "reference/cheatcodes/start-state-diff-recording", + "reference/cheatcodes/stop-and-return-state-diff", + ], + }, + { + type: "category", + label: "Assertions", + link: { + type: "doc", + + id: "reference/cheatcodes/assertions", + }, + items: [ + "reference/cheatcodes/expect-revert", + "reference/cheatcodes/expect-emit", + "reference/cheatcodes/expect-call", + ], + }, + { + type: "category", + label: "Fuzzer", + link: { + type: "doc", + + id: "reference/cheatcodes/fuzzer", + }, + items: ["reference/cheatcodes/assume"], + }, + { + type: "category", + label: "Forking", + link: { + type: "doc", + + id: "reference/cheatcodes/forking", + }, + items: [ + "reference/cheatcodes/create-fork", + "reference/cheatcodes/select-fork", + "reference/cheatcodes/create-select-fork", + "reference/cheatcodes/active-fork", + "reference/cheatcodes/roll-fork", + "reference/cheatcodes/make-persistent", + "reference/cheatcodes/revoke-persistent", + "reference/cheatcodes/is-persistent", + "reference/cheatcodes/allow-cheatcodes", + "reference/cheatcodes/transact", + ], + }, + { + type: "category", + label: "External", + link: { + type: "doc", + + id: "reference/cheatcodes/external", + }, + items: [ + "reference/cheatcodes/ffi", + "reference/cheatcodes/project-root", + "reference/cheatcodes/get-code", + "reference/cheatcodes/get-deployed-code", + "reference/cheatcodes/sleep", + "reference/cheatcodes/unix-time", + "reference/cheatcodes/set-env", + "reference/cheatcodes/env-or", + "reference/cheatcodes/env-bool", + "reference/cheatcodes/env-uint", + "reference/cheatcodes/env-int", + "reference/cheatcodes/env-address", + "reference/cheatcodes/env-bytes32", + "reference/cheatcodes/env-string", + "reference/cheatcodes/env-bytes", + "reference/cheatcodes/parse-json", + "reference/cheatcodes/key-exists", + "reference/cheatcodes/parse-json-keys", + "reference/cheatcodes/serialize-json", + "reference/cheatcodes/write-json", + ], + }, + { + type: "category", + label: "Utilities", + link: { + type: "doc", + + id: "reference/cheatcodes/utilities", + }, + items: [ + "reference/cheatcodes/addr", + "reference/cheatcodes/sign", + "reference/cheatcodes/skip", + "reference/cheatcodes/label", + "reference/cheatcodes/get-label", + "reference/cheatcodes/derive-key", + "reference/cheatcodes/parse-bytes", + "reference/cheatcodes/parse-address", + "reference/cheatcodes/parse-uint", + "reference/cheatcodes/parse-int", + "reference/cheatcodes/parse-bytes32", + "reference/cheatcodes/parse-bool", + "reference/cheatcodes/remember-key", + "reference/cheatcodes/to-string", + "reference/cheatcodes/breakpoint", + "reference/cheatcodes/create-wallet", + ], + }, + { + type: "category", + label: "Snapshots", + link: { + type: "doc", + + id: "reference/cheatcodes/snapshots", + }, + items: [], + }, + { + type: "category", + label: "RPC", + link: { + type: "doc", + + id: "reference/cheatcodes/rpc", + }, + items: [], + }, + { + type: "category", + label: "Files", + link: { + type: "doc", + + id: "reference/cheatcodes/fs", + }, + items: [], + }, + ], + }, + { + type: "category", + label: "Spark Standard Library Reference", + link: { + type: "doc", + + id: "reference/spark-std/spark-standart", + }, + items: [ + "reference/spark-std/std-logs", + { + type: "category", + label: "Std Assertions", + link: { + type: "doc", + + id: "reference/spark-std/std-assertions", + }, + items: [ + "reference/spark-std/fail", + "reference/spark-std/assertFalse", + "reference/spark-std/assertEq", + "reference/spark-std/assertApproxEqAbs", + "reference/spark-std/assertApproxEqRel", + ], + }, + { + type: "category", + label: "Std Cheats", + link: { + type: "doc", + + id: "reference/spark-std/std-cheats", + }, + items: [ + "reference/spark-std/skip", + "reference/spark-std/rewind", + "reference/spark-std/hoax", + "reference/spark-std/startHoax", + "reference/spark-std/deal", + "reference/spark-std/deployCode", + "reference/spark-std/deployCodeTo", + "reference/spark-std/bound", + "reference/spark-std/change-prank", + "reference/spark-std/make-addr", + "reference/spark-std/make-addr-and-key", + "reference/spark-std/noGasMetering", + "reference/spark-std/assume-no-precompiles", + "reference/spark-std/assume-payable", + ], + }, + { + type: "category", + label: "Std Errors", + link: { + type: "doc", + + id: "reference/spark-std/std-errors", + }, + items: [ + "reference/spark-std/assertionError", + "reference/spark-std/arithmeticError", + "reference/spark-std/divisionError", + "reference/spark-std/enumConversionError", + "reference/spark-std/encodeStorageError", + "reference/spark-std/popError", + "reference/spark-std/indexOOBError", + "reference/spark-std/memOverflowError", + "reference/spark-std/zeroVarError", + ], + }, + { + type: "category", + label: "Std Storage", + link: { + type: "doc", + + id: "reference/spark-std/std-storage", + }, + items: [ + "reference/spark-std/target", + "reference/spark-std/sig", + "reference/spark-std/with_key", + "reference/spark-std/depth", + "reference/spark-std/checked_write", + "reference/spark-std/find", + "reference/spark-std/read", + ], + }, + { + type: "category", + label: "Std Math", + link: { + type: "doc", + + id: "reference/spark-std/std-math", + }, + items: [ + "reference/spark-std/abs", + "reference/spark-std/delta", + "reference/spark-std/percentDelta", + ], + }, + { + type: "category", + label: "Script Utils", + link: { + type: "doc", + + id: "reference/spark-std/script-utils", + }, + items: [ + "reference/spark-std/compute-create-address", + "reference/spark-std/derive-remember-key", + ], + }, + { + type: "category", + label: "Console Logging", + link: { + type: "doc", + + id: "reference/spark-std/console-log", + }, + items: [], + }, + ], + }, + { + type: "category", + label: "DSTest Reference", + link: { + type: "doc", + + id: "reference/ds-test", + }, + items: [], + }, + ], + }, + { + type: "category", + label: "Miscellaneous", + link: { + type: "doc", + + id: "misc/miscellaneous", + }, + items: ["misc/struct-encoding", "misc/precompile-registry"], + }, + ], + }, + ], +}; + +export default sidebars; diff --git a/versions.json b/versions.json index 41b42e6..c65301e 100644 --- a/versions.json +++ b/versions.json @@ -1,3 +1,3 @@ [ - + "1" ]