Provide support for solidity in serde_generate
#61
Conversation
serde-generate/src/solidity.rs
Outdated
| } | ||
| } | ||
|
|
||
| fn need_memory(sol_format: &SolFormat, sol_registry: &SolRegistry) -> bool { |
There was a problem hiding this comment.
Can we make that a method of either SolRegistry or SolFormat?
| } | ||
| } | ||
|
|
||
| pub fn output<T: std::io::Write>(&self, out: &mut IndentedWriter<T>) -> Result<()> { |
There was a problem hiding this comment.
Probably ok for a first version but I'm assuming re-using a library would cheaper in terms of gas?
There was a problem hiding this comment.
I think the opposite:
- When we have all the source code in one single file, then the LLVM intermediate representation is fully available therefore optimizations are available.
- When a library is available, then the linking occurs when the library is deployed. This of course prevents some optimization. I think it has its uses if the library is an external one. However, we do not gain anything by having a library.
|
#62 should help with CI. Let's see if it comes back green. |
MathieuDutSik
force-pushed
the
serde_generate_solidity
branch
from
f1c98ad to
3dec9d1
Compare
This reverts commit 91adf02.
MathieuDutSik
force-pushed
the
serde_generate_solidity
branch
from
e25765b to
a2b5f4a
Compare
| generator.output(&mut test_file, ®istry).unwrap(); | ||
| } | ||
|
|
||
| let _bytecode = get_bytecode(path, "test.sol", "test").unwrap(); |
There was a problem hiding this comment.
let _bytecode = is not necessarily (and slightly counter-productive. E.g. it disables the warning that would be triggered if you forget the .unwrap() here).
| let ExecutionResult::Success { | ||
| reason: _, | ||
| gas_used: _, | ||
| gas_refunded: _, | ||
| logs: _, | ||
| output, | ||
| } = result |
There was a problem hiding this comment.
let ExecutionResult::Success { output, .. } = result is probably fine, especially for testing.
| output: _, | ||
| } = result | ||
| else { | ||
| panic!("The TxKind::Call execution failed to be done"); |
serde-generate/src/solidity.rs
Outdated
| impl SolRegistry { | ||
| fn insert(&mut self, sol_format: SolFormat) { | ||
| let key_name = sol_format.key_name(); | ||
| if matches!(sol_format, SolFormat::Primitive(Primitive::I8)) { |
There was a problem hiding this comment.
The cases look disjoint. Why not match sol_format { .. } ?
| _ => {} | ||
| } | ||
| // Typename entries are by definition already covered and do not need | ||
| // to be inserted. Others do. | ||
| if !matches!(sol_format, SolFormat::TypeName(_)) { | ||
| self.names.insert(key_name, sol_format); | ||
| } |
There was a problem hiding this comment.
There's really no need for matches! here.
SolFormat::Primitive(SolFormat::TypeName(_)) => {
// Typename entries do not need to be inserted.
}
_ => {
self.names.insert(key_name, sol_format);
}
Summary
Solidity is the Javascript of blockchains, therefore having a way to support solidity in one of the codes is quite important.
Solidity has a number of limitations that force some adaptations:
There are also some more mundane restrictions where we choose to simply panic with an explicit error if this occurs in the input code:
The main implication of the use of struct to represent nested structure is that it breaks the design of
ContainerFormat/Format. So, we need to introduce the recursive typeSolFormattype that provides support for this.Other design choices:
get_keywordsis a standard function instead of being a static one as in the OCaml generator. I think it does not matter.abi.encode/abi.decodethat works with padded serialization. It has anabi.encodePackedthat provides a compact serialization, but it has noabi.decodePacked. Added to that the BCS serialization of 42_u32 is [42,0,0,0] but the solidity serialization is [0,0,0,42]. Therefore hand-crafted code has been written for processing all primitive types.Test Plan
The code is tested by running an EVM virtual machine. This is nicely provided by the REVM crate.
The only external files used are the temporary ones created during the test which makes the development smooth.