EVM documentation improvements #76
Conversation
|
@ARitz-Cracker please have a look. |
packages/sei-cosmwasm/src/querier.rs
Outdated
| /// Query to get hex payload for the ERC-20 `transfer` function | ||
| /// | ||
| /// # Arguments | ||
| /// * `recipient` - Sei recipient address. |
There was a problem hiding this comment.
Is this the cosmos or 0x address?
There was a problem hiding this comment.
Yeah, I guess through the docs I was referring to x0 addresses as EVM and to bech32 as Sei. But Sei is probably confusing as we support both.
There was a problem hiding this comment.
In situations like these, it is better to be more verbose than not. Perhaps "bech32-encoded 'sei*' address" would be good.
packages/sei-cosmwasm/src/msg.rs
Outdated
| to: String, | ||
| /// Base64 encoded data to pass to the contract | ||
| data: String, // base64 encoded |
There was a problem hiding this comment.
I am assuming that String is used instead Binary in all these cases in order to prevent needless parsing and re-encoding of the base64 data?
There was a problem hiding this comment.
yes all bytes will be transferred in base64 format
packages/sei-cosmwasm/src/querier.rs
Outdated
| /// Query to get hex payload for the ERC-20 `transfer` function | ||
| /// | ||
| /// # Arguments | ||
| /// * `recipient` - Sei recipient address. |
There was a problem hiding this comment.
In situations like these, it is better to be more verbose than not. Perhaps "bech32-encoded 'sei*' address" would be good.
packages/sei-cosmwasm/src/msg.rs
Outdated
| @@ -41,13 +41,25 @@ pub enum SeiMsg { | |||
| SetMetadata { | |||
| metadata: Metadata, | |||
| }, | |||
| /// Calls EVM contract deployed at `to` address with the given `data`. | |||
| /// The from address is the callers address. | |||
| /// Please note that the CW contract has to be in allow list in order to execute delegate call. | |||
There was a problem hiding this comment.
A link to further details regarding what this "allow list" is should be here as well as the helper function comments.
There was a problem hiding this comment.
it refers to any CW code hash in this list https://github.com/sei-protocol/sei-chain/blob/seiv2/x/evm/types/params.go#L142 (currently only the pointer contracts).
| DelegateCallEvm { | ||
| /// The address of the EVM contract to call | ||
| to: String, |
There was a problem hiding this comment.
Assuming this is hex-encoded, do these require the capitalization checksums?
| /// Calls EVM contract deployed at `to` address with the given `data`. | ||
| /// The from address is the callers address. | ||
| /// Please note that the CW contract has to be in allow list in order to execute delegate call. | ||
| /// The EVM (Solidity) contract `msg.sender` in this case will be the callers address. |
There was a problem hiding this comment.
Might want to link to the differences between how "sei*" and "0x*" addresses are trans-coded for humans vs contracts everywhere "the callers address" is mentioned.
There was a problem hiding this comment.
@besated do you know if we already have a sei doc page for address mapping? If not I can help with writing up one (not sure where the gitbook repo is)
There was a problem hiding this comment.
we have this section in the docs - https://v2.docs.sei.io/setting-up-a-wallet#advanced
if you want to add more details, you can create a pr in the sei-docs repo
@ARitz-Cracker thanks for reviewing. Will be addressing most comments shortly |
|
@ARitz-Cracker addressed the most comments and will merge it. We can add more improvements in subsequent PRs |
Adding rust docs for EVM related stucts/functions