chore: cheat code documentation

[od-hunter]

resolves #300

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
book	✅ Ready (Inspect)	Visit Preview	Aug 13, 2024 4:17pm

[glihm]

Thanks for the revision @od-hunter. Most of the examples are still not using real functions from the core lib. I've made some corrections but not all, could you please take the time to check if all the examples compile and make the according corrections with the examples given?

Like so, the reader of the book will have accurate information. 🫡

[glihm]

this cheat code is about the version of the transaction, not the contract's version.
Could you please rephrase accordingly?

[glihm]

Suggested change

	use starknet::{testing, get_version};
	use starknet::{testing, get_tx_info};

get_version function doesn't exist. It's the version of the transaction inside the transaction execution info:

testing::set_version(1);
assert_eq!(get_tx_info().unbox().version, 1_felt252);

[glihm]

Suggested change

	- Testing a contract's interaction with a specific account contract, such as a wallet contract.
	- Testing a contract's interaction with a specific account contract.

[glihm]

Suggested change

	const contract: ContractAddress = contract_address_const::<'contract'>();
	const contract = contract_address_const::<'contract'>();

Type is inferred, it makes the code more readable. 👍

[glihm]

Suggested change

	use starknet::{testing, get_account_contract_address, contract_address_const};
	use starknet::{testing, get_tx_info, contract_address_const};

Same here, this function doesn't exist.

[glihm]

Suggested change

	assert(get_account_contract_address() == contract, 'wrong contract address');
	assert_eq!(get_tx_info().unbox().account_contract_address.into(), contract);

Using assert_eq! you don't always require to put a reason. Can be sometimes shorter and better. :)

[glihm]

@od-hunter thanks for the work here, in a good direction but not yet ready to be published.

I've prepared for you a test module that you can run to test all the cheat codes and adjust the documentation accordingly. Some of the examples are not working, could you please adjust with the given test module to ensure everything compiles? Thank you very much!

#[cfg(test)]
mod tests {
    use starknet::{testing, get_block_number, get_caller_address, get_contract_address, contract_address_const, get_block_timestamp, get_tx_info};

    #[test]
    fn f1() {
        testing::set_block_number(1234567);
        assert!(get_block_number() == 1234567, "bad block number");
    }

    #[test]
    fn f2() {
        let user_one = contract_address_const::<'user1'>();
        testing::set_caller_address(user_one);
        assert!(get_caller_address() == user_one, "bad caller");
    }

    #[test]
    fn f3() {
        let hub_address = contract_address_const::<'hub'>();
        testing::set_contract_address(hub_address);
        assert!(get_contract_address() == hub_address, "bad address");
    }

    #[test]
    fn f4() {
        testing::set_block_timestamp(123456);
        assert!(get_block_timestamp() == 123456, "bad timestamp");
    }

    #[test]
    fn f5() {
        testing::set_version('0.1.0');
        assert_eq!(get_tx_info().unbox().version, '0.1.0');
    }

    #[test]
    fn f6() {
        let contract = contract_address_const::<'contract'>(); 
        testing::set_account_contract_address(contract);
        assert_eq!(get_tx_info().unbox().account_contract_address.into(), contract);
    }

    #[test]
    fn f7() {
        testing::set_max_fee(123456);
        assert_eq!(get_tx_info().unbox().max_fee.into(), 123456);
    }

    #[test]
    fn f8() {
        testing::set_transaction_hash('12345678');
        assert_eq!(get_tx_info().unbox().transaction_hash, '12345678');
    }

    #[test]
    fn f9() {
        testing::set_chain_id('test_chain_id');
        assert_eq!(get_tx_info().unbox().chain_id.into(), 'test_chain_id');
    }

    #[test]
    fn f10() {
        testing::set_nonce('test_nonce');
        assert_eq!(get_tx_info().unbox().nonce, 'test_nonce');
    }

    #[test]
    fn f11() {
        testing::set_signature(array!['r', 's'].span());
        let s = get_tx_info().unbox().signature;
        assert_eq!(*s[0], 'r');
        assert_eq!(*s[1], 's');
    }

    #[test]
    fn f12() {
        testing::set_block_hash(12345678, 'value');
        assert_eq!(get_tx_info().unbox().block_hash, 12345678);
    }

    #[test]
    fn f13() {
        let contract_address = starknet::contract_address_const::<0x42>();
        let _log = testing::pop_log_raw(contract_address);
    }

    #[derive(Drop, starknet::Event)]
    struct TestEvent {
        #[key]
        id: u32,
        data: felt252,
    }

    #[test]
    fn f14() {
        let contract_address = starknet::contract_address_const::<0x42>();
        let _log = testing::pop_log::<TestEvent>(contract_address);
    }

    #[test]
    fn f15() {
        let contract_address = starknet::contract_address_const::<0x42>();
        let _msg = testing::pop_l2_to_l1_message(contract_address);
    }
}

[od-hunter]

gm sir @glihm
i am a bit stuck in the last 3 there test examples: pop_log_raw, pop_log, pop_l2_to_l1_message

i don’t know how to go about writing the assert statments for them
please can you assist me with resources to solve it

[glihm]

gm sir @glihm i am a bit stuck in the last 3 there test examples: pop_log_raw, pop_log, pop_l2_to_l1_message

i don’t know how to go about writing the assert statments for them please can you assist me with resources to solve it

Sorry for the delay here.

For the messages, you can skip them for now. These are not used that much for the moment in Dojo.

In the meantime, the pop_log is very used and important.
To test it correctly, you should have a contract that actually emits an event. And then the event will be caught by this cheat code.

What you can do to make the full test, write a minimal contract that emits an event, call the function that emits the event, and then pop the log.

A minimal contract could look something like this:

#[starknet::interface]
pub trait IContract<T> {
    fn emit_log(ref self: T);
}

#[starknet::contract]
pub mod MyContract {
    #[abi(embed_v0)]
    impl IContractImpl of IContract<ContractState> {
        fn emit_log(ref self: ContractState) {
            starknet::emit(.....);
        }
    }
}

You can use the demo event, don't forget to declare inside the contract. 👍

[od-hunter]

@glihm , please review