Skip to content

Commit e794b6f

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

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ 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+
> The **v1.1** release of OpenVM contained a **critical security vulnerability** and should **not be used**.
10+
>
11+
> Only use versions **v1.2 or later**. If you are using v1.1, please upgrade immediately.
12+
13+
714
## Installation
815

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

1926
```solidity
20-
import { IOpenVmHalo2Verifier } from "openvm-solidity-sdk/v1.1/interfaces/IOpenVmHalo2Verifier.sol";
27+
import { IOpenVmHalo2Verifier } from "openvm-solidity-sdk/v1.2/interfaces/IOpenVmHalo2Verifier.sol";
2128
2229
contract MyContract {
2330
function myFunction() public view {
@@ -34,7 +41,7 @@ contract MyContract {
3441
If you want to deploy your own instance of the verifier contract, you can use `forge create`:
3542

3643
```bash
37-
forge create src/v1.1/OpenVmHalo2Verifier.sol:OpenVmHalo2Verifier --rpc-url $RPC --private-key $PRIVATE_KEY --broadcast
44+
forge create src/v1.2/OpenVmHalo2Verifier.sol:OpenVmHalo2Verifier --rpc-url $RPC --private-key $PRIVATE_KEY --broadcast
3845
```
3946

4047
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)