feat: EIP712 implementation

[developeruche]

Implement EIP712 contract. Solidity reference here.

Resolves #184

PR Checklist

• Tests
• Documentation

[netlify]

✅ Deploy Preview for contracts-stylus ready!

Name	Link
🔨 Latest commit	663f3ff
🔍 Latest deploy log	https://app.netlify.com/sites/contracts-stylus/deploys/66b0a76e52b5850008128def
😎 Deploy Preview	https://deploy-preview-197--contracts-stylus.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[developeruche]

Please I need help on;

1. This is giving me this error:

the trait bound `alloy_primitives::Bytes: AbiType` is not satisfied
the following other types implement trait `AbiType`:
  ()
  (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)
  (B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)
  (C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)
  (D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)
  (E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)
  (F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)
  (G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)
and 37 others
required for `(Bytes, String, String, u64, Address, FixedBytes<32>, Vec<Uint<256, 4>>)` to implement `AbiType`
required for `(Bytes, String, String, u64, Address, FixedBytes<32>, Vec<Uint<256, 4>>)` to implement `EncodableReturnType`
the full name for the type has been written to '/Users/user/Documents/projects/CONTRIBUTION/rust-contracts-stylus/target/debug/deps/openzeppelin_stylus-03b9c0872ea01cad.long-type-9805022037568242759.txt'
consider using `--verbose` to print the full type name to the console
the full name for the type has been written to '/Users/user/Documents/projects/CONTRIBUTION/rust-contracts-stylus/target/debug/deps/openzeppelin_stylus-03b9c0872ea01cad.long-type-9805022037568242759.txt'
consider using `--verbose` to print the full type name to the console

code:

pub fn eip712_domain(
        &self,
    ) -> (Bytes, String, String, u64, Address, B256, Vec<U256>) {
        (
            FEILDS,
            self.eip712_name(),
            self.eip712_version(),
            block::chainid(),
            contract::address(),
            SALT,
            Vec::new(),
        )
    }

[developeruche]

abi.encode(data)

Please how can I do this using alloy

[developeruche]

@bidzyyys these are my blockers before writing the Unit test

[codecov]

Codecov Report

Attention: Patch coverage is 69.04762% with 26 lines in your changes missing coverage. Please review.

Project coverage is 88.5%. Comparing base (dc64913) to head (663f3ff).

Files	Patch %	Lines
contracts/src/utils/cryptography/eip712.rs	62.5%	18 Missing ⚠️
lib/motsu/src/shims.rs	0.0%	8 Missing ⚠️

Additional details and impacted files

Files	Coverage Δ
...racts/src/utils/cryptography/message_hash_utils.rs	100.0% <100.0%> (ø)
lib/motsu/src/shims.rs	0.0% <0.0%> (ø)
contracts/src/utils/cryptography/eip712.rs	62.5% <62.5%> (ø)

[bidzyyys]

Hi @developeruche I think I fixed your issue;
Following Solidity reference, fields is bytes1, and in Rust it should be FixedBytes<1>.

[developeruche]

Hi @developeruche I think I fixed your issue; Following Solidity reference, fields is bytes1, and in Rust it should be FixedBytes<1>.

Thanks!...
Got you, would stick to the reference...

[bidzyyys]

abi.encode(data)

Please how can I do this using alloy

Based on the Solidity interface (from sol! macro) you need to use alloy as e.g. here:
https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/examples/erc721-metadata/tests/erc721.rs#L33

[developeruche]

abi.encode(data)

Please how can I do this using alloy

Based on the Solidity interface (from sol! macro) you need to use alloy as e.g. here: https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/examples/erc721-metadata/tests/erc721.rs#L33

We cannot go this Route as this type is not an Alloy type, e.g. sol_types::SolConstructor from the sol! marco.
The Ideal way to go about this is to use the .abi_ecode() fn provided by sol_types::SolValue, but that is not avaliable in alloy_sol_type version 0.3.1 which is curently been used across the workspace.

Got this info from Alloy telegram chat.

Please do you have an alternative?

[bidzyyys]

abi.encode(data)

Please how can I do this using alloy

Based on the Solidity interface (from sol! macro) you need to use alloy as e.g. here: https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/examples/erc721-metadata/tests/erc721.rs#L33

We cannot go this Route as this type is not an Alloy type, e.g. sol_types::SolConstructor from the sol! marco. The Ideal way to go about this is to use the .abi_ecode() fn provided by sol_types::SolValue, but that is not avaliable in alloy_sol_type version 0.3.1 which is curently been used across the workspace.

Got this info from Alloy telegram chat.

Please do you have an alternative?

Please share what do you want to achieve, will be easier for me to figure it out.

[developeruche]

abi.encode(data)

Please how can I do this using alloy

Based on the Solidity interface (from sol! macro) you need to use alloy as e.g. here: https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/examples/erc721-metadata/tests/erc721.rs#L33

We cannot go this Route as this type is not an Alloy type, e.g. sol_types::SolConstructor from the sol! marco. The Ideal way to go about this is to use the .abi_ecode() fn provided by sol_types::SolValue, but that is not avaliable in alloy_sol_type version 0.3.1 which is curently been used across the workspace.
Got this info from Alloy telegram chat.
Please do you have an alternative?

Please share what do you want to achieve, will be easier for me to figure it out.

This is what I want to achieve;

keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));

[bidzyyys]

abi.encode(data)

Please how can I do this using alloy

Based on the Solidity interface (from sol! macro) you need to use alloy as e.g. here: https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/examples/erc721-metadata/tests/erc721.rs#L33

We cannot go this Route as this type is not an Alloy type, e.g. sol_types::SolConstructor from the sol! marco. The Ideal way to go about this is to use the .abi_ecode() fn provided by sol_types::SolValue, but that is not avaliable in alloy_sol_type version 0.3.1 which is curently been used across the workspace.
Got this info from Alloy telegram chat.
Please do you have an alternative?

Please share what do you want to achieve, will be easier for me to figure it out.

This is what I want to achieve;

keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));

@developeruche please prepare the code that does not compile and push it to the repo (may be commented out), I will have a look in a few hours.

[developeruche]

abi.encode(data)

Please how can I do this using alloy

Based on the Solidity interface (from sol! macro) you need to use alloy as e.g. here: https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/examples/erc721-metadata/tests/erc721.rs#L33

We cannot go this Route as this type is not an Alloy type, e.g. sol_types::SolConstructor from the sol! marco. The Ideal way to go about this is to use the .abi_ecode() fn provided by sol_types::SolValue, but that is not avaliable in alloy_sol_type version 0.3.1 which is curently been used across the workspace.
Got this info from Alloy telegram chat.
Please do you have an alternative?

Please share what do you want to achieve, will be easier for me to figure it out.

This is what I want to achieve;

keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));

@developeruche please prepare the code that does not compile and push it to the repo (may be commented out), I will have a look in a few hours.

thanks... just pushed

[bidzyyys]

@developeruche I think I figured it out, but you need to write tests to confirm.
This source code was helpful for me -> https://docs.rs/alloy-sol-types/0.3.1/src/alloy_sol_types/coder/encoder.rs.html

[developeruche]

@developeruche I think I figured it out, but you need to write tests to confirm. This source code was helpful for me -> https://docs.rs/alloy-sol-types/0.3.1/src/alloy_sol_types/coder/encoder.rs.html

thanks a lot... would get on this now

[developeruche]

@bidzyyys please I need your technical advice on how to carry out this test without using a constructor. The contract does not have a function internal or public that updates the state variables leaving this to be done only by using a constructor which is not supported ATM.

[bidzyyys]

@bidzyyys please I need your technical advice on how to carry out this test without using a constructor. The contract does not have a function internal or public that updates the state variables leaving this to be done only by using a constructor which is not supported ATM.

Hi @developeruche!

• If you need to set a state in unit test (motsu), you can directly write data to storage like here -> https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/contracts/src/token/erc20/extensions/capped.rs#L61-L70
• If you need to set a state in E2E tests, you can check the code here -> https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/examples/erc20/tests/erc20.rs#L26-L30

[developeruche]

There is a little problem, any function that has block::chainid() therein fails with this error;

dyld[7502]: missing symbol called
error: test failed, to rerun pass `-p openzeppelin-stylus --lib`

Other tests passed fine. I have gone through the codebase, but didn't see where block::chainid() was used so there is no sample test I can play with.

cc: @bidzyyys

[bidzyyys]

There is a little problem, any function that has block::chainid() therein fails with this error;

dyld[7502]: missing symbol called
error: test failed, to rerun pass `-p openzeppelin-stylus --lib`

Other tests passed fine. I have gone through the codebase, but didn't see where block::chainid() was used so there is no sample test I can play with.

cc: @bidzyyys

Hi @developeruche,
When you see this error, you should implement vm-hooks. In this case you are probably missing chainid, check this https://github.com/OffchainLabs/stylus-sdk-rs/blob/stylus/stylus-sdk/src/hostio.rs#L127-L131.

Here you should add the hook, and check out what we have and how we deal with the hooks:
https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/lib/motsu/src/shims.rs

In your case, I would hardcode chainid in shims as we did for e.g. msg_sender -> https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/lib/motsu/src/shims.rs#L179-L183

[developeruche]

There is a little problem, any function that has block::chainid() therein fails with this error;

dyld[7502]: missing symbol called
error: test failed, to rerun pass `-p openzeppelin-stylus --lib`

Other tests passed fine. I have gone through the codebase, but didn't see where block::chainid() was used so there is no sample test I can play with.
cc: @bidzyyys

Hi @developeruche, When you see this error, you should implement vm-hooks. In this case you are probably missing chainid, check this https://github.com/OffchainLabs/stylus-sdk-rs/blob/stylus/stylus-sdk/src/hostio.rs#L127-L131.

Here you should add the hook, and check out what we have and how we deal with the hooks: https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/lib/motsu/src/shims.rs

In your case, I would hardcode chainid in shims as we did for e.g. msg_sender -> https://github.com/OpenZeppelin/rust-contracts-stylus/blob/main/lib/motsu/src/shims.rs#L179-L183

it is still abit confusing how everything plugs in together;
I added this piece of code frollowing the example;

/// Gets the chain ID of the current chain. The semantics are equivalent to
/// that of the EVM's [`CHAINID`] opcode.
/// 
/// [`CHAINID`]: https://www.evm.codes/#46
/// 
/// # Panics
/// Not Enough Gas
/// Stack Overflow
#[no_mangle]
pub unsafe extern "C" fn chain_id(sender: *mut u8) {
    let addr = const_hex::const_decode_to_array::<6>(CHAIN_ID).unwrap();
    std::ptr::copy(addr.as_ptr(), sender, 6);
}

but I am still getting the same error 😢

[bidzyyys]

I like the idea of having EIP712 resolved at compile time!

[bidzyyys]

Some minor fixes to be applied with #43