Defensive Programming in Substrate Reference Document #2615
Conversation
|
the base of the PR has changed, it shouldn't create/update the |
| //! | ||
| //! ## General Practices | ||
| //! | ||
| //! When developing within the context of the a runtime, there is one golden rule: |
There was a problem hiding this comment.
Since this ref doc is describing safe programming in Substrate in general, I think it would be interesting to elaborate why the runtime should not panic (no fee DoS and, in some cases, stalled runtime) and where it's OK.
There was a problem hiding this comment.
Added one example, it may need more elaboration.
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com>
|
@kianenigma I have hopefully addressed your feedback, added documentation to the supporting files in |
kianenigma
added
the
R0-silent
Head branch was pushed to by a user without write access
|
The CI pipeline was cancelled due to failure one of the required jobs. |
|
@kianenigma (sorry for the ping) CI looks all good and green now. |
You need to fix the toml formats it seems. |
b686bfe
_This PR is being continued from paritytech#2206, which was closed when the developer_hub was merged._ closes paritytech/polkadot-sdk-docs#44 --- # Description This PR adds a reference document to the `developer-hub` crate (see paritytech#2102). This specific reference document covers defensive programming practices common within the context of developing a runtime with Substrate. In particular, this covers the following areas: - Default behavior of how Rust deals with numbers in general - How to deal with floating point numbers in runtime / fixed point arithmetic - How to deal with Integer overflows - General "safe math" / defensive programming practices for common pallet development scenarios - Defensive traits that exist within Substrate, i.e., `defensive_saturating_add `, `defensive_unwrap_or` - More general defensive programming examples (keep it concise) - Link to relevant examples where these practices are actually in production / being used - Unwrapping (or rather lack thereof) 101 todo -- - [x] Apply feedback from previous PR - [x] This may warrant a PR to append some of these docs to `sp_arithmetic` --------- Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com> Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com>
This PR is being continued from #2206, which was closed when the developer_hub was merged.
closes paritytech/polkadot-sdk-docs#44
Description
This PR adds a reference document to the
developer-hubcrate (see #2102). This specific reference document covers defensive programming practices common within the context of developing a runtime with Substrate.In particular, this covers the following areas:
defensive_saturating_add,defensive_unwrap_ortodo
sp_arithmetic