Full rewards lifecycle

.maintain/frame-weights-template.hbs

@@ -1,11 +1,27 @@
+// This file is part of Tangle.
+// Copyright (C) 2022-2025 Tangle Foundation.
+//
+// Tangle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Tangle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Tangle.  If not, see <http://www.gnu.org/licenses/>.
+
 {{header}}
 //! Autogenerated weights for `{{pallet}}`
 //!
 //! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION {{version}}
 //! DATE: {{date}}, STEPS: `{{cmd.steps}}`, REPEAT: `{{cmd.repeat}}`, LOW RANGE: `{{cmd.lowest_range_values}}`, HIGH RANGE: `{{cmd.highest_range_values}}`
 //! WORST CASE MAP SIZE: `{{cmd.worst_case_map_values}}`
 //! HOSTNAME: `{{hostname}}`, CPU: `{{cpuname}}`
-//! WASM-EXECUTION: `{{cmd.wasm_execution}}`, CHAIN: `{{cmd.chain}}`, DB CACHE: {{cmd.db_cache}}
+//! WASM-EXECUTION: `{{cmd.wasm_execution}}`, CHAIN: `{{cmd.chain}}`, DB CACHE: `{{cmd.db_cache}}`
 
 // Executed Command:
 {{#each args as |arg|}}
@@ -16,16 +32,28 @@
 #![allow(unused_parens)]
 #![allow(unused_imports)]
 #![allow(missing_docs)]
+#![allow(dead_code)]
 
-use frame_support::{traits::Get, weights::Weight};
+use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weight functions for `{{pallet}}`.
-pub struct WeightInfo<T>(PhantomData<T>);
-{{#if (eq pallet "frame_system_extensions")}}
-impl<T: frame_system::Config> frame_system::ExtensionsWeightInfo for WeightInfo<T> {
+/// Weight functions needed for `{{pallet}}`.
+pub trait WeightInfo {
+	{{#each benchmarks as |benchmark|}}
+	fn {{benchmark.name~}}
+	(
+		{{~#each benchmark.components as |c| ~}}
+		{{c.name}}: u32, {{/each~}}
+	) -> Weight;
+	{{/each}}
+}
+
+/// Weights for `{{pallet}}` using the Substrate node and recommended hardware.
+pub struct SubstrateWeight<T>(PhantomData<T>);
+{{#if (or (eq pallet "frame_system") (eq pallet "frame_system_extensions"))}}
+impl<T: crate::Config> WeightInfo for SubstrateWeight<T> {
 {{else}}
-impl<T: frame_system::Config> {{pallet}}::WeightInfo for WeightInfo<T> {
+impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 {{/if}}
 	{{#each benchmarks as |benchmark|}}
 	{{#each benchmark.comments as |comment|}}
@@ -43,20 +71,19 @@ impl<T: frame_system::Config> {{pallet}}::WeightInfo for WeightInfo<T> {
 		//  Measured:  `{{benchmark.base_recorded_proof_size}}{{#each benchmark.component_recorded_proof_size as |cp|}} + {{cp.name}} * ({{cp.slope}} ±{{underscore cp.error}}){{/each}}`
 		//  Estimated: `{{benchmark.base_calculated_proof_size}}{{#each benchmark.component_calculated_proof_size as |cp|}} + {{cp.name}} * ({{cp.slope}} ±{{underscore cp.error}}){{/each}}`
 		// Minimum execution time: {{underscore benchmark.min_execution_time}}_000 picoseconds.
-		Weight::from_parts({{underscore benchmark.base_weight}}, 0)
-			.saturating_add(Weight::from_parts(0, {{benchmark.base_calculated_proof_size}}))
+		Weight::from_parts({{underscore benchmark.base_weight}}, {{benchmark.base_calculated_proof_size}})
 			{{#each benchmark.component_weight as |cw|}}
 			// Standard Error: {{underscore cw.error}}
 			.saturating_add(Weight::from_parts({{underscore cw.slope}}, 0).saturating_mul({{cw.name}}.into()))
 			{{/each}}
 			{{#if (ne benchmark.base_reads "0")}}
-			.saturating_add(T::DbWeight::get().reads({{benchmark.base_reads}}))
+			.saturating_add(T::DbWeight::get().reads({{benchmark.base_reads}}_u64))
 			{{/if}}
 			{{#each benchmark.component_reads as |cr|}}
 			.saturating_add(T::DbWeight::get().reads(({{cr.slope}}_u64).saturating_mul({{cr.name}}.into())))
 			{{/each}}
 			{{#if (ne benchmark.base_writes "0")}}
-			.saturating_add(T::DbWeight::get().writes({{benchmark.base_writes}}))
+			.saturating_add(T::DbWeight::get().writes({{benchmark.base_writes}}_u64))
 			{{/if}}
 			{{#each benchmark.component_writes as |cw|}}
 			.saturating_add(T::DbWeight::get().writes(({{cw.slope}}_u64).saturating_mul({{cw.name}}.into())))
@@ -67,3 +94,45 @@ impl<T: frame_system::Config> {{pallet}}::WeightInfo for WeightInfo<T> {
 	}
 	{{/each}}
 }
+
+// For backwards compatibility and tests.
+impl WeightInfo for () {
+	{{#each benchmarks as |benchmark|}}
+	{{#each benchmark.comments as |comment|}}
+	/// {{comment}}
+	{{/each}}
+	{{#each benchmark.component_ranges as |range|}}
+	/// The range of component `{{range.name}}` is `[{{range.min}}, {{range.max}}]`.
+	{{/each}}
+	fn {{benchmark.name~}}
+	(
+		{{~#each benchmark.components as |c| ~}}
+		{{~#if (not c.is_used)}}_{{/if}}{{c.name}}: u32, {{/each~}}
+	) -> Weight {
+		// Proof Size summary in bytes:
+		//  Measured:  `{{benchmark.base_recorded_proof_size}}{{#each benchmark.component_recorded_proof_size as |cp|}} + {{cp.name}} * ({{cp.slope}} ±{{underscore cp.error}}){{/each}}`
+		//  Estimated: `{{benchmark.base_calculated_proof_size}}{{#each benchmark.component_calculated_proof_size as |cp|}} + {{cp.name}} * ({{cp.slope}} ±{{underscore cp.error}}){{/each}}`
+		// Minimum execution time: {{underscore benchmark.min_execution_time}}_000 picoseconds.
+		Weight::from_parts({{underscore benchmark.base_weight}}, {{benchmark.base_calculated_proof_size}})
+			{{#each benchmark.component_weight as |cw|}}
+			// Standard Error: {{underscore cw.error}}
+			.saturating_add(Weight::from_parts({{underscore cw.slope}}, 0).saturating_mul({{cw.name}}.into()))
+			{{/each}}
+			{{#if (ne benchmark.base_reads "0")}}
+			.saturating_add(RocksDbWeight::get().reads({{benchmark.base_reads}}_u64))
+			{{/if}}
+			{{#each benchmark.component_reads as |cr|}}
+			.saturating_add(RocksDbWeight::get().reads(({{cr.slope}}_u64).saturating_mul({{cr.name}}.into())))
+			{{/each}}
+			{{#if (ne benchmark.base_writes "0")}}
+			.saturating_add(RocksDbWeight::get().writes({{benchmark.base_writes}}_u64))
+			{{/if}}
+			{{#each benchmark.component_writes as |cw|}}
+			.saturating_add(RocksDbWeight::get().writes(({{cw.slope}}_u64).saturating_mul({{cw.name}}.into())))
+			{{/each}}
+			{{#each benchmark.component_calculated_proof_size as |cp|}}
+			.saturating_add(Weight::from_parts(0, {{cp.slope}}).saturating_mul({{cp.name}}.into()))
+			{{/each}}
+	}
+	{{/each}}
+}

AGENTS.md

@@ -0,0 +1,33 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `node/` hosts the Substrate node binary; treat `runtime/mainnet` and `runtime/testnet` as the authoritative runtime crates.
+- Pallets live under `pallets/…`, with matching runtime APIs in `pallets/*/rpc` and precompiles in `precompiles/`.
+- `client/` contains RPC layers and tracing utilities, while `chainspecs/` and `deployment/` hold network configuration and release artifacts.
+- Scripts for local orchestration sit in `scripts/`; TypeScript simulations are in `user-simulation/` for scenario-driven testing.
+
+## Build, Test, and Development Commands
+- `nix flake develop` opens a fully provisioned shell when using Nix.
+- `cargo check -p node` validates core changes quickly; prefer before pushing.
+- `cargo build --release --features testnet` produces the testnet node; swap features to target mainnet.
+- `./scripts/run-standalone-local.sh --clean` spins up a fresh local testnet with authorities and logs under `/tmp`.
+- `npx @acala-network/chopsticks@latest --config=scripts/chopsticks.yml` forks the live chain for rapid iteration.
+- From `user-simulation/`, use `yarn install && yarn start` to exercise end-to-end flows against a local node.
+
+## Coding Style & Naming Conventions
+- Stick to the pinned toolchain in `rust-toolchain.toml` (Rust 1.86 plus `rustfmt`, `clippy`, and `wasm32-unknown-unknown` target).
+- Format via `cargo fmt` (hard tabs, 100-column width) and lint with `cargo clippy --workspace --all-targets`.
+- Prefer `snake_case` for modules/functions, `UpperCamelCase` for types, and `SCREAMING_SNAKE_CASE` for constants; mirror existing pallet naming when adding crates.
+- Run `dprint fmt` on TOML manifests when touching dependency metadata.
+
+## Testing Guidelines
+- `cargo test --workspace` must pass; add focused crates with `-p pallet-name` for faster loops.
+- Mirror runtime invariants in Rust unit tests; use benchmarks or fuzzers under `pallets/*/benchmarking` and `pallets/*/fuzzer` when logic is math-heavy.
+- Execute `yarn test` in `user-simulation/` before merging features that affect external RPC flows.
+- Document new integration scenarios in `scripts/` (e.g., additional Chopsticks configs) when manual steps are required.
+
+## Commit & Pull Request Guidelines
+- Follow the existing Conventional Commit pattern (`feat:`, `fix:`, `docs:`, `chore:`) seen in `git log`.
+- Keep commits scoped to one logical change and include relevant crate paths in the body when touching multiple pallets.
+- PRs should summarize motivation, list test commands run, and link issues or RFCs; attach screenshots only when UX or telemetry dashboards change.
+- Request reviews from runtime and node owners for consensus-critical updates; surface migration notes for storage changes.