Add the Kusama Coretime Chain runtime #212

seadanda · 2024-03-01T15:51:53Z

This is similar to the two chains we deployed to Rococo and Westend, with a different PriceAdapter implementation. This is likely to be the most contentious addition here and is obviously not final, but a start until the correct function and parametrisation can be decided upon. Discussion is welcome.

I have also considered adding a minimum factor in adapt_price to ensure that we never actually hit 0. Due to the price corrections being purely multiplicative, if the price ever hits zero there is no going back, which I think should be configurable to avoid. I would be interested to hear people's thoughts on this. I can also add this minimum value to the broker pallet upstream (which I think is probably the best place for that).

Due to the Transact XCMs in the CoretimeInterface, there is a need for hardcoded weights for several relay chain calls. These should be checked after benchmarking the relay chain. There are hardcoded weights on the Relay Chain which should also be checked when the Coretime Chain is benchmarked. XCM emulator tests are being put together to ensure this happens automatically.

TODO:

Refine hardcoded relay weights once they are available (likely in the merge of Upgrade to latest [email protected] release #187). These calls and the hardcoded weights in the relay should be checked after benchmarks are rerun before release
Add proxy pallet
Define new OnRevenue to burn revenue from Coretime (RFC-010) WIP: here.

Pricing model

The AdaptPrice implementation in this PR is designed together with a guideline configuration to provide conservative limits in the early sales to avoid high volatility. I have listed the suggested configuration and outlined the reasoning below.

tl;dr:

Price adapter behaviour:

leadin_factor_at: linear with a max of 5x
adapt_price: linear with conservative limits, maximum factor not relevant for our ideal bulk proportion settings, but set to 1.2 as a conservative limit in case we want to change config without a runtime upgrade.

Start sales parameters:

initialPrice: ~5 KSM
coreCount: 3

Configuration parameters:

advanceNotice: 10 (1 min)
interludeLength: 50400 (7 days)
leadinLength: 50400 (7 days)
regionLength: 5040 (28 days)
idealBulkProportion: 1000000000 (100% for the first few sales)
limitCoresOffered: 3
renewalBump: 30000000 (3% per sale / ~47% annually)
contributionTimeout: 5040 (28 days)

Price adapter reasoning

For the price adapter the main goals are to avoid frontrunning, while also minimising volatility in the early sales. The assumption is that the price will take time to stabilise, and with large corrections we end up flip flopping between values far above and far below the true market price, which will take longer to stabilise the higher those values are between sales. We assume few cores per sale and take into consideration the fact that most cores are occupied by a lease.

The decision to go for a higher lead in factor and a very conservative price adapter are due to the expectation that the early sales will be set such that all cores are sold. A high lead-in max factor allows people to buy at the price they feel comfortable, which affects the market price. This in combination with a conservative price adapter (at the start with no upward correction) means that the price that people are willing to pay is used in the next sale when the cores are sold out, and is adjusted downwards if not all cores are sold. In the case where no cores are sold a minimum factor of 0.5 is applied to gradually bring the price down until a price is found, rather than having something symmetrical which snaps up then can rebound right back down in the extreme case.

Start sales reasoning

This is purely for the first sale, after which the price adapter takes over.
We suggest a starting value between ~4.4 KSM and ~36.8 KSM depending on the figure we assume for the utilisation. These values represent those for the average (mean) of 13% and for maximum utilisation of 100% respectively. We estimate that the true market price lies between these two values, and so we suggest starting from the average (mean) with a lead-in factor of 5.
This lets the market decide between guardrails of ~13%-65% utilisation in the first sale. We then round up the suggestion to 5 KSM to acknowledge the uncertainty around this value.

This is based on the model set out in Erin's proposal and (also Erin's) Kusama tweak to reflect utilisation.

Configuration reasoning

/// The number of Relay-chain blocks in advance which scheduling should be fixed and the
/// `Coretime::assign` API used to inform the Relay-chain.
pub advance_notice: RelayBlockNumber,

advanceNotice: 10 (1 min) - We require ~10 blocks to send notifyCore messages for 100 cores if the max is 10 XCM messages per block. Note 6s blocks

/// The length in blocks of the Interlude Period for forthcoming sales.
pub interlude_length: BlockNumber,

interludeLength: 50400 (7 days) - gives people ample time to renew without reducing sale too much. Note 12s blocks

/// The length in blocks of the Leadin Period for forthcoming sales.
pub leadin_length: BlockNumber,

leadinLength: 50400 (7 days) - price drops for 7 days before becoming fixed, then is fixed for just 14 days before we hit the next region. Note 12s blocks

/// The length in timeslices of Regions which are up for sale in forthcoming sales.
pub region_length: Timeslice,

regionLength: 5040 (28 days) - this is in timeslices, which are set to 80 blocks in the coretime-kusama runtime. These blocks also are relay chain blocks (6s)

/// The proportion of cores available for sale which should be sold in order for the price
/// to remain the same in the next sale.
pub ideal_bulk_proportion: Perbill,

idealBulkProportion: 1000000000 or 400000000 - 100% paired with a small core offering or 40-60% when more people are off their leases and there's a more fluid market with a higher core limit later on - this needs to be modeled before being updated after the first few sales

/// An artificial limit to the number of cores which are allowed to be sold. If `Some` then
/// no more cores will be sold than this.
pub limit_cores_offered: Option<CoreIndex>,

limitCoresOffered: 3 initially - This should replace the auctions that were cancelled (coupled with 100% target means we don't cause price spikes)

/// The amount by which the renewal price increases each sale period.
pub renewal_bump: Perbill,

renewalBump: 30000000 - 3% every 28 days equates to around 47% annually

/// The duration by which rewards for contributions to the InstaPool must be collected.
contribution_timeout: Timeslice,

contributionTimeout: 5040 (28 days) - not much thought behind this one, 1 region to collect seems like a good starting point. This is not relevant until the Coretime Credits are implemented on the relay chain.

eskimor

So we start with an uninitialized broker configuration and then set it via governance?

system-parachains/coretime/coretime-kusama/src/coretime.rs

system-parachains/coretime/coretime-kusama/src/lib.rs

system-parachains/coretime/coretime-kusama/src/coretime.rs

system-parachains/coretime/coretime-kusama/src/xcm_config.rs

Co-authored-by: joe petrowski <[email protected]>

.cargo/config.toml

eskimor · 2024-03-11T20:36:59Z

system-parachains/coretime/coretime-kusama/src/weights/pallet_broker.rs

+	/// Proof: `ParachainSystem::ValidationData` (`max_values`: Some(1), `max_size`: None, mode: `Measured`)
+	/// Storage: `ParachainSystem::LastRelayChainBlockNumber` (r:1 w:0)
+	/// Proof: `ParachainSystem::LastRelayChainBlockNumber` (`max_values`: Some(1), `max_size`: None, mode: `Measured`)
+	fn set_lease() -> Weight {


Weights look good, Relay chain configuration:

require_weight_at_most: Weight::from_parts(170_000_000, 20_000),

worst case call is reserve with 13k ... still fits.

These are copied over from Rococo, so there may be some changes when I run bench bot.

I've been putting together some emulated tests for the relay calls in the coretime chain in case things change drastically any time the weights are regenerated, might be worth having a weight sanity check for these too.

system-parachains/coretime/coretime-kusama/src/xcm_config.rs

muharem · 2024-03-13T14:50:45Z

system-parachains/coretime/coretime-kusama/src/xcm_config.rs

+>;
+
+/// Means for transacting coretime regions on this chain.
+pub type RegionTransactor = NonFungibleAdapter<


It would be nice to have an emulated test for this transactor. At least before this chain becomes fully operational

system-parachains/coretime/coretime-kusama/src/xcm_config.rs

system-parachains/coretime/coretime-kusama/build.rs

system-parachains/coretime/coretime-kusama/src/coretime.rs

…escribeTerminus`

eskimor

Leadin seems off.

system-parachains/coretime/coretime-kusama/src/coretime.rs

eskimor · 2024-03-15T12:09:55Z

system-parachains/coretime/coretime-kusama/src/lib.rs

+	fn filter(&self, c: &RuntimeCall) -> bool {
+		match self {
+			ProxyType::Any => true,
+			ProxyType::NonTransfer => !matches!(


blacklisting instead of whitelisting is extremely brittle.

It's implemented this way in asset-hubs and collectives as the concept itself is a blacklist. I see what you're saying though, that adding a new pallet which contains a transfer-like extrinsic without updating this would be an issue. The same issue applies the other way though, if you whitelist a whole pallet (as is commonly done) and a new extrinsic is added it must be changed here too.
For me I don't mind either way, this is just less code. WDYT?

Just flagging, that I think it is a bad idea. Should probably be a ticket on its own.

joepetrowski · 2024-03-21T06:29:31Z

AFAIK there is just one more thing to address here, viz. handling the burning of Coretime revenue. There is a branch here that puts the revenue in a temp pot that we can handle "properly" in the next runtime upgrade.

The reason we don't burn funds directly on each sale is that the Relay Chain's CheckingAccount tracks all DOT that has been teleported out, so if we burn it on the Coretime chain then it won't actually update the total issuance on the Relay.

IMO the correct solution is to accumulate funds in some temp pot and every period (session, day, sales period, etc.) we send an XCM program to the Relay Chain that will teleport the assets (to withdraw them from Checking) and then burn them. We probably don't want to send this program on every single Coretime purchase.

Donal suggested the above branch as a way to hold funds until the next upgrade handles this XCM program.

bkontur

please apply Cargo.toml suggestions which should make it compilable

system-parachains/coretime/coretime-kusama/Cargo.toml

bkontur · 2024-03-21T10:17:01Z

@seadanda please add it also to the chain-spec-builder

@seadanda and also it should be added to the runtimes-matrix.json (because of release pipeline uses that): https://github.com/polkadot-fellows/runtimes/pull/245/files#diff-ad68d7934f89ae4eaf252d564bbe2e1892b7e1810eddc3dbe53d533a1e07a958R57-R62 (without uri)

Fixed here: seadanda#2

Co-authored-by: Branislav Kontur <[email protected]>

bkontur · 2024-03-21T11:11:41Z

also I am investigating one failed benchmarks with new weights will be fixed here: seadanda#2

2024-03-21 11:14:20.632  INFO main frame::benchmark::pallet: Starting benchmark: pallet_broker::start_sales    
2024-03-21 11:14:20.633 ERROR main runtime: panicked at /home/bparity/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-system-29.0.0/src/lib.rs:1894:9:
assertion `left == right` failed: expected event <wasm:stripped> is not equal to the last event <wasm:stripped>
  left: <wasm:stripped>
 right: <wasm:stripped>    
Error: 
   0: Invalid input: Error executing and verifying runtime benchmark: Execution aborted due to trap: wasm trap: wasm `unreachable` instruction executed
      WASM backtrace:
      error while executing at wasm backtrace:
          0: 0x4cda - <unknown>!rust_begin_unwind
          1: 0x2481 - <unknown>!core::panicking::panic_fmt::hbb0c5dd9c7ebab99
          2: 0x5a9d - <unknown>!core::panicking::assert_failed_inner::h96e1bd7bd3a6b9b7
          3: 0x284e70 - <unknown>!core::panicking::assert_failed::hb0c4fae7bcf657cd
          4: 0x281904 - <unknown>!frame_system::<impl frame_system::pallet::Pallet<T>>::assert_last_event::heed0b4ca0fe4794b
          5: 0x2bac76 - <unknown>!core::ops::function::FnOnce::call_once{{vtable.shim}}::h403ba4fe8f41ce76
          6: 0x2383be - <unknown>!<coretime_kusama_runtime::Runtime as frame_benchmarking::utils::runtime_decl_for_benchmark::BenchmarkV1<sp_runtime::generic::block::Block<sp_runtime::generic::header::Header<u32,sp_runtime::traits::BlakeTwo256>,sp_runtime::generic::unchecked_extrinsic::UncheckedExtrinsic<sp_runtime::multiaddress::MultiAddress<<<sp_runtime::MultiSignature as sp_runtime::traits::Verify>::Signer as sp_runtime::traits::IdentifyAccount>::AccountId,()>,coretime_kusama_runtime::RuntimeCall,sp_runtime::MultiSignature,(frame_system::extensions::check_non_zero_sender::CheckNonZeroSender<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_spec_version::CheckSpecVersion<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_tx_version::CheckTxVersion<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_genesis::CheckGenesis<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_mortality::CheckMortality<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_nonce::CheckNonce<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_weight::CheckWeight<coretime_kusama_runtime::Runtime>,pallet_transaction_payment::ChargeTransactionPayment<coretime_kusama_runtime::Runtime>)>>>>::dispatch_benchmark::h356a9fad89f80485
          7: 0x2f1aeb - <unknown>!Benchmark_dispatch_benchmark

Backtrace omitted. Run with RUST_BACKTRACE=1 environment variable to display it.
Run with RUST_BACKTRACE=full to include source snippets.

bkontur · 2024-03-21T14:26:29Z

also I am investigating one failed benchmarks with new weights will be fixed here: seadanda#2

2024-03-21 11:14:20.632  INFO main frame::benchmark::pallet: Starting benchmark: pallet_broker::start_sales    
2024-03-21 11:14:20.633 ERROR main runtime: panicked at /home/bparity/.cargo/registry/src/index.crates.io-6f17d22bba15001f/frame-system-29.0.0/src/lib.rs:1894:9:
assertion `left == right` failed: expected event <wasm:stripped> is not equal to the last event <wasm:stripped>
  left: <wasm:stripped>
 right: <wasm:stripped>    
Error: 
   0: Invalid input: Error executing and verifying runtime benchmark: Execution aborted due to trap: wasm trap: wasm `unreachable` instruction executed
      WASM backtrace:
      error while executing at wasm backtrace:
          0: 0x4cda - <unknown>!rust_begin_unwind
          1: 0x2481 - <unknown>!core::panicking::panic_fmt::hbb0c5dd9c7ebab99
          2: 0x5a9d - <unknown>!core::panicking::assert_failed_inner::h96e1bd7bd3a6b9b7
          3: 0x284e70 - <unknown>!core::panicking::assert_failed::hb0c4fae7bcf657cd
          4: 0x281904 - <unknown>!frame_system::<impl frame_system::pallet::Pallet<T>>::assert_last_event::heed0b4ca0fe4794b
          5: 0x2bac76 - <unknown>!core::ops::function::FnOnce::call_once{{vtable.shim}}::h403ba4fe8f41ce76
          6: 0x2383be - <unknown>!<coretime_kusama_runtime::Runtime as frame_benchmarking::utils::runtime_decl_for_benchmark::BenchmarkV1<sp_runtime::generic::block::Block<sp_runtime::generic::header::Header<u32,sp_runtime::traits::BlakeTwo256>,sp_runtime::generic::unchecked_extrinsic::UncheckedExtrinsic<sp_runtime::multiaddress::MultiAddress<<<sp_runtime::MultiSignature as sp_runtime::traits::Verify>::Signer as sp_runtime::traits::IdentifyAccount>::AccountId,()>,coretime_kusama_runtime::RuntimeCall,sp_runtime::MultiSignature,(frame_system::extensions::check_non_zero_sender::CheckNonZeroSender<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_spec_version::CheckSpecVersion<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_tx_version::CheckTxVersion<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_genesis::CheckGenesis<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_mortality::CheckMortality<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_nonce::CheckNonce<coretime_kusama_runtime::Runtime>,frame_system::extensions::check_weight::CheckWeight<coretime_kusama_runtime::Runtime>,pallet_transaction_payment::ChargeTransactionPayment<coretime_kusama_runtime::Runtime>)>>>>::dispatch_benchmark::h356a9fad89f80485
          7: 0x2f1aeb - <unknown>!Benchmark_dispatch_benchmark

Backtrace omitted. Run with RUST_BACKTRACE=1 environment variable to display it.
Run with RUST_BACKTRACE=full to include source snippets.

fixed by seadanda@648edde

Szegoo · 2024-03-24T12:15:10Z

system-parachains/coretime/coretime-kusama/src/coretime.rs

+/// if cores sell out) to avoid runaway prices in the early sales. The intention is that this will
+/// be coupled with a low number of cores per sale and a 100% ideal bulk ratio for the first sales.
+pub struct PriceAdapter;
+impl AdaptPrice for PriceAdapter {


Given that the implementation of the price adapter is different from the ones utilized in Rococo and Westend, it becomes even more important to expose a runtime api for querying the price. This will prevent mistakes in offchain code that is connecting to the Coretime chain: paritytech/polkadot-sdk#3485

system-parachains/coretime/coretime-kusama/src/coretime.rs

bkchr · 2024-03-24T14:45:23Z

system-parachains/coretime/coretime-kusama/src/xcm_config.rs

+}
+
+/// A call filter for the XCM Transact instruction. This is a temporary measure until we properly
+/// account for proof size weights.


That should be resolved by using the new mq pallet or @ggwpez?

* Add burn onrevenue impl (WIP) * Define burn account into which revenue will be moved * Add test (WIP) * Fix test

bkchr · 2024-03-25T11:30:07Z

/merge

fellowship-merge-bot · 2024-03-25T11:33:27Z

Enabled auto-merge in Pull Request

Available commands

/merge: Enables auto-merge for Pull Request
/merge cancel: Cancels auto-merge for Pull Request
/merge help: Shows this menu

For more information see the documentation

@ggwpez

In the update to [sdk 1.14](#381) the `request_revenue_info` is now implemented but this call had been switched off when it was added in #212. This PR just enables this again in the coretime interface. cc @ggwpez @s0me0ne-unkn0wn

seadanda added 3 commits March 5, 2024 09:44

Add Kusama Coretime

f3fef79

Add PriceAdapter

2f737fc

Add Changelog

167860c

seadanda force-pushed the donal-coretime-kusama branch from 7c18139 to 167860c Compare March 5, 2024 09:45

eskimor reviewed Mar 5, 2024

View reviewed changes

system-parachains/coretime/coretime-kusama/src/coretime.rs Outdated Show resolved Hide resolved

system-parachains/coretime/coretime-kusama/src/coretime.rs Outdated Show resolved Hide resolved

seadanda added 2 commits March 5, 2024 10:38

Add missing weight

adde260

Merge branch 'main' into donal-coretime-kusama

16bfe23

seadanda marked this pull request as ready for review March 5, 2024 12:26

seadanda added 2 commits March 5, 2024 16:19

Fix pallet_xcm benchmarks

54e341a

Add weights from Kusama relay

9f8786f

eskimor mentioned this pull request Mar 5, 2024

1.2.0 Release #140

Closed

19 tasks

joepetrowski reviewed Mar 7, 2024

View reviewed changes

seadanda and others added 6 commits March 7, 2024 18:55

Apply suggestions from code review

ce92340

Co-authored-by: joe petrowski <[email protected]>

Remove unnecessary migration

18c79cc

Rescue FungibleTransactor from previous clobber

470b218

Remove unnecessary clones in XCMs

08de737

Update AdaptPrice implementation

8cbed69

Edit wording slightly

8e443e9

seadanda commented Mar 8, 2024

View reviewed changes

.cargo/config.toml Show resolved Hide resolved

Merge branch 'main' into donal-coretime-kusama

71f8f15

eskimor reviewed Mar 11, 2024

View reviewed changes

muharem approved these changes Mar 13, 2024

View reviewed changes

seadanda added 4 commits March 14, 2024 23:44

Remove unused CoreCount storage

be6c473

Use RelayTreasuryPalletAccount and add DescribeAllTerminal and `D…

e9d2efb

…escribeTerminus`

Add proxy to coretime chain

061dac1

Tidy up

73824d9

eskimor suggested changes Mar 15, 2024

View reviewed changes

seadanda added 3 commits March 15, 2024 21:35

Remove XCM calls to missing relay functionality

0c4dcde

Fix leadin and add bounds tests for PriceAdapter

af5aad8

Merge branch 'main' into donal-coretime-kusama

30c8496

seadanda and others added 4 commits March 20, 2024 22:18

Update licenses

8a8c55a

Make Coretime async backing ready

5abb10a

Merge branch 'main' into donal-coretime-kusama

b3e917b

fmt

264c5c3

joepetrowski approved these changes Mar 21, 2024

View reviewed changes

Merge branch 'main' into donal-coretime-kusama

530b741

bkontur reviewed Mar 21, 2024

View reviewed changes

seadanda and others added 2 commits March 21, 2024 17:22

Apply suggestions from bko code review

8fcce21

Co-authored-by: Branislav Kontur <[email protected]>

Update lock file

9bfa404

bkontur added 4 commits March 21, 2024 23:15

Added to the runtime-matrix.json

5560a6d

Added to chain-spec-generator

ef14269

Set PriceAdapter for benchmarks

a19707e

Fresh weights

71683db

Szegoo reviewed Mar 24, 2024

View reviewed changes

bkchr reviewed Mar 24, 2024

View reviewed changes

Transfer revenue into holding account to be burnt later

1a1b2ea

* Add burn onrevenue impl (WIP) * Define burn account into which revenue will be moved * Add test (WIP) * Fix test

bkchr approved these changes Mar 25, 2024

View reviewed changes

bkchr added 2 commits March 25, 2024 11:16

Merge remote-tracking branch 'origin/main' into donal-coretime-kusama

a14b993

Fix merge issue

4a69881

fellowship-merge-bot bot enabled auto-merge (squash) March 25, 2024 11:33

fellowship-merge-bot bot merged commit 640a001 into polkadot-fellows:main Mar 25, 2024
32 of 34 checks passed

seadanda deleted the donal-coretime-kusama branch March 25, 2024 13:48

seadanda mentioned this pull request Jul 18, 2024

Re-enable request_revenue_info_at in CoretimeInterface #393

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the Kusama Coretime Chain runtime #212

Add the Kusama Coretime Chain runtime #212

seadanda commented Mar 1, 2024 •

edited

Loading

eskimor left a comment

eskimor Mar 11, 2024

seadanda Mar 12, 2024

muharem Mar 13, 2024

eskimor left a comment

eskimor Mar 15, 2024

seadanda Mar 15, 2024

eskimor Mar 15, 2024

joepetrowski commented Mar 21, 2024

bkontur left a comment

bkontur commented Mar 21, 2024

bkontur commented Mar 21, 2024

bkontur commented Mar 21, 2024

Szegoo Mar 24, 2024 •

edited

Loading

bkchr Mar 24, 2024

bkchr commented Mar 25, 2024

fellowship-merge-bot bot commented Mar 25, 2024

Add the Kusama Coretime Chain runtime #212

Add the Kusama Coretime Chain runtime #212

Conversation

seadanda commented Mar 1, 2024 • edited Loading

Pricing model

tl;dr:

Price adapter behaviour:

Start sales parameters:

Configuration parameters:

Price adapter reasoning

Start sales reasoning

Configuration reasoning

eskimor left a comment

Choose a reason for hiding this comment

eskimor Mar 11, 2024

Choose a reason for hiding this comment

seadanda Mar 12, 2024

Choose a reason for hiding this comment

muharem Mar 13, 2024

Choose a reason for hiding this comment

eskimor left a comment

Choose a reason for hiding this comment

eskimor Mar 15, 2024

Choose a reason for hiding this comment

seadanda Mar 15, 2024

Choose a reason for hiding this comment

eskimor Mar 15, 2024

Choose a reason for hiding this comment

joepetrowski commented Mar 21, 2024

bkontur left a comment

Choose a reason for hiding this comment

bkontur commented Mar 21, 2024

bkontur commented Mar 21, 2024

bkontur commented Mar 21, 2024

Szegoo Mar 24, 2024 • edited Loading

Choose a reason for hiding this comment

bkchr Mar 24, 2024

Choose a reason for hiding this comment

bkchr commented Mar 25, 2024

fellowship-merge-bot bot commented Mar 25, 2024

seadanda commented Mar 1, 2024 •

edited

Loading

Szegoo Mar 24, 2024 •

edited

Loading