miden-objtool 0.9.2

Common utilities for analyzing Miden artifacts
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# `miden-objtool`

Provides the `miden-objtool` CLI to analyze compilation artifacts.

## Compatibility

The compilation artifacts to be examined must have been produced by a `midenup` toolchain version compatible with the `compiler` version used to build `miden-objtool`. Otherwise you may run into errors like `unsupported version`.

## Installation

Running `cargo make install-miden-objtool` from the repository root installs the `miden-objtool` binary globally via the cargo bin directory. Alternatively, `cargo make install` installs multiple tools, including `miden-objtool`.

Once installed, `miden-objtool` can be executed with:

```sh
miden-objtool decorators ./mypkg.masp
```

# Commands

## `decorators`

Note that this computes sizes in memory and does *not* write packages stripped of decorators to disk.

**Example usage**

```sh
miden-objtool decorators ./mypkg.masp

Package kind: library
Artifact: library

Metric                 KB   Delta  Delta %
original masp       36.65       -        -
original forest     36.13    0.00   +0.00%
without decorators  17.95  -18.19  -50.33%
compacted forest    13.10  -23.03  -63.74%
```

**Help**

```sh
miden-objtool decorators --help

Compare serialized MAST forest sizes after stripping decorators

Usage: miden-objtool decorators <PATH>

Arguments:
  <PATH>  Path to the input .masp file

Options:
  -h, --help  Print help
```