Skip to content

Commit 3d93f8e

Browse files
committed
feat: release v1.2
1 parent f3d9d8d commit 3d93f8e

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ This repository contains OpenVM verifier contracts generated from official relea
44

55
The contracts are built on every _minor_ release as OpenVM guarantees verifier backward compatibility across patch releases.
66

7+
## ⚠️ Security Notice
8+
9+
> **Do not use version v1.1 of this SDK.**
10+
>
11+
> The `v1.1` release contains a **critical security vulnerability** and must **not be used under any circumstances**.
12+
>
13+
> Please use **v1.2 or later**. If you're currently using `v1.1`, upgrade immediately.
14+
15+
716
## Installation
817

918
To install `openvm-solidity-sdk` as a dependency in your forge project, run the following:
@@ -17,7 +26,7 @@ forge install openvm-org/openvm-solidity-sdk
1726
If you are using a deployed instance of the verifier contract, then you can import the interfaces in your contract directly.
1827

1928
```solidity
20-
import { IOpenVmHalo2Verifier } from "openvm-solidity-sdk/v1.1/interfaces/IOpenVmHalo2Verifier.sol";
29+
import { IOpenVmHalo2Verifier } from "openvm-solidity-sdk/v1.2/interfaces/IOpenVmHalo2Verifier.sol";
2130
2231
contract MyContract {
2332
function myFunction() public view {
@@ -34,7 +43,7 @@ contract MyContract {
3443
If you want to deploy your own instance of the verifier contract, you can use `forge create`:
3544

3645
```bash
37-
forge create src/v1.1/OpenVmHalo2Verifier.sol:OpenVmHalo2Verifier --rpc-url $RPC --private-key $PRIVATE_KEY --broadcast
46+
forge create src/v1.2/OpenVmHalo2Verifier.sol:OpenVmHalo2Verifier --rpc-url $RPC --private-key $PRIVATE_KEY --broadcast
3847
```
3948

4049
If you want to import the verifier contract into your own repository for testing purposes, note that it is locked to Solidity version `0.8.19`. If your project uses a different version, the import may not compile. As a workaround, you can compile the contract separately and use `vm.etch()` to inject the raw bytecode into your tests.

0 commit comments

Comments
 (0)