enable tendermint no_std and error handle by flex-error #890

DaviRain-Su · 2021-06-02T02:32:32Z

#824 ,Support to Tendermint no_std features.
For error handle use anyhow, flex-eror and use no-std-compat to handle no_std features primitives.

flex-error crates: https://github.com/informalsystems/flex-error/
An experimental PR for ibc-rs is available at informalsystems/ibc-rs informalsystems/hermes#988.

This is a follow-up to support tendermint no_std features #889.

Referenced an issue explaining the need for the change
Updated all relevant documentation in docs
Updated all code comments where relevant
Wrote tests
Updated CHANGELOG.md

… because fs, and path, thiserror

…t-rs into octopus-no-std

soareschen

I went through the changes a little and given some suggestions on how you can better define the errors.

soareschen · 2021-06-04T08:38:01Z

proto/Cargo.toml

@@ -20,7 +20,8 @@ all-features = true
 prost = "0.7"
 prost-types = "0.7"
 bytes = "1.0"
-anomaly = "0.2"
+anyhow = {version = "1.0", default-features = false, git = "https://github.com/DaviRain-Su/anyhow.git", branch = "open-stderror"}


The version of anyhow here gives a compile error:

error[E0433]: failed to resolve: use of undeclared crate or module `anyhow` | 272 | pub type BoxError = alloc::Box<dyn anyhow::StdError + Send + Sync>; | ^^^^^^ use of undeclared crate or module `anyhow` error: aborting due to previous error

I have reset this change.

soareschen · 2021-06-04T08:41:25Z

proto/src/lib.rs

+pub use alloc::boxed::Box;
+
+#[cfg(feature = "std")]
+pub use std::boxed::Box;


I think we can probably don't use feature flags here and use alloc crate directly. When compiled with std it should automatically link with the one provided by std.

I have reset this change.

soareschen · 2021-06-04T08:51:16Z

tendermint/src/error.rs

-    #[error("protocol error")]
-    Protocol,
+    Parse
+    [DisplayError<Error>]


We only need to wrap upstream errors if they are coming from code not belong to the us. If you just want to attach additional details in string, you can instead define suberrors such as Parse { reason: String } and omit the error source.

Better yet, we should split out the different suberrors such as:

ParseUrl { url: String } [ DisplayError<url::ParseError> ] | e | { format_args!("error parsing url {}", e.url) } InvalidHashLength { length: usize } | e | { format_args!("hash has invalid length {}", e.length) }

soareschen · 2021-06-04T08:53:12Z

tendermint/src/error.rs

+    |_| { format_args!("invalid hash: expected hash size to be 32 bytes") },
+
+    NoTimestamp
+    [DisplayError<Error>]


There is no need for any error source here, since there is no additional information needed.

I have reset this change.

soareschen · 2021-06-04T08:55:05Z

tendermint/src/vote.rs

@@ -65,7 +68,7 @@ impl TryFrom<RawVote> for Vote {

    fn try_from(value: RawVote) -> Result<Self, Self::Error> {
        if value.timestamp.is_none() {
-            return Err(NoTimestamp.into());
+            return Err(error::no_timestamp_error(anyhow::anyhow!("no timestamp error")));


This can be simplified into just

return Err(error::no_timestamp_error());

Behind the scene flex-error automatically calls anyhow to capture the stack trace already.

I have reset this change.

DaviRain-Su · 2021-06-10T14:32:17Z

@soareschen Have modified all the problems you mentioned.

soareschen · 2021-06-10T19:04:06Z

tendermint/src/block/commit_sig.rs

+                    .timestamp
+                    .ok_or(error::no_timestamp_error())?
+                    .try_into()
+                    .map_err(|e: std::convert::Infallible| {


This is still not fixed. The Infallible variant can also be removed.

soareschen · 2021-06-11T08:26:56Z

tendermint/src/block/commit_sig.rs

+                    .ok_or(error::no_timestamp_error())?
+                    .try_into()
+                    .map_err(|e | {
+                        error::in_fallible_error(e)


See the documentation for Infallible here: https://doc.rust-lang.org/std/convert/enum.Infallible.html

Basically Infallible is an empty enum, which means there is no way you can ever construct a valid value for Infallible. So if we have a function that is given an Infallible value, we know that can never happen, so that part of the code will never actually get executed. As a result, we can discard an infallible value e: Infallible using match e {}.

Strictly speaking, we should never need to use Infallible in this case. Because a TryFrom with Infallible error is just equivalent to Try. So the type Timestamp in this case should just implement Try instead of TryFrom:

--- a/tendermint/src/time.rs +++ b/tendermint/src/time.rs - impl TryFrom<Timestamp> for Time { - type Error = Infallible; - - fn try_from(value: Timestamp) -> Result<Self, Self::Error> { - // prost_types::Timestamp has a SystemTime converter but - // tendermint_proto::Timestamp can be JSON-encoded - let prost_value = prost_types::Timestamp { - seconds: value.seconds, - nanos: value.nanos, - }; - - Ok(SystemTime::from(prost_value).into()) - } - } + impl From<Timestamp> for Time { + fn from(value: Timestamp) -> Self { + // prost_types::Timestamp has a SystemTime converter but + // tendermint_proto::Timestamp can be JSON-encoded + let prost_value = prost_types::Timestamp { + seconds: value.seconds, + nanos: value.nanos, + }; + + SystemTime::from(prost_value).into() + } + }

Then here we can just rewrite it as

timestamp: value .timestamp .ok_or(error::no_timestamp_error())? .into()

See the commit informalsystems/hermes@6b397f1 for similar work done at informalsystems/hermes#988.

I understand thank you.

Feedback addressed

DaviRain-Su · 2021-06-15T15:11:40Z

I made some fixes.

soareschen · 2021-07-09T16:07:45Z

@DaviRain-Su I notice that right now in master, the tendermint, tendermint-rpc, and tendermint-light-client-js crates are already compilable in wasm using the cargo build-wasm-tendermint and build-wasm-light-client commands. Does that means that the crates already work in WebAssembly and Substrate despite not yet supporting no_std?

@thanethomson do you have any context on how the Wasm builds of Tendermint works?

DaviRain-Su · 2021-07-12T01:49:56Z

@DaviRain-Su I notice that right now in master, the tendermint, tendermint-rpc, and tendermint-light-client-js crates are already compilable in wasm using the cargo build-wasm-tendermint and build-wasm-light-client commands. Does that means that the crates already work in WebAssembly and Substrate despite not yet supporting no_std?

@thanethomson do you have any context on how the Wasm builds of Tendermint works?

I think it might not be supported, I found that some of the dependency crates don't have default-feature = false turned on.

DaviRain-Su · 2021-07-12T01:53:52Z

@soareschen When I use cargo check -p tendermint --target wasm32-unknown-unknown to compile tendermint it gives the following error.
error: target is not supported, for more information see: https://docs.rs/getrandom/#unsupported-targets --> /Users/davirain/.cargo/registry/src/rsproxy.cn-8f6827c7555bfaf8/getrandom-0.2.2/src/lib.rs:213:9 | 213 | / compile_error!("target is not supported, for more information see: \ 214 | | https://docs.rs/getrandom/#unsupported-targets"); | |_________________________________________________________________________^

soareschen · 2021-07-12T07:50:38Z

@DaviRain-Su did you tried building with the current branch or on master? I tried checking and building tendermint with the wasm32-unknown-unknown target on master and it works.

DaviRain-Su · 2021-07-17T12:07:33Z

@DaviRain-Su did you tried building with the current branch or on master? I tried checking and building tendermint with the wasm32-unknown-unknown target on master and it works.

Yes, the current branch and the master branch are the same, and also encountered the same problem as in compiling ibc-proto.

soareschen · 2021-09-17T14:21:01Z

Closing this as the related changes have been merged through other PRs or addressed in other issues.

en and others added 24 commits April 20, 2021 21:12

Enable no_std support

2e97844

fix tendermint Cargo.toml, add 'default-features' to use no_std

601b91f

fix tendermint soure code to support no_std, but now have some error,…

3cba120

… because fs, and path, thiserror

fix: set config,net default std

9a74165

move anomaly

fdbf551

fix ..

f1a3acb

remove anomaly and replace anyhow

03df333

add some fix, but have error

7218ea0

update ...

ce4448a

update ...

8d03730

Merge branch 'octopus-no-std' of github.com:octopus-network/tendermin…

9613130

…t-rs into octopus-no-std

modify primitive no_std_time mod

6cb2a0b

supprot tendermint no_std features

06a09a9

Merge branch 'octopus-no-std' of github.com:octopus-network/tendermin…

3ebcc4c

…t-rs into octopus-no-std

Merge branch 'master' into octopus-no-std

9a0ce8c

Merge branch 'octopus-no-std' of github.com:octopus-network/tendermin…

d8ff8d9

…t-rs into octopus-no-std

Merge branch 'octopus-no-std' of github.com:octopus-network/tendermin…

9381876

…t-rs into octopus-no-std

Merge branch 'octopus-no-std' of github.com:octopus-network/tendermin…

10a4082

…t-rs into octopus-no-std

Merge branch 'octopus-no-std' of github.com:octopus-network/tendermin…

d66f3c0

…t-rs into octopus-no-std

fix proto to support no_std

281b540

add flex-error

0b33a89

add Infallible ChronoParse SubtleEncoding SerdeJson Toml error

1034095

reset temdermint-proto

535d6a4

fix some bugs

07f7026

DaviRain-Su mentioned this pull request Jun 4, 2021

support tendermint no_std features #889

Closed

DaviRain-Su added 2 commits June 4, 2021 13:40

remove tendermint-proro error handle anomaly replace anyhow

10105bb

reset tendermint-proto

9e18096

soareschen requested changes Jun 4, 2021

View reviewed changes

DaviRain-Su added 2 commits June 4, 2021 16:59

update ...

ea319d7

update tendermint-p2p, error handle use anyhow

d49781c

DaviRain-Su mentioned this pull request Jun 10, 2021

Support IBC no_std and error handle by flex-error informalsystems/hermes#1073

Closed

5 tasks

soareschen requested changes Jun 10, 2021

View reviewed changes

DaviRain-Su added 2 commits June 11, 2021 10:52

upgrate k256 version

4557ea6

update Infallible error

2de7c9e

soareschen reviewed Jun 11, 2021

View reviewed changes

Remove Infallible and implement Into for Timestamp directly

1dd613a

fix error

467dd56

DaviRain-Su mentioned this pull request Jun 21, 2021

Add no-std support to ibc informalsystems/hermes#1109

Closed

5 tasks

DaviRain-Su added 6 commits June 23, 2021 19:57

Merge upstream

cbc7f4c

Format code

341a041

fix clippy

437c96e

format code

ce34310

Merge Upstream

47bab2f

Update no_std Used by sp-std replace no-std-compat

26e972b

soareschen mentioned this pull request Jul 9, 2021

Tracking issue for no-std support informalsystems/hermes#1158

Closed

25 tasks

DaviRain-Su added 2 commits July 10, 2021 08:47

fix bug

0bccca1

Update flex-error version and git registry

3ce0bbb

DaviRain-Su added 3 commits July 28, 2021 11:56

Update ...

8540fe7

Merge upstream

d4d0b44

Update tendermint Error

6225e76

soareschen closed this Sep 17, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

enable tendermint no_std and error handle by flex-error #890

enable tendermint no_std and error handle by flex-error #890

DaviRain-Su commented Jun 2, 2021

soareschen left a comment

soareschen Jun 4, 2021

DaviRain-Su Jun 9, 2021

soareschen Jun 4, 2021

DaviRain-Su Jun 9, 2021

soareschen Jun 4, 2021

soareschen Jun 4, 2021

DaviRain-Su Jun 9, 2021

soareschen Jun 4, 2021

DaviRain-Su Jun 9, 2021

DaviRain-Su commented Jun 10, 2021

soareschen Jun 10, 2021

soareschen Jun 11, 2021

DaviRain-Su Jun 11, 2021

DaviRain-Su commented Jun 15, 2021

soareschen commented Jul 9, 2021

DaviRain-Su commented Jul 12, 2021

DaviRain-Su commented Jul 12, 2021

soareschen commented Jul 12, 2021

DaviRain-Su commented Jul 17, 2021

soareschen commented Sep 17, 2021

enable tendermint no_std and error handle by flex-error #890

enable tendermint no_std and error handle by flex-error #890

Conversation

DaviRain-Su commented Jun 2, 2021

soareschen 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

DaviRain-Su commented Jun 10, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaviRain-Su commented Jun 15, 2021

soareschen commented Jul 9, 2021

DaviRain-Su commented Jul 12, 2021

DaviRain-Su commented Jul 12, 2021

soareschen commented Jul 12, 2021

DaviRain-Su commented Jul 17, 2021

soareschen commented Sep 17, 2021