Merge branch 'main' into release-v0.4.0

zeitgeistpm · Oct 10, 2023 · e459e29 · e459e29
2 parents 628c559 + 575ebec
commit e459e29
Show file tree

Hide file tree

Showing 49 changed files with 1,841 additions and 1,842 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -24,10 +24,11 @@ jobs:
 
       - name: Install build tools
         run: ./scripts/init.sh
-
-      - uses: actions-rs/[email protected]
-        with:
-          crate: taplo-cli
+
+# TODO(#1125): Use actions-rs/install for Taplo once stable        
+#      - uses: actions-rs/[email protected]
+#        with:
+#          crate: taplo-cli
 
       - name: Cache Dependencies
         uses: Swatinem/rust-cache@v1

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -52,22 +52,9 @@ mark the PR with the following labels according to
 
 ## Style Guide
 
-- Use `rustfmt` to format your contributions.
-- Avoid panickers like `unwrap()` even if there's proof that they are
-  infallible.
-- Dispatches that don't use `#[transactional]` macro **must** contain a comment
-  including `MARK(non-transactional): ...` followed by a short explanation why
-  the dispatch doesn't require `#[transactional]`.
-- Functions are written in snake case, i.e. `my_function`, anything else is
-  declared in CamelCase (starting with a capital first letter).
-- Indentations consist of spaces, unless the language used requires tabs.
-- Anything that is publicly visible must be documented. This encompasses but is
-  not limited to whole crates (top level documentation), public types and
-  functions, dispatachble functions (functions that can be called by
-  transactions), the `Error` and `Event` enum as well as the `Config` trait.
-- Any newly added or modified functionality must be subject to at least one test
-  case. A full code coverage is the targeted goal.
+- Refer to the [style guide].
 
 [rules]: #Rules
 [docs/changelog_for_devs.md]: docs/changelog_for_devs.md
+[style guide]: docs/STYLE_GUIDE.md
 [zeitgeistpm]: https://github.com/zeitgeistpm
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/STYLE_GUIDE.md b/docs/STYLE_GUIDE.md
@@ -1,5 +1,10 @@
 # Style guide
 
+As a basis, the
+[Substrate Style Guide](https://docs.substrate.io/build/troubleshoot-your-code/)
+should be taken into account. In addition to that, the following sections
+further elaborate the style guide used in this repository.
+
 ## Comments
 
 - Comments **must** be wrapped at 100 chars per line.

diff --git a/misc/frame_weight_template.hbs b/misc/frame_weight_template.hbs
@@ -25,6 +25,9 @@ impl<T: frame_system::Config> {{pallet}}::weights::WeightInfo for WeightInfo<T>
     {{#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| ~}}
@@ -34,27 +37,26 @@ impl<T: frame_system::Config> {{pallet}}::weights::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}} nanoseconds.
-        {{#if (ne benchmark.base_calculated_proof_size "0")}}
         Weight::from_parts({{underscore benchmark.base_weight}}, {{benchmark.base_calculated_proof_size}})
-        {{else}}
-        Weight::from_ref_time({{underscore benchmark.base_weight}})
-        {{/if}}
             {{#each benchmark.component_weight as |cw|}}
             // Standard Error: {{underscore cw.error}}
-            .saturating_add(Weight::from_ref_time({{underscore cw.slope}}).saturating_mul({{cw.name}}.into()))
+            .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}}_u64))
+            .saturating_add(T::DbWeight::get().reads({{benchmark.base_reads}}))
             {{/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}}_u64))
+            .saturating_add(T::DbWeight::get().writes({{benchmark.base_writes}}))
             {{/if}}
+            {{#each benchmark.component_writes as |cw|}}
+            .saturating_add(T::DbWeight::get().writes(({{cw.slope}}_u64).saturating_mul({{cw.name}}.into())))
+            {{/each}}
             {{#each benchmark.component_calculated_proof_size as |cp|}}
-			.saturating_add(Weight::from_proof_size({{cp.slope}}).saturating_mul({{cp.name}}.into()))
-			{{/each}}
+           .saturating_add(Weight::from_parts(0, {{cp.slope}}).saturating_mul({{cp.name}}.into()))
+           {{/each}}
     }
     {{/each}}
 }
diff --git a/misc/orml_weight_template.hbs b/misc/orml_weight_template.hbs
@@ -25,6 +25,9 @@ impl<T: frame_system::Config> {{pallet}}::WeightInfo for WeightInfo<T> {
     {{#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| ~}}
@@ -34,27 +37,26 @@ 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}} nanoseconds.
-        {{#if (ne benchmark.base_calculated_proof_size "0")}}
         Weight::from_parts({{underscore benchmark.base_weight}}, {{benchmark.base_calculated_proof_size}})
-        {{else}}
-        Weight::from_ref_time({{underscore benchmark.base_weight}})
-        {{/if}}
             {{#each benchmark.component_weight as |cw|}}
             // Standard Error: {{underscore cw.error}}
-            .saturating_add(Weight::from_ref_time({{underscore cw.slope}}).saturating_mul({{cw.name}}.into()))
+            .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}}_u64))
+            .saturating_add(T::DbWeight::get().reads({{benchmark.base_reads}}))
             {{/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}}_u64))
+            .saturating_add(T::DbWeight::get().writes({{benchmark.base_writes}}))
             {{/if}}
+            {{#each benchmark.component_writes as |cw|}}
+            .saturating_add(T::DbWeight::get().writes(({{cw.slope}}_u64).saturating_mul({{cw.name}}.into())))
+            {{/each}}
             {{#each benchmark.component_calculated_proof_size as |cp|}}
-			.saturating_add(Weight::from_proof_size({{cp.slope}}).saturating_mul({{cp.name}}.into()))
-			{{/each}}
+           .saturating_add(Weight::from_parts(0, {{cp.slope}}).saturating_mul({{cp.name}}.into()))
+           {{/each}}
     }
     {{/each}}
 }
diff --git a/misc/weight_template.hbs b/misc/weight_template.hbs
@@ -37,6 +37,9 @@ impl<T: frame_system::Config> WeightInfoZeitgeist for WeightInfo<T> {
     {{#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| ~}}
@@ -46,27 +49,26 @@ impl<T: frame_system::Config> WeightInfoZeitgeist 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}} nanoseconds.
-        {{#if (ne benchmark.base_calculated_proof_size "0")}}
         Weight::from_parts({{underscore benchmark.base_weight}}, {{benchmark.base_calculated_proof_size}})
-        {{else}}
-        Weight::from_ref_time({{underscore benchmark.base_weight}})
-        {{/if}}
             {{#each benchmark.component_weight as |cw|}}
             // Standard Error: {{underscore cw.error}}
-            .saturating_add(Weight::from_ref_time({{underscore cw.slope}}).saturating_mul({{cw.name}}.into()))
+            .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}}_u64))
+            .saturating_add(T::DbWeight::get().reads({{benchmark.base_reads}}))
             {{/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}}_u64))
+            .saturating_add(T::DbWeight::get().writes({{benchmark.base_writes}}))
             {{/if}}
+            {{#each benchmark.component_writes as |cw|}}
+            .saturating_add(T::DbWeight::get().writes(({{cw.slope}}_u64).saturating_mul({{cw.name}}.into())))
+            {{/each}}
             {{#each benchmark.component_calculated_proof_size as |cp|}}
-			.saturating_add(Weight::from_proof_size({{cp.slope}}).saturating_mul({{cp.name}}.into()))
-			{{/each}}
+           .saturating_add(Weight::from_parts(0, {{cp.slope}}).saturating_mul({{cp.name}}.into()))
+           {{/each}}
     }
     {{/each}}
 }
diff --git a/primitives/src/constants.rs b/primitives/src/constants.rs
@@ -113,6 +113,9 @@ pub const MAX_ASSETS: u16 = MAX_CATEGORIES + 1;
 /// Pallet identifier, mainly used for named balance reserves.
 pub const SWAPS_PALLET_ID: PalletId = PalletId(*b"zge/swap");
 
+// Orderbook
+pub const ORDERBOOK_PALLET_ID: PalletId = PalletId(*b"zge/ordb");
+
 // Treasury
 /// Pallet identifier, used to derive treasury account
 pub const TREASURY_PALLET_ID: PalletId = PalletId(*b"zge/tsry");
diff --git a/primitives/src/constants/mock.rs b/primitives/src/constants/mock.rs
@@ -120,6 +120,11 @@ parameter_types! {
     pub const SwapsPalletId: PalletId = PalletId(*b"zge/swap");
 }
 
+// Orderbook parameters
+parameter_types! {
+    pub const OrderbookPalletId: PalletId = PalletId(*b"zge/ordb");
+}
+
 // Shared within tests
 // Balance
 parameter_types! {

diff --git a/primitives/src/market.rs b/primitives/src/market.rs
@@ -61,7 +61,7 @@ pub struct Market<AI, BA, BN, M, A> {
     /// The resolved outcome.
     pub resolved_outcome: Option<OutcomeReport>,
     /// See [`MarketDisputeMechanism`].
-    pub dispute_mechanism: MarketDisputeMechanism,
+    pub dispute_mechanism: Option<MarketDisputeMechanism>,
     /// The bonds reserved for this market.
     pub bonds: MarketBonds<AI, BA>,
 }
@@ -162,7 +162,7 @@ where
             .saturating_add(MarketStatus::max_encoded_len())
             .saturating_add(<Option<Report<AI, BN>>>::max_encoded_len())
             .saturating_add(<Option<OutcomeReport>>::max_encoded_len())
-            .saturating_add(<MarketDisputeMechanism>::max_encoded_len())
+            .saturating_add(<Option<MarketDisputeMechanism>>::max_encoded_len())
             .saturating_add(<MarketBonds<AI, BA>>::max_encoded_len())
     }
 }
@@ -393,7 +393,7 @@ mod tests {
             status: MarketStatus::Active,
             report: None,
             resolved_outcome: None,
-            dispute_mechanism: MarketDisputeMechanism::Authorized,
+            dispute_mechanism: Some(MarketDisputeMechanism::Authorized),
             bonds: MarketBonds::default(),
         };
         assert_eq!(market.matches_outcome_report(&outcome_report), expected);

diff --git a/primitives/src/pool.rs b/primitives/src/pool.rs
@@ -1,3 +1,4 @@
+// Copyright 2023 Forecasting Technologies LTD.
 // Copyright 2021-2022 Zeitgeist PM LLC.
 //
 // This file is part of Zeitgeist.
@@ -83,4 +84,5 @@ where
 pub enum ScoringRule {
     CPMM,
     RikiddoSigmoidFeeMarketEma,
+    Orderbook,
 }
diff --git a/runtime/battery-station/Cargo.toml b/runtime/battery-station/Cargo.toml
@@ -113,6 +113,7 @@ zrml-court = { workspace = true }
 zrml-global-disputes = { workspace = true, optional = true }
 zrml-liquidity-mining = { workspace = true }
 zrml-market-commons = { workspace = true }
+zrml-orderbook-v1 = { workspace = true }
 zrml-prediction-markets = { workspace = true }
 zrml-rikiddo = { workspace = true }
 zrml-simple-disputes = { workspace = true }
@@ -214,6 +215,7 @@ runtime-benchmarks = [
     "zrml-global-disputes/runtime-benchmarks",
     "zrml-styx/runtime-benchmarks",
     "zrml-swaps/runtime-benchmarks",
+    "zrml-orderbook-v1/runtime-benchmarks",
 ]
 std = [
     "frame-executive/std",
@@ -328,6 +330,7 @@ std = [
     "zrml-styx/std",
     "zrml-swaps-runtime-api/std",
     "zrml-swaps/std",
+    "zrml-orderbook-v1/std",
 ]
 try-runtime = [
     "frame-executive/try-runtime",
@@ -380,6 +383,7 @@ try-runtime = [
     "zrml-global-disputes/try-runtime",
     "zrml-styx/try-runtime",
     "zrml-swaps/try-runtime",
+    "zrml-orderbook-v1/try-runtime",
 
     # Parachain
     "pallet-author-inherent?/try-runtime",

diff --git a/runtime/battery-station/src/lib.rs b/runtime/battery-station/src/lib.rs
@@ -128,16 +128,16 @@ impl Contains<RuntimeCall> for ContractsCallfilter {
                     dispute { .. } => true,
                     // Only allow CPMM markets using Authorized or SimpleDisputes dispute mechanism
                     create_market {
-                        dispute_mechanism: MarketDisputeMechanism::Authorized,
+                        dispute_mechanism: Some(MarketDisputeMechanism::Authorized),
                         scoring_rule: ScoringRule::CPMM,
                         ..
                     } => true,
                     create_cpmm_market_and_deploy_assets {
-                        dispute_mechanism: MarketDisputeMechanism::Authorized,
+                        dispute_mechanism: Some(MarketDisputeMechanism::Authorized),
                         ..
                     } => true,
                     edit_market {
-                        dispute_mechanism: MarketDisputeMechanism::Authorized,
+                        dispute_mechanism: Some(MarketDisputeMechanism::Authorized),
                         scoring_rule: ScoringRule::CPMM,
                         ..
                     } => true,
@@ -180,18 +180,18 @@ impl Contains<RuntimeCall> for IsCallable {
                         scoring_rule: ScoringRule::RikiddoSigmoidFeeMarketEma, ..
                     } => false,
                     create_market {
-                        dispute_mechanism: MarketDisputeMechanism::SimpleDisputes,
+                        dispute_mechanism: Some(MarketDisputeMechanism::SimpleDisputes),
                         ..
                     } => false,
                     edit_market {
                         scoring_rule: ScoringRule::RikiddoSigmoidFeeMarketEma, ..
                     } => false,
                     create_cpmm_market_and_deploy_assets {
-                        dispute_mechanism: MarketDisputeMechanism::SimpleDisputes,
+                        dispute_mechanism: Some(MarketDisputeMechanism::SimpleDisputes),
                         ..
                     } => false,
                     edit_market {
-                        dispute_mechanism: MarketDisputeMechanism::SimpleDisputes,
+                        dispute_mechanism: Some(MarketDisputeMechanism::SimpleDisputes),
                         ..
                     } => false,
                     _ => true,

diff --git a/runtime/battery-station/src/parameters.rs b/runtime/battery-station/src/parameters.rs
@@ -305,6 +305,9 @@ parameter_types! {
     /// Pallet identifier, mainly used for named balance reserves.
     pub const SwapsPalletId: PalletId = SWAPS_PALLET_ID;
 
+    // Orderbook parameters
+    pub const OrderbookPalletId: PalletId = ORDERBOOK_PALLET_ID;
+
     // System
     pub const BlockHashCount: u64 = 250;
     pub const SS58Prefix: u8 = 73;