diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml index bb28241..fe6ec61 100644 --- a/.trunk/trunk.yaml +++ b/.trunk/trunk.yaml @@ -19,13 +19,13 @@ lint: enabled: - checkov@3.2.255 - git-diff-check - - markdownlint@0.41.0 + - markdownlint@0.42.0 - osv-scanner@1.8.5 - oxipng@9.1.2 - prettier@3.3.3 - svgo@3.3.2 - trivy@0.55.2 - - trufflehog@3.82.2 + - trufflehog@3.82.5 actions: disabled: - trunk-announce diff --git a/docs/architecture/_category_.json b/docs/architecture/_category_.json index 10a232f..76f5dd5 100644 --- a/docs/architecture/_category_.json +++ b/docs/architecture/_category_.json @@ -1,8 +1,8 @@ { - "label": "Architecture Deep Dive", + "label": "Technical Deep Dive", "position": 4, "link": { "type": "generated-index", - "description": "Deep Dive into all the concepts associated with Kakarot ZK-EVM: from what is a ZK-EVM to how it works under the hood" + "description": "Deep Dive into all the concepts associated with Kakarot: from what is a provable EVM to how it works under the hood" } } diff --git a/docs/architecture/cairo-precompiles.md b/docs/architecture/cairo-precompiles.md index 0f6a324..a180563 100644 --- a/docs/architecture/cairo-precompiles.md +++ b/docs/architecture/cairo-precompiles.md @@ -1,4 +1,9 @@ -# Precompiles +--- +title: Starknet MultiVM - EVM precompiles +sidebar_position: 3 +--- + +## Precompiles Precompiles are predefined smart contracts with unique addresses that provide specific functionality. Instead of being executed at the EVM bytecode level, @@ -14,7 +19,7 @@ provides L2-specific precompiles. These L2-specific precompiles have methods that smart contracts can call in a way similar to calling Solidity functions. One of these precompiles is the _Cairo Precompile_. -# Cairo Precompile +## Cairo Precompile Kakarot ZK-EVM being a Starknet appchain, it is possible to run Cairo Contracts on Kakarot. The address `75001` is reserved for the "Cairo precompile", that @@ -70,8 +75,9 @@ library CairoLib { ``` -It contains two functions, `callContract` and `staticcallContract`, that allow the user to call a Cairo contract or class deployed on -the Starknet appchain. The method takes three arguments: +It contains two functions, `callContract` and `staticcallContract`, that allow +the user to call a Cairo contract or class deployed on the Starknet appchain. +The method takes three arguments: - `contractAddress` : The address of the Cairo contract to call - `functionSelector`: The selector of the function to call, as the `sn_keccak` diff --git a/docs/architecture/security.md b/docs/architecture/security.md new file mode 100644 index 0000000..7a35ca3 --- /dev/null +++ b/docs/architecture/security.md @@ -0,0 +1,18 @@ +--- +title: Security +sidebar_position: 4 +--- + +## Private Audit + +Kakarot has been audited by +[Zellic](https://github.com/kkrt-labs/kakarot/blob/main/audits/Kakarot%20EVM%20-%20Zellic%20Audit%20Report.pdf) +in Q3 2024. + +## Competitive Audit + +Kakarot has organized with Code4rena a competitive audit in Q4 2024. + +## Bug Bounties + +Kakarot will have open bug bounties starting Q4 2024.