git.delta.rocks / unique-network / refs/commits / 27c50a6bb7ad

67//! Parts are defined in the Base to which they belong. Parts can be either67//! Parts are defined in the Base to which they belong. Parts can be either
68//! of the `slot` type or `fixed` type. Slots are intended for equippables.68//! of the `slot` type or `fixed` type. Slots are intended for equippables.
69//! Note that "part of something" and "Part of a Base" can be easily confused,69//! Note that "part of something" and "Part of a Base" can be easily confused,
70//! and in this documentation these words are distinguished by the capital letter.70//! and so in this documentation these words are distinguished by the capital letter.
71//!71//!
72//! - **Theme:** Named objects of variable => value pairs which get interpolated into72//! - **Theme:** Named objects of variable => value pairs which get interpolated into
73//! the Base's `themable` Parts. Themes can hold any value, but are often represented73//! the Base's `themable` Parts. Themes can hold any value, but are often represented
78//! - **Scoped properties:** Properties that are normally obscured from users.78//! - **Scoped properties:** Properties that are normally obscured from users.
79//! Their purpose is to contain structured metadata that was not included in the Unique standard79//! Their purpose is to contain structured metadata that was not included in the Unique standard
80//! for collections and tokens, meant to be operated on by proxies and other outliers.80//! for collections and tokens, meant to be operated on by proxies and other outliers.
81//! Scoped properties are prefixed with `some-scope:`, where `some-scope` is81//! Scoped property keys are prefixed with `some-scope:`, where `some-scope` is
82//! an arbitrary keyword, like "rmrk", and `:` is an unacceptable symbol in user-defined82//! an arbitrary keyword, like "rmrk". `:` is considered an unacceptable symbol in user-defined
83//! properties, which, along with other safeguards, makes them impossible to tamper with.83//! properties, which, along with other safeguards, makes scoped ones impossible to tamper with.
84//!84//!
85//! - **Auxiliary properties:** A slightly different structure of properties,85//! - **Auxiliary properties:** A slightly different structure of properties,
86//! trading universality of use for more convenient storage, writes and access.86//! trading universality of use for more convenient storage, writes and access.
91//! An external user is supposed to be able to utilize this proxy as they would91//! An external user is supposed to be able to utilize this proxy as they would
92//! utilize RMRK, and get exactly the same results. Normally, Unique transactions92//! utilize RMRK, and get exactly the same results. Normally, Unique transactions
93//! are off-limits to RMRK collections and tokens, and vice versa. However,93//! are off-limits to RMRK collections and tokens, and vice versa. However,
94//! the information stored on chain can be freely interpreted by storage reads and RPCs.94//! the information stored on chain can be freely interpreted by storage reads and Unique RPCs.
95//!95//!
96//! ### ID Mapping96//! ### ID Mapping
97//!97//!
115//!115//!
116//! ### Collection and NFT Types, and Base, Parts and Themes Handling116//! ### Collection and NFT Types, and Base, Parts and Themes Handling
117//!117//!
118//! RMRK introduces the concept of a Base, which is a catalgoue of Parts,118//! RMRK introduces the concept of a Base, which is a catalogue of Parts,
119//! possible components of an NFT. Due to its similarity with the functionality119//! possible components of an NFT. Due to its similarity with the functionality
120//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes120//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes
121//! are the collection's NFTs. See [`CollectionType`] and [`NftType`].121//! are this collection's NFTs. See [`CollectionType`] and [`NftType`].
122//!122//!
123//! ## Interface123//! ## Interface
124//!124//!

70//! Parts are defined in the Base to which they belong. Parts can be either70//! Parts are defined in the Base to which they belong. Parts can be either
71//! of the `slot` type or `fixed` type. Slots are intended for equippables.71//! of the `slot` type or `fixed` type. Slots are intended for equippables.
72//! Note that "part of something" and "Part of a Base" can be easily confused,72//! Note that "part of something" and "Part of a Base" can be easily confused,
73//! and in this documentation these words are distinguished by the capital letter.73//! and so in this documentation these words are distinguished by the capital letter.
74//!74//!
75//! - **Theme:** Named objects of variable => value pairs which get interpolated into75//! - **Theme:** Named objects of variable => value pairs which get interpolated into
76//! the Base's `themable` Parts. Themes can hold any value, but are often represented76//! the Base's `themable` Parts. Themes can hold any value, but are often represented
81//! - **Scoped properties:** Properties that are normally obscured from users.81//! - **Scoped properties:** Properties that are normally obscured from users.
82//! Their purpose is to contain structured metadata that was not included in the Unique standard82//! Their purpose is to contain structured metadata that was not included in the Unique standard
83//! for collections and tokens, meant to be operated on by proxies and other outliers.83//! for collections and tokens, meant to be operated on by proxies and other outliers.
84//! Scoped properties are prefixed with `some-scope:`, where `some-scope` is84//! Scoped property keys are prefixed with `some-scope:`, where `some-scope` is
85//! an arbitrary keyword, like "rmrk", and `:` is an unacceptable symbol in user-defined85//! an arbitrary keyword, like "rmrk". `:` is considered an unacceptable symbol in user-defined
86//! properties, which, along with other safeguards, makes them impossible to tamper with.86//! properties, which, along with other safeguards, makes scoped ones impossible to tamper with.
87//!87//!
88//! - **Auxiliary properties:** A slightly different structure of properties,88//! - **Auxiliary properties:** A slightly different structure of properties,
89//! trading universality of use for more convenient storage, writes and access.89//! trading universality of use for more convenient storage, writes and access.
94//! An external user is supposed to be able to utilize this proxy as they would94//! An external user is supposed to be able to utilize this proxy as they would
95//! utilize RMRK, and get exactly the same results. Normally, Unique transactions95//! utilize RMRK, and get exactly the same results. Normally, Unique transactions
96//! are off-limits to RMRK collections and tokens, and vice versa. However,96//! are off-limits to RMRK collections and tokens, and vice versa. However,
97//! the information stored on chain can be freely interpreted by storage reads and RPCs.97//! the information stored on chain can be freely interpreted by storage reads and Unique RPCs.
98//!98//!
99//! ### ID Mapping99//! ### ID Mapping
100//!100//!
118//!118//!
119//! ### Collection and NFT Types, and Base, Parts and Themes Handling119//! ### Collection and NFT Types, and Base, Parts and Themes Handling
120//!120//!
121//! RMRK introduces the concept of a Base, which is a catalgoue of Parts,121//! RMRK introduces the concept of a Base, which is a catalogue of Parts,
122//! possible components of an NFT. Due to its similarity with the functionality122//! possible components of an NFT. Due to its similarity with the functionality
123//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes123//! of a token collection, a Base is stored and handled as one, and the Base's Parts and Themes
124//! are the collection's NFTs. See [`CollectionType`] and [`NftType`].124//! are this collection's NFTs. See [`CollectionType`] and [`NftType`].
125//!125//!
126//! ## Interface126//! ## Interface
127//!127//!