Wake

Wake - development, testing, and static analysis framework for Solidity

Type object
File match **/*wake.toml **/*.wake.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/wake/latest.json
Source https://raw.githubusercontent.com/Ackee-Blockchain/wake/refs/heads/main/docs/wake-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

subconfigs string[]

List of paths to additional config files to load

api_keys Record<string, string>

API keys for various services

compiler object
1 nested properties
solc object

Default configuration for Solidity files not belonging to a subproject

9 nested properties
allow_paths string[]

Additional allowed paths for solc --allow-paths

evm_version string

Version of the EVM to compile for

Values: "homestead" "tangerineWhistle" "spuriousDragon" "byzantium" "constantinople" "petersburg" "istanbul" "berlin" "london" "paris" "shanghai" "cancun" "prague" "osaka"
exclude_paths string[]

Files in these paths are excluded from compilation unless imported from non-excluded file

Default:
[
  "node_modules",
  "venv",
  ".venv",
  "lib",
  "script",
  "test"
]
include_paths string[]

Paths to search for direct (non-relative) imports

Default:
[
  "node_modules"
]
optimizer object
3 nested properties
enabled boolean
runs integer
Default: 200
min=1
details object
remappings string[]
target_version string

Target Solidity version for all files

pattern=^\d+\.\d+\.\d+$
via_IR boolean

Use new IR-based compiler pipeline

metadata object
3 nested properties
append_CBOR boolean
use_literal_content boolean
bytecode_hash string
Values: "none" "ipfs" "bzzr1"
lsp object

Configuration for the Language Server Protocol features

5 nested properties
compilation_delay number

Delay to wait after a file content change before recompiling

Default: 0
min=0
code_lens object

Configuration for LSP code lens features

2 nested properties
enable boolean

Show code lenses

Default: true
sort_tag_priority string[]

Order of code lens with the same start and end position

Default:
[
  "lsp-references",
  "lsp-selectors",
  "lsp-inheritance-graph",
  "lsp-linearized-inheritance-graph"
]
detectors object
1 nested properties
enable boolean

Run detectors in LSP

Default: true
inlay_hints object

Configuration for LSP inlay hints

2 nested properties
enable boolean

Show inlay hints

Default: true
sort_tag_priority string[]

Priority order for inlay hint types

Default:
[]
find_references object
1 nested properties
include_declarations boolean

Include declarations in the results

Default: false
testing object

Configuration for testing

4 nested properties
cmd string

Which development chain to use for testing

Default: "anvil"
Values: "anvil" "ganache" "hardhat"
anvil object
1 nested properties
cmd_args string

Arguments for the Anvil command

Default: "--prune-history 100 --transaction-block-keeper 10 --steps-tracing --silent"
ganache object
1 nested properties
cmd_args string

Arguments for the Ganache command

Default: "-k istanbul -q"
hardhat object
1 nested properties
cmd_args string

Arguments for the Hardhat command

Default: ""
deployment object

Configuration for deployment

2 nested properties
confirm_transactions boolean

Require confirmation for each transaction

Default: true
silent boolean

Do not require confirmation for each transaction and do not print transaction status

Default: false
detectors object

Configuration for detectors

4 nested properties
exclude string[]

Names of detectors that should not be loaded

Default:
[]
only string[]

Names of detectors that should only be loaded

ignore_paths string[]

Detections in these paths must be ignored under all circumstances. Useful for ignoring detections in Solidity test files

Default:
[
  "venv",
  ".venv",
  "test"
]
exclude_paths string[]

Detections in these paths are ignored unless linked to a (sub)detection in a non-excluded path. Useful for ignoring detections in dependencies

Default:
[
  "node_modules",
  "lib",
  "script"
]
printers object

Configuration for printers

2 nested properties
exclude string[]

Names of printers that should not be loaded

Default:
[]
only string[]

Names of printers that should only be loaded

detector Record<string, object>

Namespace for detector-specific config options. Each property should be named after the detector name and hold an object with string keys matching the Click option names

printer Record<string, object>

Namespace for printer-specific config options. Each property should be named after the printer name and hold an object with string keys matching the Click option names

general object
3 nested properties
call_trace_options string[]

Information to show in call traces

Default:
[
  "contract_name",
  "function_name",
  "named_arguments",
  "status",
  "call_type",
  "value",
  "return_value",
  "error",
  "events"
]
json_rpc_timeout number

Timeout applied to JSON-RPC requests

Default: 15
min=0
link_format string

Format of links used in detectors and printers

Default: "vscode://file/{path}:{line}:{col}"
generator object

Unstable, may change in the future

5 nested properties
control_flow_graph object
2 nested properties
direction string

Graph direction: TB (top-bottom), BT (bottom-top), LR (left-right), RL (right-left)

Default: "TB"
Values: "TB" "BT" "LR" "RL"
vscode_urls boolean

Generate VSCode-compatible URLs in graph output

Default: true
imports_graph object
3 nested properties
direction string

Graph direction: TB (top-bottom), BT (bottom-top), LR (left-right), RL (right-left)

Default: "TB"
Values: "TB" "BT" "LR" "RL"
imports_direction string

Direction of import arrows in the graph

Default: "imported-to-importing"
Values: "imported-to-importing" "importing-to-imported"
vscode_urls boolean

Generate VSCode-compatible URLs in graph output

Default: true
inheritance_graph object
2 nested properties
direction string

Graph direction: TB (top-bottom), BT (bottom-top), LR (left-right), RL (right-left)

Default: "BT"
Values: "TB" "BT" "LR" "RL"
vscode_urls boolean

Generate VSCode-compatible URLs in graph output

Default: true
inheritance_graph_full object
2 nested properties
direction string

Graph direction: TB (top-bottom), BT (bottom-top), LR (left-right), RL (right-left)

Default: "BT"
Values: "TB" "BT" "LR" "RL"
vscode_urls boolean

Generate VSCode-compatible URLs in graph output

Default: true
linearized_inheritance_graph object
2 nested properties
direction string

Graph direction: TB (top-bottom), BT (bottom-top), LR (left-right), RL (right-left)

Default: "LR"
Values: "TB" "BT" "LR" "RL"
vscode_urls boolean

Generate VSCode-compatible URLs in graph output

Default: true
subproject Record<string, object>

Configuration for subdirectories requiring different compiler settings than the default