Skip to content

Commit

Permalink
vm: Add Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
moCello committed Dec 28, 2024
1 parent d2b44ad commit df203e4
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions vm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,31 @@
[![Repository](https://img.shields.io/badge/github-rusk--abi-blueviolet?logo=github)](https://github.com/dusk-network/dusk-vm)
[![Documentation](https://img.shields.io/badge/docs-rusk--abi-blue?logo=rust)](https://docs.rs/dusk-vm/)

## Dusk VM
# Dusk VM

The VM to execute smart contracts on the Dusk network.
The Dusk VM is a virtual machine designed for **Dusk**, enabling secure and efficient execution of smart contracts, state transitions, and cryptographic operations tailored for zero-knowledge-based applications.

It serves as the execution engine of the Dusk Blockchain, leveraging advanced cryptographic primitives and frameworks to support privacy-preserving, compliant and scalable decentralized applications.

## Features

- **State Management**: Manage blockchain state using sessions for isolated transaction execution and finalization.
- **Cryptographic Support**: Offers built-in support for hashing (Poseidon), signature verification (BLS, Schnorr), and proof validation (PLONK, Groth16).
- **Virtual Machine for zk-SNARK Applications**: Optimized for privacy-preserving computations.

## Installation

Add `dusk-vm` to your `Cargo.toml`:

```toml
[dependencies]
dusk-vm = "0.x" # Replace with the latest version
```

## Documentation

For detailed usage and API examples, refer to the [crate documentation on docs.rs](https://docs.rs/dusk-vm/).

## License

License: MPL-2.0

0 comments on commit df203e4

Please sign in to comment.