Skip to content

Commit

Permalink
Update readme & bounce the version
Browse files Browse the repository at this point in the history
  • Loading branch information
yanganto committed Aug 27, 2021
1 parent 3a64ef1 commit 9e9ed0b
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 7 deletions.
16 changes: 13 additions & 3 deletions README.md
@@ -1,11 +1,11 @@
# SewUp

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/second-state/SewUp/CI)
[![Generic badge](https://img.shields.io/badge/sewup-0.0.10-green.svg)](https://crates.io/crates/sewup)
[![Generic badge](https://img.shields.io/badge/sewup-0.0.11-green.svg)](https://crates.io/crates/sewup)
[![Generic badge](https://img.shields.io/badge/SewUpDoc-main-green.svg)](https://second-state.github.io/SewUp/sewup/)
[![Generic badge](https://img.shields.io/badge/sewup_derive-0.0.10-green.svg)](https://crates.io/crates/sewup-derive)
[![Generic badge](https://img.shields.io/badge/sewup_derive-0.0.11-green.svg)](https://crates.io/crates/sewup-derive)
[![Generic badge](https://img.shields.io/badge/SewUpDeriveDoc-main-green.svg)](https://second-state.github.io/SewUp/sewup_derive/)
[![Generic badge](https://img.shields.io/badge/cargo_sewup-0.0.10-green.svg)](https://crates.io/crates/cargo-sewup)
[![Generic badge](https://img.shields.io/badge/cargo_sewup-0.0.11-green.svg)](https://crates.io/crates/cargo-sewup)

**S**econdstate **EW**asm **U**tility **P**rogram, a library helps you sew up your Ethereum project with Rust and just like development in a common backend.
There is an [issue](https://github.com/second-state/SewUp/issues/116) on building document on Doc.rs, please kindly use the [document](https://second-state.github.io/SewUp/sewup/) of master instead.
Expand All @@ -31,7 +31,10 @@ If you want to write a contract return different type of data base on different
please checkout `#[ewasm_main(auto)]` and `EwasmAny` or the example of rdb feature to learn
how to write a flexible smart contract with ewasm.

### Develop
Following is the minimal setting to initial a sewup project.
```toml
# Cargo.toml
[package]
name = "hello-contract"

Expand Down Expand Up @@ -113,6 +116,13 @@ mod tests {
}
```

### Interact
There are so many clients can interacte with contract.

For ERC tokens, we provide `web3js` examples in [wiki page](https://github.com/second-state/SewUp/wiki/ERC-Testing).
The example of clients interacting with contract with [kv](https://github.com/second-state/SewUp/blob/main/examples/kv-contract/src/client.rs) or [rdb](https://github.com/second-state/SewUp/blob/main/examples/rdb-contract/src/client.rs) features.
You can in the example projects for kv and rdb, then `Cargo run` to interact with the contract after modified the contract address.

### Testing
Run `cargo build --release --target=wasm32-unknown-unknown`, then the contract will build in `target/wasm32-unknown-unknown/release/*.wasm`
Besides, you can run deploy the ewasm contract on [WasmEdge](https://github.com/WasmEdge/WasmEdge) and run tests on it with `cargo test`,
Expand Down
2 changes: 1 addition & 1 deletion cargo-sewup/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "cargo-sewup"
version = "0.0.10"
version = "0.0.11"
edition = "2018"
description = "A cli tool build sewup project to a deploy wasm"
license = "Apache-2.0"
Expand Down
2 changes: 1 addition & 1 deletion sewup-derive/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "sewup-derive"
version = "0.0.10"
version = "0.0.11"
authors = ["Antonio Yang <yanganto@gmail.com>"]
edition = "2018"
description = "Macros implementation for SewUp"
Expand Down
4 changes: 2 additions & 2 deletions sewup/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "sewup"
version = "0.0.10"
version = "0.0.11"
authors = ["Antonio Yang <yanganto@gmail.com>"]
edition = "2018"
build="build.rs"
Expand All @@ -18,7 +18,7 @@ serde-value = "0.7.0"
toml = "0.5.8"
ewasm_api = { version = "0.11.0", default-features = false, features = ["std", "qimalloc"], package = "ss_ewasm_api" }
tiny-keccak = { version = "2.0.2", features = ["sha3", "keccak"] }
sewup-derive = { version = "0.0.10", path ="../sewup-derive" }
sewup-derive = { version = "0.0.11", path ="../sewup-derive" }
bincode = "1.3"
cryptoxide = "0.3.3"
hex-literal = "0.3.1"
Expand Down

0 comments on commit 9e9ed0b

Please sign in to comment.