zephyr_sdk/
ledger_meta.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
354
355
356
357
358
359
360
361
362
use sha2::{Digest, Sha256};
use soroban_sdk::xdr::{
    ContractEvent, ContractEventBody, FeeBumpTransactionInnerTx, GeneralizedTransactionSet, Hash,
    LedgerCloseMeta, LedgerEntry, LedgerEntryChange, LedgerKey, Limits, ScBytes, ScVal,
    Transaction, TransactionEnvelope, TransactionMeta, TransactionPhase, TransactionResultMeta,
    TransactionResultResult, TransactionSignaturePayload,
    TransactionSignaturePayloadTaggedTransaction, TxSetComponent, VecM, WriteXdr,
};

use crate::EnvClient;

/// Represents all of the entry changes that happened in the
/// ledger close.
#[derive(Clone)]
#[allow(missing_docs)]
pub struct EntryChanges {
    pub state: Vec<LedgerEntry>,
    pub removed: Vec<LedgerKey>,
    pub updated: Vec<LedgerEntry>,
    pub created: Vec<LedgerEntry>,
}

/// Ledger meta reader.
///
/// Aids developers in dealing with raw XDR structures.
///
pub struct MetaReader<'a>(&'a soroban_sdk::xdr::LedgerCloseMeta);

#[allow(missing_docs)]
impl<'a> MetaReader<'a> {
    pub fn new(meta: &'a LedgerCloseMeta) -> Self {
        Self(meta)
    }

    pub fn newtork_id(&self) -> [u8; 32] {
        let env = EnvClient::empty();
        let ScVal::Bytes(ScBytes(val)) = env.to_scval(env.soroban().ledger().network_id()) else {
            panic!()
        };
        val.try_into().unwrap()
    }

    pub fn txhash_by_transaction(&self, tx_envelope: &TransactionEnvelope) -> [u8; 32] {
        let network = self.newtork_id();
        let tagged = match tx_envelope {
            TransactionEnvelope::Tx(v1) => {
                let tx = v1.tx.clone();
                TransactionSignaturePayloadTaggedTransaction::Tx(tx.clone())
            }
            TransactionEnvelope::TxFeeBump(feebump) => {
                TransactionSignaturePayloadTaggedTransaction::TxFeeBump(feebump.tx.clone())
            }
            _ => panic!(),
        };

        let payload = TransactionSignaturePayload {
            network_id: Hash(network),
            tagged_transaction: tagged,
        };

        let mut hasher = Sha256::new();
        hasher.update(payload.to_xdr(Limits::none()).unwrap());
        let result: [u8; 32] = hasher.finalize().into();
        result
    }

    pub fn ledger_sequence(&self) -> u32 {
        match &self.0 {
            LedgerCloseMeta::V1(v1) => v1.ledger_header.header.ledger_seq,
            LedgerCloseMeta::V0(v0) => v0.ledger_header.header.ledger_seq,
        }
    }

    pub fn ledger_timestamp(&self) -> u64 {
        match &self.0 {
            LedgerCloseMeta::V1(v1) => v1.ledger_header.header.scp_value.close_time.0,
            LedgerCloseMeta::V0(v0) => v0.ledger_header.header.scp_value.close_time.0,
        }
    }

    // todo: add handles for other entries.

    pub fn envelopes(&self) -> Vec<TransactionEnvelope> {
        match &self.0 {
            LedgerCloseMeta::V0(v0) => v0.tx_set.txs.to_vec(),
            LedgerCloseMeta::V1(v1) => {
                let phases = match &v1.tx_set {
                    GeneralizedTransactionSet::V1(v1) => &v1.phases,
                };

                let mut envelopes = Vec::new();

                for phase in phases.iter() {
                    match phase {
                        TransactionPhase::V0(v0) => {
                            for txset_component in v0.iter() {
                                match txset_component {
                                    TxSetComponent::TxsetCompTxsMaybeDiscountedFee(
                                        txset_maybe_discounted_fee,
                                    ) => {
                                        for tx_envelope in txset_maybe_discounted_fee.txs.to_vec() {
                                            envelopes.push(tx_envelope)
                                        }
                                    }
                                }
                            }
                        }
                    }
                }

                envelopes
            }
        }
    }

    pub fn envelopes_with_meta(&self) -> Vec<(TransactionEnvelope, TransactionResultMeta)> {
        let mut composed = Vec::new();
        let processing = self.tx_processing();

        match &self.0 {
            LedgerCloseMeta::V0(_) => (), // todo
            LedgerCloseMeta::V1(v1) => {
                let phases = match &v1.tx_set {
                    GeneralizedTransactionSet::V1(v1) => &v1.phases,
                };

                for phase in phases.iter() {
                    match phase {
                        TransactionPhase::V0(v0) => {
                            for txset_component in v0.iter() {
                                match txset_component {
                                    TxSetComponent::TxsetCompTxsMaybeDiscountedFee(
                                        txset_maybe_discounted_fee,
                                    ) => {
                                        for (idx, tx_envelope) in
                                            txset_maybe_discounted_fee.txs.iter().enumerate()
                                        {
                                            let txhash = self.txhash_by_transaction(tx_envelope);

                                            let mut tprocessing = None;
                                            for meta in processing.clone() {
                                                if meta.result.transaction_hash.0 == txhash {
                                                    tprocessing = Some(meta)
                                                }
                                            }
                                            composed.push((
                                                tx_envelope.clone(),
                                                tprocessing
                                                    .unwrap_or(processing[idx].clone())
                                                    .clone(),
                                            ))
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        };

        composed
    }

    pub fn tx_processing(&self) -> Vec<TransactionResultMeta> {
        match &self.0 {
            LedgerCloseMeta::V1(v1) => v1.tx_processing.to_vec(),
            LedgerCloseMeta::V0(v0) => v0.tx_processing.to_vec(),
        }
    }

    pub fn v1_success_ledger_entries(&self) -> EntryChanges {
        let mut state_entries = Vec::new();
        let mut removed_entries = Vec::new();
        let mut updated_entries = Vec::new();
        let mut created_entries = Vec::new();

        match &self.0 {
            LedgerCloseMeta::V0(_) => (),
            LedgerCloseMeta::V1(v1) => {
                for tx_processing in v1.tx_processing.iter() {
                    let result = &tx_processing.result.result.result;
                    let success = match result {
                        TransactionResultResult::TxSuccess(_) => true,
                        TransactionResultResult::TxFeeBumpInnerSuccess(_) => true,
                        _ => false,
                    };

                    if success {
                        match &tx_processing.tx_apply_processing {
                            TransactionMeta::V3(meta) => {
                                let ops = &meta.operations;

                                for operation in ops.clone().into_vec() {
                                    for change in operation.changes.0.iter() {
                                        match &change {
                                            LedgerEntryChange::State(state) => {
                                                state_entries.push(state.clone())
                                            }
                                            LedgerEntryChange::Created(created) => {
                                                created_entries.push(created.clone())
                                            }
                                            LedgerEntryChange::Updated(updated) => {
                                                updated_entries.push(updated.clone())
                                            }
                                            LedgerEntryChange::Removed(removed) => {
                                                removed_entries.push(removed.clone())
                                            }
                                        };
                                    }
                                }
                            }
                            _ => (),
                        }
                    }
                }
            }
        };

        EntryChanges {
            state: state_entries,
            removed: removed_entries,
            updated: updated_entries,
            created: created_entries,
        }
    }

    pub fn v1_ledger_entries(&self) -> EntryChanges {
        let mut state_entries = Vec::new();
        let mut removed_entries = Vec::new();
        let mut updated_entries = Vec::new();
        let mut created_entries = Vec::new();

        match &self.0 {
            LedgerCloseMeta::V0(_) => (),
            LedgerCloseMeta::V1(v1) => {
                for tx_processing in v1.tx_processing.iter() {
                    match &tx_processing.tx_apply_processing {
                        TransactionMeta::V3(meta) => {
                            let ops = &meta.operations;

                            for operation in ops.clone().into_vec() {
                                for change in operation.changes.0.iter() {
                                    match &change {
                                        LedgerEntryChange::State(state) => {
                                            state_entries.push(state.clone())
                                        }
                                        LedgerEntryChange::Created(created) => {
                                            created_entries.push(created.clone())
                                        }
                                        LedgerEntryChange::Updated(updated) => {
                                            updated_entries.push(updated.clone())
                                        }
                                        LedgerEntryChange::Removed(removed) => {
                                            removed_entries.push(removed.clone())
                                        }
                                    };
                                }
                            }
                        }
                        _ => (),
                    }
                }
            }
        };

        EntryChanges {
            state: state_entries,
            removed: removed_entries,
            updated: updated_entries,
            created: created_entries,
        }
    }

    pub fn soroban_events(&self) -> Vec<ContractEvent> {
        let mut events = Vec::new();

        for result in self.tx_processing() {
            if let TransactionMeta::V3(v3) = &result.tx_apply_processing {
                if let Some(soroban) = &v3.soroban_meta {
                    for event in soroban.events.iter() {
                        events.push(event.clone())
                    }
                }
            }
        }

        events
    }

    pub fn pretty(&self) -> PrettyMetaReader {
        PrettyMetaReader { inner: self }
    }
}

/// Pretty representation of a Soroban event.
#[derive(Clone, Debug)]
pub struct PrettyContractEvent {
    /// Event xdr that derived this object.
    pub raw: ContractEvent,

    /// Contract address that emitted the event.
    pub contract: [u8; 32],

    /// Contract event topics.
    pub topics: VecM<ScVal>,

    /// Contract event data
    pub data: ScVal,
}

impl From<ContractEvent> for PrettyContractEvent {
    fn from(value: ContractEvent) -> Self {
        let ContractEventBody::V0(event) = &value.body;

        Self {
            contract: value.contract_id.as_ref().unwrap().0,
            topics: event.topics.clone(),
            data: event.data.clone(),
            raw: value,
        }
    }
}
pub struct PrettyMetaReader<'a> {
    inner: &'a MetaReader<'a>,
}

impl<'a> PrettyMetaReader<'a> {
    pub fn soroban_events(&self) -> Vec<PrettyContractEvent> {
        let mut events = Vec::new();

        for result in self.inner.tx_processing() {
            if let TransactionMeta::V3(v3) = &result.tx_apply_processing {
                if let Some(soroban) = &v3.soroban_meta {
                    for event in soroban.events.iter() {
                        events.push(event.clone().into())
                    }
                }
            }
        }

        events
    }

    pub fn soroban_events_and_txhash(&self) -> Vec<(PrettyContractEvent, [u8; 32])> {
        let mut events = Vec::new();

        for result in self.inner.tx_processing() {
            let txhash = result.result.transaction_hash.0;

            if let TransactionMeta::V3(v3) = &result.tx_apply_processing {
                if let Some(soroban) = &v3.soroban_meta {
                    for event in soroban.events.iter() {
                        events.push((event.clone().into(), txhash))
                    }
                }
            }
        }

        events
    }
}