Add test to check custom AddressGenerator implementation

[epanchee]

Hi @DariuszDepta,

This PR contains failing test showing custom address generator is broken. Could you check why custom address generator no longer updated in app builder? Figured this out when was migrating from cw-multi-test:v0.16.5 to the latest version (v0.19.0).

I briefly checked via Clion debugger and it seems that this function actually does update Box pointer here. However, vtable still points to the default address generator implementation. No clue why

[DariuszDepta]

Hi @epanchee,

Since version 0.18.0, the function next_address is deprecated and in fact not used anymore for generating contract addresses. I think this may be your case while migrating from 0.16.5 to 0.19.0 of CosmWasm MultiTest.
We will consider better changelog communication to avoid such situations in the future.
Meanwhile, there is a working example based on your test case shown below.
Let me know if it helped.

#[test]
fn custom_address_generator_should_work() {
    struct CustomAddressGenerator;

    impl AddressGenerator for CustomAddressGenerator {
        // deprecated from version 0.18.0
        fn next_address(&self, _storage: &mut dyn Storage) -> Addr {
            Addr::unchecked("deprecated")
        }

        // use this function instead of next_address
        fn contract_address(
            &self,
            _api: &dyn Api,
            _storage: &mut dyn Storage,
            _code_id: u64,
            _instance_id: u64,
        ) -> AnyResult<Addr> {
            Ok(Addr::unchecked("test_address"))
        }
    }

    // prepare wasm module with custom address generator
    let wasm_keeper = WasmKeeper::new().with_address_generator(CustomAddressGenerator);

    let mut app = AppBuilder::default().with_wasm(wasm_keeper).build(no_init);

    // store contract's code
    let code_id = app.store_code(test_contracts::counter::contract());

    let contract_addr = app
        .instantiate_contract(
            code_id,
            Addr::unchecked("owner"),
            &Empty {},
            &[],
            "Counter",
            None,
        )
        .unwrap();

    // make sure that contract address equals to "test_address" generated by custom address generator
    assert_eq!(contract_addr.as_str(), "test_address");
}

Anyway, let us append this test case to MultiTest after fixing, that also other developers can benefit from it.
Would you adjust your PR that I can just approve and merge it?
Thanks in advance!

[epanchee]

Hi @epanchee,

Since version 0.18.0, the function next_address is deprecated and in fact not used anymore for generating contract addresses. I think this may be your case while migrating from 0.16.5 to 0.19.0 of CosmWasm MultiTest. We will consider better changelog communication to avoid such situations in the future. Meanwhile, there is a working example based on your test case shown below. Let me know if it helped.

#[test]
fn custom_address_generator_should_work() {
    struct CustomAddressGenerator;

    impl AddressGenerator for CustomAddressGenerator {
        // deprecated from version 0.18.0
        fn next_address(&self, _storage: &mut dyn Storage) -> Addr {
            Addr::unchecked("deprecated")
        }

        // use this function instead of next_address
        fn contract_address(
            &self,
            _api: &dyn Api,
            _storage: &mut dyn Storage,
            _code_id: u64,
            _instance_id: u64,
        ) -> AnyResult<Addr> {
            Ok(Addr::unchecked("test_address"))
        }
    }

    // prepare wasm module with custom address generator
    let wasm_keeper = WasmKeeper::new().with_address_generator(CustomAddressGenerator);

    let mut app = AppBuilder::default().with_wasm(wasm_keeper).build(no_init);

    // store contract's code
    let code_id = app.store_code(test_contracts::counter::contract());

    let contract_addr = app
        .instantiate_contract(
            code_id,
            Addr::unchecked("owner"),
            &Empty {},
            &[],
            "Counter",
            None,
        )
        .unwrap();

    // make sure that contract address equals to "test_address" generated by custom address generator
    assert_eq!(contract_addr.as_str(), "test_address");
}

Anyway, let us append this test case to MultiTest after fixing, that also other developers can benefit from it.
Would you adjust your PR that I can just approve and merge it?
Thanks in advance!

Ahh, missed default function implementation in AddressGenerator trait. My bad, sorry!

Updated test accordingly. Also as next_address() becomes deprecated I think explicit panic in case it is called looks better in this test.

[DariuszDepta]

LGTM!