Commit Graph
28 Commits
Author SHA1 Message Date
Luke Schoen 5a925ecc7e feat: Allocate ss58 address format to DataHighway (#6530) 2020-06-30 08:31:32 +00:00
Luke Schoen c263a24efe refactor: Remove unnecessary space (#5276) 2020-03-17 14:12:34 +01:00
Luke Schoen 811124234d docs: Try fix typo (#2677) 2019-05-28 16:59:09 +02:00
Luke SchoenandGavin Wood 94d4ef9105 Fix typo in block_builder.rs (#2674)
* Fix typo in block_builder.rs

* Fix the typo fix again in block_builder.rs

Co-Authored-By: Gavin Wood <github@gavwood.com>
2019-05-28 16:58:31 +02:00
Luke Schoen b017e683dc docs: Update Support SRML to link to StorageDoubleMap in Rustdocs (#2646)
* docs: Update Support SRML to link to StorageDoubleMap in Rustdocs

* review-fix: Add missing backticks. Add trait text for consistency. Fix typo

* review-fix: Move trait text out of link
2019-05-23 10:34:00 +01:00
Luke Schoen 1ce221f0d8 docs: Rephrase EnumerableStorageMap comment in Rustdocs (#2647) 2019-05-22 09:18:18 +02:00
Luke Schoen 39197f58f4 refactor: Remove duplicate line. Show on separate lines to fix formatting (#2402) 2019-04-29 09:40:08 +02:00
Luke Schoen 21d1ee4e99 Documentation for the Session Module (#2283)
* WIP

* fix: Redo session module docs incorporating approach used by Joe in democracy

* remove unncessary quotes

* docs: Add example from srml to session module docs

* replace asterix with dash

* session start

* make example compile

* index html updates

* Update lib.rs
2019-04-23 22:30:30 +02:00
Luke Schoen f1f01f8212 Documentation for example module (#1947)
* WIP: SRML Example Module README

* add newlines

* review-fix: Change const to let. Explain generic usage more

* refactor: Remove example steps 2 and 3. User can refer to other examples to figure it out

* fix: Update to incorporate approved approach of staking module docs in PR #1951

* fix: Move into expandable Details arrow and fix syntax so appears correctly in rust docs

* fix: Fix linting

* docs: Add Public Dispatchable functions

* fix: Rearrange to use Simple Code Snippet and Examples from SRML

* fix: Remove duplicate Dispatchable Functions section

* fix: Remove Implementation Details as requested by Gav
2019-04-23 19:01:58 +01:00
Luke Schoen 5fe4c4591d Documentation for assets module (#1945)
* WIP - SRML Assets Module README

* docs: Tweaks for consistency

* docs: Add missing newline

* review-fix: Remove non-SRML trait dependencies

* review-fix: Replace const with let

* review-fix: Remove use of compact in signature

* review-fix: Change const to let since cannot use result of function call

* fix: Add backticks around type and mention type it derives from

* review-fix: Update variable names since changed to lowercase since using let

* fix: Change type to bold instead of code

* review-fix: Update Asset module

* refactor: Consistent bullet points. Remove whitespace between items

* review-fix: Remove useless blah

* review-fix: Remove Storage Items

* review-fix: Remove Types

* review-fix: Remove duplicate instructions

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* Update srml/assets/src/lib.rs

Co-Authored-By: ltfschoen <ltfschoen@users.noreply.github.com>

* review-fix: Remove since will be replaced after macro expansion #2068 as per comment

* review-fix: Move Goals within overview

* fix: Fix indentation

* style and a few minor changes

* remove Events

* capitalization

* docs: Reword the Goals to remove mention of cold wallets based on discussion with Joe

* Wording

* Update lib.rs

* Update lib.rs

* Update lib.rs
2019-04-23 18:59:17 +01:00
Luke Schoen d70799dfc8 fix minor typos (#2324)
* opening and closing links

* sudo example compiles

* add Aura after it was merged to master

* Timestamp doc testing passes

* Timestamp doc testing works, extraneous lines commented out

* balances

* remove extern crate line

* Removed unneeded code snippet from aura

* make consensus compiles

* executive compiles

* cleanup unnecessary lines

* staking (removed examples that are just copies of tests)

* minor typos

* restore tab spacing
2019-04-18 15:51:42 +02:00
Luke Schoen 7e24278634 docs: Fix off-chain worker execution strategy comment (#2253) 2019-04-11 09:19:10 +02:00
Luke Schoen 296d37ac7f docs: Update Substrate CLI Light option to be experimental (#2250)
Consistency with Parity Ethereum CLI Light option https://github.com/paritytech/parity-ethereum/blob/master/parity/cli/mod.rs#L263
2019-04-10 21:43:50 +02:00
Luke Schoen a4168f2515 docs: Update Readme with example of how to run tests only for a single package (#1946) 2019-03-07 22:13:49 +01:00
Luke Schoen cb52401350 Update SRML Council: prevent excess votes/computation (#1162)
* fix: Add assertions to prevent excess votes and computation, and to end council seat election when no empty seats

* Add assertion to prevent a vote from voters that provide a list of votes that exceeds the desired seats length, since otherise an attacker may be able to submit a very long list of `votes` that far exceeds the amount of candidates and waste more computation than a reasonable voting bond would cover. Added additional associated test that may be run with `cargo test -p srml-council`

* Add assertion so expired council seats are not up for election when desired seat count changes during the voting period such that there are no longer any empty seats

* Update comment to refer to `reporter` instead of `who` (target of inactivity), since the origin is the `reporter`

* Update commment to refer more specifically to how many vote indexes, since `InactiveGracePeriod` is measured in vote indexes

* Update comment for `ApprovalsOf` since previously the comment was a duplicate of the comment for `LastActiveOf`'s

* Create variable to refer to `retaining_seats` to improve readability

* Reference Notes: https://hackmd.io/nr6kPD2sR4urmljtvHs0CQ

* WIP - length votes should be less than length candidates. pushing changes for reference so can fix

* fix: Amount of candidate approval votes cannot exceed candidates amount. Candidates amount must be over zero.

* Fix so that amount of candidate approval votes cannot exceed amount of candidates (instead of desired seats)

* Add assertion to `set_approvals` such that amount of candidates to receive approval votes must be greater than zero. Add associated test

* fix: Remove assertion preventing votes when empty seats is 0

* review-fix: Replace with is_zero and add corresponding test

* Update seats.rs

* Update seats.rs
2019-01-07 15:53:37 +01:00
Luke Schoen b2ce2f4bd9 Update SRML Assets: add total supply query, refactor with specific tests (#1185)
* Update SRML Assets: add total supply query, refactor with specific unit tests, update assertions

* Add feature and tests to allow querying total supply

* Add assertion and tests to ensure that transfer amount is greater than or equal to one unit

* Replace broad `it_works` function test with various specific unit tests

* Fix `destroy` function by moving assertion before the action

* Fix typos `Transfered` should be `Transferred`, `requried` should be `required`

* Reference: https://hackmd.io/nr6kPD2sR4urmljtvHs0CQ?view#Assets-Module

* refactor: Order imports alphabetically

* review-fix: Replace non-zero check with shorter equivalent

* review-fix: Restore order of non-zero assertion and destroy account

* Update lib.rs
2018-12-14 08:32:59 +01:00
Luke Schoen 59e1801ca1 docs: (#1200)
Fixes ordering of command-line arguments. `substrate --help` shows usage as substrate `[FLAGS] [OPTIONS] [SUBCOMMAND]`, where `--chain=staging` is one of the possible OPTIONS, and `build-spec` is a possible SUBCOMMAND.
The ordering should be `substrate --chain=staging build-spec` instead.

Relates to issue raised by user attente in Riot https://matrix.to/#/!HzySYSaIhtyWrwiwEV:matrix.org/$154385734133299JuBZU:matrix.parity.io
2018-12-03 20:29:46 +01:00
Luke Schoen 84b959b9e7 docs: Fix typos (#1141) 2018-11-20 08:41:56 +01:00
Luke Schoen 037f9dde10 docs: Extends #999. Remove disused package readmes. Rename to sr-metadata. Fix Readme Rustdoc names (#1016)
* docs: Remove safe-mix since is no longer local dependency

* docs: Fix existing packages link. Still only includes Substrate Core

* docs: Remove empty package Readmes. Remove old docs links. Rename to Readme

* docs: Remove link to old docs

* misc: Merge latest from master. Renaem to sr-metadata. Fix list of RustDoc package names

* Rename substrate-metadata to sr-metadata, since it is in the "srml" subdirectory

* Change example to use package name that opens all packages in RustDocs

* Fix list of packages names that are available to open in RustDocs

* fix typo

* fix ordering of CLI options and add missing backslash
2018-11-12 21:18:06 +01:00
Luke Schoen 6edf23d155 refactor: Fixes #1083. Rename ApplyExtrinsicFailed method without typo (#1084) 2018-11-07 21:42:47 +01:00
Luke Schoen 10210b9520 docs: Remove readme since should not be in src folder (#1004) 2018-10-26 11:10:06 +02:00
Luke Schoen f923e38cc7 docs: Relates to Issue #995. Fix links in existing documentation (#999)
* docs: Remove safe-mix since is no longer local dependency

* docs: Fix existing packages link. Still only includes Substrate Core
2018-10-26 11:09:48 +02:00
Luke Schoen 7b4b98abef docs: Move contribution links to Contribution section (#994) 2018-10-25 18:35:42 +02:00
Luke Schoen 190f167251 docs: Fix broken link to License in Readme (#993)
* docs: Fix link to LICENSE

* fix: Remove surrounding text
2018-10-25 18:35:13 +02:00
Luke Schoen a6596582bf docs: Relates to #578 Minor fixes to documentation section in Readme (#992)
* docs: Fix syntax for module comment. Rename to substrate Core

* docs: Reorder package layers in order of level of abstraction

* docs: Make text more concise

* docs: Add SRML abbreviation
2018-10-25 18:34:49 +02:00
Luke Schoen c207ecfbfc docs: Relates to #578. Add instructions for rustdoc viewing and contributing (#957)
* doc: Relates to #578. Add rustdoc documentation guide to readme

* fix: Fix testing of dot points. Show packages over multiple lines so all visible

* fix: Fix indentation and change from authorting to contributing
2018-10-25 10:13:20 +02:00
Luke Schoen e47f3835fd fix: Fix typo in argument name (#935) 2018-10-20 12:43:20 +02:00
Luke Schoen 4307f456ad docs: Fixes #204. Update Readme. Add command to switch to Rust stable. Append binaries to installation command (#205)
* docs: Fixes #204

* Add command to switch to a stable version of Rust before installing Polkadot PoC-1 since error occurs when trying to install using Rust Nightly, which some users may have configured as their active toolchain
* Append ` polkadot subkey` to the command that installs the latest version of Polkadot PoC-1 to overcome error

* Update README.md
2018-06-07 09:29:41 +02:00