Add docs #1391

maltekliemann · 2024-11-12T23:27:47Z

What does it do?

What important points should reviewers know?

Is there something left for follow-up PRs?

What alternative implementations were considered?

Are there relevant PRs or issues?

References

Chralt98 · 2025-01-14T15:26:00Z

zrml/neo-swaps/src/types/decision_market_oracle.rs

+/// The oracle evaluates to `true` if and only if the `positive_outcome` is more valuable than the
+/// `negative_outcome` in the liquidity pool specified by `pool_id`.


Will be changed by audit fixes. It will then use a scoreboard.

Chralt98 · 2025-01-14T15:27:00Z

zrml/futarchy/src/lib.rs

        type MinDuration: Get<BlockNumberFor<Self>>;

-        // The type used to define the oracle for each proposal.
+        /// The type used to define the oracle a proposal.


Suggested change

/// The type used to define the oracle a proposal.

/// The type used to define the oracle for a proposal.

Chralt98 · 2025-01-14T15:28:20Z

zrml/futarchy/README.md

+The oracle evaluates positively (meaning that it will allow the proposal to
+pass) if and only if the positive outcome is move valuable than the negative
+outcome.


The scoreboard should be described here instead (look at audit fixes).

Chralt98 · 2025-01-14T15:35:03Z

zrml/futarchy/README.md

+- A hard-coded origin (usually root) submits a proposal to be approved or
+  rejected via futarchy. If the origin is root, this is done by running a


The newest version just uses the root origin, not a configurable hard-coded origin anymore.

Chralt98 · 2025-01-14T15:37:43Z

zrml/combinatorial-tokens/src/traits/combinatorial_id_manager.rs

+    /// If `force_max_work` parameter is set, the calculation will use up the maximum amount of work
+    /// necessary, independent of the other parameters. Should only be used for benchmarking
+    /// purposes.


Will be changed to Fuel parameter.

Chralt98 · 2025-01-14T15:47:46Z

zrml/combinatorial-tokens/README.md

+
+In addition to splitting and merging, combinatorial tokens can be redeemed if one of the markets involved in creating them has been resolved. For example, if the `XY` market above resolves to `X`, then every unit of `X & A` redeems for a unit of `A` and `Y & A` is worthless. If the scalar market above resolves so that `Long` is valued at `.4` and `Short` at `.6`, then every unit of `Yes & Long` redeems for `.4` units of `Yes` and every unit of `Yes & Short` redeems for `.6`.
+
+And important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.


Suggested change

And important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.

An important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.

Chralt98 · 2025-01-14T15:50:19Z

zrml/combinatorial-tokens/README.md

+
+And important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.
+
+Collections and position are identified using their IDs. When using the standard combinatorial ID Manager, this ID is a 256 bit value. The position ID of a certain token can be calculated using the collection ID and the collateral.


Suggested change

Collections and position are identified using their IDs. When using the standard combinatorial ID Manager, this ID is a 256 bit value. The position ID of a certain token can be calculated using the collection ID and the collateral.

Collections and positions are identified using their IDs. When using the standard combinatorial ID Manager, this ID is a 256 bit value. The position ID of a certain token can be calculated using the collection ID and the collateral.

Chralt98 · 2025-01-14T15:51:00Z

zrml/combinatorial-tokens/README.md

+
+- _Combinatorial token_: Any instance of `zeitgeist_primitives::Asset::CombinatorialToken`.
+- _Complete set (of a prediction market)_: An abstract set containing every outcome of a particular prediction market. One unit of a complete set is one unit of each outcome token from the market in question. After the market resolves, a complete set always redeems for exactly one unit of collateral.
+- _Merge_: The prcoess of exchanging multiple tokens for a single token of equal value.


Suggested change

- _Merge_: The prcoess of exchanging multiple tokens for a single token of equal value.

- _Merge_: The process of exchanging multiple tokens for a single token of equal value.

Chralt98 · 2025-01-15T11:24:00Z

zrml/neo-swaps/src/lib.rs

+        /// The `force_max_work` parameter can be used to force the `CombinatorialTokensApi` to
+        /// spend the maximum amount of work, independently of the parameters that it is called
+        /// with. This is useful for benchmarking purposes and should not be used in production.


It will be called Fuel after the audit fixes.

Chralt98 · 2025-01-15T11:24:39Z

zrml/neo-swaps/src/lib.rs

+        ///
+        /// # Complexity
+        ///
+        /// `O(n)` where `n` is the number of splits required to create the pool.


It will also depend on the Fuel parameter.

Chralt98 · 2025-01-15T11:40:13Z

zrml/combinatorial-tokens/src/lib.rs

+        /// The `force_max_work` parameter can be used to trigger the maximum amount of allowed work
+        /// for the combinatorial ID manager. Should only be used for benchmarking purposes.


Use Fuel parameter after audit fixes.

Chralt98 · 2025-01-15T11:42:57Z

zrml/combinatorial-tokens/src/lib.rs

+        /// The `force_max_work` parameter can be used to trigger the maximum amount of allowed work
+        /// for the combinatorial ID manager. Should only be used for benchmarking purposes.


Use Fuel parameter after audit fixes.

Chralt98 · 2025-01-15T11:44:50Z

zrml/combinatorial-tokens/src/lib.rs

+        /// The `force_max_work` parameter can be used to trigger the maximum amount of allowed work
+        /// for the combinatorial ID manager. Should only be used for benchmarking purposes.


Use Fuel parameter after audit fixes.

maltekliemann added 3 commits November 11, 2024 22:50

Add some docs and remove TODOs

c406d72

More documentation

9619577

.

ad42f61

mergify bot added the s:in-progress The pull requests is currently being worked on label Nov 16, 2024

Chralt98 reviewed Jan 14, 2025

View reviewed changes

Chralt98 reviewed Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs #1391

Add docs #1391

maltekliemann commented Nov 12, 2024

Chralt98 Jan 14, 2025

Chralt98 Jan 14, 2025

Chralt98 Jan 14, 2025

Chralt98 Jan 14, 2025

Chralt98 Jan 14, 2025

Chralt98 Jan 14, 2025 •

edited

Loading

Chralt98 Jan 14, 2025

Chralt98 Jan 14, 2025

Chralt98 Jan 15, 2025

Chralt98 Jan 15, 2025

Chralt98 Jan 15, 2025

Chralt98 Jan 15, 2025

Chralt98 Jan 15, 2025

		/// The oracle evaluates to `true` if and only if the `positive_outcome` is more valuable than the
		/// `negative_outcome` in the liquidity pool specified by `pool_id`.

	/// The type used to define the oracle a proposal.
	/// The type used to define the oracle for a proposal.

		- A hard-coded origin (usually root) submits a proposal to be approved or
		rejected via futarchy. If the origin is root, this is done by running a


		In addition to splitting and merging, combinatorial tokens can be redeemed if one of the markets involved in creating them has been resolved. For example, if the `XY` market above resolves to `X`, then every unit of `X & A` redeems for a unit of `A` and `Y & A` is worthless. If the scalar market above resolves so that `Long` is valued at `.4` and `Short` at `.6`, then every unit of `Yes & Long` redeems for `.4` units of `Yes` and every unit of `Yes & Short` redeems for `.6`.

		And important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.

	And important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.
	An important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.


		And important distinction which we've so far neglected to make is the distinction between an abstract _collection_ like `X & A` or `Yes & Short` and a concrete _position_, which is a collection together with a collateral token against which it is valued. Collections are purely abstract and used in the implementation. Positions are actual tokens on the chain.

		Collections and position are identified using their IDs. When using the standard combinatorial ID Manager, this ID is a 256 bit value. The position ID of a certain token can be calculated using the collection ID and the collateral.

	Collections and position are identified using their IDs. When using the standard combinatorial ID Manager, this ID is a 256 bit value. The position ID of a certain token can be calculated using the collection ID and the collateral.
	Collections and positions are identified using their IDs. When using the standard combinatorial ID Manager, this ID is a 256 bit value. The position ID of a certain token can be calculated using the collection ID and the collateral.

	- _Merge_: The prcoess of exchanging multiple tokens for a single token of equal value.
	- _Merge_: The process of exchanging multiple tokens for a single token of equal value.

		/// The `force_max_work` parameter can be used to trigger the maximum amount of allowed work
		/// for the combinatorial ID manager. Should only be used for benchmarking purposes.

Add docs #1391

Are you sure you want to change the base?

Add docs #1391

Conversation

maltekliemann commented Nov 12, 2024

What does it do?

What important points should reviewers know?

Is there something left for follow-up PRs?

What alternative implementations were considered?

Are there relevant PRs or issues?

References

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chralt98 Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chralt98 Jan 14, 2025 •

edited

Loading