Skip to content

Commit d9a7018

Browse files
committed
Update readme
1 parent 8e7bba1 commit d9a7018

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,19 @@
22

33
A cargo subcommand to build Rust contracts to PolkaVM bytecode.
44

5+
This tool scaffolds Rust contract projects from Solidity interface files (`.sol`). It automates:
6+
- Function selector generation
7+
- Input/output encoding and decoding (ABI)
8+
59
This tool is designed for building smart contracts in Rust using the low-level API provided by [pallet-revive-uapi](https://docs.rs/pallet-revive-uapi/latest/pallet_revive_uapi/). For a more high-level, user-friendly API, see [Ink!](https://use.ink/).
610

11+
## Contract Generation
12+
13+
Contracts can be generated using two approaches:
14+
15+
- **High-level API**: Uses the `sol!` macro with automatic struct generation for type-safe contract development
16+
- **Low-level API**: Provides more manual control over the contract implementation
17+
718
To learn more, visit the [Rust Contract Template](https://github.com/paritytech/rust-contract-template).
819

920
## Installation

0 commit comments

Comments
 (0)