diff --git a/docs/concepts/governance.md b/docs/concepts/governance.md index 8e73dc0e5..3036c7b76 100644 --- a/docs/concepts/governance.md +++ b/docs/concepts/governance.md @@ -346,3 +346,4 @@ Some network parameters have minimum/maximum boundaries to ensure they aren't su | `governance.proposal.(TYPE).minEnact` | Must be greater than / equal to the corresponding `minClose`, proposal can't be enacted before voting on it has closed. | | `governance.proposal.(TYPE).requiredMajority` | Minimum 0.0, maximum 1.0. Is multiplied by 100 to get percentage. | | `governance.proposal.(TYPE).requiredParticipation`| Minimum 0.0, maximum 1.0. Is multiplied by 100 to get percentage. | +| `rewards.activityStreak.benefitTiers`: `reward_multiplier` | Minimum 1.0. | \ No newline at end of file diff --git a/docs/concepts/trading-on-vega/discounts-rewards.md b/docs/concepts/trading-on-vega/discounts-rewards.md index 8dc38969d..7a278b996 100644 --- a/docs/concepts/trading-on-vega/discounts-rewards.md +++ b/docs/concepts/trading-on-vega/discounts-rewards.md @@ -70,6 +70,12 @@ You can see the current reward hoarder bonus requirements and benefits on the [b These tiers are set through network parameters, and thus can be changed through [governance](../governance.md#network-parameter-governance). +:::tip Try it out +[Tutorial: Propose a network parameter change](../../tutorials/proposals/network-parameter-proposal.md) + +Note: You'll need to format your proposal using JSON to include multiple tiers in the value field. +::: + ## Activity streak Traders that keep up an activity streak, either by placing trades or keeping a position open over several epochs, can receive a greater share of rewards and their locked reward proceeds will be available sooner. @@ -83,6 +89,12 @@ You can see the current activity streak requirements and benefits on the [block The details for activity streaks are set through network parameters, and thus can be changed through [governance](../governance.md#network-parameter-governance). +:::tip Try it out +[Tutorial: Propose a network parameter change](../../tutorials/proposals/network-parameter-proposal.md) + +Note: You'll need to format your proposal using JSON to include multiple tiers in the value field. +::: + ## Setting rewards Rewards can be set up by anyone to incentivise certain trading behaviours they want to see on a market (or markets). @@ -102,7 +114,7 @@ Some rewards measure trader activity over a number of epochs (set per reward). T :::tip Try it out * [How to fund rewards](#how-to-fund-rewards) -* [Set up a reward transfer](../../tutorials/assets-tokens/transferring-assets.md) +* [Tutorial: Set up a reward transfer](../../tutorials/assets-tokens/transferring-assets.md) ::: ### How rewards are scaled diff --git a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md index 340260207..451cbd740 100644 --- a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md +++ b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md @@ -3,7 +3,7 @@ { rationale: { title: "Update market.fee.factors.infrastructureFee", - description: "Proposal to update market.fee.factors.infrastructureFee to 300}" + description: "Proposal to update market.fee.factors.infrastructureFee to 300" }, terms: { updateNetworkParameter: { diff --git a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_cmd.md b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_cmd.md index 765c2bab0..c53d36bd3 100644 --- a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_cmd.md +++ b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_cmd.md @@ -4,7 +4,7 @@ "proposalSubmission": { "rationale": { "title": "Update market.fee.factors.infrastructureFee", - "description": "Proposal to update market.fee.factors.infrastructureFee to 300}" + "description": "Proposal to update market.fee.factors.infrastructureFee to 300" }, "terms": { "updateNetworkParameter": { diff --git a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md index 51d9f40bc..7912a1688 100644 --- a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md +++ b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md @@ -3,7 +3,7 @@ { "rationale": { "title": "Update market.fee.factors.infrastructureFee", - "description": "Proposal to update market.fee.factors.infrastructureFee to 300}" + "description": "Proposal to update market.fee.factors.infrastructureFee to 300" }, "terms": { "updateNetworkParameter": { diff --git a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md index 66c03bb9b..06dfa39f1 100644 --- a/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md +++ b/docs/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md @@ -5,7 +5,7 @@ vegawallet.exe transaction send --wallet YOUR_WALLETNAME --pubkey YOUR_PUBLIC_KE \"proposalSubmission\": {^ \"rationale\": {^ \"title\": \"Update market.fee.factors.infrastructureFee\",^ - \"description\": \"Proposal to update market.fee.factors.infrastructureFee to 300}\"^ + \"description\": \"Proposal to update market.fee.factors.infrastructureFee to 300\"^ },^ \"terms\": {^ \"updateNetworkParameter\": {^ diff --git a/docs/tutorials/proposals/network-parameter-proposal.md b/docs/tutorials/proposals/network-parameter-proposal.md index 81f060d91..bb4023c9c 100644 --- a/docs/tutorials/proposals/network-parameter-proposal.md +++ b/docs/tutorials/proposals/network-parameter-proposal.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -title: Update network parameter +title: Change network parameter vega_network: TESTNET hide_title: true keywords: @@ -44,6 +44,26 @@ The contents of a `changes` object specifies what will be different after the pr **Value** is the new value you're proposing that the network parameter should have. +Some network parameters include multiple pieces of information in one value. Changes to one of those network parameters needs to include the correct formatting. You can see how the existing value is formatted on [Explorer ↗](https://explorer.vega.xyz/network-parameters). + +For example, a proposal to change the `rewards.activityStreak.benefitTiers` network parameter would include a value that looks like the following, using escaped JSON: + +```json title="Code sample for multiple values" +"value": +" { \"tiers\": [ + { \"minimum_activity_streak\": 1, + \"reward_multiplier\": \"1.05\", + \"vesting_multiplier\": \"1.05\" }, + { \"minimum_activity_streak\": 2, + \"reward_multiplier\": \"1.10\", + \"vesting_multiplier\": \"1.10\" }, + { \"minimum_activity_streak\": 3, + \"reward_multiplier\": \"1.20\", + \"vesting_multiplier\": \"1.20\" } + ] +}" +``` + ## Templates and submitting In the tabs below you'll see: diff --git a/scripts/libGenerateProposals/updateNetworkParameter.js b/scripts/libGenerateProposals/updateNetworkParameter.js index 49bbcd63c..158189735 100644 --- a/scripts/libGenerateProposals/updateNetworkParameter.js +++ b/scripts/libGenerateProposals/updateNetworkParameter.js @@ -14,7 +14,7 @@ function updateNetworkParameter(skeleton, proposalSoFar) { const result = { rationale: { title: `Update ${keyToUpdate}`, - description: `Proposal to update ${keyToUpdate} to 300}` + description: `Proposal to update ${keyToUpdate} to 300` }, terms: { updateNetworkParameter: { diff --git a/versioned_docs/version-v0.73/concepts/governance.md b/versioned_docs/version-v0.73/concepts/governance.md index 20acde9e2..e1b90ed2a 100644 --- a/versioned_docs/version-v0.73/concepts/governance.md +++ b/versioned_docs/version-v0.73/concepts/governance.md @@ -345,3 +345,4 @@ Some network parameters have minimum/maximum boundaries to ensure they aren't su | `governance.proposal.(TYPE).minEnact` | Must be greater than / equal to the corresponding `minClose`, proposal can't be enacted before voting on it has closed. | | `governance.proposal.(TYPE).requiredMajority` | Minimum 0.0, maximum 1.0. Is multiplied by 100 to get percentage. | | `governance.proposal.(TYPE).requiredParticipation`| Minimum 0.0, maximum 1.0. Is multiplied by 100 to get percentage. | +| `rewards.activityStreak.benefitTiers`: `reward_multiplier` | Minimum 1.0. | \ No newline at end of file diff --git a/versioned_docs/version-v0.73/concepts/trading-on-vega/discounts-rewards.md b/versioned_docs/version-v0.73/concepts/trading-on-vega/discounts-rewards.md index 7e2bba359..650df1438 100644 --- a/versioned_docs/version-v0.73/concepts/trading-on-vega/discounts-rewards.md +++ b/versioned_docs/version-v0.73/concepts/trading-on-vega/discounts-rewards.md @@ -14,7 +14,9 @@ You can offset some of the [fees](./fees.md) you pay, or earn even more, by rece You can earn a commission for referring new users when a referral program is enabled. New users get a discount on their fees, while whoever refers them gets a cut of their referees’ trading fees. How much commission the referrer receives is increased if they have VEGA associated to their public key. :::tip Refer a friend -Get benefits for referring, or being referred. In the [referrals section of Console](https://vegaprotocol.eth.limo/#/referrals), you can: +Get benefits for referring, or being referred. + +In the [referrals section of Console](https://vegaprotocol.eth.limo/#/referrals), you can: * Create a code to refer others * Enter a code you've been given ::: @@ -71,6 +73,12 @@ You can see the current reward hoarder bonus requirements and benefits on the [b These tiers are set through network parameters, and thus can be changed through [governance](../governance.md#network-parameter-governance). +:::tip Try it out +**[Tutorial: Propose a network parameter change](../../tutorials/proposals/network-parameter-proposal.md)** + +Note: You'll need to format your proposal to include multiple data in the value field. +::: + ## Activity streak Traders that keep up an activity streak, either by placing trades or keeping a position open over several epochs, can receive a greater share of rewards and their locked reward proceeds will be available sooner. @@ -84,6 +92,12 @@ You can see the current activity streak requirements and benefits on the [block The details for activity streaks are set through network parameters, and thus can be changed through [governance](../governance.md#network-parameter-governance). +:::tip Try it out +**[Tutorial: Propose a network parameter change](../../tutorials/proposals/network-parameter-proposal.md)** + +Note: You'll need to format your proposal to include multiple data in the value field. +::: + ## Setting rewards Rewards can be set up by anyone to incentivise certain trading behaviours they want to see on a market (or markets). diff --git a/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md b/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md index 7068f67d5..1b2f8f81c 100644 --- a/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md +++ b/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_annotated.md @@ -3,7 +3,7 @@ { rationale: { title: "Update market.fee.factors.infrastructureFee", - description: "Proposal to update market.fee.factors.infrastructureFee to 300}" + description: "Proposal to update market.fee.factors.infrastructureFee to 300" }, terms: { updateNetworkParameter: { diff --git a/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md b/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md index d7a093385..ab31e6f2e 100644 --- a/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md +++ b/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_json.md @@ -3,7 +3,7 @@ { "rationale": { "title": "Update market.fee.factors.infrastructureFee", - "description": "Proposal to update market.fee.factors.infrastructureFee to 300}" + "description": "Proposal to update market.fee.factors.infrastructureFee to 300" }, "terms": { "updateNetworkParameter": { diff --git a/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md b/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md index 80b23ec91..76394118d 100644 --- a/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md +++ b/versioned_docs/version-v0.73/tutorials/proposals/_generated-proposals/_updateNetworkParameter_win.md @@ -5,7 +5,7 @@ vegawallet.exe transaction send --wallet YOUR_WALLETNAME --pubkey YOUR_PUBLIC_KE \"proposalSubmission\": {^ \"rationale\": {^ \"title\": \"Update market.fee.factors.infrastructureFee\",^ - \"description\": \"Proposal to update market.fee.factors.infrastructureFee to 300}\"^ + \"description\": \"Proposal to update market.fee.factors.infrastructureFee to 300\"^ },^ \"terms\": {^ \"updateNetworkParameter\": {^ diff --git a/versioned_docs/version-v0.73/tutorials/proposals/network-parameter-proposal.md b/versioned_docs/version-v0.73/tutorials/proposals/network-parameter-proposal.md index d08324543..9d207cd30 100644 --- a/versioned_docs/version-v0.73/tutorials/proposals/network-parameter-proposal.md +++ b/versioned_docs/version-v0.73/tutorials/proposals/network-parameter-proposal.md @@ -1,6 +1,6 @@ --- sidebar_position: 4 -title: Update network parameter +title: Change network parameter vega_network: MAINNET hide_title: true keywords: @@ -44,6 +44,26 @@ The contents of a `changes` object specifies what will be different after the pr **Value** is the new value you're proposing that the network parameter should have. +Some network parameters include multiple pieces of information in one value. Changes to one of those network parameters needs to include the correct formatting. You can see how the existing value is formatted on [Explorer ↗](https://explorer.vega.xyz/network-parameters). + +For example, a proposal to change the `rewards.activityStreak.benefitTiers` network parameter would include a value that looks like the following, using escaped JSON: + +```json title="Code sample for multiple values" +"value": +" { \"tiers\": [ + { \"minimum_activity_streak\": 1, + \"reward_multiplier\": \"1.05\", + \"vesting_multiplier\": \"1.05\" }, + { \"minimum_activity_streak\": 2, + \"reward_multiplier\": \"1.10\", + \"vesting_multiplier\": \"1.10\" }, + { \"minimum_activity_streak\": 3, + \"reward_multiplier\": \"1.20\", + \"vesting_multiplier\": \"1.20\" } + ] +}" +``` + ## Templates and submitting In the tabs below you'll see: