sui_replay/displays/
transaction_displays.rs

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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use crate::displays::Pretty;
use crate::replay::LocalExec;
use move_core_types::annotated_value::{MoveTypeLayout, MoveValue};
use move_core_types::language_storage::TypeTag;
use std::fmt::{Display, Formatter};
use std::sync::Arc;
use sui_execution::Executor;
use sui_types::execution::ExecutionResult;
use sui_types::object::bounded_visitor::BoundedVisitor;
use sui_types::transaction::CallArg::Pure;
use sui_types::transaction::{
    write_sep, Argument, CallArg, Command, ObjectArg, ProgrammableMoveCall, ProgrammableTransaction,
};
use tabled::{
    builder::Builder as TableBuilder,
    settings::{style::HorizontalLine, Panel as TablePanel, Style as TableStyle},
};

pub struct FullPTB {
    pub ptb: ProgrammableTransaction,
    pub results: Vec<ResolvedResults>,
}

pub struct ResolvedResults {
    pub mutable_reference_outputs: Vec<(Argument, MoveValue)>,
    pub return_values: Vec<MoveValue>,
}

/// These Display implementations provide alternate displays that are used to format info contained
/// in these Structs when calling the CLI replay command with an additional provided flag.
impl Display for Pretty<'_, FullPTB> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Pretty(full_ptb) = self;
        let FullPTB { ptb, results } = full_ptb;

        let ProgrammableTransaction { inputs, commands } = ptb;

        // write input objects section
        if !inputs.is_empty() {
            let mut builder = TableBuilder::default();
            for (i, input) in inputs.iter().enumerate() {
                match input {
                    Pure(v) => {
                        if v.len() <= 16 {
                            builder.push_record(vec![format!("{i:<3} Pure Arg          {:?}", v)]);
                        } else {
                            builder.push_record(vec![format!(
                            "{i:<3} Pure Arg          [{}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, ...]",
                            v[0],
                            v[1],
                            v[2],
                            v[3],
                            v[4],
                            v[5],
                            v[6],
                            v[7],
                            v[8],
                            v[9],
                            v[10],
                            v[11],
                            v[12],
                            v[13],
                            v[14],
                        )]);
                        }
                    }

                    CallArg::Object(ObjectArg::ImmOrOwnedObject(o)) => {
                        builder.push_record(vec![format!("{i:<3} Imm/Owned Object  ID: {}", o.0)]);
                    }
                    CallArg::Object(ObjectArg::SharedObject { id, .. }) => {
                        builder.push_record(vec![format!("{i:<3} Shared Object     ID: {}", id)]);
                    }
                    CallArg::Object(ObjectArg::Receiving(o)) => {
                        builder.push_record(vec![format!("{i:<3} Receiving Object  ID: {}", o.0)]);
                    }
                };
            }

            let mut table = builder.build();
            table.with(TablePanel::header("Input Objects"));
            table.with(TableStyle::rounded().horizontals([HorizontalLine::new(
                1,
                TableStyle::modern().get_horizontal(),
            )]));
            write!(f, "\n{}\n", table)?;
        } else {
            write!(f, "\n  No input objects for this transaction")?;
        }

        // write command results section
        if !results.is_empty() {
            write!(f, "\n\n")?;
        }
        for (i, result) in results.iter().enumerate() {
            if i == results.len() - 1 {
                write!(
                    f,
                    "╭───────────────────╮\n│ Command {i:<2} Output │\n╰───────────────────╯{}\n\n\n",
                    Pretty(result)
                )?
            } else {
                write!(
                    f,
                    "╭───────────────────╮\n│ Command {i:<2} Output │\n╰───────────────────╯{}\n",
                    Pretty(result)
                )?
            }
        }

        // write ptb functions section
        let mut builder = TableBuilder::default();
        if !commands.is_empty() {
            for (i, c) in commands.iter().enumerate() {
                if i == commands.len() - 1 {
                    builder.push_record(vec![format!("{i:<2} {}", Pretty(c))]);
                } else {
                    builder.push_record(vec![format!("{i:<2} {}\n", Pretty(c))]);
                }
            }

            let mut table = builder.build();
            table.with(TablePanel::header("Commands"));
            table.with(TableStyle::rounded().horizontals([HorizontalLine::new(
                1,
                TableStyle::modern().get_horizontal(),
            )]));
            write!(f, "\n{}\n", table)?;
        } else {
            write!(f, "\n  No commands for this transaction")?;
        }

        Ok(())
    }
}

impl Display for Pretty<'_, Command> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Pretty(command) = self;
        match command {
            Command::MoveCall(p) => {
                write!(f, "{}", Pretty(&**p))
            }
            Command::MakeMoveVec(ty_opt, elems) => {
                write!(f, "MakeMoveVec:\n ┌")?;
                if let Some(ty) = ty_opt {
                    write!(f, "\n │ Type Tag: {ty}")?;
                }
                write!(f, "\n │ Arguments:\n │   ")?;
                write_sep(f, elems.iter().map(Pretty), "\n │   ")?;
                write!(f, "\n └")
            }
            Command::TransferObjects(objs, addr) => {
                write!(f, "TransferObjects:\n ┌\n │ Arguments: \n │   ")?;
                write_sep(f, objs.iter().map(Pretty), "\n │   ")?;
                write!(f, "\n │ Address: {}\n └", Pretty(addr))
            }
            Command::SplitCoins(coin, amounts) => {
                write!(
                    f,
                    "SplitCoins:\n ┌\n │ Coin: {}\n │ Amounts: \n │   ",
                    Pretty(coin)
                )?;
                write_sep(f, amounts.iter().map(Pretty), "\n │   ")?;
                write!(f, "\n └")
            }
            Command::MergeCoins(target, coins) => {
                write!(
                    f,
                    "MergeCoins:\n ┌\n │ Target: {}\n │ Coins: \n │   ",
                    Pretty(target)
                )?;
                write_sep(f, coins.iter().map(Pretty), "\n │   ")?;
                write!(f, "\n └")
            }
            Command::Publish(_bytes, deps) => {
                write!(f, "Publish:\n ┌\n │ Dependencies: \n │   ")?;
                write_sep(f, deps, "\n │   ")?;
                write!(f, "\n └")
            }
            Command::Upgrade(_bytes, deps, current_package_id, ticket) => {
                write!(f, "Upgrade:\n ┌\n │ Dependencies: \n │   ")?;
                write_sep(f, deps, "\n │   ")?;
                write!(f, "\n │ Current Package ID: {current_package_id}")?;
                write!(f, "\n │ Ticket: {}", Pretty(ticket))?;
                write!(f, "\n └")
            }
        }
    }
}

impl Display for Pretty<'_, ProgrammableMoveCall> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Pretty(move_call) = self;
        let ProgrammableMoveCall {
            package,
            module,
            function,
            type_arguments,
            arguments,
        } = move_call;

        write!(
            f,
            "MoveCall:\n ┌\n │ Function:  {} \n │ Module:    {}\n │ Package:   {}",
            function, module, package
        )?;

        if !type_arguments.is_empty() {
            write!(f, "\n │ Type Arguments: \n │   ")?;
            write_sep(f, type_arguments, "\n │   ")?;
        }
        if !arguments.is_empty() {
            write!(f, "\n │ Arguments: \n │   ")?;
            write_sep(f, arguments.iter().map(Pretty), "\n │   ")?;
        }

        write!(f, "\n └")
    }
}

impl Display for Pretty<'_, Argument> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Pretty(argument) = self;

        let output = match argument {
            Argument::GasCoin => "GasCoin".to_string(),
            Argument::Input(i) => format!("Input  {}", i),
            Argument::Result(i) => format!("Result {}", i),
            Argument::NestedResult(j, k) => format!("Result {}: {}", j, k),
        };
        write!(f, "{}", output)
    }
}
impl Display for Pretty<'_, ResolvedResults> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Pretty(ResolvedResults {
            mutable_reference_outputs,
            return_values,
        }) = self;

        let len_m_ref = mutable_reference_outputs.len();
        let len_ret_vals = return_values.len();

        if len_ret_vals > 0 {
            write!(f, "\n Return Values:\n ──────────────")?;
        }

        for (i, value) in return_values.iter().enumerate() {
            write!(f, "\n • Result {i:<2} ")?;
            write!(f, "\n{:#}\n", value)?;
        }

        if len_m_ref > 0 {
            write!(
                f,
                "\n Mutable Reference Outputs:\n ──────────────────────────"
            )?;
        }

        for (arg, value) in mutable_reference_outputs {
            write!(f, "\n • {} ", arg)?;
            write!(f, "\n{:#}\n", value)?;
        }

        if len_ret_vals == 0 && len_m_ref == 0 {
            write!(f, "\n No return values")?;
        }

        Ok(())
    }
}

impl Display for Pretty<'_, TypeTag> {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let Pretty(type_tag) = self;
        match type_tag {
            TypeTag::Vector(v) => {
                write!(f, "Vector of {}", Pretty(&**v))
            }
            TypeTag::Struct(s) => {
                write!(f, "{}::{}", s.module, s.name)
            }
            _ => {
                write!(f, "{}", type_tag)
            }
        }
    }
}

fn resolve_to_layout(
    type_tag: &TypeTag,
    executor: &Arc<dyn Executor + Send + Sync>,
    store_factory: &LocalExec,
) -> MoveTypeLayout {
    match type_tag {
        TypeTag::Vector(inner) => {
            MoveTypeLayout::Vector(Box::from(resolve_to_layout(inner, executor, store_factory)))
        }
        TypeTag::Struct(inner) => {
            let mut layout_resolver = executor.type_layout_resolver(Box::new(store_factory));
            layout_resolver
                .get_annotated_layout(inner)
                .unwrap()
                .into_layout()
        }
        TypeTag::Bool => MoveTypeLayout::Bool,
        TypeTag::U8 => MoveTypeLayout::U8,
        TypeTag::U64 => MoveTypeLayout::U64,
        TypeTag::U128 => MoveTypeLayout::U128,
        TypeTag::Address => MoveTypeLayout::Address,
        TypeTag::Signer => MoveTypeLayout::Signer,
        TypeTag::U16 => MoveTypeLayout::U16,
        TypeTag::U32 => MoveTypeLayout::U32,
        TypeTag::U256 => MoveTypeLayout::U256,
    }
}

fn resolve_value(
    bytes: &[u8],
    type_tag: &TypeTag,
    executor: &Arc<dyn Executor + Send + Sync>,
    store_factory: &LocalExec,
) -> anyhow::Result<MoveValue> {
    let layout = resolve_to_layout(type_tag, executor, store_factory);
    BoundedVisitor::deserialize_value(bytes, &layout)
}

pub fn transform_command_results_to_annotated(
    executor: &Arc<dyn Executor + Send + Sync>,
    store_factory: &LocalExec,
    results: Vec<ExecutionResult>,
) -> anyhow::Result<Vec<ResolvedResults>> {
    let mut output = Vec::new();
    for (m_refs, return_vals) in results.iter() {
        let mut m_refs_out = Vec::new();
        let mut return_vals_out = Vec::new();
        for (arg, bytes, tag) in m_refs {
            m_refs_out.push((*arg, resolve_value(bytes, tag, executor, store_factory)?));
        }
        for (bytes, tag) in return_vals {
            return_vals_out.push(resolve_value(bytes, tag, executor, store_factory)?);
        }
        output.push(ResolvedResults {
            mutable_reference_outputs: m_refs_out,
            return_values: return_vals_out,
        });
    }
    Ok(output)
}