starknet_api 0.18.0-rc.0

Starknet Rust types related to computation and execution.
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

use apollo_sizeof::SizeOf;
use expect_test::expect;
use rstest::rstest;
use starknet_types_core::felt::Felt;

use crate::core::CompiledClassHash;
use crate::rpc_transaction::{
    DataAvailabilityMode,
    RpcDeployAccountTransaction,
    RpcInvokeTransaction,
    RpcTransaction,
};
use crate::state::SierraContractClass;
use crate::test_utils::declare::{rpc_declare_tx, DeclareTxArgs};
use crate::test_utils::deploy_account::{rpc_deploy_account_tx, DeployAccountTxArgs};
use crate::test_utils::invoke::{rpc_invoke_tx, InvokeTxArgs};
use crate::test_utils::valid_resource_bounds_for_testing;
use crate::transaction::fields::{
    AccountDeploymentData,
    ContractAddressSalt,
    PaymasterData,
    Proof,
    ProofFacts,
    Tip,
    TransactionSignature,
};
use crate::{calldata, class_hash, contract_address, felt, nonce};

fn create_declare_tx() -> RpcTransaction {
    rpc_declare_tx(
        DeclareTxArgs {
            resource_bounds: valid_resource_bounds_for_testing(),
            tip: Tip(1),
            signature: TransactionSignature(vec![felt!("0x1"), felt!("0x2")].into()),
            sender_address: contract_address!("0x3"),
            nonce: nonce!(1),
            paymaster_data: PaymasterData(vec![felt!("0x0")]),
            account_deployment_data: AccountDeploymentData(vec![felt!("0x3")]),
            nonce_data_availability_mode: DataAvailabilityMode::L1,
            fee_data_availability_mode: DataAvailabilityMode::L2,
            compiled_class_hash: CompiledClassHash(felt!("0x2")),
            ..Default::default()
        },
        SierraContractClass::default(),
    )
}

fn create_deploy_account_tx() -> RpcTransaction {
    rpc_deploy_account_tx(DeployAccountTxArgs {
        resource_bounds: valid_resource_bounds_for_testing(),
        contract_address_salt: ContractAddressSalt(felt!("0x1")),
        class_hash: class_hash!("0x2"),
        constructor_calldata: calldata![felt!("0x1")],
        nonce: nonce!(1),
        signature: TransactionSignature(vec![felt!("0x1")].into()),
        nonce_data_availability_mode: DataAvailabilityMode::L2,
        fee_data_availability_mode: DataAvailabilityMode::L1,
        paymaster_data: PaymasterData(vec![felt!("0x2"), felt!("0x0")]),
        ..Default::default()
    })
}

fn base_invoke_tx_args() -> InvokeTxArgs {
    InvokeTxArgs {
        resource_bounds: valid_resource_bounds_for_testing(),
        calldata: calldata![felt!("0x1"), felt!("0x2")],
        sender_address: contract_address!("0x1"),
        nonce: nonce!(1),
        paymaster_data: PaymasterData(vec![Felt::TWO, Felt::ZERO]),
        account_deployment_data: AccountDeploymentData(vec![felt!("0x1")]),
        ..Default::default()
    }
}

fn create_invoke_tx() -> RpcTransaction {
    rpc_invoke_tx(base_invoke_tx_args())
}

fn create_invoke_tx_with_client_side_proving() -> RpcTransaction {
    rpc_invoke_tx(InvokeTxArgs {
        proof_facts: ProofFacts::snos_proof_facts_for_testing(),
        proof: Proof::proof_for_testing(),
        ..base_invoke_tx_args()
    })
}

// Test the custom serde/deserde of RPC transactions.
#[rstest]
#[case(create_declare_tx())]
#[case(create_deploy_account_tx())]
#[case(create_invoke_tx_with_client_side_proving())]
#[case(create_invoke_tx())]
fn test_rpc_transactions(#[case] tx: RpcTransaction) {
    let serialized = serde_json::to_string(&tx).unwrap();
    let deserialized: RpcTransaction = serde_json::from_str(&serialized).unwrap();
    assert_eq!(tx, deserialized);
}

// Check size of RPC transactions.
#[test]
fn test_deploy_account_tx_size_of() {
    let tx = create_deploy_account_tx();
    if let RpcTransaction::DeployAccount(deploy_tx) = tx {
        let RpcDeployAccountTransaction::V3(tx_v3) = deploy_tx;

        // hardcoded number was generated using:
        //
        // let expected_size = std::mem::size_of::<RpcDeployAccountTransactionV3>()
        // + tx_v3.resource_bounds.l1_gas.max_amount.dynamic_size()
        // + tx_v3.resource_bounds.l1_gas.max_price_per_unit.dynamic_size()
        // + tx_v3.resource_bounds.l2_gas.max_amount.dynamic_size()
        // + tx_v3.resource_bounds.l2_gas.max_price_per_unit.dynamic_size()
        // + tx_v3.resource_bounds.l1_data_gas.max_amount.dynamic_size()
        // + tx_v3.resource_bounds.l1_data_gas.max_price_per_unit.dynamic_size()
        // + tx_v3.tip.dynamic_size()
        // + tx_v3.contract_address_salt.dynamic_size()
        // + tx_v3.class_hash.dynamic_size()
        // + tx_v3.constructor_calldata.dynamic_size()
        // + tx_v3.nonce.dynamic_size()
        // + tx_v3.signature.dynamic_size()
        // + tx_v3.nonce_data_availability_mode.dynamic_size()
        // + tx_v3.fee_data_availability_mode.dynamic_size()
        // + tx_v3.paymaster_data.dynamic_size();

        // Check the size of the V3 deploy account transaction.
        expect![[r#"
            432
        "#]]
        .assert_debug_eq(&tx_v3.size_bytes());
    } else {
        panic!("Expected RpcTransaction::DeployAccount");
    }
}

#[test]
fn test_invoke_tx_size_of() {
    let tx = create_invoke_tx_with_client_side_proving();
    if let RpcTransaction::Invoke(invoke_tx) = tx {
        let RpcInvokeTransaction::V3(tx_v3) = invoke_tx;

        // hardcoded number was generated using:
        //
        // let expected_size = std::mem::size_of::<RpcInvokeTransactionV3>()
        // + tx_v3.resource_bounds.l1_gas.max_amount.dynamic_size()
        // + tx_v3.resource_bounds.l1_gas.max_price_per_unit.dynamic_size()
        // + tx_v3.resource_bounds.l2_gas.max_amount.dynamic_size()
        // + tx_v3.resource_bounds.l2_gas.max_price_per_unit.dynamic_size()
        // + tx_v3.resource_bounds.l1_data_gas.max_amount.dynamic_size()
        // + tx_v3.resource_bounds.l1_data_gas.max_price_per_unit.dynamic_size()
        // + tx_v3.tip.dynamic_size()
        // + tx_v3.calldata.dynamic_size()
        // + tx_v3.sender_address.dynamic_size()
        // + tx_v3.nonce.dynamic_size()
        // + tx_v3.signature.dynamic_size()
        // + tx_v3.nonce_data_availability_mode.dynamic_size()
        // + tx_v3.fee_data_availability_mode.dynamic_size()
        // + tx_v3.paymaster_data.dynamic_size()
        // + tx_v3.account_deployment_data.dynamic_size();
        // + tx_v3.proof_facts.dynamic_size()
        // + tx_v3.proof.dynamic_size();

        // Check the size of the V3 invoke transaction.
        expect![[r#"
            774
        "#]]
        .assert_debug_eq(&tx_v3.size_bytes());
    } else {
        panic!("Expected RpcTransaction::Invoke");
    }
}