ckb-test-chain-utils 1.1.0

Provide several functions used for testing
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
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

#![allow(dead_code)]
#![allow(missing_docs)]
use crate::MockStore;
use crate::{always_success_cell, load_input_data_hash_cell, load_input_one_byte_cell};
use ckb_chain_spec::consensus::Consensus;
use ckb_dao::DaoCalculator;
use ckb_store::ChainStore;
use ckb_types::prelude::*;
use ckb_types::{
    bytes::Bytes,
    core::{
        Capacity, HeaderView, TransactionBuilder, TransactionView, capacity_bytes,
        cell::{OverlayCellProvider, TransactionsProvider, resolve_transaction},
    },
    packed::{self, Byte32, CellDep, CellInput, CellOutputBuilder, OutPoint},
};
use std::collections::HashSet;

const MIN_CAP: Capacity = capacity_bytes!(60);

pub fn create_always_success_tx() -> TransactionView {
    let (always_success_cell, always_success_cell_data, script) = always_success_cell();
    TransactionBuilder::default()
        .witness(script.clone().into_witness())
        .input(CellInput::new(OutPoint::null(), 0))
        .output(always_success_cell.clone())
        .output_data(always_success_cell_data)
        .build()
}

pub fn create_load_input_data_hash_cell_tx() -> TransactionView {
    let (load_input_data_hash_cell_cell, load_input_data_hash_cell_data, script) =
        load_input_data_hash_cell();
    TransactionBuilder::default()
        .witness(script.clone().into_witness())
        .input(CellInput::new(OutPoint::null(), 0))
        .output(load_input_data_hash_cell_cell.clone())
        .output_data(load_input_data_hash_cell_data)
        .build()
}

pub fn create_load_input_one_byte_cell_tx() -> TransactionView {
    let (load_input_one_byte_cell, load_input_one_byte_cell_data, script) =
        load_input_one_byte_cell();
    TransactionBuilder::default()
        .witness(script.clone().into_witness())
        .input(CellInput::new(OutPoint::null(), 0))
        .output(load_input_one_byte_cell.clone())
        .output_data(load_input_one_byte_cell_data)
        .build()
}

pub fn create_load_input_data_hash_cell_out_point() -> OutPoint {
    OutPoint::new(create_load_input_data_hash_cell_tx().hash(), 0)
}

pub fn create_load_input_one_byte_out_point() -> OutPoint {
    OutPoint::new(create_load_input_one_byte_cell_tx().hash(), 0)
}

// NOTE: this is quite a waste of resource but the alternative is to modify 100+
// invocations, let's stick to this way till this becomes a real problem
pub fn create_always_success_out_point() -> OutPoint {
    OutPoint::new(create_always_success_tx().hash(), 0)
}

pub fn calculate_reward(store: &MockStore, consensus: &Consensus, parent: &HeaderView) -> Capacity {
    let number = parent.number() + 1;
    let target_number = consensus.finalize_target(number).unwrap();
    let target_hash = store.store().get_block_hash(target_number).unwrap();
    let target = store.store().get_block_header(&target_hash).unwrap();
    let data_loader = store.store().borrow_as_data_loader();
    let calculator = DaoCalculator::new(consensus, &data_loader);
    calculator
        .primary_block_reward(&target)
        .unwrap()
        .safe_add(calculator.secondary_block_reward(&target).unwrap())
        .unwrap()
}

#[allow(clippy::int_plus_one)]
pub fn create_cellbase(
    store: &MockStore,
    consensus: &Consensus,
    parent: &HeaderView,
) -> TransactionView {
    let (_, _, always_success_script) = always_success_cell();
    let capacity = calculate_reward(store, consensus, parent);
    let builder = TransactionBuilder::default()
        .input(CellInput::new_cellbase_input(parent.number() + 1))
        .witness(always_success_script.clone().into_witness());

    if (parent.number() + 1) <= consensus.finalization_delay_length() {
        builder.build()
    } else {
        builder
            .output(
                CellOutputBuilder::default()
                    .capacity(capacity)
                    .lock(always_success_script.clone())
                    .build(),
            )
            .output_data(Bytes::new())
            .build()
    }
}

// more flexible mock function for make non-full-dead-cell test case
pub fn create_multi_outputs_transaction(
    parent: &TransactionView,
    indices: Vec<usize>,
    output_len: usize,
    data: Vec<u8>,
) -> TransactionView {
    let (_, _, always_success_script) = always_success_cell();
    let always_success_out_point = create_always_success_out_point();

    let parent_outputs = parent.outputs();
    let total_capacity = indices
        .iter()
        .map(|i| {
            let capacity: Capacity = parent_outputs.get(*i).unwrap().capacity().into();
            capacity
        })
        .try_fold(Capacity::zero(), Capacity::safe_add)
        .unwrap();

    let output_capacity = Capacity::shannons(total_capacity.as_u64() / output_len as u64);
    let reminder = Capacity::shannons(total_capacity.as_u64() % output_len as u64);

    assert!(output_capacity > MIN_CAP);
    let data = Bytes::from(data);

    let outputs = (0..output_len).map(|i| {
        let capacity = if i == output_len - 1 {
            output_capacity.safe_add(reminder).unwrap()
        } else {
            output_capacity
        };
        CellOutputBuilder::default()
            .capacity(capacity)
            .lock(always_success_script.clone())
            .build()
    });

    let outputs_data = (0..output_len)
        .map(|_| (&data).into())
        .collect::<Vec<packed::Bytes>>();

    let parent_pts = parent.output_pts();
    let inputs = indices
        .iter()
        .map(|i| CellInput::new(parent_pts[*i].clone(), 0));

    TransactionBuilder::default()
        .outputs(outputs)
        .outputs_data(outputs_data)
        .inputs(inputs)
        .cell_dep(
            CellDep::new_builder()
                .out_point(always_success_out_point)
                .build(),
        )
        .build()
}

pub fn create_transaction(parent: &Byte32, unique_data: u8) -> TransactionView {
    create_transaction_with_out_point(OutPoint::new(parent.clone(), 0), unique_data)
}

pub fn create_transaction_with_out_point(out_point: OutPoint, unique_data: u8) -> TransactionView {
    let (_, _, always_success_script) = always_success_cell();
    let always_success_out_point = create_always_success_out_point();

    let data = Bytes::from(vec![unique_data]);
    TransactionBuilder::default()
        .output(
            CellOutputBuilder::default()
                .capacity(capacity_bytes!(100))
                .lock(always_success_script.clone())
                .build(),
        )
        .output_data(data)
        .input(CellInput::new(out_point, 0))
        .cell_dep(
            CellDep::new_builder()
                .out_point(always_success_out_point)
                .build(),
        )
        .build()
}

pub fn dao_data(
    consensus: &Consensus,
    parent: &HeaderView,
    txs: &[TransactionView],
    store: &MockStore,
    ignore_resolve_error: bool,
) -> Byte32 {
    let mut seen_inputs = HashSet::new();
    // In case of resolving errors, we just output a dummy DAO field,
    // since those should be the cases where we are testing invalid
    // blocks
    let transactions_provider = TransactionsProvider::new(txs.iter());
    let overlay_cell_provider = OverlayCellProvider::new(&transactions_provider, store);
    let rtxs = txs.iter().try_fold(vec![], |mut rtxs, tx| {
        let rtx = resolve_transaction(tx.clone(), &mut seen_inputs, &overlay_cell_provider, store);
        match rtx {
            Ok(rtx) => {
                rtxs.push(rtx);
                Ok(rtxs)
            }
            Err(e) => Err(e),
        }
    });
    let rtxs = if ignore_resolve_error {
        rtxs.unwrap_or_else(|_| vec![])
    } else {
        rtxs.unwrap()
    };
    let data_loader = store.store().borrow_as_data_loader();
    let calculator = DaoCalculator::new(consensus, &data_loader);
    calculator.dao_field(rtxs.iter(), parent).unwrap()
}