Paratoken Standard by coinfork · Pull Request #32 · w3f/PSPs

coinfork · 2021-12-01T22:57:52Z

Initial draft of the Paratoken standard

apopiak

Some typos and suggestions.

apopiak · 2021-12-06T16:35:32Z

PSPs/drafts/psp-32.md

+- [Asset Identification](#asset-identification)
+- [Paratoken Structure](#paratoken-structure)
+    - [Base Interface](#base-interface)
+    - [Common Types](#base-interface)


Suggested change

- [Common Types](#base-interface)

- [Common Types](#common-types)

apopiak · 2021-12-06T16:37:21Z

PSPs/drafts/psp-32.md

+The paratoken standard enforces the use of [`Universally Unique Asset Identifier`](uuaid/uuaid.md) as an
+identifier of the asset on its API.


I don't think uuaid/uuaid.md is included in the PSP, maybe add a hosted link?

I'm also curious to learn more about Universally Unique Asset Identifier

Yes, this needs further clarification

apopiak · 2021-12-06T16:39:00Z

PSPs/drafts/psp-32.md

+	/// owner. 
+	fn create_asset( owner: Origin, policy: MonetaryPolicy);
+
+	/// Transfer the ownership of `asset` from `origin` to `target`.


Suggested change

/// Transfer the ownership of `asset` from `origin` to `target`.

/// Transfer the ownership of `asset` from `origin` to `new_owner`.

apopiak · 2021-12-06T16:39:46Z

PSPs/drafts/psp-32.md

+	/// Mints new `amount` of `asset` and transfer to `owner` account.
+	fn mint( owner: Origin, asset: T::AssetId, amount: T::AssetBalance);
+
+	/// Destroies `amount` from `token` of `asset`. 


Suggested change

/// Destroies `amount` from `token` of `asset`.

/// Destroys `amount` from `token` of `asset`.

apopiak · 2021-12-06T16:40:49Z

PSPs/drafts/psp-32.md

+	// Balances and transfers 
+	// ===================================
+
+	/// Transfers `amount` of `token` from `asset` from `from` account to `target` account.


Suggested change

/// Transfers `amount` of `token` from `asset` from `from` account to `target` account.

/// Transfers `amount` of `token` from `asset` from `from` account to `to` account.

apopiak · 2021-12-06T16:41:13Z

PSPs/drafts/psp-32.md

+		token: T::TokenId, 
+		amount: T::AssetBalance);
+
+	/// Fetchs the balance of `tokens` of `asset` for `owner` account. 


Suggested change

/// Fetchs the balance of `tokens` of `asset` for `owner` account.

/// Fetches the balance of `tokens` of `asset` for `owner` account.

apopiak · 2021-12-06T16:45:42Z

PSPs/drafts/psp-32.md

+
+## Policies
+
+Polices define what is the behaviour of the asset for specific operations.


Suggested change

Polices define what is the behaviour of the asset for specific operations.

Policies define what is the behaviour of the asset for specific operations.

Noc2 · 2021-12-08T13:01:05Z

@coinfork Feel free to ping me here, once you are happy with this. I can merge the draft, so that it’s easier to share and potentially to get additional feedback.

coinfork · 2021-12-15T02:57:16Z

@coinfork Feel free to ping me here, once you are happy with this. I can merge the draft, so that it’s easier to share and potentially to get additional feedback.

Sounds good! We'll be pushing a few updates first.

xlc · 2021-12-15T03:24:34Z

PSPs/drafts/psp-32.md

+
+	/// Only this issuer can mint tokens but just once.
+	/// That ensures that no more tokens will be created after the first minting.
+	OneTimeIssuer(AccountId),


Is MintingPolicy mutable? If it is, then we don't need this. The asset owner can update the policy to NotAllowed after the minting is done.

At the moment, MintingPolicy can be both mutable and immutable to suggest that OneTimeIssuer is required.

xlc · 2021-12-15T03:26:19Z

PSPs/drafts/psp-32.md

+token won't support any inflation.
+
+```Rust
+	struct Mutability {


Suggested change

struct Mutability {

enum Policy {

Otherwise it is very confusing

and maybe you will also want something like

enum Mutability { Immutable, Mutable { by: AccountId }, }

Scoped mutability is an interesting idea

Having the attribute of mutability for a policy is confusing to me. Stuff will happen and policies must be updated.
Could something like below considered (having a set of authorities)?

/// Authorities with privilege to update policy. /// `None` means no one can update the policy making it immutable. pub type PolicyMakers = Option<Vec<AccountId>>;

Some voting mechanism could also be implemented for PolicyMakers so it's "fair".

xlc · 2021-12-15T03:28:31Z

PSPs/drafts/psp-32.md

+pub enum Event<T: Config> {
+	/// A new asset was created by `owner`.
+	/// \[ asset_id, owner \]
+	AssetCreated(T::AssetId, T::AccountId),


Suggested change

AssetCreated(T::AssetId, T::AccountId),

AssetCreated { asset_id: T::AssetId, owner: T::AccountId },

Named fields are supported now, we might as well use it.

xlc · 2021-12-15T03:29:37Z

PSPs/drafts/psp-32.md

+}
+```
+
+## Extension: Batch


maybe this should be in another meta operation standard?

What is a meta operation standard? @xlc Can you elaborate?

I mean this doesn't really needs to be token related. For features like batch transaction, proxy, multisig etc, they could be in another standard for those utility/meta operations.

You might be right that that is preferable.
Note, though, that the proposed batch transactions here allow for optimizations (e.g. optimized batch minting of NFTs) which generic batches (e.g. via pallet_utilitly::batch) would not.

bernardoaraujor · 2022-01-29T22:54:02Z

PSPs/drafts/psp-32.md

+| 0x0001  | 1.0.0   | [Batch Extension](extensions/batch.md) |
+| 0x0002  | 1.0.0   | [Chunks Extension](extensions/chunks.md) |
+| 0x0003  | 1.0.0   | [Enumerable Extension](extensions/enumerable.md) |
+| 0x0004  | 0.1.0   | **TBD** Teleportation |
+| 0x0005  | 1.0.0   | [Operator](extensions/operator.md) |


I can't find extensions/*

after scrolling down I found the ## Extension: * sections of psp-32.md
wouldn't it make more sense to point at these sections, instead of extensions/*?

lamafab · 2022-03-02T14:18:13Z

PSPs/drafts/psp-32.md

+
+	/// Creates a new asset using the given `policy` where `origin` will be the 
+	/// owner. 
+	fn create_asset( owner: Origin, policy: MonetaryPolicy);


Shouldn't this return an AssetId? MonetaryPolicy is not defined.

lamafab · 2022-03-02T14:19:08Z

PSPs/drafts/psp-32.md

+		amount: T::AssetBalance);
+
+	/// Fetchs the balance of `tokens` of `asset` for `owner` account. 
+	fn balance(owner: Account, asset: T::Account, token: T::TokenId) -> T::AssetBalance;


What's the difference between asset (T::Account?) and token here?

lamafab · 2022-03-02T14:59:31Z

PSPs/drafts/psp-32.md

+	// ===================================
+
+	/// Returns the asset attribute of `key` for the given `asset`.
+	fn asset_attribute( asset: T::AssetId, key: T::AttributeKey) -> Option<T::AttributeValue>;


T::AttributeKey should be just AttributeKey, given that you define AttributeKey later on. I assume you intend this to be a shared/standardized type. The draft does not explain what "attributes" exactly are or for what purpose those should be used. You briefly touch on it in the summary at the beginning, but a (small) proper subsection would be better.

Also, there are many assumptions about that generic type T. Should T implement a trait with specific associated types? All those associated types (Account, AssetId, AssetBalance) should probably be fixed and well defined anyway.

lamafab · 2022-03-02T15:02:23Z

PSPs/drafts/psp-32.md

+The paratoken standard enforces the use of [`Universally Unique Asset Identifier`](uuaid/uuaid.md) as an
+identifier of the asset on its API.


Yes, this needs further clarification

lamafab · 2022-03-18T16:13:45Z

Please note that we also have to following drafts open:

Paratoken Standard

4dabb41

Initial draft of the Paratoken standard

apopiak reviewed Dec 7, 2021

View reviewed changes

xlc reviewed Dec 15, 2021

View reviewed changes

bernardoaraujor reviewed Jan 29, 2022

View reviewed changes

lamafab reviewed Mar 2, 2022

View reviewed changes

lamafab added the awaiting-changes Waiting for upstream changes label Mar 18, 2022

	- [Common Types](#base-interface)
	- [Common Types](#common-types)

		The paratoken standard enforces the use of [`Universally Unique Asset Identifier`](uuaid/uuaid.md) as an
		identifier of the asset on its API.

	/// Transfer the ownership of `asset` from `origin` to `target`.
	/// Transfer the ownership of `asset` from `origin` to `new_owner`.

	/// Destroies `amount` from `token` of `asset`.
	/// Destroys `amount` from `token` of `asset`.

	/// Transfers `amount` of `token` from `asset` from `from` account to `target` account.
	/// Transfers `amount` of `token` from `asset` from `from` account to `to` account.

	/// Fetchs the balance of `tokens` of `asset` for `owner` account.
	/// Fetches the balance of `tokens` of `asset` for `owner` account.


		## Policies

		Polices define what is the behaviour of the asset for specific operations.

	Polices define what is the behaviour of the asset for specific operations.
	Policies define what is the behaviour of the asset for specific operations.

	AssetCreated(T::AssetId, T::AccountId),
	AssetCreated { asset_id: T::AssetId, owner: T::AccountId },

Conversation

coinfork commented Dec 1, 2021

Uh oh!

apopiak left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Noc2 commented Dec 8, 2021

Uh oh!

coinfork commented Dec 15, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cowboy-bebug Feb 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bernardoaraujor Jan 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lamafab commented Mar 18, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

cowboy-bebug Feb 15, 2022 •

edited

Loading

bernardoaraujor Jan 29, 2022 •

edited

Loading