From ab47075d4ba6ed99a4904d674082f70c17d7de18 Mon Sep 17 00:00:00 2001 From: Hugo Trentesaux <hugo@trentesaux.fr> Date: Tue, 14 Feb 2023 13:04:40 +0100 Subject: [PATCH] more doc --- pallets/README.md | 8 ++++---- pallets/duniter-account/README.md | 8 ++++++++ pallets/duniter-test-parameters/README.md | 3 +++ resources/README.md | 2 +- scripts/README.md | 2 +- 5 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 pallets/duniter-test-parameters/README.md diff --git a/pallets/README.md b/pallets/README.md index 797865079..1f0305b5d 100644 --- a/pallets/README.md +++ b/pallets/README.md @@ -17,7 +17,7 @@ These pallets are at the core of Duniter/Äž1 currency ## Functional pallets -- **`duniter-test-parameters`** TODO -- **`oneshot-account`** TODO -- **`provide-randomness`** TODO -- **`upgrade-origin`** TODO \ No newline at end of file +- **`duniter-test-parameters`** Test parameters only used in ÄžDev to allow tweaking parameters more easily. +- **`oneshot-account`** Oneshot accounts are light accounts only used once for anonimity or convenience use case. +- **`provide-randomness`** Lets blockchain users ask for a verifiable random number. +- **`upgrade-origin`** Allows some origins to dispatch a call as root. \ No newline at end of file diff --git a/pallets/duniter-account/README.md b/pallets/duniter-account/README.md index 51b746dd4..d9b809d8a 100644 --- a/pallets/duniter-account/README.md +++ b/pallets/duniter-account/README.md @@ -7,3 +7,11 @@ Duniter customizes the `AccountData` of the `Balances` Substrate pallet. In part The RandomId field was added with the idea to provide a unique id that can not be controlled by user to serve as a basis for robust identification. The discussion is available on the forum. https://forum.duniter.org/t/la-solution-pour-des-identicones-securisees-le-random-id/9126 + +## Account creation fee + +DuniterAccount defines a creation fee that is preleved to the account one block after its creation. This fee goes to the treasury. + +## Sufficient + +DuniterAccount tweaks the substrate AccountInfo to allow identity accounts to exist without existential deposit. This allows to spare the creation fee. \ No newline at end of file diff --git a/pallets/duniter-test-parameters/README.md b/pallets/duniter-test-parameters/README.md new file mode 100644 index 000000000..80a352ff4 --- /dev/null +++ b/pallets/duniter-test-parameters/README.md @@ -0,0 +1,3 @@ +# Duniter test parameters + +This pallet allows ÄžDev runtime to tweak parameter values instead of having it runtime constants. \ No newline at end of file diff --git a/resources/README.md b/resources/README.md index aa7aaeb33..5bd6a187f 100644 --- a/resources/README.md +++ b/resources/README.md @@ -1,3 +1,3 @@ # Resources -TODO \ No newline at end of file +Files used for different purpose like tests. \ No newline at end of file diff --git a/scripts/README.md b/scripts/README.md index 2d79b0c22..95a516bbd 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -1,3 +1,3 @@ # Scripts -TODO \ No newline at end of file +Scripts not moved to xtasks because they only depend on Docker and not Rust. \ No newline at end of file -- GitLab