diff --git a/doc/Specs-Datamodel.md b/doc/Specs-Datamodel.md index 9ed6b8d..7ef47db 100644 --- a/doc/Specs-Datamodel.md +++ b/doc/Specs-Datamodel.md @@ -93,11 +93,7 @@ * 13.6. [PartialOrd, Ord](#PartialOrdOrd) * 14. [Todo](#Todo) - -# Specs - Datas +# Specs - Datas ## 1. Documents de référence @@ -113,6 +109,14 @@ The `DepositMethod` struct identifies a specific deposit method, encapsulating t |----------------|--------------|--------|------------------------------| | `method` | ```String``` | | Represents a deposit method. | +Pseudo-code: + +```json +{ + "method": "" +} +``` + ### 2.2. CommitmentMethod `CommitmentMethod` represents a particular method of commitment, defining how commitments are made or managed in the system. @@ -121,6 +125,14 @@ The `DepositMethod` struct identifies a specific deposit method, encapsulating t |----------------|--------------|--------|---------------------------------| | `method` | ```String``` | | Represents a commitment method. | +Pseudo-code: + +```json +{ + "method": "" +} +``` + ### 2.3. PaymentMethod `PaymentMethod` specifies a payment mechanism, detailing the method used for financial transactions. @@ -129,6 +141,14 @@ The `DepositMethod` struct identifies a specific deposit method, encapsulating t |----------------|--------------|--------|------------------------------------------------------| | `method` | ```String``` | | La méthode de paiement représentée par cette struct. | +Pseudo-code: + +```json +{ + "method": "" +} +``` + ## 3. Items ### 3.1. Item @@ -146,6 +166,21 @@ The `Item` struct serves as a foundational element, detailing the basic structur | `metadata_role_confidential` | ```MetadataRoleConfidential``` | | Role-specific confidential metadata associated with the item. | | `metadata_private` | ```MetadataPrivate``` | | Private metadata associated with the item. | +Pseudo-code: + +```json +{ + "uuid": "string", + "version": 0, + "item_type": "string", + "name": "string", + "pagination_number_per_request_pcd": 0, + "metadata_contract_public": MetadataContractPublic, + "metadata_role_confidential": MetadataRoleConfidential, + "metadata_private": MetadataPrivate +} +``` + ### 3.2. ItemArtefact `ItemArtefact` associates an item with artefact-specific attributes, including public, confidential, and private attribute groups, to represent artefacts within the system. @@ -157,6 +192,17 @@ The `Item` struct serves as a foundational element, detailing the basic structur | `role_confidential_attribute_group` | ```Vec``` | | A list of role-specific confidential attributes for the artefact. | | `private_attribute_group` | ```Vec``` | | A list of private attributes associated with the artefact. | +Pseudo-code: + +```json +{ + "item": Item, + "public_attribute_group": [], + "role_confidential_attribute_group": [], + "private_attribute_group": [] +} +``` + ### 3.3. ItemMember | Attribute Name | Type | Option | Description | @@ -166,6 +212,17 @@ The `Item` struct serves as a foundational element, detailing the basic structur | `role_confidential_attribute_group` | ```ItemMemberRoleConfidentialAttributeGroup``` | | A list of role-specific confidential attributes for the member. | | `private_attribute_group` | ```ItemMemberPrivateAttributeGroup``` | | A list of private attributes associated with the member. | +Pseudo-code: + +```json +{ + "item": Item, + "public_attribute_group": ItemMemberPublicAttributeGroup, + "role_confidential_attribute_group": ItemMemberRoleConfidentialAttributeGroup, + "private_attribute_group": ItemMemberPrivateAttributeGroup +} +``` + #### 3.3.1. ItemMemberPublicAttributeGroup `ItemMemberPublicAttributeGroup` outlines public attributes for members, including service provider addresses and payment methods, for transparency in member-related information. @@ -181,6 +238,21 @@ The `Item` struct serves as a foundational element, detailing the basic structur | `payment_method_list_public` | ```Vec``` | | A list of public payment methods available. | | `succession_process_hash` | ```String``` | | The hash of the succession process associated with this item. | +Pseudo-code: + +```json +{ + "sp_address_public": "", + "sp_address_public_sig": "", + "sp_address_revoke_public": "", + "sp_address_revoke_public_sig": "", + "third_sp_address_list_public": [], + "data_size_max": 0, + "payment_method_list_public": [], + "succession_process_hash": "" +} +``` + #### 3.3.2. ItemMemberRoleConfidentialAttributeGroup `ItemMemberRoleConfidentialAttributeGroup` @@ -191,6 +263,17 @@ The `Item` struct serves as a foundational element, detailing the basic structur | `pre_id_confidential` | ```String``` | yes | `pre_id` of this member from the cache if it exist | | `device_footprint_enc_by_sp_shared_secret` | ```String``` | yes | `pre_id` of this member from the cache if it exist | +Pseudo-code: + +```json +{ + "shard_confidential": "", + "pre_id_confidential": "", + "device_footprint_enc_by_sp_shared_secret": "" +} +``` + + #### 3.3.3. ItemMemberRolePrivateAttributeGroup `ItemMemberRolePrivateAttributeGroup` @@ -202,6 +285,18 @@ The `Item` struct serves as a foundational element, detailing the basic structur | `priv_key_signet_scan` | ```String``` | yes | | | `randSeedPart2` | ```String``` | yes | | +Pseudo-code: + +```json +{ + "priv_key_mainnet_spend": "", + "priv_key_mainnet_scan": "", + "priv_key_signet_scan": "", + "randSeedPart2": "" +} +``` + + ### 3.4. ItemCommitment `ItemCommitment` links an item with commitment-specific attributes across public, confidential, and private spheres, fully representing a commitment. @@ -213,6 +308,18 @@ The `Item` struct serves as a foundational element, detailing the basic structur | `role_confidential_attribute_group` | ```ItemCommitmentRoleConfidentialAttributeGroup``` | | The role-specific confidential attribute group for this commitment. | | `private_attribute_group` | ```ItemCommitmentPrivateAttributeGroup``` | | The private attribute group associated with this commitment. | +Pseudo-code: + +```json +{ + "item": Item, + "public_attribute_group": ItemCommitmentPublicAttributeGroup, + "role_confidential_attribute_group": ItemCommitmentRoleConfidentialAttributeGroup, + "private_attribute_group": ItemCommitmentPrivateAttributeGroup +} +``` + + #### 3.4.1. ItemCommitmentRoleConfidentialAttributeGroup This struct encompasses role-specific confidential attributes for commitments, securing sensitive commitment information. @@ -221,6 +328,14 @@ This struct encompasses role-specific confidential attributes for commitments, s |-----------------------------|-------------------|--------|------------------------------------------------------------------| | `payload_list_confidential` | ```Vec``` | | A list of confidential payloads associated with this commitment. | +Pseudo-code: + +```json +{ + "payload_list_confidential": [] +} +``` + #### 3.4.2. ItemCommitmentPrivateAttributeGroup `ItemCommitmentPrivateAttributeGroup` contains private attributes for commitments, ensuring privacy for the most sensitive commitment details. @@ -229,6 +344,14 @@ This struct encompasses role-specific confidential attributes for commitments, s |------------------------|-------------------|--------|-------------------------------------------------------------| | `payload_list_private` | ```Vec``` | | A list of private payloads associated with this commitment. | +Pseudo-code: + +```json +{ + "payload_list_private": [] +} +``` + ##### 4.2.1. ItemCommitmentPublicAttributeGroup This struct groups public attributes related to commitments, such as goals and provider types, to publicly share commitment details. @@ -243,6 +366,20 @@ This struct groups public attributes related to commitments, such as goals and p | `ref_request_pcd_hash_list` | ```Vec``` | | A list of reference hashes for RequestPcd documents related to this commitment. | | `payload_public_list` | ```Vec``` | | A list of public payloads associated with this commitment. | +Pseudo-code: + +```json +{ + "for_sp_address_list": [], + "goal_list": [], + "provider_type": "", + "commitment_request_pcd_hash_list": [], + "ref_item_hash_list": [], + "ref_request_pcd_hash_list": [], + "payload_public_list": [] +} +``` + ### 3.5. ItemDeposit It combines an item with deposit-specific attributes, including public, confidential, and private groups, to comprehensively represent a deposit. @@ -254,6 +391,17 @@ It combines an item with deposit-specific attributes, including public, confiden | `role_confidential_attribute_group` | ```ItemDepositRoleConfidentialAttributeGroup``` | | The role-specific confidential attribute group for this deposit. | | `private_attribute_group` | ```ItemDepositPrivateAttributeGroup``` | | The private attribute group associated with this deposit. | +Pseudo-code: + +```json +{ + "item": Item, + "public_attribute_group": ItemDepositPublicAttributeGroup, + "role_confidential_attribute_group": ItemDepositRoleConfidentialAttributeGroup, + "private_attribute_group": ItemDepositPrivateAttributeGroup +} +``` + #### 3.5.1. ItemDepositPublicAttributeGroup It details public attributes for deposits, including target addresses and goals, facilitating the understanding of deposit objectives. @@ -269,6 +417,21 @@ It details public attributes for deposits, including target addresses and goals, | `payload_list_public` | ```Vec``` | | A list of public payloads associated with this deposit. | | `audit_code_list_public` | ```Vec``` | | A list of public audit codes associated with this deposit. | +Pseudo-code: + +```json +{ + "for_sp_address_list": [], + "for_address_list": [], + "goal_list": [], + "provider_type": "", + "ref_item_hash_list": [], + "ref_request_pcd_hash_list": [], + "payload_list_public": [], + "audit_code_list_public": [] +} +``` + #### 3.5.2. ItemDepositRoleConfidentialAttributeGroup Similar to its commitment counterpart, this struct holds confidential attributes specific to deposits, protecting sensitive deposit information. @@ -278,6 +441,15 @@ Similar to its commitment counterpart, this struct holds confidential attributes | `payload_list_confidential` | ```Vec``` | | A list of confidential payloads associated with this deposit. | | `audit_code_list_confidential` | ```Vec``` | | A list of confidential audit codes associated with this deposit. | +Pseudo-code: + +```json +{ + "payload_list_confidential": [], + "audit_code_list_confidential": [] +} +``` + #### 3.5.3. ItemDepositPrivateAttributeGroup `ItemDepositPrivateAttributeGroup` secures private deposit attributes, safeguarding the most sensitive aspects of deposits. @@ -287,6 +459,15 @@ Similar to its commitment counterpart, this struct holds confidential attributes | `payload_list_private` | ```Vec``` | | A list of private payloads associated with this deposit. | | `audit_code_private` | ```String``` | | A private audit code associated with this deposit. | +Pseudo-code: + +```json +{ + "payload_list_private": [], + "audit_code_private": "" +} +``` + ### 3.6. ItemEnum This enumeration represents different types of items within a system, where each variant encapsulates a specific struct for a type of item: @@ -310,6 +491,17 @@ This enumeration represents different types of items within a system, where each | `role_confidential_attribute_group` | ```ItemPaymentRoleConfidentialAttributeGroup``` | | The role-specific confidential attribute group for this payment. | | `private_attribute_group` | ```ItemPaymentPrivateAttributeGroup``` | | The private attribute group associated with this payment. | +Pseudo-code: + +```json +{ + "item": Item, + "public_attribute_group": ItemPaymentPublicAttributeGroup, + "role_confidential_attribute_group": ItemPaymentRoleConfidentialAttributeGroup, + "private_attribute_group": ItemPaymentPrivateAttributeGroup +} +``` + #### 3.7.1. ItemPaymentPublicAttributeGroup This struct organizes public payment attributes, detailing aspects like service provider addresses and payment goals, for public knowledge. @@ -328,6 +520,12 @@ This struct organizes public payment attributes, detailing aspects like service | `payload_list_public` | ```Vec``` | | A list of public payloads associated with this payment. | | `audit_code_list_public` | ```Vec``` | | A list of public audit codes associated with this payment. | +Pseudo-code: + +```json + +``` + #### 3.7.2. ItemPaymentRoleConfidentialAttributeGroup It holds confidential payment attributes, maintaining the confidentiality of critical payment information. @@ -337,6 +535,24 @@ It holds confidential payment attributes, maintaining the confidentiality of cri | `payload_list_confidential` | ```Vec``` | | A list of confidential payloads associated with this payment. | | `audit_code_list_confidential` | ```Vec``` | | A list of confidential audit codes associated with this payment. | +Pseudo-code: + +```json +{ + "for_sp_address_list": [], + "goal_list": [], + "provider_type": "", + "commitment_request_pcd_hash_list": [], + "order_request_pcd_hash_list": [], + "invoice_request_pcd_hash_list": [], + "pay_request_pcd_hash_list": [], + "ref_item_hash_list": [], + "ref_request_pcd_hash_list": [], + "payload_list_public": [], + "audit_code_list_public": [] +} +``` + #### 3.7.3. ItemPaymentPrivateAttributeGroup ItemPaymentPrivateAttributeGroup protects private payment attributes, ensuring the highest level of privacy for payment details. @@ -346,6 +562,16 @@ ItemPaymentPrivateAttributeGroup protects private payment attributes, ensuring t | `payload_list_private` | ```Vec``` | | A list of private payloads associated with this payment. | | `audit_code_private` | ```String``` | | A private audit code associated with this payment. | +Pseudo-code: + +```json +{ + "payload_list_private": [], + "audit_code_private": "" +} +``` + + ### 3.8. ItemPeer `ItemPeer` combines basic item information with layers, public, and private attributes, fully detailing a peer within the system. @@ -357,6 +583,17 @@ ItemPaymentPrivateAttributeGroup protects private payment attributes, ensuring t | `public_attribute_group` | ```ItemPeerPublicAttributeGroup``` | | Groupe d'attributs publics associés à ce pair. | | `private_attribute_group` | ```ItemPeerPrivateAttributeGroup``` | | Groupe d'attributs privés associés à ce pair. | +Pseudo-code: + +```json +{ + "item": Item, + "layer_list": [], + "public_attribute_group": ItemPeerPublicAttributeGroup, + "private_attribute_group": ItemPeerPrivateAttributeGroup +} +``` + #### 3.8.1. ItemPeerPublicAttributeGroup It outlines public peer attributes, such as service provider addresses and PoW details, for transparency in peer-related information. @@ -375,6 +612,24 @@ It outlines public peer attributes, such as service provider addresses and PoW d | `daily_sp_tx_mine_list` | ```Vec``` | | A daily list of service provider transactions mined by this peer. | | `daily_sp_tx_mine_reward_list` | ```Vec``` | | A daily list of rewards for service provider transactions mined by this peer. | +Pseudo-code: + +```json +{ + "sp_address": "", + "domain": "", + "ip_address": "", + "pow_difficulty": 0, + "pow_pattern": "", + "pow_prefix": "", + "data_size_max": 0, + "timestamp_delay_max": 0, + "daily_hash_list": [], + "daily_sp_tx_mine_list": [], + "daily_sp_tx_mine_reward_list": [] +} +``` + #### 3.8.2. ItemPeerPrivateAttributeGroup `ItemPeerPrivateAttributeGroup` contains a private configuration ```String``` for a peer, keeping certain peer configurations confidential. @@ -383,6 +638,14 @@ It outlines public peer attributes, such as service provider addresses and PoW d |----------------|--------------|--------|-----------------------------------------------------------------| | `config` | ```String``` | | A private configuration ```String``` associated with this peer. | +Pseudo-code: + +```json +{ + "config": "" +} +``` + ### 3.9. ItemProcess `ItemProcess` associates an item with a process, including public attribute groups, to represent processes within the system comprehensively. @@ -392,6 +655,15 @@ It outlines public peer attributes, such as service provider addresses and PoW d | `item` | ```Item``` | | Represents the item associated with this process. | | `item_process_public_attribute_group` | ```ItemProcessPublicAttributeGroup``` | | The public attribute group associated with this process. | +Pseudo-code: + +```json +{ + "item": {}, + "item_process_public_attribute_group": ItemProcessPublicAttributeGroup +} +``` + #### 3.9.1. ItemProcessPublicAttributeGroup This struct details public attributes related to processes, like roles groups, to facilitate understanding of process organization. @@ -400,6 +672,14 @@ This struct details public attributes related to processes, like roles groups, t |----------------|------------|--------|-----------------------------------------------------------| | `roles_group` | RolesGroup | | Represents a group of roles associated with this process. | +Pseudo-code: + +```json +{ + "roles_group": {} +} +``` + ## 4. Encryption ### 4.1. KeyEncryption @@ -412,6 +692,16 @@ The `KeyEncryption` struct provides details about encryption keys, including the | `key` | ```String``` | Yes | An optional encryption key. | | `algorithm` | ```String``` | Yes | An optional encryption algorithm used with this key. | +Pseudo-code: + +```json +{ + "attribute_name": "", + "key": "", + "algorithm": "" +} +``` + ### 4.2. Aes256GcmIv96Bit This struct represents an encryption scheme using `AES-256-GCM` with a 96-bit initialization vector (IV), specifying the key details for robust data encryption. @@ -420,6 +710,14 @@ This struct represents an encryption scheme using `AES-256-GCM` with a 96-bit in |----------------|-----------------------------|--------|------------------------------------------------------------------------------| | `key` | ```GenericArray``` | | Represents an encryption key for the AES-256-GCM algorithm with a 96-bit IV. | +Pseudo-code: + +```json +{ + "key": [] +} +``` + ## 5. Messages ### 5.1. Message @@ -431,6 +729,15 @@ This struct represents an encryption scheme using `AES-256-GCM` with a 96-bit in | `message` | ```Message``` | | Represents a message, assuming `Message` is a predefined struct. | | `request_enc` | ```String``` | | The encrypted request content. | +Pseudo-code: + +```json +{ + "message": Message, + "request_enc": "" +} +``` + ### 5.2. MessageConnect The `MessageConnect` struct is designed to handle connection-related messages, facilitating the establishment of connections within the system. @@ -439,6 +746,14 @@ The `MessageConnect` struct is designed to handle connection-related messages, f |----------------|---------------|--------|------------------------------------------------------------------| | message | ```Message``` | | Represents a message, assuming `Message` is a predefined struct. | +Pseudo-code: + +```json +{ + "message": Message +} +``` + ### 5.3. MessageGeneric `Message` provides a general structure for messages, including shared peers and processes, and details like PoW challenges, supporting diverse communication needs @@ -451,6 +766,18 @@ The `MessageConnect` struct is designed to handle connection-related messages, f | `pow` | ```Pow``` | | Represents a Proof of Work (PoW) challenge, assuming `Pow` is a predefined struct. | | `raw_transaction_list` | ```Vec``` | Yes | Transaction to broadcast | +Pseudo-code: + +```json +{ + "shared_peer_list": [], + "shared_process_list": [], + "faucet_sp_address": "", + "pow": {}, + "raw_transaction_list": [] +} +``` + ### 5.4. Pow The `Pow` struct outlines a Proof of Work challenge, including data hash, timestamp, and nonce, to ensure computational effort for security purposes. @@ -463,6 +790,19 @@ The `Pow` struct outlines a Proof of Work challenge, including data hash, timest | `pattern` | ```String``` | | The pattern that the PoW solution must match. | | `difficulty` | ```usize``` | | The difficulty level of the PoW challenge. | +Pseudo-code: + +```json +{ + "data_hash": "", + "timestamp": 0, + "nonce": 0, + "pattern": "", + "difficulty": 0 +} +``` + + ### 5.5. SharedProcess `SharedProcess` identifies a shared process within the system, aiding in the management and coordination of collaborative processes. @@ -471,6 +811,15 @@ The `Pow` struct outlines a Proof of Work challenge, including data hash, timest |----------------|--------------------|--------|---------------------------------------------| | `processes` | `Vec` | | A list of SP addresses related to the role. | +Pseudo-code: + +```json +{ + "processes": [] +} +``` + + ### 5.6. SharedPeer `SharedPeer` specifies a peer within the network, playing a key role in distributed information sharing and communication. @@ -484,6 +833,19 @@ The `Pow` struct outlines a Proof of Work challenge, including data hash, timest | `l1_miner` | ```L1Miner``` | Yes | | | `l2_node_list` | ```[L2Node]``` | | Represents a table of level 2 (L2) node in the network. | +Pseudo-code: + +```json +{ + "domain": "", + "address_ip": "", + "relay": Relay, + "l1_node": L1Node, + "l1_miner": L1Miner, + "l2_node_list": [] +} +``` + ## 6. Relay Represents a `Relay` in the network, specifying its address and port, data handling capacity, and Proof of Work (PoW) requirements. @@ -501,6 +863,23 @@ Represents a `Relay` in the network, specifying its address and port, data handl | `spend_key` | ```String``` | Yes | | | `scan_key` | ```String``` | Yes | | +Pseudo-code: + +```json +{ + "address_port": 0, + "data_max_size": 0, + "pow_difficulty": 0, + "pow_pattern": "", + "pow_prefix": "", + "pow_timeout": 0, + "faucet_sp_address": 0, + "faucet_tx_list": [], + "spend_key": "", + "scan_key": "" +} +``` + ## 7. L1Node The `L1Node` struct details a Level 1 blockchain node, including its network, IP address, and status, integral to blockchain operations and interactions. @@ -518,6 +897,23 @@ The `L1Node` struct details a Level 1 blockchain node, including its network, IP | `spend_key` | ```String``` | Yes | | | `scan_key` | ```String``` | Yes | | +Pseudo-code: + +```json +{ + "address_port": 0, + "explorer_base_url": "", + "sp_address_anchorage": "", + "sp_address_reward": "", + "l2_mining": L2Mining, + "l2_certif": L2Certif, + "reward_tx_list": [], + "anchorage_tx_list": [], + "spend_key": "", + "scan_key": "" +} +``` + ### 7.1. L1NodeMining | Attribute Name | Type | Option | Description | @@ -528,6 +924,18 @@ The `L1Node` struct details a Level 1 blockchain node, including its network, IP | `spend_key` | ```String``` | Yes | | | `scan_key` | ```String``` | Yes | | +Pseudo-code: + +```json +{ + "sp_address_minig_reward": "", + "block_mined_list": [], + "mining_reward_tx_list": [], + "spend_key": "", + "scan_key": "" +} +``` + ### 7.2. L2Node This struct represents a Level 2 (Layer 2) blockchain node, focusing on scalability solutions and includes details such as its network and operation layer. @@ -542,6 +950,20 @@ This struct represents a Level 2 (Layer 2) blockchain node, focusing on scalabil | `magic_number` | ```u32``` | | The magic number. | | `challenge` | ```String``` | | The challenge. | +Pseudo-code: + +```json +{ + "address_port": 0, + "explorer_base_url": "", + "sp_address_anchorage": "", + "sp_address_reward": "", + "nbits": 0, + "magic_number": 0, + "challenge": "" +} +``` + ### 7.3. L2NodeMining | Attribute Name | Type | Option | Description | @@ -554,6 +976,20 @@ This struct represents a Level 2 (Layer 2) blockchain node, focusing on scalabil | `spend_key` | ```String``` | Yes | | | `scan_key` | ```String``` | Yes | | +Pseudo-code: + +```json +{ + "sp_address_minig_reward": "", + "sp_address_refunder": "", + "block_hash_mined_list": [], + "minig_reward_tx_list": [], + "refunder_tx_list": [], + "spend_key": "", + "scan_key": "" +} +``` + ### 7.4. L2Certif `L2Certif` specifies a Layer 2 certification, including its network and certification type, vital for managing certifications on Layer 2 solutions. @@ -569,6 +1005,12 @@ This struct represents a Level 2 (Layer 2) blockchain node, focusing on scalabil | `spend_key` | ```String``` | Yes | | | `scan_key` | ```String``` | Yes | | +Pseudo-code: + +```json + +``` + ### 7.5. BlockCertif | Attribute Name | Type | Option | Description | @@ -577,6 +1019,21 @@ This struct represents a Level 2 (Layer 2) blockchain node, focusing on scalabil | `certif_hash` | ```Vec``` | | List of certification hashes. | | `l1_tx` | ```String``` | | Level 1 transaction. | +Pseudo-code: + +```json +{ + "sp_address_certif_l1": "", + "sp_address_refunded": "", + "block_certified_list": [], + "certif_l1_tx_list": [], + "refunded_tx_list": [], + "anchorage_tx_list": [], + "spend_key": "", + "scan_key": "" +} +``` + ## 8. Metadata `MetaData` aggregates various metadata types, including tags, zones, and key lists, offering a comprehensive view of metadata for diverse applications. @@ -594,6 +1051,23 @@ This struct represents a Level 2 (Layer 2) blockchain node, focusing on scalabil | `legal_text_list` | ```Vec``` | | A list of legal texts associated with the metadata. | | `key_list` | ```Vec``` | | A list of key encryption methods associated with the metadata. | +Pseudo-code: + +```json +{ + "tag_list": [], + "zone_list": [], + "label_list": [], + "ref_list": [], + "data_list": [], + "amount": Amount, + "number": Number, + "render_template_list": [], + "legal_text_list": [], + "key_list": [] +} +``` + ### 8.1. MetadataContractPublic The `MetadataContractPublic` struct encapsulates public metadata for contracts, providing transparency and accessibility of contract-related information. @@ -602,6 +1076,14 @@ The `MetadataContractPublic` struct encapsulates public metadata for contracts, |----------------|----------------|--------|------------------------------------------------------------| | `meta_data` | ```MetaData``` | | Represents the public metadata associated with a contract. | +Pseudo-code: + +```json +{ + "meta_data": MetaData +} +``` + ### 8.2. MetadataPrivate `MetadataPrivate` holds private metadata, ensuring the confidentiality of sensitive information associated with entities or contracts. @@ -610,6 +1092,14 @@ The `MetadataContractPublic` struct encapsulates public metadata for contracts, |----------------|----------------|--------|------------------------------------------------------------| | `meta_data` | ```MetaData``` | | Represents the private metadata associated with an entity. | +Pseudo-code: + +```json +{ + "meta_data": MetaData +} +``` + ### 8.3. MetadataRoleConfidential This struct contains role-specific confidential metadata, balancing the need for privacy with role-based access and transparency. @@ -618,6 +1108,14 @@ This struct contains role-specific confidential metadata, balancing the need for |----------------|----------------|--------|-------------------------------------------------------------------------------| | `meta_data` | ```MetaData``` | | Represents the role-specific confidential metadata associated with an entity. | +Pseudo-code: + +```json +{ + "meta_data": MetaData +} +``` + ### 8.4. Amount The `Amount` struct details financial amounts, including its timestamp, unit, and changes, facilitating precise financial transactions and records. @@ -630,6 +1128,18 @@ The `Amount` struct details financial amounts, including its timestamp, unit, an | `amount_unit` | ```String``` | | The unit of the amount, such as "USD", "EUR", etc. | | `amount_unit_ref` | ```String``` | | A reference to an external unit system, providing context for the `amount_unit`. | +Pseudo-code: + +```json +{ + "timestamp": 0, + "change_source_list": [], + "amount_cent": 0, + "amount_unit": "", + "amount_unit_ref": "" +} +``` + ### 8.5. Number `Number` provides a numeric value and its unit, supporting a wide range of quantitative representations in system operations. @@ -640,6 +1150,16 @@ The `Amount` struct details financial amounts, including its timestamp, unit, an | `number` | ```i32``` | | The numeric value. | | `number_unit` | ```String``` | | The unit of measurement for the number, if applicable. | +Pseudo-code: + +```json +{ + "fixed_state": false, + "number": 0, + "number_unit": "" +} +``` + ## 9. Request Defines a general request structure within the system, encapsulating details about the requested item, its type, version, and associated process and document references. @@ -656,6 +1176,23 @@ Defines a general request structure within the system, encapsulating details abo | `request_prd_origin_hash` | ```String``` | Yes | Optional hash of the originating RequestPrd. | | `item_reference_hash` | ```String``` | Yes | Optionally specifies the hash of the item related to the request. | +Pseudo-code: + +```json +{ + "item_name": "", + "request_type": "", + "version": 0, + "process_hash": "", + "request_pcd_reference_hash": "", + "request_pcd_origin_hash": "", + "request_prd_reference_hash": "", + "request_prd_origin_hash": "", + "item_reference_hash": "" +} + +``` + ## 10. RequestPcd The `request_pcd` struct integrates a request with a list of generic encrypted items and pagination details, facilitating the handling of encrypted RequestPcd requests within the system. @@ -666,6 +1203,16 @@ The `request_pcd` struct integrates a request with a list of generic encrypted i | `item_enc_list` | ```Vec< RequestPcdItemGenericEnc>``` | | List of generic encrypted items. | | `pagination` | ```Pagination``` | Yes | Pagination details, assuming `Pagination` is a predefined struct. | +Pseudo-code: + +```json +{ + "request": Request, + "item_enc_list": [], + "pagination": {Pagination +} +``` + ### 10.1. Pagination The `Pagination` struct is essential for managing large datasets, detailing the pagination strategy with start index, number of items, and page index. @@ -677,6 +1224,17 @@ The `Pagination` struct is essential for managing large datasets, detailing the | `page_index` | ```usize``` | | L'indice de la page actuelle pour la pagination. | | `page_total` | ```usize``` | | | +Pseudo-code: + +```json +{ + "start": 0, + "number": 0, + "page_index": 0, + "page_total": 0 +} +``` + ### 10.2. RequestPcdItemGenericEnc `request_pcdItemGenericEnc` encompasses encrypted items with optional lists of public, role-confidential, and private encrypted attributes, offering a flexible encryption model for diverse data types. @@ -690,6 +1248,19 @@ The `Pagination` struct is essential for managing large datasets, detailing the | `request_pcd_item_enc_attribute_role_confidential_list` | ```Vec< RequestPcdItemEncAttributeRoleConfidential>``` | Yes | Optional list of role-confidential encrypted attributes. | | `request_pcd_item_enc_attribute_private_list` | ```Vec< RequestPcdItemEncAttributePrivate>``` | Yes | Optional list of private encrypted attributes. | +Pseudo-code: + +```json +{ + "version": 0, + "item_type": "", + "name": "", + "request_pcd_item_enc_attribute_public_list": [], + "request_pcd_item_enc_attribute_role_confidential_list": [], + "request_pcd_item_enc_attribute_private_list": [] +} +``` + #### 10.2.1. RequestPcdItemEncAttributePublic This struct outlines public encrypted attributes for RequestPcd items, ensuring the secure transmission of public attribute data. @@ -699,6 +1270,15 @@ This struct outlines public encrypted attributes for RequestPcd items, ensuring | `attribute_name` | ```String``` | | The name of the attribute. | | `data_enc` | ```String``` | | The encrypted data associated with the attribute. | +Pseudo-code: + +```json +{ + "attribute_name": "", + "data_enc": "" +} +``` + #### 10.2.2. RequestPcdItemEncAttributeRoleConfidential `request_pcdItemEncAttributeRoleConfidential` deals with role-specific confidential encrypted attributes, securing sensitive data while allowing role-based access. @@ -708,6 +1288,15 @@ This struct outlines public encrypted attributes for RequestPcd items, ensuring | `attribute_name` | ```String``` | | The name of the attribute. | | `data_enc` | ```String``` | Yes | The encrypted data associated with the attribute. | +Pseudo-code: + +```json +{ + "attribute_name": "", + "data_enc": "" +} +``` + #### 10.2.3. RequestPcdItemEncAttributePrivate It specifies private encrypted attributes for `request_pcd` items, protecting the most sensitive information with encryption. @@ -717,6 +1306,15 @@ It specifies private encrypted attributes for `request_pcd` items, protecting th | `attribute_name` | ```String``` | | The name of the attribute. | | `data_enc` | ```String``` | Yes | The encrypted data associated with this attribute name. | +Pseudo-code: + +```json +{ + "attribute_name": "", + "data_enc": "" +} +``` + ## 11. RequestPrd Encapsulates a detailed request within the system, focusing on the interaction with Portable Request Documents ( RequestPrd) and specifying various levels of message confidentiality and intended service provider (SP) communication details. @@ -749,44 +1347,113 @@ Encapsulates a detailed request within the system, focusing on the interaction w | `certif_key_enc_by_shared_secret` | ```String``` | Yes | Encrypted certification key, encrypted with a shared secret. | | `device_footprint_enc_by_sp_shared_secret` | ```String``` | | The device footprint encrypted by a service provider's shared secret. | +Pseudo-code: + +```json +{ + "request": {}, + "sig_value": "", + "request_pcd_reference_keys_role_confidential_list_enc_by_shared_secret": [], + "request_pcd_origin_hash_keys_role_confidential_list_enc_by_shared_secret": [], + "message_public": "", + "message_confidential": "", + "message_private": "", + "sp_address_to": "", + "sp_address_from": "", + "sp_address_reply": "", + "timestamp_declared": 0, + "role_name_from": "", + "role_name_to": "", + "payment_method_enc_by_shared_secret": "", + "deposit_method_enc_by_shared_secret": "", + "commitment_method_enc_by_shared_secret": "", + "payment_request_pcd_hash_list_enc_by_shared_secret": [], + "cap_request_pcd_hash_list_enc_by_shared_secret": [], + "deposit_request_pcd_hash_list_enc_by_shared_secret": [], + "commitment_request_pcd_hash_list_enc_by_shared_secret": [], + "ask_payment_method_enc_by_shared_secret": "", + "ask_deposit_method_enc_by_shared_secret": "", + "ask_commitment_method_enc_by_shared_secret": "", + "certif_key_enc_by_shared_secret": "", + "device_footprint_enc_by_sp_shared_secret": "" +} +``` ### 11.3. RequestPrdList `request_prdList` struct is utilized for listing or querying RequestPrds, aiding in the retrieval or enumeration of Portable Request Documents within the system, streamlining the management and access of RequestPrds. -| Attribute Name | Type | Option | Description | -|---------------------------------------|-------------------|--------|-------------------------------------------------------------------------------------------| -| `request_prd` | ```request_prd``` | | Represents a Portable Request Document. | -| `item_member_enc_by_sp_shared_secret` | ```String``` | Yes | (only for members manager) ItemMember to add if the `pre_id` not exist to the member list | -| `pre_id_sp_enc_by_shared_secret` | ```string``` | Yes | (only for members manager) An existing member `pre_id`. | +| Attribute Name | Type | Option | Description | +|---------------------------------------|------------------|--------|-------------------------------------------------------------------------------------------| +| `request_prd` | ```RequestPrd``` | | Represents a Portable Request Document. | +| `item_member_enc_by_sp_shared_secret` | ```String``` | Yes | (only for members manager) ItemMember to add if the `pre_id` not exist to the member list | +| `pre_id_sp_enc_by_shared_secret` | ```string``` | Yes | (only for members manager) An existing member `pre_id`. | + +Pseudo-code: + +```json +{ + "request_prd": RequestPrd, + "item_member_enc_by_sp_shared_secret": "", + "pre_id_sp_enc_by_shared_secret": "" +} +``` ### 11.6. RequestPrdUpdate `request_prdUpdate` struct facilitates the updating of RequestPrds, incorporating new version hashes and lists of related RequestPcd hashes, alongside requested methods for payments, deposits, and commitments, ensuring RequestPrds remain current and relevant. -| Attribute Name | Type | Option | Description | -|----------------|-------------------|--------|-----------------------------------------| -| `request_prd` | ```request_prd``` | | Represents a Portable Request Document. | +| Attribute Name | Type | Option | Description | +|----------------|------------------|--------|-----------------------------------------| +| `request_prd` | ```RequestPrd``` | | Represents a Portable Request Document. | + +Pseudo-code: + +```json +{ + "request_prd": RequestPrd +} +``` ### 11.1. RequestPrdResponse `request_prd` and its variations represent different aspects and actions related to Portable Request Documents ( RequestPrd), covering everything from confirmation to updates, key management, and messaging, essential for managing and processing RequestPrds securely and efficiently. -| Attribute Name | Type | Option | Description | -|---------------------------------------------|-------------------|--------|------------------------------------------------------------| -| `request_prd` | ```request_prd``` | | Represents a Request. | -| `sig_value` | ```String``` | | The signature value for the response. | -| `shared_secret_key_enc_by_sp_shared_secret` | ```String``` | Yes | Optional encryption key used for shared secrets. | -| `shard_enc_by_sp_shared_secret` | ```String``` | Yes | The shard encrypted by a service provider's shared secret. | +| Attribute Name | Type | Option | Description | +|---------------------------------------------|------------------|--------|------------------------------------------------------------| +| `request_prd` | ```RequestPrd``` | | Represents a Request. | +| `sig_value` | ```String``` | | The signature value for the response. | +| `shared_secret_key_enc_by_sp_shared_secret` | ```String``` | Yes | Optional encryption key used for shared secrets. | +| `shard_enc_by_sp_shared_secret` | ```String``` | Yes | The shard encrypted by a service provider's shared secret. | + +Pseudo-code: + +```json +{ + "request_prd": RequestPrd, + "sig_value": "", + "shared_secret_key_enc_by_sp_shared_secret": "", + "shard_enc_by_sp_shared_secret": "" +} +``` ### 11.2. RequestPrdConfirm The `request_prdConfirm` struct is designed for confirming actions or requests within the system, utilizing a Portable Request Document ( RequestPrd) alongside an encrypted confirmation code, ensuring secure acknowledgment of operations. -| Attribute Name | Type | Option | Description | -|-------------------------------------|-------------------|--------|-----------------------------------------------------| -| `request_prd` | ```request_prd``` | | The RequestPrd (Portable Request Document) request. | -| `code_confirm_enc_by_shared_secret` | ```String``` | Yes | The confirmation code encrypted by a shared secret. | +| Attribute Name | Type | Option | Description | +|-------------------------------------|------------------|--------|-----------------------------------------------------| +| `request_prd` | ```RequestPrd``` | | The RequestPrd (Portable Request Document) request. | +| `code_confirm_enc_by_shared_secret` | ```String``` | Yes | The confirmation code encrypted by a shared secret. | + +Pseudo-code: + +```json +{ + "request_prd": RequestPrd, + "code_confirm_enc_by_shared_secret": "" +} +``` ### 11.4. RequestPrdMessage @@ -794,17 +1461,36 @@ The `request_prdMessage` struct serves the purpose of encapsulating messages wit | Attribute Name | Type | Option | Description | |------------------------|-------------------|--------|-----------------------------------------| -| `request_prd` | ```request_prd``` | | Represents a Portable Request Document. | +| `request_prd` | ```RequestPrd``` | | Represents a Portable Request Document. | | `raw_transaction_list` | ```Vec``` | Yes | Represents a Portable Request Document. | +Pseudo-code: + +```json +{ + "request_prd": RequestPrd, + "raw_transaction_list": [] +} +``` + ### 11.5. RequestPrdResponse `request_prdResponse` is designed for responding to RequestPrd requests, including the original RequestPrd, signature for verification, and optional encrypted methods, ensuring a secure and verifiable response mechanism. -| Attribute Name | Type | Option | Description | -|----------------|-------------------|--------|-----------------------------------------| -| `request_prd` | ```request_prd``` | | Represents a Portable Request Document. | -| `sig_value` | ```String``` | | The signature value for the response. | +| Attribute Name | Type | Option | Description | +|----------------|------------------|--------|-----------------------------------------| +| `request_prd` | ```RequestPrd``` | | Represents a Portable Request Document. | +| `sig_value` | ```String``` | | The signature value for the response. | + +Pseudo-code: + +```json +{ + "request_prd": RequestPrd, + "sig_value": "" +} +``` + ## 12. Roles The `Roles` enum defines the various roles within the system, specifying responsibilities, required security measures such as two-factor authentication, validation timeouts, and conditions for action validation, crucial for role-based access control and process flow. @@ -830,24 +1516,64 @@ The `Role` struct broadly defines a role within the system, encapsulating the ge | `role_resolve` | ```String``` | Yes | Optional role for resolving conflicts. | | `role_renew` | ```String``` | Yes | Optional role for renewing conditions or capabilities. | +Pseudo-code: + +```json +{ + "item": Item, + "sp_output_salt_enc": "", + "required_2fa": false, + "validation_timeout": 0, + "condition_prd_address_set_list": [], + "condition_publish_list": [], + "condition_cap_list": [], + "condition_payment_list": [], + "condition_commitment_list": [], + "condition_attribute_encryption_list": [], + "condition_orchestration_list": [], + "role_succession": "", + "role_resolve": "", + "role_renew": "" +} +``` + ### 12.2. Conditions #### 12.2.1. TransactionMode `TransactionMode` and its specific types (Distribution, Direct) describe how transactions are handled within the system, whether through direct communication or distributed across multiple entities, influencing the flow and security of transactions. -| Attribute Name | Type | Option | Description | -|------------------|------------------------|--------|------------------------------------------------------------------------------------------| -| `value` | ```Amount or Number``` | | Valeurs échangées | -| `hash_ok_list` | ```Vec``` | Yes | Commitments de hash valant pour un résultat "OK" | -| `hash_ko_list` | ```Vec``` | Yes | Commitments de hash valant pour un résultat "KO" | -| `hash_none_list` | ```Vec``` | Yes | Commitments de hash valant pour un résultat "None" | -| `from_list` | ```Vec``` | | Adresse silent payment ou role qui doit opérer le paiement | -| `from_type` | ```String``` | | Soit "addresses" soit "roles" | -| `from_method` | ```String``` | | Méthode de distribution de la somme des prélèvements : "Amount divided" ou "Same Amount" | -| `to_list` | ```Vec``` | | Adresse silent payment ou role qui doit recevoir le Versement | -| `to_type` | ```String``` | | Soit "addresses" soit "roles" | -| `to_method` | ```String``` | | Méthode de distribution de la somme des versements : "Amount divided" ou "Same Amount" | +| Attribute Name | Type | Option | Description | +|------------------|-------------------|--------|------------------------------------------------------------------------------------------| +| `amount` | ```Amount``` | Yes | Montants échangées | +| `number` | ```Number``` | Yes | Unités échangées | +| `hash_ok_list` | ```Vec``` | Yes | Commitments de hash valant pour un résultat "OK" | +| `hash_ko_list` | ```Vec``` | Yes | Commitments de hash valant pour un résultat "KO" | +| `hash_none_list` | ```Vec``` | Yes | Commitments de hash valant pour un résultat "None" | +| `from_list` | ```Vec``` | | Adresse silent payment ou role qui doit opérer le paiement | +| `from_type` | ```String``` | | Soit "addresses" soit "roles" | +| `from_method` | ```String``` | | Méthode de distribution de la somme des prélèvements : "Amount divided" ou "Same Amount" | +| `to_list` | ```Vec``` | | Adresse silent payment ou role qui doit recevoir le Versement | +| `to_type` | ```String``` | | Soit "addresses" soit "roles" | +| `to_method` | ```String``` | | Méthode de distribution de la somme des versements : "Amount divided" ou "Same Amount" | + +Pseudo-code: + +```json +{ + "amount": Amount, + "number": Number, + "hash_ok_list": [], + "hash_ko_list": [], + "hash_none_list": [], + "from_list": [], + "from_type": "", + "from_method": "", + "to_list": [], + "to_type": "", + "to_method": "" +} +``` #### 12.2.2. ConditionPayment @@ -860,6 +1586,17 @@ This struct outlines the conditions for payments, including the amount, payment | `payment_proof_validation` | ```ConditionRequestPrdAddressSet``` | | Validation conditions + {sp_address_sender} and {sp_address_receiver} placehoders for Address SP | | `condition_deposit_list` | ```Vec``` | Yes | A list of deposit conditions. | +Pseudo-code: + +```json +{ + "request_prd_type": "", + "transaction_mode": TransactionMode, + "payment_proof_validation": ConditionRequestPrdAddressSet, + "condition_deposit_list": [] +} +``` + #### 12.2.3. ConditionCommitment The `ConditionCommitment` struct specifies a condition involving an artefact role and transaction mode, defining how commitments are handled and verified. @@ -870,6 +1607,16 @@ The `ConditionCommitment` struct specifies a condition involving an artefact rol | `transaction_mode` | ```TransactionMode``` | | Specifies the transaction mode associated with this role. | | `payment_proof_validation` | ```ConditionRequestPrdAddressSet``` | | Validation conditions + {sp_address_sender} and {sp_address_receiver} placehoders for Address SP | +Pseudo-code: + +```json +{ + "request_prd_type": "", + "transaction_mode": TransactionMode, + "payment_proof_validation": ConditionRequestPrdAddressSet +} +``` + #### 12.2.4. ConditionDeposit `ConditionDeposit` is similar to ConditionCap but specifically focuses on deposit-related transactions, establishing the criteria for deposit actions. @@ -880,6 +1627,16 @@ The `ConditionCommitment` struct specifies a condition involving an artefact rol | `transaction_mode` | ```TransactionMode``` | | Specifies the transaction mode associated with this role. | | `payment_proof_validation` | ```ConditionRequestPrdAddressSet``` | | Validation conditions + {sp_address_sender} and {sp_address_receiver} placehoders for Address SP | +Pseudo-code: + +```json +{ + "request_prd_type": "", + "transaction_mode": TransactionMode, + "payment_proof_validation": ConditionRequestPrdAddressSet +} +``` + #### 12.2.5. ConditionOrchestration `ConditionOrchestration` defines success and failure roles for orchestration conditions, guiding the flow of processes based on outcomes. @@ -891,6 +1648,17 @@ The `ConditionCommitment` struct specifies a condition involving an artefact rol | `role_ko` | ```String``` | | Represents the failed outcome role in the condition. | | `payment_proof_validation` | ```ConditionRequestPrdAddressSet``` | | Validation conditions + {sp_address_sender} and {sp_address_receiver} placehoders for Address SP | +Pseudo-code: + +```json +{ + "request_prd_type": "", + "role_ok": "", + "role_ko": "", + "payment_proof_validation": ConditionRequestPrdAddressSet +} +``` + #### 12.2.6. ConditionCap The `ConditionCap` struct represents a condition related to a deposit role and its associated transaction mode, indicating the requirements for transactions within this context. @@ -901,6 +1669,16 @@ The `ConditionCap` struct represents a condition related to a deposit role and i | `transaction_mode` | ```TransactionMode``` | | Specifies the transaction mode associated with this role. | | `payment_proof_validation` | ```ConditionRequestPrdAddressSet``` | | Validation conditions + {sp_address_sender} and {sp_address_receiver} placehoders for Address SP | +Pseudo-code: + +```json +{ + "request_prd_type": "", + "transaction_mode": "", + "payment_proof_validation": ConditionRequestPrdAddressSet +} +``` + #### 12.2.7. ConditionRequestPrdAddressSet Condition `request_prdAddressSet` involves complex conditions based on RequestPrd addresses, including quotas, values, and scores, to determine condition fulfillment. @@ -931,6 +1709,36 @@ Condition `request_prdAddressSet` involves complex conditions based on RequestPr | `request_prd_sp_address_score_min_min_ok` | ```boolean``` | Yes | Indicates if the minimum score is considered OK. | | `request_prd_sp_address_score_min_min_per` | ```i64``` | Yes | The minimum percentage for the minimum score. | +Pseudo-code: + +```json +{ + "request_prd_type": "", + "from_role": "", + "request_prd_sp_address_list": [], + "request_prd_sp_address_required_list": [], + "request_prd_sp_address_quota": 0, + "request_prd_value_ok_list": [], + "request_prd_value_ko_list": [], + "request_prd_value_none_list": [], + "request_prd_value_auto_ok": false, + "request_prd_value_auto_ko": false, + "request_prd_value_auto_none": false, + "request_prd_sp_address_value_min": 0, + "request_prd_sp_address_value_min_ok": false, + "request_prd_sp_adddress_value_ok_min_per": 0, + "request_prd_sp_address_value_ok_max": 0, + "request_prd_sp_adderss_value_ko_max_per": 0, + "request_prd_sp_address_value_ko_max": 0, + "request_prd_sp_address_value_none_max": 0, + "request_prd_sp_adderss_value_none_max_per": 0, + "request_prd_sp_address_score_min": 0, + "request_prd_sp_address_score_min_min_required": 0, + "request_prd_sp_address_score_min_min_ok": false, + "request_prd_sp_address_score_min_min_per": 0 +} +``` + #### 12.2.8. ConditionPublish `ConditionPublish` sets the criteria for publishing actions, including data size limits, publication counts, and timeouts, to regulate content distribution. @@ -946,6 +1754,21 @@ Condition `request_prdAddressSet` involves complex conditions based on RequestPr | `request_prd_waiting_timeout` | ```u64``` | | The waiting timeout for a publication to be considered valid. | | `request_pcd_waiting_timeout` | ```u64``` | | The waiting timeout for the condition to be considered met. | +Pseudo-code: + +```json +{ + "request_prd_type": "", + "request_pcd_data_size_max_unit": "", + "request_pcd_data_size_max_total": 0, + "request_pcd_number_min": 0, + "request_pcd_number_max": 0, + "request_pcd_amount_max_total": Amount, + "request_prd_waiting_timeout": 0, + "request_pcd_waiting_timeout": 0 +} +``` + ### 12.3. RolesGroup RolesGroup outlines a collection of roles. @@ -957,6 +1780,17 @@ RolesGroup outlines a collection of roles. | `role_process` | ```RoleProcess``` | | Represents the entities charged with defining and managing processes within the system. | | `role_artefact_list` | ```Vec``` | | A list of artefact roles, allowing customization and extension of functionalities and interactions beyond standard roles. | +Pseudo-code: + +```json +{ + "role_peer": RolePeer, + "role_member": RoleMember, + "role_process": RoleProcess, + "role_artefact_list": [] +} +``` + #### 12.3.1. RoleArtefact The `RoleArtefact` struct is utilized to define the role associated with artefacts within the system. It specifies the responsibilities and permissions tied to the handling, management, or interaction with artefacts, ensuring clarity in role-based actions and access controls related to artefact-related operations. @@ -966,6 +1800,15 @@ The `RoleArtefact` struct is utilized to define the role associated with artefac | `item_name` | ```String``` | | The name of the item associated with the deposit. | | `role` | ```Role``` | | The role associated with this deposit. | +Pseudo-code: + +```json +{ + "item_name": "Nom de l'élément", + "role": Role +} +``` + #### 12.3.2. RoleDeposit `RoleDeposit` outlines the role and responsibilities concerning deposits in the system. It identifies the specific obligations and permissions granted to entities managing or engaging with deposit transactions, providing a structured approach to deposit management and execution. @@ -975,6 +1818,15 @@ The `RoleArtefact` struct is utilized to define the role associated with artefac | `item_name` | ```String``` | | The name of the item associated with the artefact. | | `role` | ```Role``` | | The role associated with this artefact. | +Pseudo-code: + +```json +{ + "item_name": "Nom de l'élément", + "role": Role +} +``` + #### 12.3.3. RoleCommitment The `RoleCommitment` struct details the role associated with commitments, delineating the duties and authorities of entities tasked with creating, managing, or fulfilling commitments. This struct ensures that commitment-related activities are clearly defined and regulated within the system. @@ -984,6 +1836,15 @@ The `RoleCommitment` struct details the role associated with commitments, deline | `item_name` | ```String``` | | The name of the item associated with the commitment. | | `role` | ```Role``` | | The role associated with this commitment. | +Pseudo-code: + +```json +{ + "item_name": "Nom de l'élément", + "role": Role +} +``` + #### 12.3.4. RoleMember `RoleMember` defines the role of members within the system, specifying the rights and responsibilities of membership. This includes access to resources, participation in processes, and contributions to decision-making, highlighting the importance of members in the system's ecosystem. @@ -993,6 +1854,15 @@ The `RoleCommitment` struct details the role associated with commitments, deline | `item_name` | ```String``` | | The name of the item associated with the member. | | `role` | ```Role``` | | The role associated with this member. | +Pseudo-code: + +```json +{ + "item_name": "Nom de l'élément", + "role": Role +} +``` + ### 12.4. RolePeer The `RolePeer` struct identifies peers associated with specific roles, detailing their identifiers, associated peers, and metadata, essential for defining peer responsibilities and permissions within the networked environment. @@ -1002,6 +1872,15 @@ The `RolePeer` struct identifies peers associated with specific roles, detailing | `item_name` | ```String``` | | The name of the item associated with the peer. | | `role` | ```Role``` | | The role associated with this peer. | +Pseudo-code: + +```json +{ + "item_name": "Nom de l'élément", + "role": Role +} +``` + #### 12.4.1. RolePayment The `RolePayment` struct is dedicated to defining the role related to payments, outlining the specific tasks, permissions, and responsibilities assigned to entities handling or involved in payment transactions, ensuring secure and orderly payment processes. @@ -1011,6 +1890,15 @@ The `RolePayment` struct is dedicated to defining the role related to payments, | `item_name` | ```String``` | | The name of the item associated with the payment. | | `role` | ```Role``` | | The role associated with this payment. | +Pseudo-code: + +```json +{ + "item_name": "Nom de l'élément", + "role": Role +} +``` + #### 12.4.2. RoleProcess `RoleProcess` describes the role associated with processes within the system. It specifies the expectations, duties, and permissions of entities that initiate, manage, or participate in various system processes, facilitating smooth and regulated process flow. @@ -1020,6 +1908,15 @@ The `RolePayment` struct is dedicated to defining the role related to payments, | `item_name` | ```String``` | | The name of the item associated with the process. | | `role` | ```Role``` | | The role associated with this process. | +Pseudo-code: + +```json +{ + "item_name": "Nom de l'élément", + "role": Role +} +``` + ## 13. 12. Rust considerations ### 13.1.  General Implications for Project Objects