Skip to content

Commit

Permalink
add audit report (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eikix authored Sep 26, 2024
1 parent e3c517c commit 6d12bcb
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .trunk/trunk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ lint:
enabled:
- [email protected]
- git-diff-check
- markdownlint@0.41.0
- markdownlint@0.42.0
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- [email protected]
- [email protected].2
- [email protected].5
actions:
disabled:
- trunk-announce
Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/_category_.json
Original file line number Diff line number Diff line change
@@ -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"
}
}
14 changes: 10 additions & 4 deletions docs/architecture/cairo-precompiles.md
Original file line number Diff line number Diff line change
@@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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`
Expand Down
18 changes: 18 additions & 0 deletions docs/architecture/security.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 6d12bcb

Please sign in to comment.