Skip to content

Commit 2fd10c0

Browse files
committed
Cleanup module template, bump version to 0.2.0
1 parent 1926bbc commit 2fd10c0

File tree

5 files changed

+13
-14
lines changed

5 files changed

+13
-14
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "sumi"
3-
version = "0.1.1"
3+
version = "0.2.0"
44
edition = "2021"
55
authors = ["Stake Technologies <[email protected]>"]
66
description = "Astar binding generator for Solidity and ink!"

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center"><img src="media/sumi.png"/><br/></p>
22

3-
Sumi is a binding generator specifically designed for [Astar Network](https://astar.network) ecosystem with XVM in mind. It takes EVM metadata and converts it to an ink! module that can later be used to call into original EVM smart contract.
3+
Sumi is a binding generator specifically designed for [Astar Network](https://astar.network) ecosystem with XVM in mind. It takes EVM metadata and converts it to an ink! module that can later be used to call into original EVM smart contract. Reverse ink! to EVM mode is also supported but is highly experimental and should be considered as a PoC for now.
44

55
Please note that Sumi is not a transpiler, it's a binding generator. If you need to convert your existing Solidity smart contract to ink! please use [Sol2ink](https://github.com/Supercolony-net/sol2ink) instead.
66

@@ -10,7 +10,7 @@ Please note that Sumi is not a transpiler, it's a binding generator. If you need
1010

1111
# Quick start guide
1212

13-
1. Install Sumi using `cargo install --git https://github.com/AstarNetwork/sumi --tag v0.1.1`
13+
1. Install Sumi using `cargo install --git https://github.com/AstarNetwork/sumi --tag v0.2.0`
1414
2. Use Solidity compiler (or [Remix IDE](https://remix.ethereum.org) if in doubt) to obtain smart contract metadata:
1515
`solc --pretty-json --abi <input>.sol -o .`
1616
Don't forget to replace `<input>.sol` with your actual file name.
@@ -24,14 +24,15 @@ Sumi can also work in pipeline mode. By default it will read from stdin and writ
2424

2525
# Command line reference
2626

27-
Usage: sumi [OPTIONS] --module-name <MODULE_NAME>
28-
27+
Usage: sumi [OPTIONS]
28+
2929
Options:
30-
-i, --input <INPUT> Input filename or stdin if empty
31-
-o, --output <OUTPUT> Output filename or stdout if empty
32-
-m, --module-name <MODULE_NAME> Ink module name to generate
33-
-e, --evm-id <EVM_ID> EVM ID to use in module [default: 0x0F]
34-
-h, --help Print help information
30+
-i, --input <INPUT> Input filename or stdin if empty
31+
-o, --output <OUTPUT> Output filename or stdout if empty
32+
--module-name <MODULE_NAME> Ink module name to generate
33+
-e, --evm-id <EVM_ID> EVM ID to use in module [default: 0x0F]
34+
-m, --mode <MODE> [default: evm-to-ink] [possible values: evm-to-ink, ink-to-evm]
35+
-h, --help Print help information
3536

3637
You can always use `sumi --help` to get the same reference.
3738

src/ink2sol.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ fn type_conversion() {}
358358
#[cfg(test)]
359359
mod tests {
360360
use super::*;
361-
use scale_info::{meta_type, PortableRegistry, Registry};
361+
// use scale_info::{meta_type, PortableRegistry, Registry};
362362

363363
/* #[test]
364364
fn type_registry() {

templates/solidity-module.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ contract {module_name} \{
1818
ink_address = _ink_address;
1919
}
2020

21-
{# { with V3 } #}
2221
{{ for message in project.spec.messages }}
2322
{{- if message.mutates }} {# handling only non-view methods for now #}
2423
{{ for line in message.docs -}}
@@ -57,7 +56,6 @@ contract {module_name} \{
5756
{ type.id | type encoder }
5857
{{- endif }}
5958
{{- endfor }}
60-
{# { endwith } #}
6159

6260
function encode_uint128(uint128 value) private pure returns (bytes memory) \{
6361
return abi.encodePacked(value);

0 commit comments

Comments
 (0)