Skip to content

Commit

Permalink
Merge pull request #921 from o1-labs/docs/secure-zkapps
Browse files Browse the repository at this point in the history
Security and zkApps
  • Loading branch information
mitschabaude authored May 16, 2024
2 parents a863b2b + c36f227 commit 1ac0e70
Show file tree
Hide file tree
Showing 3 changed files with 398 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/zkapps/o1js/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function knowsPreimage(preimage: Field) {
}

const expectedHash =
Field(0x1d444102d9e8da6d566467defcc446e8c1c3a3616d059facadbfd674afbc37ecn);
0x1d444102d9e8da6d566467defcc446e8c1c3a3616d059facadbfd674afbc37ecn;
```

In a zkApp, this code can be used to prove that you know a secret value whose hash is publicly known without revealing the secret.
Expand All @@ -57,3 +57,12 @@ o1js is a general-purpose zk framework that gives you the tools to create zk pro
All of the o1js framework is packaged as a single TypeScript library that can be used in major web browsers and Node.js. The best way to get started with o1js is [using the zkApp CLI](/zkapps/writing-a-zkapp/introduction-to-zkapps/how-to-write-a-zkapp). You can also install o1js from npm with `npm i o1js`.

Start your o1js journey by learning about [basic zk programming concepts](/zkapps/o1js/basic-concepts).

## Audits of o1js

* **Third-party audit (Q1/Q2 2024)**. An audit by an external security firm is ongoing and on track to complete in Q2 2024. Results will be shared when available.

* [**Internal audit (Q1 2024)**](https://github.com/o1-labs/o1js/files/15192821/Internal.o1js.audit.Q1.2024.pdf). In March 2024, the o1js team spent roughly two person-weeks to conduct an internal audit of parts of the o1js code base. The audit focused on reviewing core provable code. A number of issues were found and fixed.

Please see our page on [Security and zkApps](/zkapps/writing-a-zkapp/introduction-to-zkapps/secure-zkapps) for more information on ensuring your zkApp is secure.

Loading

0 comments on commit 1ac0e70

Please sign in to comment.