Improved README #106

hashedone · 2023-05-02T19:24:40Z

There is some bug with multitest generation which makes it invalid right now - figuring it out.

codecov · 2023-05-02T19:30:17Z

Codecov Report

Merging #106 (47815af) into main (966ecb4) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   66.09%   66.09%           
=======================================
  Files          28       28           
  Lines        1926     1926           
=======================================
  Hits         1273     1273           
  Misses        653      653

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

hashedone · 2023-05-03T14:36:20Z

Closes #102 #103

jawoznia · 2023-05-04T09:50:22Z

README.md

-chains' custom messages, so it is possible to use it with custom blockchains - except for handling custom
-queries and sudo messages. All messages can be generic, so creating a contract eligible to work
-across several different CosmWasm blockchains is also possible.
+Fist you need your contract crate, which should be a library crate:


jawoznia · 2023-05-04T09:50:56Z

README.md


+```
+
+To use sylvia in the contract, you need to add couple dependencies - sylvia itself,


a couple of dependencies

jawoznia · 2023-05-04T09:51:10Z

README.md

+and additionally: `cosmwasm-schema`, `schemars` and `cosmwasm_std`.
+
+```shell
+$ cargo add syvia cosmwasm-schema schemars cosmwasm-std


jawoznia · 2023-05-04T09:51:45Z

README.md

+To build your contract as wasm you can use:
+
+```rust
+$ targo build --target wasm32-unknown-unknown


jawoznia · 2023-05-04T09:52:25Z

README.md

+```
+
+To use sylvia in the contract, you need to add couple dependencies - sylvia itself,
+and additionally: `cosmwasm-schema`, `schemars` and `cosmwasm_std`.


also serde is required I think

jawoznia · 2023-05-04T09:59:55Z

README.md

+function argument. Be careful using the typical Rust pattern to prefix it with
+`_` to leave it unused. Unfortunately, to properly silence the unused warning here,
+you need to add the `#[allow(unused)]` attribute before the argument or the whole
+function.


Adding _ prefix should work. It is f.e. done in messages_generation.rs

I completely forgot it finally get to be implemented

jawoznia · 2023-05-04T10:01:33Z

README.md

+it is very easy to do:
+
+```rust
+```rust


jawoznia · 2023-05-04T10:03:49Z

README.md

+
+## Interfaces
+
+One of the fundamental ideas of Sylvia's framework is interfaces, allowing the


jawoznia · 2023-05-04T10:17:36Z

README.md

+        .call(owner);
+
+    contract
+        .group()


group_proxy()

I really don't like this proxy suffix tbh :/ Just because we named type this way doesn't have to make the call have some suffixed added. Anyway - we will get rid of this call as soon as #109 is done.

ethanfrey

Nice docs and explanation.

Added some minor comments, but generally good to merge when addressed.

The other meta-issue, is this is huge, and maybe best to break into 4-5 different pages and link them from a directory in the README. Keeping the intro explanation, then links to how to use, then the Roadmap. Maybe a few other key points in the README, but keeping the detailed codingg instructions linked from README more like a book.

(I prefer the docs here than in book now, as easier to find, and the code is changing so wil need to be updated with future PRs)

ethanfrey · 2023-05-04T18:13:41Z

README.md

+...
+```
+
+You should also make sure your crate is compiling as `cdylib`, setting the proper


This is useful instructions. But two points:

I would break "create a new contract" into it's own markdown file (linked from this)

People shouldn't do all these steps, but could do something like cw-template to generate a basic sylvia contract (feel free to make it simpler / targetted to multi-contract repos)

Splitting it into different files is definitely the way to go. However API is not stabilized yet, and it would be easier to check one file before release to update it, than the whole set of them.

Cargo template is a good idea. Just created #110. Will be part of 0.5 (I really don't want to add anything to 0.4).

ethanfrey · 2023-05-04T18:14:35Z

README.md

+
+```rust
+struct InstantiateMsg {
+    counter: 64,


ethanfrey · 2023-05-04T18:16:12Z

README.md

+```
+
+One problem you might face now is that we use the `StdResult` for our contract,
+but we often want to define the custom error type for our contracts - hopefully,


As in CosmWasm/book#39... it's fortunately (not hopefully)

ethanfrey · 2023-05-04T18:18:21Z

README.md

+
+Here are a couple of things to talk about.
+
+First, note that I defined the interface trait in its separate module with a name


Please explain this a bit more in detail with examples:

mod group -> trait Group
mod cross_staking -> trait CrossStaking

ethanfrey · 2023-05-04T18:21:21Z

README.md

+use sylvia::cw_std::{WasmMsg, to_binary};
+
+fn some_handler(my_contract_addr: String) -> StdResult<Response> {
+    let msg = my_contract_crate::Execute::Increment {};


This isn't my_contract_crate::MyContractExecMsg::Increment {} ??

I am seeing stuff like this when coding.

Actually typo - it is my_contract_crate::ExecMsg::Increment {}

ethanfrey · 2023-05-04T18:22:02Z

README.md

+```rust
+use sylvia::cw_std::{WasmMsg, to_binary};
+
+fn some_handler(my_contract_addr: String) -> StdResult<Response> {


Let's make this easier with #28 and you can update this code to show how to use the handlers...
Not blocking a merge, but a note for later

#28 is not yet implemented. It Is README for the state of today. Will be updated before 0.5 release

ethanfrey · 2023-05-04T18:26:48Z

README.md

+}
+```
+
+First of all, note the `contract` module I am using here - it is a slight change


Very nice explanation of multi-test usage

Unfortunately not true before 0.4 because of #108 has to be first merged.

Improved README

977dc7f

hashedone force-pushed the documentation-improve branch from dca6188 to 977dc7f Compare May 2, 2023 19:35

Fixed mistakes

614a446

hashedone requested review from ethanfrey and jawoznia May 3, 2023 08:22

jawoznia reviewed May 4, 2023

View reviewed changes

ethanfrey reviewed May 4, 2023

View reviewed changes

hashedone added 2 commits May 5, 2023 02:55

Post review corrections

c79b4d7

Merge branch 'main' into documentation-improve

47815af

jawoznia approved these changes May 16, 2023

View reviewed changes

hashedone merged commit d62c205 into main May 16, 2023
6 checks passed

hashedone deleted the documentation-improve branch May 16, 2023 15:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved README #106

Improved README #106

hashedone commented May 2, 2023

codecov bot commented May 2, 2023 •

edited

Loading

hashedone commented May 3, 2023

jawoznia May 4, 2023

jawoznia May 4, 2023

jawoznia May 4, 2023

jawoznia May 4, 2023

jawoznia May 4, 2023

jawoznia May 4, 2023

hashedone May 5, 2023

jawoznia May 4, 2023

jawoznia May 4, 2023

jawoznia May 4, 2023

hashedone May 5, 2023

ethanfrey left a comment

ethanfrey May 4, 2023

hashedone May 5, 2023

ethanfrey May 4, 2023

ethanfrey May 4, 2023

ethanfrey May 4, 2023

ethanfrey May 4, 2023

hashedone May 4, 2023

ethanfrey May 4, 2023

hashedone May 5, 2023

ethanfrey May 4, 2023

hashedone May 5, 2023


		```

		To use sylvia in the contract, you need to add couple dependencies - sylvia itself,


		## Interfaces

		One of the fundamental ideas of Sylvia's framework is interfaces, allowing the


		Here are a couple of things to talk about.

		First, note that I defined the interface trait in its separate module with a name

Improved README #106

Improved README #106

Conversation

hashedone commented May 2, 2023

codecov bot commented May 2, 2023 • edited Loading

Codecov Report

hashedone commented May 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethanfrey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented May 2, 2023 •

edited

Loading