4nk/sdk_common
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix option type vs option column (doc)

Browse Source
This commit is contained in:
NicolasCantu 2024-02-15 18:28:48 +01:00
parent b6fe884458
commit 96494372ba
2 changed files with 67 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/PRD-PCD-Specs.md
View File

@ -168,6 +168,8 @@ La réception d'un PCD suit plusieurs étapes :
Utile pour les utilisateurs cherchant à consulter ou à explorer des listes de contrats, de membres, ou d'autres items dans le réseau. Chaque PCD liste des `Item` d'un même type, par exemple les `ItemProcess`, les `ItemMember`, les `ItemPeer`, les `ItemPayment`, etc. Utile pour les utilisateurs cherchant à consulter ou à explorer des listes de contrats, de membres, ou d'autres items dans le réseau. Chaque PCD liste des `Item` d'un même type, par exemple les `ItemProcess`, les `ItemMember`, les `ItemPeer`, les `ItemPayment`, etc.
## 8. <a name='RequestPrdMessage-EnvoideMessages'></a>RequestPrdMessage - Envoi de Messages ## 8. <a name='RequestPrdMessage-EnvoideMessages'></a>RequestPrdMessage - Envoi de Messages
Le RequestPrdMessage facilite l'envoi de messages sécurisés entre utilisateurs ou entre utilisateurs et processus/contrats. Le RequestPrdMessage facilite l'envoi de messages sécurisés entre utilisateurs ou entre utilisateurs et processus/contrats.

130
doc/Specs-Datamodel.md
View File

@ -465,11 +465,11 @@ The Item struct serves as a foundational element, detailing the basic structure
The KeyEncryption struct provides details about encryption keys, including the attribute it's for, the key itself, and the algorithm used, crucial for securing data within the system. The KeyEncryption struct provides details about encryption keys, including the attribute it's for, the key itself, and the algorithm used, crucial for securing data within the system.
| Attribute Name | Type | Option | Description | | Attribute Name | Type | Option | Description |
|----------------|----------------|--------|---------------------------------------------------------------| |----------------|--------|--------|---------------------------------------------------------------|
| attribute_name | Option<String> | Yes | An optional name of the attribute this encryption key is for. | | attribute_name | String | Yes | An optional name of the attribute this encryption key is for. |
| key | Option<String> | Yes | An optional encryption key. | | key | String | Yes | An optional encryption key. |
| algorithm | Option<String> | Yes | An optional encryption algorithm used with this key. | | algorithm | String | Yes | An optional encryption algorithm used with this key. |
### 5.2. <a name='Aes256GcmIv96Bit'></a>Aes256GcmIv96Bit ### 5.2. <a name='Aes256GcmIv96Bit'></a>Aes256GcmIv96Bit
@ -508,19 +508,19 @@ Message provides a general structure for messages, including shared peers and pr
| shared_process_list | Vec<SharedProcess> | | A list of shared processes, assuming `SharedProcess` is a predefined struct. | | shared_process_list | Vec<SharedProcess> | | A list of shared processes, assuming `SharedProcess` is a predefined struct. |
| faucet_sp_address | String | | The service provider address for a faucet. | | faucet_sp_address | String | | The service provider address for a faucet. |
| pow | Pow | | Represents a Proof of Work (PoW) challenge, assuming `Pow` is a predefined struct. | | pow | Pow | | Represents a Proof of Work (PoW) challenge, assuming `Pow` is a predefined struct. |
| raw_transaction_list | Vec<String > | | Transaction to broadcast | | raw_transaction_list | Vec<String> | | Transaction to broadcast |
### 6.4. <a name='Pow'></a>Pow ### 6.4. <a name='Pow'></a>Pow
The Pow struct outlines a Proof of Work challenge, including data hash, timestamp, and nonce, to ensure computational effort for security purposes. The Pow struct outlines a Proof of Work challenge, including data hash, timestamp, and nonce, to ensure computational effort for security purposes.
| Attribute Name | Type | Option | Description | | Attribute Name | Type | Option | Description |
|----------------|-------------|--------|---------------------------------------------------------| |----------------|--------|--------|---------------------------------------------------------|
| data_hash | String | | The hash of the data for which the PoW is being solved. | | data_hash | String | | The hash of the data for which the PoW is being solved. |
| timestamp | Option<u64> | Yes | An optional timestamp associated with the PoW solution. | | timestamp | u64 | Yes | An optional timestamp associated with the PoW solution. |
| nonce | Option<u64> | Yes | An optional nonce value used in the PoW calculation. | | nonce | u64 | Yes | An optional nonce value used in the PoW calculation. |
| pattern | String | | The pattern that the PoW solution must match. | | pattern | String | | The pattern that the PoW solution must match. |
| difficulty | usize | | The difficulty level of the PoW challenge. | | difficulty | usize | | The difficulty level of the PoW challenge. |
### 6.5. <a name='SharedProcess'></a>SharedProcess ### 6.5. <a name='SharedProcess'></a>SharedProcess
@ -677,17 +677,17 @@ Number provides a numeric value and its unit, supporting a wide range of quantit
Defines a general request structure within the system, encapsulating details about the requested item, its type, version, and associated process and document references. Defines a general request structure within the system, encapsulating details about the requested item, its type, version, and associated process and document references.
| Attribute Name | Type | Option | Description | | Attribute Name | Type | Option | Description |
|---------------------|----------------|--------|--------------------------------------------------------------------------------------------| |---------------------|--------|--------|--------------------------------------------------------------------------------------------|
| item_name | Option<String> | Yes | Optionally specifies the name of the item being requested. | | item_name | String | Yes | Optionally specifies the name of the item being requested. |
| request_type | String | | Specifies the type of request. `type` is a reserved keyword in Rust, hence `request_type`. | | request_type | String | | Specifies the type of request. `type` is a reserved keyword in Rust, hence `request_type`. |
| version | i64 | | Specifies the version of the item or process being requested. | | version | i64 | | Specifies the version of the item or process being requested. |
| process_hash | String | | The hash of the process associated with the request. | | process_hash | String | | The hash of the process associated with the request. |
| pcd_reference_hash | Option<String> | Yes | Optionally specifies the hash of PCD related to the request. | | pcd_reference_hash | String | Yes | Optionally specifies the hash of PCD related to the request. |
| pcd_origin_hash | Option<String> | Yes | Optional hash of the originating PCD. | | pcd_origin_hash | String | Yes | Optional hash of the originating PCD. |
| prd_reference_hash | Option<String> | Yes | Optionally specifies the hash of PRD related to the request. | | prd_reference_hash | String | Yes | Optionally specifies the hash of PRD related to the request. |
| prd_origin_hash | Option<String> | Yes | Optional hash of the originating PRD. | | prd_origin_hash | String | Yes | Optional hash of the originating PRD. |
| item_reference_hash | Option<String> | Yes | Optionally specifies the hash of the item related to the request. | | item_reference_hash | String | Yes | Optionally specifies the hash of the item related to the request. |
## 10. <a name='PCD'></a>PCD ## 10. <a name='PCD'></a>PCD
@ -741,12 +741,12 @@ It specifies private encrypted attributes for PCD items, protecting the most sen
PcdItemGenericEnc encompasses encrypted items with optional lists of public, role-confidential, and private encrypted attributes, offering a flexible encryption model for diverse data types. PcdItemGenericEnc encompasses encrypted items with optional lists of public, role-confidential, and private encrypted attributes, offering a flexible encryption model for diverse data types.
| Attribute Name | Type | Option | Description | | Attribute Name | Type | Option | Description |
|-----------------------------------------------|--------------------------------------------------|--------|----------------------------------------------------------| |-----------------------------------------------|------------------------------------------|--------|----------------------------------------------------------|
| item_enc | PcdItemEnc | | The encrypted item. | | item_enc | PcdItemEnc | | The encrypted item. |
| pcd_item_enc_attribute_public_list | Option<Vec<PcdItemEncAttributePublic>> | Yes | Optional list of public encrypted attributes. | | pcd_item_enc_attribute_public_list | Vec<PcdItemEncAttributePublic> | Yes | Optional list of public encrypted attributes. |
| pcd_item_enc_attribute_role_confidential_list | Option<Vec<PcdItemEncAttributeRoleConfidential>> | Yes | Optional list of role-confidential encrypted attributes. | | pcd_item_enc_attribute_role_confidential_list | Vec<PcdItemEncAttributeRoleConfidential> | Yes | Optional list of role-confidential encrypted attributes. |
| pcd_item_enc_attribute_private_list | Option<Vec<PcdItemEncAttributePrivate>> | Yes | Optional list of private encrypted attributes. | | pcd_item_enc_attribute_private_list | Vec<PcdItemEncAttributePrivate> | Yes | Optional list of private encrypted attributes. |
### 10.6. <a name='PcdItemEnc'></a>PcdItemEnc ### 10.6. <a name='PcdItemEnc'></a>PcdItemEnc
@ -766,46 +766,46 @@ The PcdItemEnc struct encapsulates encrypted PCD items, detailing the version, t
Encapsulates a detailed request within the system, focusing on the interaction with Portable Request Documents (PRD) and specifying various levels of message confidentiality and intended service provider (SP) communication details. Encapsulates a detailed request within the system, focusing on the interaction with Portable Request Documents (PRD) and specifying various levels of message confidentiality and intended service provider (SP) communication details.
| Attribute Name | Type | Option | Description | | Attribute Name | Type | Option | Description |
|------------------------------------------------------|---------------------|--------|----------------------------------------------------------------------------------------| |------------------------------------------------------|-------------|--------|----------------------------------------------------------------------------------------|
| request | Request | | A predefined struct representing the basic request information. | | request | Request | | A predefined struct representing the basic request information. |
| sig_value | String | | Valeur associée à la signature | | sig_value | String | | Valeur associée à la signature |
| pcd_keys_role_confidential_list_enc_by_shared_secret | String | | Encrypted list of PCD keys for role-confidential data, encrypted with a shared secret. | | pcd_keys_role_confidential_list_enc_by_shared_secret | String | | Encrypted list of PCD keys for role-confidential data, encrypted with a shared secret. |
| message_public | Option<String> | Yes | Optionally specifies a public message associated with the request. | | message_public | String | Yes | Optionally specifies a public message associated with the request. |
| message_confidential | Option<String> | Yes | Optionally specifies a confidential message associated with the request. | | message_confidential | String | Yes | Optionally specifies a confidential message associated with the request. |
| message_private | Option<String> | Yes | Optionally specifies a private message associated with the request. | | message_private | String | Yes | Optionally specifies a private message associated with the request. |
| sp_address_to | String | | The service provider address to which the request is directed. | | sp_address_to | String | | The service provider address to which the request is directed. |
| sp_address_from | String | | The service provider address from which the request originates. | | sp_address_from | String | | The service provider address from which the request originates. |
| sp_address_reply | String | | The service provider address for replies to the request. | | sp_address_reply | String | | The service provider address for replies to the request. |
| timestamp_declared | u64 | | A Unix timestamp indicating when the request was declared. | | timestamp_declared | u64 | | A Unix timestamp indicating when the request was declared. |
| role_name_from | String | | The name of the role from which the request originates. | | role_name_from | String | | The name of the role from which the request originates. |
| role_name_to | String | | The name of the role to which the request is directed. | | role_name_to | String | | The name of the role to which the request is directed. |
| payment_method_enc_by_shared_secret | Option<String> | Yes | Encrypted payment method, encrypted with a shared secret. | | payment_method_enc_by_shared_secret | String> | Yes | Encrypted payment method, encrypted with a shared secret. |
| deposit_method_enc_by_shared_secret | Option<String> | Yes | Encrypted deposit method, encrypted with a shared secret. | | deposit_method_enc_by_shared_secret | String> | Yes | Encrypted deposit method, encrypted with a shared secret. |
| commitment_method_enc_by_shared_secret | Option<String> | Yes | Encrypted commitment method, encrypted with a shared secret. | | commitment_method_enc_by_shared_secret | String> | Yes | Encrypted commitment method, encrypted with a shared secret. |
| payment_pcd_hash_list_enc_by_shared_secret | Option<Vec<String>> | Yes | A list of hashes for payment-related PCDs. | | payment_pcd_hash_list_enc_by_shared_secret | Vec<String> | Yes | A list of hashes for payment-related PCDs. |
| cap_pcd_hash_list_enc_by_shared_secret | Option<Vec<String>> | Yes | A list of hashes for capability-related PCDs. | | cap_pcd_hash_list_enc_by_shared_secret | Vec<String> | Yes | A list of hashes for capability-related PCDs. |
| deposit_pcd_hash_list_enc_by_shared_secret | Option<Vec<String>> | Yes | A list of hashes for deposit-related PCDs. | | deposit_pcd_hash_list_enc_by_shared_secret | Vec<String> | Yes | A list of hashes for deposit-related PCDs. |
| commitment_pcd_hash_list_enc_by_shared_secret | Option<Vec<String>> | Yes | A list of hashes for commitment-related PCDs. | | commitment_pcd_hash_list_enc_by_shared_secret | Vec<String> | Yes | A list of hashes for commitment-related PCDs. |
| ask_payment_method_enc_by_shared_secret | Option<String> | Yes | The requested payment method. | | ask_payment_method_enc_by_shared_secret | String> | Yes | The requested payment method. |
| ask_deposit_method_enc_by_shared_secret | Option<String> | Yes | The requested deposit method. | | ask_deposit_method_enc_by_shared_secret | String> | Yes | The requested deposit method. |
| ask_commitment_method_enc_by_shared_secret | Option<String> | Yes | The requested commitment method. | | ask_commitment_method_enc_by_shared_secret | String> | Yes | The requested commitment method. |
| certif_key_enc_by_shared_secret | Option<String> | Yes | Encrypted certification key, encrypted with a shared secret. | | 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. | | device_footprint_enc_by_sp_shared_secret | String | | The device footprint encrypted by a service provider's shared secret. |
### 11.1. <a name='RequestPrdResponse'></a>RequestPrdResponse ### 11.1. <a name='RequestPrdResponse'></a>RequestPrdResponse
RequestPrd and its variations (Confirm, KeyBackup, KeyHello, List, Message, Response, Update) represent different aspects and actions related to Portable Request Documents (PRD), covering everything from confirmation to updates, key management, and messaging, essential for managing and processing PRDs securely and efficiently. RequestPrd and its variations (Confirm, KeyBackup, KeyHello, List, Message, Response, Update) represent different aspects and actions related to Portable Request Documents (PRD), covering everything from confirmation to updates, key management, and messaging, essential for managing and processing PRDs securely and efficiently.
| Attribute Name | Type | Option | Description | | Attribute Name | Type | Option | Description |
|-----------------------------------------|-----------------------|--------|-----------------------------------------------------------------------------| |-----------------------------------------|---------------|--------|-----------------------------------------------------------------------------|
| requestPrd | RequestRD | | Represents a Request. | | requestPrd | RequestRD | | Represents a Request. |
| sig_value | String | | The signature value for the response. | | sig_value | String | | The signature value for the response. |
| pcd_origin_hash | Option<String> | Yes | Optional hash of the originating PCD. | | pcd_origin_hash | String | Yes | Optional hash of the originating PCD. |
| shared_secret_key | Option<KeyEncryption> | Yes | Optional encryption key used for shared secrets. | | shared_secret_key | KeyEncryption | Yes | Optional encryption key used for shared secrets. |
| pcd_new_version_hash | String | | The hash of the new version of the PCD. | | pcd_new_version_hash | String | | The hash of the new version of the PCD. |
| part_1_enc_hash_enc_by_sp_shared_secret | String | Yes | The first part of the hash encrypted by a service provider's shared secret. | | part_1_enc_hash_enc_by_sp_shared_secret | String | Yes | The first part of the hash encrypted by a service provider's shared secret. |
| shard_enc_by_sp_shared_secret | String | Yes | The shard encrypted by a service provider's shared secret. | | shard_enc_by_sp_shared_secret | String | Yes | The shard encrypted by a service provider's shared secret. |
### 11.2. <a name='RequestPrdConfirm'></a>RequestPrdConfirm ### 11.2. <a name='RequestPrdConfirm'></a>RequestPrdConfirm