candid-extractor
| Crates.io | candid-extractor |
| lib.rs | candid-extractor |
| version | 0.1.6 |
| created_at | 2023-09-18 16:38:25.861576+00 |
| updated_at | 2025-03-10 14:53:54.509026+00 |
| description | A CLI tool to extract the Candid interface from a Canister WASM. |
| homepage | |
| repository | https://github.com/dfinity/candid-extractor |
| max_upload_size | |
| id | 976095 |
| size | 63,066 |
sdk (github:dfinity:sdk)
documentation
README
candid-extractor
A CLI tool to extract the Candid interface from a Canister WASM.
Installation
cargo install candid-extractor
You can also use cargo-binstall if it's available.
cargo binstall candid-extractor
Usage
candid-extractor path/to/canister.wasm
The Candid interface will be printed to stdout.
Prerequisites for Canisters
candid-extractor can extract the Candid interface if the Canister meets the following requirements:
- Exports a memory named "memory".
- Exports a function named "get_candid_pointer", which returns an index within the "memory".
- If "memory" is 32-bit, the function should return an
i32. - If "memory" is 64-bit, the function should return an
i64.
- If "memory" is 32-bit, the function should return an
- The Candid interface should be encoded in UTF-8 and stored in "memory" starting from the returned index.
- A "NUL terminator" (byte 0x00) should be added at the end of the data if additional content exists after it in "memory".